jack: add 'channels' private option.
[ffmpeg.git] / libavdevice / jack_audio.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 Libav.
7  *
8  * Libav 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  * Libav 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 Libav; 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/log.h"
28 #include "libavutil/fifo.h"
29 #include "libavutil/opt.h"
30 #include "libavcodec/avcodec.h"
31 #include "libavformat/avformat.h"
32 #include "libavformat/timefilter.h"
33
34 /**
35  * Size of the internal FIFO buffers as a number of audio packets
36  */
37 #define FIFO_PACKETS_NUM 16
38
39 typedef struct {
40     AVClass        *class;
41     jack_client_t * client;
42     int             activated;
43     sem_t           packet_count;
44     jack_nframes_t  sample_rate;
45     jack_nframes_t  buffer_size;
46     jack_port_t **  ports;
47     int             nports;
48     TimeFilter *    timefilter;
49     AVFifoBuffer *  new_pkts;
50     AVFifoBuffer *  filled_pkts;
51     int             pkt_xrun;
52     int             jack_xrun;
53 } JackData;
54
55 static int process_callback(jack_nframes_t nframes, void *arg)
56 {
57     /* Warning: this function runs in realtime. One mustn't allocate memory here
58      * or do any other thing that could block. */
59
60     int i, j;
61     JackData *self = arg;
62     float * buffer;
63     jack_nframes_t latency, cycle_delay;
64     AVPacket pkt;
65     float *pkt_data;
66     double cycle_time;
67
68     if (!self->client)
69         return 0;
70
71     /* The approximate delay since the hardware interrupt as a number of frames */
72     cycle_delay = jack_frames_since_cycle_start(self->client);
73
74     /* Retrieve filtered cycle time */
75     cycle_time = ff_timefilter_update(self->timefilter,
76                                       av_gettime() / 1000000.0 - (double) cycle_delay / self->sample_rate,
77                                       self->buffer_size);
78
79     /* Check if an empty packet is available, and if there's enough space to send it back once filled */
80     if ((av_fifo_size(self->new_pkts) < sizeof(pkt)) || (av_fifo_space(self->filled_pkts) < sizeof(pkt))) {
81         self->pkt_xrun = 1;
82         return 0;
83     }
84
85     /* Retrieve empty (but allocated) packet */
86     av_fifo_generic_read(self->new_pkts, &pkt, sizeof(pkt), NULL);
87
88     pkt_data  = (float *) pkt.data;
89     latency   = 0;
90
91     /* Copy and interleave audio data from the JACK buffer into the packet */
92     for (i = 0; i < self->nports; i++) {
93         latency += jack_port_get_total_latency(self->client, self->ports[i]);
94         buffer = jack_port_get_buffer(self->ports[i], self->buffer_size);
95         for (j = 0; j < self->buffer_size; j++)
96             pkt_data[j * self->nports + i] = buffer[j];
97     }
98
99     /* Timestamp the packet with the cycle start time minus the average latency */
100     pkt.pts = (cycle_time - (double) latency / (self->nports * self->sample_rate)) * 1000000.0;
101
102     /* Send the now filled packet back, and increase packet counter */
103     av_fifo_generic_write(self->filled_pkts, &pkt, sizeof(pkt), NULL);
104     sem_post(&self->packet_count);
105
106     return 0;
107 }
108
109 static void shutdown_callback(void *arg)
110 {
111     JackData *self = arg;
112     self->client = NULL;
113 }
114
115 static int xrun_callback(void *arg)
116 {
117     JackData *self = arg;
118     self->jack_xrun = 1;
119     ff_timefilter_reset(self->timefilter);
120     return 0;
121 }
122
123 static int supply_new_packets(JackData *self, AVFormatContext *context)
124 {
125     AVPacket pkt;
126     int test, pkt_size = self->buffer_size * self->nports * sizeof(float);
127
128     /* Supply the process callback with new empty packets, by filling the new
129      * packets FIFO buffer with as many packets as possible. process_callback()
130      * can't do this by itself, because it can't allocate memory in realtime. */
131     while (av_fifo_space(self->new_pkts) >= sizeof(pkt)) {
132         if ((test = av_new_packet(&pkt, pkt_size)) < 0) {
133             av_log(context, AV_LOG_ERROR, "Could not create packet of size %d\n", pkt_size);
134             return test;
135         }
136         av_fifo_generic_write(self->new_pkts, &pkt, sizeof(pkt), NULL);
137     }
138     return 0;
139 }
140
141 static int start_jack(AVFormatContext *context)
142 {
143     JackData *self = context->priv_data;
144     jack_status_t status;
145     int i, test;
146     double o, period;
147
148     /* Register as a JACK client, using the context filename as client name. */
149     self->client = jack_client_open(context->filename, JackNullOption, &status);
150     if (!self->client) {
151         av_log(context, AV_LOG_ERROR, "Unable to register as a JACK client\n");
152         return AVERROR(EIO);
153     }
154
155     sem_init(&self->packet_count, 0, 0);
156
157     self->sample_rate = jack_get_sample_rate(self->client);
158     self->ports       = av_malloc(self->nports * sizeof(*self->ports));
159     self->buffer_size = jack_get_buffer_size(self->client);
160
161     /* Register JACK ports */
162     for (i = 0; i < self->nports; i++) {
163         char str[16];
164         snprintf(str, sizeof(str), "input_%d", i + 1);
165         self->ports[i] = jack_port_register(self->client, str,
166                                             JACK_DEFAULT_AUDIO_TYPE,
167                                             JackPortIsInput, 0);
168         if (!self->ports[i]) {
169             av_log(context, AV_LOG_ERROR, "Unable to register port %s:%s\n",
170                    context->filename, str);
171             jack_client_close(self->client);
172             return AVERROR(EIO);
173         }
174     }
175
176     /* Register JACK callbacks */
177     jack_set_process_callback(self->client, process_callback, self);
178     jack_on_shutdown(self->client, shutdown_callback, self);
179     jack_set_xrun_callback(self->client, xrun_callback, self);
180
181     /* Create time filter */
182     period            = (double) self->buffer_size / self->sample_rate;
183     o                 = 2 * M_PI * 1.5 * period; /// bandwidth: 1.5Hz
184     self->timefilter  = ff_timefilter_new (1.0 / self->sample_rate, sqrt(2 * o), o * o);
185
186     /* Create FIFO buffers */
187     self->filled_pkts = av_fifo_alloc(FIFO_PACKETS_NUM * sizeof(AVPacket));
188     /* New packets FIFO with one extra packet for safety against underruns */
189     self->new_pkts    = av_fifo_alloc((FIFO_PACKETS_NUM + 1) * sizeof(AVPacket));
190     if ((test = supply_new_packets(self, context))) {
191         jack_client_close(self->client);
192         return test;
193     }
194
195     return 0;
196
197 }
198
199 static void free_pkt_fifo(AVFifoBuffer *fifo)
200 {
201     AVPacket pkt;
202     while (av_fifo_size(fifo)) {
203         av_fifo_generic_read(fifo, &pkt, sizeof(pkt), NULL);
204         av_free_packet(&pkt);
205     }
206     av_fifo_free(fifo);
207 }
208
209 static void stop_jack(JackData *self)
210 {
211     if (self->client) {
212         if (self->activated)
213             jack_deactivate(self->client);
214         jack_client_close(self->client);
215     }
216     sem_destroy(&self->packet_count);
217     free_pkt_fifo(self->new_pkts);
218     free_pkt_fifo(self->filled_pkts);
219     av_freep(&self->ports);
220     ff_timefilter_destroy(self->timefilter);
221 }
222
223 static int audio_read_header(AVFormatContext *context, AVFormatParameters *params)
224 {
225     JackData *self = context->priv_data;
226     AVStream *stream;
227     int test;
228
229     if ((test = start_jack(context)))
230         return test;
231
232     stream = av_new_stream(context, 0);
233     if (!stream) {
234         stop_jack(self);
235         return AVERROR(ENOMEM);
236     }
237
238     stream->codec->codec_type   = AVMEDIA_TYPE_AUDIO;
239 #if HAVE_BIGENDIAN
240     stream->codec->codec_id     = CODEC_ID_PCM_F32BE;
241 #else
242     stream->codec->codec_id     = CODEC_ID_PCM_F32LE;
243 #endif
244     stream->codec->sample_rate  = self->sample_rate;
245     stream->codec->channels     = self->nports;
246
247     av_set_pts_info(stream, 64, 1, 1000000);  /* 64 bits pts in us */
248     return 0;
249 }
250
251 static int audio_read_packet(AVFormatContext *context, AVPacket *pkt)
252 {
253     JackData *self = context->priv_data;
254     struct timespec timeout = {0, 0};
255     int test;
256
257     /* Activate the JACK client on first packet read. Activating the JACK client
258      * means that process_callback() starts to get called at regular interval.
259      * If we activate it in audio_read_header(), we're actually reading audio data
260      * from the device before instructed to, and that may result in an overrun. */
261     if (!self->activated) {
262         if (!jack_activate(self->client)) {
263             self->activated = 1;
264             av_log(context, AV_LOG_INFO,
265                    "JACK client registered and activated (rate=%dHz, buffer_size=%d frames)\n",
266                    self->sample_rate, self->buffer_size);
267         } else {
268             av_log(context, AV_LOG_ERROR, "Unable to activate JACK client\n");
269             return AVERROR(EIO);
270         }
271     }
272
273     /* Wait for a packet comming back from process_callback(), if one isn't available yet */
274     timeout.tv_sec = av_gettime() / 1000000 + 2;
275     if (sem_timedwait(&self->packet_count, &timeout)) {
276         if (errno == ETIMEDOUT) {
277             av_log(context, AV_LOG_ERROR,
278                    "Input error: timed out when waiting for JACK process callback output\n");
279         } else {
280             av_log(context, AV_LOG_ERROR, "Error while waiting for audio packet: %s\n",
281                    strerror(errno));
282         }
283         if (!self->client)
284             av_log(context, AV_LOG_ERROR, "Input error: JACK server is gone\n");
285
286         return AVERROR(EIO);
287     }
288
289     if (self->pkt_xrun) {
290         av_log(context, AV_LOG_WARNING, "Audio packet xrun\n");
291         self->pkt_xrun = 0;
292     }
293
294     if (self->jack_xrun) {
295         av_log(context, AV_LOG_WARNING, "JACK xrun\n");
296         self->jack_xrun = 0;
297     }
298
299     /* Retrieve the packet filled with audio data by process_callback() */
300     av_fifo_generic_read(self->filled_pkts, pkt, sizeof(*pkt), NULL);
301
302     if ((test = supply_new_packets(self, context)))
303         return test;
304
305     return 0;
306 }
307
308 static int audio_read_close(AVFormatContext *context)
309 {
310     JackData *self = context->priv_data;
311     stop_jack(self);
312     return 0;
313 }
314
315 #define OFFSET(x) offsetof(JackData, x)
316 static const AVOption options[] = {
317     { "channels", "Number of audio channels.", OFFSET(nports), FF_OPT_TYPE_INT, { 2 }, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
318     { NULL },
319 };
320
321 static const AVClass jack_indev_class = {
322     .class_name     = "JACK indev",
323     .item_name      = av_default_item_name,
324     .option         = options,
325     .version        = LIBAVUTIL_VERSION_INT,
326 };
327
328 AVInputFormat ff_jack_demuxer = {
329     "jack",
330     NULL_IF_CONFIG_SMALL("JACK Audio Connection Kit"),
331     sizeof(JackData),
332     NULL,
333     audio_read_header,
334     audio_read_packet,
335     audio_read_close,
336     .flags = AVFMT_NOFILE,
337     .priv_class = &jack_indev_class,
338 };