2 * JACK Audio Connection Kit input device
3 * Copyright (c) 2009 Samalyse
4 * Author: Olivier Guilyardi <olivier samalyse com>
6 * This file is part of Libav.
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.
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.
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
24 #include <semaphore.h>
25 #include <jack/jack.h>
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"
38 * Size of the internal FIFO buffers as a number of audio packets
40 #define FIFO_PACKETS_NUM 16
42 typedef struct JackData {
44 jack_client_t * client;
47 jack_nframes_t sample_rate;
48 jack_nframes_t buffer_size;
51 TimeFilter * timefilter;
52 AVFifoBuffer * new_pkts;
53 AVFifoBuffer * filled_pkts;
58 static int process_callback(jack_nframes_t nframes, void *arg)
60 /* Warning: this function runs in realtime. One mustn't allocate memory here
61 * or do any other thing that could block. */
66 jack_nframes_t latency, cycle_delay;
74 /* The approximate delay since the hardware interrupt as a number of frames */
75 cycle_delay = jack_frames_since_cycle_start(self->client);
77 /* Retrieve filtered cycle time */
78 cycle_time = ff_timefilter_update(self->timefilter,
79 av_gettime() / 1000000.0 - (double) cycle_delay / self->sample_rate,
82 /* Check if an empty packet is available, and if there's enough space to send it back once filled */
83 if ((av_fifo_size(self->new_pkts) < sizeof(pkt)) || (av_fifo_space(self->filled_pkts) < sizeof(pkt))) {
88 /* Retrieve empty (but allocated) packet */
89 av_fifo_generic_read(self->new_pkts, &pkt, sizeof(pkt), NULL);
91 pkt_data = (float *) pkt.data;
94 /* Copy and interleave audio data from the JACK buffer into the packet */
95 for (i = 0; i < self->nports; i++) {
96 jack_latency_range_t range;
97 jack_port_get_latency_range(self->ports[i], JackCaptureLatency, &range);
99 buffer = jack_port_get_buffer(self->ports[i], self->buffer_size);
100 for (j = 0; j < self->buffer_size; j++)
101 pkt_data[j * self->nports + i] = buffer[j];
104 /* Timestamp the packet with the cycle start time minus the average latency */
105 pkt.pts = (cycle_time - (double) latency / (self->nports * self->sample_rate)) * 1000000.0;
107 /* Send the now filled packet back, and increase packet counter */
108 av_fifo_generic_write(self->filled_pkts, &pkt, sizeof(pkt), NULL);
109 sem_post(&self->packet_count);
114 static void shutdown_callback(void *arg)
116 JackData *self = arg;
120 static int xrun_callback(void *arg)
122 JackData *self = arg;
124 ff_timefilter_reset(self->timefilter);
128 static int supply_new_packets(JackData *self, AVFormatContext *context)
131 int test, pkt_size = self->buffer_size * self->nports * sizeof(float);
133 /* Supply the process callback with new empty packets, by filling the new
134 * packets FIFO buffer with as many packets as possible. process_callback()
135 * can't do this by itself, because it can't allocate memory in realtime. */
136 while (av_fifo_space(self->new_pkts) >= sizeof(pkt)) {
137 if ((test = av_new_packet(&pkt, pkt_size)) < 0) {
138 av_log(context, AV_LOG_ERROR, "Could not create packet of size %d\n", pkt_size);
141 av_fifo_generic_write(self->new_pkts, &pkt, sizeof(pkt), NULL);
146 static int start_jack(AVFormatContext *context)
148 JackData *self = context->priv_data;
149 jack_status_t status;
153 /* Register as a JACK client, using the context filename as client name. */
154 self->client = jack_client_open(context->filename, JackNullOption, &status);
156 av_log(context, AV_LOG_ERROR, "Unable to register as a JACK client\n");
160 sem_init(&self->packet_count, 0, 0);
162 self->sample_rate = jack_get_sample_rate(self->client);
163 self->ports = av_malloc(self->nports * sizeof(*self->ports));
165 return AVERROR(ENOMEM);
166 self->buffer_size = jack_get_buffer_size(self->client);
168 /* Register JACK ports */
169 for (i = 0; i < self->nports; i++) {
171 snprintf(str, sizeof(str), "input_%d", i + 1);
172 self->ports[i] = jack_port_register(self->client, str,
173 JACK_DEFAULT_AUDIO_TYPE,
175 if (!self->ports[i]) {
176 av_log(context, AV_LOG_ERROR, "Unable to register port %s:%s\n",
177 context->filename, str);
178 jack_client_close(self->client);
183 /* Register JACK callbacks */
184 jack_set_process_callback(self->client, process_callback, self);
185 jack_on_shutdown(self->client, shutdown_callback, self);
186 jack_set_xrun_callback(self->client, xrun_callback, self);
188 /* Create time filter */
189 period = (double) self->buffer_size / self->sample_rate;
190 o = 2 * M_PI * 1.5 * period; /// bandwidth: 1.5Hz
191 self->timefilter = ff_timefilter_new (1.0 / self->sample_rate, sqrt(2 * o), o * o);
192 if (!self->timefilter) {
193 jack_client_close(self->client);
194 return AVERROR(ENOMEM);
197 /* Create FIFO buffers */
198 self->filled_pkts = av_fifo_alloc(FIFO_PACKETS_NUM * sizeof(AVPacket));
199 /* New packets FIFO with one extra packet for safety against underruns */
200 self->new_pkts = av_fifo_alloc((FIFO_PACKETS_NUM + 1) * sizeof(AVPacket));
201 if (!self->new_pkts) {
202 jack_client_close(self->client);
203 return AVERROR(ENOMEM);
205 if ((test = supply_new_packets(self, context))) {
206 jack_client_close(self->client);
214 static void free_pkt_fifo(AVFifoBuffer *fifo)
217 while (av_fifo_size(fifo)) {
218 av_fifo_generic_read(fifo, &pkt, sizeof(pkt), NULL);
219 av_packet_unref(&pkt);
224 static void stop_jack(JackData *self)
228 jack_deactivate(self->client);
229 jack_client_close(self->client);
231 sem_destroy(&self->packet_count);
232 free_pkt_fifo(self->new_pkts);
233 free_pkt_fifo(self->filled_pkts);
234 av_freep(&self->ports);
235 ff_timefilter_destroy(self->timefilter);
238 static int audio_read_header(AVFormatContext *context)
240 JackData *self = context->priv_data;
244 if ((test = start_jack(context)))
247 stream = avformat_new_stream(context, NULL);
250 return AVERROR(ENOMEM);
253 stream->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
255 stream->codecpar->codec_id = AV_CODEC_ID_PCM_F32BE;
257 stream->codecpar->codec_id = AV_CODEC_ID_PCM_F32LE;
259 stream->codecpar->sample_rate = self->sample_rate;
260 stream->codecpar->channels = self->nports;
262 avpriv_set_pts_info(stream, 64, 1, 1000000); /* 64 bits pts in us */
266 static int audio_read_packet(AVFormatContext *context, AVPacket *pkt)
268 JackData *self = context->priv_data;
269 struct timespec timeout = {0, 0};
272 /* Activate the JACK client on first packet read. Activating the JACK client
273 * means that process_callback() starts to get called at regular interval.
274 * If we activate it in audio_read_header(), we're actually reading audio data
275 * from the device before instructed to, and that may result in an overrun. */
276 if (!self->activated) {
277 if (!jack_activate(self->client)) {
279 av_log(context, AV_LOG_INFO,
280 "JACK client registered and activated (rate=%dHz, buffer_size=%d frames)\n",
281 self->sample_rate, self->buffer_size);
283 av_log(context, AV_LOG_ERROR, "Unable to activate JACK client\n");
288 /* Wait for a packet coming back from process_callback(), if one isn't available yet */
289 timeout.tv_sec = av_gettime() / 1000000 + 2;
290 if (sem_timedwait(&self->packet_count, &timeout)) {
291 if (errno == ETIMEDOUT) {
292 av_log(context, AV_LOG_ERROR,
293 "Input error: timed out when waiting for JACK process callback output\n");
296 int ret = AVERROR(errno);
297 av_strerror(ret, errbuf, sizeof(errbuf));
298 av_log(context, AV_LOG_ERROR, "Error while waiting for audio packet: %s\n",
302 av_log(context, AV_LOG_ERROR, "Input error: JACK server is gone\n");
307 if (self->pkt_xrun) {
308 av_log(context, AV_LOG_WARNING, "Audio packet xrun\n");
312 if (self->jack_xrun) {
313 av_log(context, AV_LOG_WARNING, "JACK xrun\n");
317 /* Retrieve the packet filled with audio data by process_callback() */
318 av_fifo_generic_read(self->filled_pkts, pkt, sizeof(*pkt), NULL);
320 if ((test = supply_new_packets(self, context)))
326 static int audio_read_close(AVFormatContext *context)
328 JackData *self = context->priv_data;
333 #define OFFSET(x) offsetof(JackData, x)
334 static const AVOption options[] = {
335 { "channels", "Number of audio channels.", OFFSET(nports), AV_OPT_TYPE_INT, { .i64 = 2 }, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
339 static const AVClass jack_indev_class = {
340 .class_name = "JACK indev",
341 .item_name = av_default_item_name,
343 .version = LIBAVUTIL_VERSION_INT,
346 AVInputFormat ff_jack_demuxer = {
348 .long_name = NULL_IF_CONFIG_SMALL("JACK Audio Connection Kit"),
349 .priv_data_size = sizeof(JackData),
350 .read_header = audio_read_header,
351 .read_packet = audio_read_packet,
352 .read_close = audio_read_close,
353 .flags = AVFMT_NOFILE,
354 .priv_class = &jack_indev_class,