FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pulse_audio_dec.c
Go to the documentation of this file.
1 /*
2  * Pulseaudio input
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>
6  *
7  * This file is part of FFmpeg.
8  *
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.
13  *
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.
18  *
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
22  */
23 
24 #include <pulse/rtclock.h>
25 #include <pulse/error.h>
26 
27 #include "libavutil/internal.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/time.h"
30 
31 #include "libavformat/avformat.h"
32 #include "libavformat/internal.h"
33 #include "pulse_audio_common.h"
34 #include "timefilter.h"
35 
36 #define DEFAULT_CODEC_ID AV_NE(AV_CODEC_ID_PCM_S16BE, AV_CODEC_ID_PCM_S16LE)
37 
38 typedef struct PulseData {
39  AVClass *class;
40  char *server;
41  char *name;
42  char *stream_name;
44  int channels;
47 
48  pa_threaded_mainloop *mainloop;
49  pa_context *context;
50  pa_stream *stream;
51 
54  int wallclock;
55 } PulseData;
56 
57 
58 #define CHECK_SUCCESS_GOTO(rerror, expression, label) \
59  do { \
60  if (!(expression)) { \
61  rerror = AVERROR_EXTERNAL; \
62  goto label; \
63  } \
64  } while (0)
65 
66 #define CHECK_DEAD_GOTO(p, rerror, label) \
67  do { \
68  if (!(p)->context || !PA_CONTEXT_IS_GOOD(pa_context_get_state((p)->context)) || \
69  !(p)->stream || !PA_STREAM_IS_GOOD(pa_stream_get_state((p)->stream))) { \
70  rerror = AVERROR_EXTERNAL; \
71  goto label; \
72  } \
73  } while (0)
74 
75 static void context_state_cb(pa_context *c, void *userdata) {
76  PulseData *p = userdata;
77 
78  switch (pa_context_get_state(c)) {
79  case PA_CONTEXT_READY:
80  case PA_CONTEXT_TERMINATED:
81  case PA_CONTEXT_FAILED:
82  pa_threaded_mainloop_signal(p->mainloop, 0);
83  break;
84  }
85 }
86 
87 static void stream_state_cb(pa_stream *s, void * userdata) {
88  PulseData *p = userdata;
89 
90  switch (pa_stream_get_state(s)) {
91  case PA_STREAM_READY:
92  case PA_STREAM_FAILED:
93  case PA_STREAM_TERMINATED:
94  pa_threaded_mainloop_signal(p->mainloop, 0);
95  break;
96  }
97 }
98 
99 static void stream_request_cb(pa_stream *s, size_t length, void *userdata) {
100  PulseData *p = userdata;
101 
102  pa_threaded_mainloop_signal(p->mainloop, 0);
103 }
104 
105 static void stream_latency_update_cb(pa_stream *s, void *userdata) {
106  PulseData *p = userdata;
107 
108  pa_threaded_mainloop_signal(p->mainloop, 0);
109 }
110 
112 {
113  PulseData *pd = s->priv_data;
114 
115  if (pd->mainloop)
116  pa_threaded_mainloop_stop(pd->mainloop);
117 
118  if (pd->stream)
119  pa_stream_unref(pd->stream);
120  pd->stream = NULL;
121 
122  if (pd->context) {
123  pa_context_disconnect(pd->context);
124  pa_context_unref(pd->context);
125  }
126  pd->context = NULL;
127 
128  if (pd->mainloop)
129  pa_threaded_mainloop_free(pd->mainloop);
130  pd->mainloop = NULL;
131 
133  pd->timefilter = NULL;
134 
135  return 0;
136 }
137 
139 {
140  PulseData *pd = s->priv_data;
141  AVStream *st;
142  char *device = NULL;
143  int ret;
144  enum AVCodecID codec_id =
146  const pa_sample_spec ss = { ff_codec_id_to_pulse_format(codec_id),
147  pd->sample_rate,
148  pd->channels };
149 
150  pa_buffer_attr attr = { -1 };
151 
152  st = avformat_new_stream(s, NULL);
153 
154  if (!st) {
155  av_log(s, AV_LOG_ERROR, "Cannot add stream\n");
156  return AVERROR(ENOMEM);
157  }
158 
159  attr.fragsize = pd->fragment_size;
160 
161  if (s->filename[0] != '\0' && strcmp(s->filename, "default"))
162  device = s->filename;
163 
164  if (!(pd->mainloop = pa_threaded_mainloop_new())) {
165  pulse_close(s);
166  return AVERROR_EXTERNAL;
167  }
168 
169  if (!(pd->context = pa_context_new(pa_threaded_mainloop_get_api(pd->mainloop), pd->name))) {
170  pulse_close(s);
171  return AVERROR_EXTERNAL;
172  }
173 
174  pa_context_set_state_callback(pd->context, context_state_cb, pd);
175 
176  if (pa_context_connect(pd->context, pd->server, 0, NULL) < 0) {
177  pulse_close(s);
178  return AVERROR(pa_context_errno(pd->context));
179  }
180 
181  pa_threaded_mainloop_lock(pd->mainloop);
182 
183  if (pa_threaded_mainloop_start(pd->mainloop) < 0) {
184  ret = -1;
185  goto unlock_and_fail;
186  }
187 
188  for (;;) {
189  pa_context_state_t state;
190 
191  state = pa_context_get_state(pd->context);
192 
193  if (state == PA_CONTEXT_READY)
194  break;
195 
196  if (!PA_CONTEXT_IS_GOOD(state)) {
197  ret = AVERROR(pa_context_errno(pd->context));
198  goto unlock_and_fail;
199  }
200 
201  /* Wait until the context is ready */
202  pa_threaded_mainloop_wait(pd->mainloop);
203  }
204 
205  if (!(pd->stream = pa_stream_new(pd->context, pd->stream_name, &ss, NULL))) {
206  ret = AVERROR(pa_context_errno(pd->context));
207  goto unlock_and_fail;
208  }
209 
210  pa_stream_set_state_callback(pd->stream, stream_state_cb, pd);
211  pa_stream_set_read_callback(pd->stream, stream_request_cb, pd);
212  pa_stream_set_write_callback(pd->stream, stream_request_cb, pd);
213  pa_stream_set_latency_update_callback(pd->stream, stream_latency_update_cb, pd);
214 
215  ret = pa_stream_connect_record(pd->stream, device, &attr,
216  PA_STREAM_INTERPOLATE_TIMING
217  |PA_STREAM_ADJUST_LATENCY
218  |PA_STREAM_AUTO_TIMING_UPDATE);
219 
220  if (ret < 0) {
221  ret = AVERROR(pa_context_errno(pd->context));
222  goto unlock_and_fail;
223  }
224 
225  for (;;) {
226  pa_stream_state_t state;
227 
228  state = pa_stream_get_state(pd->stream);
229 
230  if (state == PA_STREAM_READY)
231  break;
232 
233  if (!PA_STREAM_IS_GOOD(state)) {
234  ret = AVERROR(pa_context_errno(pd->context));
235  goto unlock_and_fail;
236  }
237 
238  /* Wait until the stream is ready */
239  pa_threaded_mainloop_wait(pd->mainloop);
240  }
241 
242  pa_threaded_mainloop_unlock(pd->mainloop);
243 
244  /* take real parameters */
246  st->codec->codec_id = codec_id;
247  st->codec->sample_rate = pd->sample_rate;
248  st->codec->channels = pd->channels;
249  avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
250 
251  pd->timefilter = ff_timefilter_new(1000000.0 / pd->sample_rate,
252  1000, 1.5E-6);
253 
254  if (!pd->timefilter) {
255  pulse_close(s);
256  return AVERROR(ENOMEM);
257  }
258 
259  return 0;
260 
261 unlock_and_fail:
262  pa_threaded_mainloop_unlock(pd->mainloop);
263 
264  pulse_close(s);
265  return ret;
266 }
267 
269 {
270  PulseData *pd = s->priv_data;
271  int ret;
272  size_t read_length;
273  const void *read_data = NULL;
274  int64_t dts;
275  pa_usec_t latency;
276  int negative;
277 
278  pa_threaded_mainloop_lock(pd->mainloop);
279 
280  CHECK_DEAD_GOTO(pd, ret, unlock_and_fail);
281 
282  while (!read_data) {
283  int r;
284 
285  r = pa_stream_peek(pd->stream, &read_data, &read_length);
286  CHECK_SUCCESS_GOTO(ret, r == 0, unlock_and_fail);
287 
288  if (read_length <= 0) {
289  pa_threaded_mainloop_wait(pd->mainloop);
290  CHECK_DEAD_GOTO(pd, ret, unlock_and_fail);
291  } else if (!read_data) {
292  /* There's a hole in the stream, skip it. We could generate
293  * silence, but that wouldn't work for compressed streams. */
294  r = pa_stream_drop(pd->stream);
295  CHECK_SUCCESS_GOTO(ret, r == 0, unlock_and_fail);
296  }
297  }
298 
299  if (av_new_packet(pkt, read_length) < 0) {
300  ret = AVERROR(ENOMEM);
301  goto unlock_and_fail;
302  }
303 
304  dts = av_gettime();
305  pa_operation_unref(pa_stream_update_timing_info(pd->stream, NULL, NULL));
306 
307  if (pa_stream_get_latency(pd->stream, &latency, &negative) >= 0) {
308  enum AVCodecID codec_id =
310  int frame_size = ((av_get_bits_per_sample(codec_id) >> 3) * pd->channels);
311  int frame_duration = read_length / frame_size;
312 
313 
314  if (negative) {
315  dts += latency;
316  } else
317  dts -= latency;
318  if (pd->wallclock)
319  pkt->pts = ff_timefilter_update(pd->timefilter, dts, pd->last_period);
320 
321  pd->last_period = frame_duration;
322  } else {
323  av_log(s, AV_LOG_WARNING, "pa_stream_get_latency() failed\n");
324  }
325 
326  memcpy(pkt->data, read_data, read_length);
327  pa_stream_drop(pd->stream);
328 
329  pa_threaded_mainloop_unlock(pd->mainloop);
330  return 0;
331 
332 unlock_and_fail:
333  pa_threaded_mainloop_unlock(pd->mainloop);
334  return ret;
335 }
336 
338 {
339  PulseData *s = h->priv_data;
340  return ff_pulse_audio_get_devices(device_list, s->server, 0);
341 }
342 
343 #define OFFSET(a) offsetof(PulseData, a)
344 #define D AV_OPT_FLAG_DECODING_PARAM
345 
346 static const AVOption options[] = {
347  { "server", "set PulseAudio server", OFFSET(server), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, D },
348  { "name", "set application name", OFFSET(name), AV_OPT_TYPE_STRING, {.str = LIBAVFORMAT_IDENT}, 0, 0, D },
349  { "stream_name", "set stream description", OFFSET(stream_name), AV_OPT_TYPE_STRING, {.str = "record"}, 0, 0, D },
350  { "sample_rate", "set sample rate in Hz", OFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 48000}, 1, INT_MAX, D },
351  { "channels", "set number of audio channels", OFFSET(channels), AV_OPT_TYPE_INT, {.i64 = 2}, 1, INT_MAX, D },
352  { "frame_size", "set number of bytes per frame", OFFSET(frame_size), AV_OPT_TYPE_INT, {.i64 = 1024}, 1, INT_MAX, D },
353  { "fragment_size", "set buffering size, affects latency and cpu usage", OFFSET(fragment_size), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D },
354  { "wallclock", "set the initial pts using the current time", OFFSET(wallclock), AV_OPT_TYPE_INT, {.i64 = 1}, -1, 1, D },
355  { NULL },
356 };
357 
358 static const AVClass pulse_demuxer_class = {
359  .class_name = "Pulse demuxer",
360  .item_name = av_default_item_name,
361  .option = options,
362  .version = LIBAVUTIL_VERSION_INT,
364 };
365 
367  .name = "pulse",
368  .long_name = NULL_IF_CONFIG_SMALL("Pulse audio input"),
369  .priv_data_size = sizeof(PulseData),
374  .flags = AVFMT_NOFILE,
375  .priv_class = &pulse_demuxer_class,
376 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
AVOption.
Definition: opt.h:255
void ff_timefilter_destroy(TimeFilter *self)
Free all resources associated with the filter.
Definition: timefilter.c:62
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define LIBAVUTIL_VERSION_INT
Definition: version.h:62
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4006
#define D
#define CHECK_DEAD_GOTO(p, rerror, label)
static av_cold int pulse_close(AVFormatContext *s)
static AVPacket pkt
AVInputFormat ff_pulse_demuxer
char * stream_name
static const AVClass pulse_demuxer_class
Format I/O context.
Definition: avformat.h:1272
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
Opaque type representing a time filter state.
Definition: timefilter.c:30
#define av_cold
Definition: attributes.h:74
AVOptions.
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:3672
uint8_t * data
Definition: avcodec.h:1173
static int read_data(void *opaque, uint8_t *buf, int buf_size)
Definition: hls.c:1020
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
#define CHECK_SUCCESS_GOTO(rerror, expression, label)
#define av_log(a,...)
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:83
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:102
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int av_get_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
Definition: utils.c:3326
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:175
const char * r
Definition: vf_curves.c:107
GLsizei GLsizei * length
Definition: opengl_enc.c:115
enum AVCodecID codec_id
Definition: mov_chan.c:433
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:861
common internal API header
#define LIBAVFORMAT_IDENT
Definition: version.h:44
pa_stream * stream
#define OFFSET(a)
char filename[1024]
input or output filename
Definition: avformat.h:1348
enum AVCodecID audio_codec_id
Forced audio codec_id.
Definition: avformat.h:1434
ret
Definition: avfilter.c:974
pa_sample_format_t av_cold ff_codec_id_to_pulse_format(enum AVCodecID codec_id)
static const AVOption options[]
TimeFilter * timefilter
char * server
static void stream_request_cb(pa_stream *s, size_t length, void *userdata)
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:620
int64_t av_gettime(void)
Get the current time in microseconds.
Definition: time.c:39
Stream structure.
Definition: avformat.h:842
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
sample_rate
TimeFilter * ff_timefilter_new(double time_base, double period, double bandwidth)
Create a new Delay Locked Loop time filter.
Definition: timefilter.c:46
int frame_size
Definition: mxfenc.c:1803
static void stream_state_cb(pa_stream *s, void *userdata)
enum AVMediaType codec_type
Definition: avcodec.h:1260
pa_context * context
enum AVCodecID codec_id
Definition: avcodec.h:1269
static av_cold int pulse_read_header(AVFormatContext *s)
int sample_rate
samples per second
Definition: avcodec.h:2012
Describe the class of an AVClass context structure.
Definition: log.h:67
int ff_pulse_audio_get_devices(AVDeviceInfoList *devices, const char *server, int output)
static void context_state_cb(pa_context *c, void *userdata)
static int get_device_list(AVOpenCLDeviceList *device_list)
Definition: opencl.c:195
List of devices.
Definition: avdevice.h:459
static uint32_t state
Definition: trasher.c:27
static int flags
Definition: cpu.c:47
Main libavformat public API header.
double ff_timefilter_update(TimeFilter *self, double system_time, double period)
Update the filter.
Definition: timefilter.c:72
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:465
static double c[64]
static void stream_latency_update_cb(pa_stream *s, void *userdata)
int channels
number of audio channels
Definition: avcodec.h:2013
void * priv_data
Format private data.
Definition: avformat.h:1300
static int pulse_get_device_list(AVFormatContext *h, AVDeviceInfoList *device_list)
pa_threaded_mainloop * mainloop
#define DEFAULT_CODEC_ID
static int pulse_read_packet(AVFormatContext *s, AVPacket *pkt)
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:628
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:57
This structure stores compressed data.
Definition: avcodec.h:1150
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1166
const char * name
Definition: opengl_enc.c:103