3 * Copyright (c) 2011 Luca Barbato <lu_zero@gentoo.org>
4 * Copyright 2004-2006 Lennart Poettering
5 * Copyright (c) 2014 Michael Niedermayer <michaelni@gmx.at>
7 * This file is part of FFmpeg.
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * FFmpeg is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <pulse/rtclock.h>
25 #include <pulse/error.h>
26 #include "libavformat/avformat.h"
27 #include "libavformat/internal.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/time.h"
30 #include "pulse_audio_common.h"
31 #include "timefilter.h"
33 #define DEFAULT_CODEC_ID AV_NE(AV_CODEC_ID_PCM_S16BE, AV_CODEC_ID_PCM_S16LE)
35 typedef struct PulseData {
45 pa_threaded_mainloop *mainloop;
49 TimeFilter *timefilter;
54 #define CHECK_SUCCESS_GOTO(rerror, expression, label) \
56 if (!(expression)) { \
57 rerror = AVERROR_EXTERNAL; \
62 #define CHECK_DEAD_GOTO(p, rerror, label) \
64 if (!(p)->context || !PA_CONTEXT_IS_GOOD(pa_context_get_state((p)->context)) || \
65 !(p)->stream || !PA_STREAM_IS_GOOD(pa_stream_get_state((p)->stream))) { \
66 rerror = AVERROR_EXTERNAL; \
71 static void context_state_cb(pa_context *c, void *userdata) {
72 PulseData *p = userdata;
74 switch (pa_context_get_state(c)) {
75 case PA_CONTEXT_READY:
76 case PA_CONTEXT_TERMINATED:
77 case PA_CONTEXT_FAILED:
78 pa_threaded_mainloop_signal(p->mainloop, 0);
83 static void stream_state_cb(pa_stream *s, void * userdata) {
84 PulseData *p = userdata;
86 switch (pa_stream_get_state(s)) {
88 case PA_STREAM_FAILED:
89 case PA_STREAM_TERMINATED:
90 pa_threaded_mainloop_signal(p->mainloop, 0);
95 static void stream_request_cb(pa_stream *s, size_t length, void *userdata) {
96 PulseData *p = userdata;
98 pa_threaded_mainloop_signal(p->mainloop, 0);
101 static void stream_latency_update_cb(pa_stream *s, void *userdata) {
102 PulseData *p = userdata;
104 pa_threaded_mainloop_signal(p->mainloop, 0);
107 static av_cold int pulse_close(AVFormatContext *s)
109 PulseData *pd = s->priv_data;
112 pa_threaded_mainloop_stop(pd->mainloop);
115 pa_stream_unref(pd->stream);
119 pa_context_disconnect(pd->context);
120 pa_context_unref(pd->context);
125 pa_threaded_mainloop_free(pd->mainloop);
128 ff_timefilter_destroy(pd->timefilter);
129 pd->timefilter = NULL;
134 static av_cold int pulse_read_header(AVFormatContext *s)
136 PulseData *pd = s->priv_data;
140 enum AVCodecID codec_id =
141 s->audio_codec_id == AV_CODEC_ID_NONE ? DEFAULT_CODEC_ID : s->audio_codec_id;
142 const pa_sample_spec ss = { ff_codec_id_to_pulse_format(codec_id),
146 pa_buffer_attr attr = { -1 };
148 st = avformat_new_stream(s, NULL);
151 av_log(s, AV_LOG_ERROR, "Cannot add stream\n");
152 return AVERROR(ENOMEM);
155 attr.fragsize = pd->fragment_size;
157 if (strcmp(s->filename, "default"))
158 device = s->filename;
160 if (!(pd->mainloop = pa_threaded_mainloop_new())) {
162 return AVERROR_EXTERNAL;
165 if (!(pd->context = pa_context_new(pa_threaded_mainloop_get_api(pd->mainloop), pd->name))) {
167 return AVERROR_EXTERNAL;
170 pa_context_set_state_callback(pd->context, context_state_cb, pd);
172 if (pa_context_connect(pd->context, pd->server, 0, NULL) < 0) {
174 return AVERROR(pa_context_errno(pd->context));
177 pa_threaded_mainloop_lock(pd->mainloop);
179 if (pa_threaded_mainloop_start(pd->mainloop) < 0) {
181 goto unlock_and_fail;
185 pa_context_state_t state;
187 state = pa_context_get_state(pd->context);
189 if (state == PA_CONTEXT_READY)
192 if (!PA_CONTEXT_IS_GOOD(state)) {
193 ret = AVERROR(pa_context_errno(pd->context));
194 goto unlock_and_fail;
197 /* Wait until the context is ready */
198 pa_threaded_mainloop_wait(pd->mainloop);
201 if (!(pd->stream = pa_stream_new(pd->context, pd->stream_name, &ss, NULL))) {
202 ret = AVERROR(pa_context_errno(pd->context));
203 goto unlock_and_fail;
206 pa_stream_set_state_callback(pd->stream, stream_state_cb, pd);
207 pa_stream_set_read_callback(pd->stream, stream_request_cb, pd);
208 pa_stream_set_write_callback(pd->stream, stream_request_cb, pd);
209 pa_stream_set_latency_update_callback(pd->stream, stream_latency_update_cb, pd);
211 ret = pa_stream_connect_record(pd->stream, device, &attr,
212 PA_STREAM_INTERPOLATE_TIMING
213 |PA_STREAM_ADJUST_LATENCY
214 |PA_STREAM_AUTO_TIMING_UPDATE);
217 ret = AVERROR(pa_context_errno(pd->context));
218 goto unlock_and_fail;
222 pa_stream_state_t state;
224 state = pa_stream_get_state(pd->stream);
226 if (state == PA_STREAM_READY)
229 if (!PA_STREAM_IS_GOOD(state)) {
230 ret = AVERROR(pa_context_errno(pd->context));
231 goto unlock_and_fail;
234 /* Wait until the stream is ready */
235 pa_threaded_mainloop_wait(pd->mainloop);
238 pa_threaded_mainloop_unlock(pd->mainloop);
240 /* take real parameters */
241 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
242 st->codec->codec_id = codec_id;
243 st->codec->sample_rate = pd->sample_rate;
244 st->codec->channels = pd->channels;
245 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
247 pd->timefilter = ff_timefilter_new(1000000.0 / pd->sample_rate,
250 if (!pd->timefilter) {
252 return AVERROR(ENOMEM);
258 pa_threaded_mainloop_unlock(pd->mainloop);
264 static int pulse_read_packet(AVFormatContext *s, AVPacket *pkt)
266 PulseData *pd = s->priv_data;
269 const void *read_data = NULL;
274 pa_threaded_mainloop_lock(pd->mainloop);
276 CHECK_DEAD_GOTO(pd, ret, unlock_and_fail);
281 r = pa_stream_peek(pd->stream, &read_data, &read_length);
282 CHECK_SUCCESS_GOTO(ret, r == 0, unlock_and_fail);
284 if (read_length <= 0) {
285 pa_threaded_mainloop_wait(pd->mainloop);
286 CHECK_DEAD_GOTO(pd, ret, unlock_and_fail);
287 } else if (!read_data) {
288 /* There's a hole in the stream, skip it. We could generate
289 * silence, but that wouldn't work for compressed streams. */
290 r = pa_stream_drop(pd->stream);
291 CHECK_SUCCESS_GOTO(ret, r == 0, unlock_and_fail);
295 if (av_new_packet(pkt, read_length) < 0) {
296 ret = AVERROR(ENOMEM);
297 goto unlock_and_fail;
301 pa_operation_unref(pa_stream_update_timing_info(pd->stream, NULL, NULL));
303 if (pa_stream_get_latency(pd->stream, &latency, &negative) >= 0) {
304 enum AVCodecID codec_id =
305 s->audio_codec_id == AV_CODEC_ID_NONE ? DEFAULT_CODEC_ID : s->audio_codec_id;
306 int frame_size = ((av_get_bits_per_sample(codec_id) >> 3) * pd->channels);
307 int frame_duration = read_length / frame_size;
314 pkt->pts = ff_timefilter_update(pd->timefilter, dts, pd->last_period);
316 pd->last_period = frame_duration;
318 av_log(s, AV_LOG_WARNING, "pa_stream_get_latency() failed\n");
321 memcpy(pkt->data, read_data, read_length);
322 pa_stream_drop(pd->stream);
324 pa_threaded_mainloop_unlock(pd->mainloop);
328 pa_threaded_mainloop_unlock(pd->mainloop);
332 static int pulse_get_device_list(AVFormatContext *h, AVDeviceInfoList *device_list)
334 PulseData *s = h->priv_data;
335 return ff_pulse_audio_get_devices(device_list, s->server, 0);
338 #define OFFSET(a) offsetof(PulseData, a)
339 #define D AV_OPT_FLAG_DECODING_PARAM
341 static const AVOption options[] = {
342 { "server", "set PulseAudio server", OFFSET(server), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, D },
343 { "name", "set application name", OFFSET(name), AV_OPT_TYPE_STRING, {.str = LIBAVFORMAT_IDENT}, 0, 0, D },
344 { "stream_name", "set stream description", OFFSET(stream_name), AV_OPT_TYPE_STRING, {.str = "record"}, 0, 0, D },
345 { "sample_rate", "set sample rate in Hz", OFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 48000}, 1, INT_MAX, D },
346 { "channels", "set number of audio channels", OFFSET(channels), AV_OPT_TYPE_INT, {.i64 = 2}, 1, INT_MAX, D },
347 { "frame_size", "set number of bytes per frame", OFFSET(frame_size), AV_OPT_TYPE_INT, {.i64 = 1024}, 1, INT_MAX, D },
348 { "fragment_size", "set buffering size, affects latency and cpu usage", OFFSET(fragment_size), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D },
352 static const AVClass pulse_demuxer_class = {
353 .class_name = "Pulse demuxer",
354 .item_name = av_default_item_name,
356 .version = LIBAVUTIL_VERSION_INT,
357 .category = AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT,
360 AVInputFormat ff_pulse_demuxer = {
362 .long_name = NULL_IF_CONFIG_SMALL("Pulse audio input"),
363 .priv_data_size = sizeof(PulseData),
364 .read_header = pulse_read_header,
365 .read_packet = pulse_read_packet,
366 .read_close = pulse_close,
367 .get_device_list = pulse_get_device_list,
368 .flags = AVFMT_NOFILE,
369 .priv_class = &pulse_demuxer_class,