Merge commit '4f373a5111f900af54301907132942f95276285c'
[ffmpeg.git] / libavdevice / jack.c
1 /*
2  * JACK Audio Connection Kit input device
3  * Copyright (c) 2009 Samalyse
4  * Author: Olivier Guilyardi <olivier samalyse com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #include "config.h"
24 #include <semaphore.h>
25 #include <jack/jack.h>
26
27 #include "libavutil/internal.h"
28 #include "libavutil/log.h"
29 #include "libavutil/fifo.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/time.h"
32 #include "libavcodec/avcodec.h"
33 #include "libavformat/avformat.h"
34 #include "libavformat/internal.h"
35 #include "timefilter.h"
36 #include "avdevice.h"
37
38 /**
39  * Size of the internal FIFO buffers as a number of audio packets
40  */
41 #define FIFO_PACKETS_NUM 16
42
43 typedef struct JackData {
44     AVClass        *class;
45     jack_client_t * client;
46     int             activated;
47     sem_t           packet_count;
48     jack_nframes_t  sample_rate;
49     jack_nframes_t  buffer_size;
50     jack_port_t **  ports;
51     int             nports;
52     TimeFilter *    timefilter;
53     AVFifoBuffer *  new_pkts;
54     AVFifoBuffer *  filled_pkts;
55     int             pkt_xrun;
56     int             jack_xrun;
57 } JackData;
58
59 static int process_callback(jack_nframes_t nframes, void *arg)
60 {
61     /* Warning: this function runs in realtime. One mustn't allocate memory here
62      * or do any other thing that could block. */
63
64     int i, j;
65     JackData *self = arg;
66     float * buffer;
67     jack_nframes_t latency, cycle_delay;
68     AVPacket pkt;
69     float *pkt_data;
70     double cycle_time;
71
72     if (!self->client)
73         return 0;
74
75     /* The approximate delay since the hardware interrupt as a number of frames */
76     cycle_delay = jack_frames_since_cycle_start(self->client);
77
78     /* Retrieve filtered cycle time */
79     cycle_time = ff_timefilter_update(self->timefilter,
80                                       av_gettime() / 1000000.0 - (double) cycle_delay / self->sample_rate,
81                                       self->buffer_size);
82
83     /* Check if an empty packet is available, and if there's enough space to send it back once filled */
84     if ((av_fifo_size(self->new_pkts) < sizeof(pkt)) || (av_fifo_space(self->filled_pkts) < sizeof(pkt))) {
85         self->pkt_xrun = 1;
86         return 0;
87     }
88
89     /* Retrieve empty (but allocated) packet */
90     av_fifo_generic_read(self->new_pkts, &pkt, sizeof(pkt), NULL);
91
92     pkt_data  = (float *) pkt.data;
93     latency   = 0;
94
95     /* Copy and interleave audio data from the JACK buffer into the packet */
96     for (i = 0; i < self->nports; i++) {
97     #if HAVE_JACK_PORT_GET_LATENCY_RANGE
98         jack_latency_range_t range;
99         jack_port_get_latency_range(self->ports[i], JackCaptureLatency, &range);
100         latency += range.max;
101     #else
102         latency += jack_port_get_total_latency(self->client, self->ports[i]);
103     #endif
104         buffer = jack_port_get_buffer(self->ports[i], self->buffer_size);
105         for (j = 0; j < self->buffer_size; j++)
106             pkt_data[j * self->nports + i] = buffer[j];
107     }
108
109     /* Timestamp the packet with the cycle start time minus the average latency */
110     pkt.pts = (cycle_time - (double) latency / (self->nports * self->sample_rate)) * 1000000.0;
111
112     /* Send the now filled packet back, and increase packet counter */
113     av_fifo_generic_write(self->filled_pkts, &pkt, sizeof(pkt), NULL);
114     sem_post(&self->packet_count);
115
116     return 0;
117 }
118
119 static void shutdown_callback(void *arg)
120 {
121     JackData *self = arg;
122     self->client = NULL;
123 }
124
125 static int xrun_callback(void *arg)
126 {
127     JackData *self = arg;
128     self->jack_xrun = 1;
129     ff_timefilter_reset(self->timefilter);
130     return 0;
131 }
132
133 static int supply_new_packets(JackData *self, AVFormatContext *context)
134 {
135     AVPacket pkt;
136     int test, pkt_size = self->buffer_size * self->nports * sizeof(float);
137
138     /* Supply the process callback with new empty packets, by filling the new
139      * packets FIFO buffer with as many packets as possible. process_callback()
140      * can't do this by itself, because it can't allocate memory in realtime. */
141     while (av_fifo_space(self->new_pkts) >= sizeof(pkt)) {
142         if ((test = av_new_packet(&pkt, pkt_size)) < 0) {
143             av_log(context, AV_LOG_ERROR, "Could not create packet of size %d\n", pkt_size);
144             return test;
145         }
146         av_fifo_generic_write(self->new_pkts, &pkt, sizeof(pkt), NULL);
147     }
148     return 0;
149 }
150
151 static int start_jack(AVFormatContext *context)
152 {
153     JackData *self = context->priv_data;
154     jack_status_t status;
155     int i, test;
156
157     /* Register as a JACK client, using the context filename as client name. */
158     self->client = jack_client_open(context->filename, JackNullOption, &status);
159     if (!self->client) {
160         av_log(context, AV_LOG_ERROR, "Unable to register as a JACK client\n");
161         return AVERROR(EIO);
162     }
163
164     sem_init(&self->packet_count, 0, 0);
165
166     self->sample_rate = jack_get_sample_rate(self->client);
167     self->ports       = av_malloc_array(self->nports, sizeof(*self->ports));
168     self->buffer_size = jack_get_buffer_size(self->client);
169
170     /* Register JACK ports */
171     for (i = 0; i < self->nports; i++) {
172         char str[16];
173         snprintf(str, sizeof(str), "input_%d", i + 1);
174         self->ports[i] = jack_port_register(self->client, str,
175                                             JACK_DEFAULT_AUDIO_TYPE,
176                                             JackPortIsInput, 0);
177         if (!self->ports[i]) {
178             av_log(context, AV_LOG_ERROR, "Unable to register port %s:%s\n",
179                    context->filename, str);
180             jack_client_close(self->client);
181             return AVERROR(EIO);
182         }
183     }
184
185     /* Register JACK callbacks */
186     jack_set_process_callback(self->client, process_callback, self);
187     jack_on_shutdown(self->client, shutdown_callback, self);
188     jack_set_xrun_callback(self->client, xrun_callback, self);
189
190     /* Create time filter */
191     self->timefilter  = ff_timefilter_new (1.0 / self->sample_rate, self->buffer_size, 1.5);
192     if (!self->timefilter) {
193         jack_client_close(self->client);
194         return AVERROR(ENOMEM);
195     }
196
197     /* Create FIFO buffers */
198     self->filled_pkts = av_fifo_alloc_array(FIFO_PACKETS_NUM, sizeof(AVPacket));
199     /* New packets FIFO with one extra packet for safety against underruns */
200     self->new_pkts    = av_fifo_alloc_array((FIFO_PACKETS_NUM + 1), sizeof(AVPacket));
201     if ((test = supply_new_packets(self, context))) {
202         jack_client_close(self->client);
203         return test;
204     }
205
206     return 0;
207
208 }
209
210 static void free_pkt_fifo(AVFifoBuffer **fifo)
211 {
212     AVPacket pkt;
213     while (av_fifo_size(*fifo)) {
214         av_fifo_generic_read(*fifo, &pkt, sizeof(pkt), NULL);
215         av_free_packet(&pkt);
216     }
217     av_fifo_freep(fifo);
218 }
219
220 static void stop_jack(JackData *self)
221 {
222     if (self->client) {
223         if (self->activated)
224             jack_deactivate(self->client);
225         jack_client_close(self->client);
226     }
227     sem_destroy(&self->packet_count);
228     free_pkt_fifo(&self->new_pkts);
229     free_pkt_fifo(&self->filled_pkts);
230     av_freep(&self->ports);
231     ff_timefilter_destroy(self->timefilter);
232 }
233
234 static int audio_read_header(AVFormatContext *context)
235 {
236     JackData *self = context->priv_data;
237     AVStream *stream;
238     int test;
239
240     if ((test = start_jack(context)))
241         return test;
242
243     stream = avformat_new_stream(context, NULL);
244     if (!stream) {
245         stop_jack(self);
246         return AVERROR(ENOMEM);
247     }
248
249     stream->codec->codec_type   = AVMEDIA_TYPE_AUDIO;
250 #if HAVE_BIGENDIAN
251     stream->codec->codec_id     = AV_CODEC_ID_PCM_F32BE;
252 #else
253     stream->codec->codec_id     = AV_CODEC_ID_PCM_F32LE;
254 #endif
255     stream->codec->sample_rate  = self->sample_rate;
256     stream->codec->channels     = self->nports;
257
258     avpriv_set_pts_info(stream, 64, 1, 1000000);  /* 64 bits pts in us */
259     return 0;
260 }
261
262 static int audio_read_packet(AVFormatContext *context, AVPacket *pkt)
263 {
264     JackData *self = context->priv_data;
265     struct timespec timeout = {0, 0};
266     int test;
267
268     /* Activate the JACK client on first packet read. Activating the JACK client
269      * means that process_callback() starts to get called at regular interval.
270      * If we activate it in audio_read_header(), we're actually reading audio data
271      * from the device before instructed to, and that may result in an overrun. */
272     if (!self->activated) {
273         if (!jack_activate(self->client)) {
274             self->activated = 1;
275             av_log(context, AV_LOG_INFO,
276                    "JACK client registered and activated (rate=%dHz, buffer_size=%d frames)\n",
277                    self->sample_rate, self->buffer_size);
278         } else {
279             av_log(context, AV_LOG_ERROR, "Unable to activate JACK client\n");
280             return AVERROR(EIO);
281         }
282     }
283
284     /* Wait for a packet coming back from process_callback(), if one isn't available yet */
285     timeout.tv_sec = av_gettime() / 1000000 + 2;
286     if (sem_timedwait(&self->packet_count, &timeout)) {
287         if (errno == ETIMEDOUT) {
288             av_log(context, AV_LOG_ERROR,
289                    "Input error: timed out when waiting for JACK process callback output\n");
290         } else {
291             char errbuf[128];
292             int ret = AVERROR(errno);
293             av_strerror(ret, errbuf, sizeof(errbuf));
294             av_log(context, AV_LOG_ERROR, "Error while waiting for audio packet: %s\n",
295                    errbuf);
296         }
297         if (!self->client)
298             av_log(context, AV_LOG_ERROR, "Input error: JACK server is gone\n");
299
300         return AVERROR(EIO);
301     }
302
303     if (self->pkt_xrun) {
304         av_log(context, AV_LOG_WARNING, "Audio packet xrun\n");
305         self->pkt_xrun = 0;
306     }
307
308     if (self->jack_xrun) {
309         av_log(context, AV_LOG_WARNING, "JACK xrun\n");
310         self->jack_xrun = 0;
311     }
312
313     /* Retrieve the packet filled with audio data by process_callback() */
314     av_fifo_generic_read(self->filled_pkts, pkt, sizeof(*pkt), NULL);
315
316     if ((test = supply_new_packets(self, context)))
317         return test;
318
319     return 0;
320 }
321
322 static int audio_read_close(AVFormatContext *context)
323 {
324     JackData *self = context->priv_data;
325     stop_jack(self);
326     return 0;
327 }
328
329 #define OFFSET(x) offsetof(JackData, x)
330 static const AVOption options[] = {
331     { "channels", "Number of audio channels.", OFFSET(nports), AV_OPT_TYPE_INT, { .i64 = 2 }, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
332     { NULL },
333 };
334
335 static const AVClass jack_indev_class = {
336     .class_name     = "JACK indev",
337     .item_name      = av_default_item_name,
338     .option         = options,
339     .version        = LIBAVUTIL_VERSION_INT,
340     .category       = AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT,
341 };
342
343 AVInputFormat ff_jack_demuxer = {
344     .name           = "jack",
345     .long_name      = NULL_IF_CONFIG_SMALL("JACK Audio Connection Kit"),
346     .priv_data_size = sizeof(JackData),
347     .read_header    = audio_read_header,
348     .read_packet    = audio_read_packet,
349     .read_close     = audio_read_close,
350     .flags          = AVFMT_NOFILE,
351     .priv_class     = &jack_indev_class,
352 };