h264_metadata: Add option to delete filler data
[libav.git] / libavdevice / jack.c
CommitLineData
80ff8a16
OG
1/*
2 * JACK Audio Connection Kit input device
3 * Copyright (c) 2009 Samalyse
4 * Author: Olivier Guilyardi <olivier samalyse com>
5 *
2912e87a 6 * This file is part of Libav.
80ff8a16 7 *
2912e87a 8 * Libav is free software; you can redistribute it and/or
80ff8a16
OG
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 *
2912e87a 13 * Libav is distributed in the hope that it will be useful,
80ff8a16
OG
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
2912e87a 19 * License along with Libav; if not, write to the Free Software
80ff8a16
OG
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
c201069f 27#include "libavutil/internal.h"
80ff8a16
OG
28#include "libavutil/log.h"
29#include "libavutil/fifo.h"
a7c93dae 30#include "libavutil/opt.h"
c4ef6a3e 31#include "libavutil/time.h"
80ff8a16
OG
32#include "libavcodec/avcodec.h"
33#include "libavformat/avformat.h"
c3f9ebf7 34#include "libavformat/internal.h"
5dd35b43 35#include "timefilter.h"
80ff8a16
OG
36
37/**
38 * Size of the internal FIFO buffers as a number of audio packets
39 */
40#define FIFO_PACKETS_NUM 16
41
c0de9159 42typedef struct JackData {
a7c93dae 43 AVClass *class;
80ff8a16
OG
44 jack_client_t * client;
45 int activated;
46 sem_t packet_count;
47 jack_nframes_t sample_rate;
48 jack_nframes_t buffer_size;
49 jack_port_t ** ports;
50 int nports;
51 TimeFilter * timefilter;
52 AVFifoBuffer * new_pkts;
53 AVFifoBuffer * filled_pkts;
54 int pkt_xrun;
55 int jack_xrun;
56} JackData;
57
58static int process_callback(jack_nframes_t nframes, void *arg)
59{
60 /* Warning: this function runs in realtime. One mustn't allocate memory here
61 * or do any other thing that could block. */
62
63 int i, j;
64 JackData *self = arg;
65 float * buffer;
66 jack_nframes_t latency, cycle_delay;
67 AVPacket pkt;
68 float *pkt_data;
69 double cycle_time;
70
71 if (!self->client)
72 return 0;
73
74 /* The approximate delay since the hardware interrupt as a number of frames */
75 cycle_delay = jack_frames_since_cycle_start(self->client);
76
77 /* Retrieve filtered cycle time */
78 cycle_time = ff_timefilter_update(self->timefilter,
79 av_gettime() / 1000000.0 - (double) cycle_delay / self->sample_rate,
80 self->buffer_size);
81
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))) {
84 self->pkt_xrun = 1;
85 return 0;
86 }
87
88 /* Retrieve empty (but allocated) packet */
89 av_fifo_generic_read(self->new_pkts, &pkt, sizeof(pkt), NULL);
90
91 pkt_data = (float *) pkt.data;
92 latency = 0;
93
94 /* Copy and interleave audio data from the JACK buffer into the packet */
95 for (i = 0; i < self->nports; i++) {
8772997d
SM
96 jack_latency_range_t range;
97 jack_port_get_latency_range(self->ports[i], JackCaptureLatency, &range);
98 latency += range.max;
80ff8a16
OG
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];
102 }
103
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;
106
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);
110
111 return 0;
112}
113
114static void shutdown_callback(void *arg)
115{
116 JackData *self = arg;
117 self->client = NULL;
118}
119
120static int xrun_callback(void *arg)
121{
122 JackData *self = arg;
123 self->jack_xrun = 1;
124 ff_timefilter_reset(self->timefilter);
125 return 0;
126}
127
128static int supply_new_packets(JackData *self, AVFormatContext *context)
129{
130 AVPacket pkt;
131 int test, pkt_size = self->buffer_size * self->nports * sizeof(float);
132
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);
139 return test;
140 }
141 av_fifo_generic_write(self->new_pkts, &pkt, sizeof(pkt), NULL);
142 }
143 return 0;
144}
145
a7c93dae 146static int start_jack(AVFormatContext *context)
80ff8a16
OG
147{
148 JackData *self = context->priv_data;
149 jack_status_t status;
150 int i, test;
151 double o, period;
152
153 /* Register as a JACK client, using the context filename as client name. */
34bcada4 154 self->client = jack_client_open(context->filename, JackNullOption, &status);
80ff8a16
OG
155 if (!self->client) {
156 av_log(context, AV_LOG_ERROR, "Unable to register as a JACK client\n");
157 return AVERROR(EIO);
158 }
159
160 sem_init(&self->packet_count, 0, 0);
161
162 self->sample_rate = jack_get_sample_rate(self->client);
80ff8a16 163 self->ports = av_malloc(self->nports * sizeof(*self->ports));
386e2755
FT
164 if (!self->ports)
165 return AVERROR(ENOMEM);
80ff8a16
OG
166 self->buffer_size = jack_get_buffer_size(self->client);
167
168 /* Register JACK ports */
169 for (i = 0; i < self->nports; i++) {
170 char str[16];
171 snprintf(str, sizeof(str), "input_%d", i + 1);
172 self->ports[i] = jack_port_register(self->client, str,
173 JACK_DEFAULT_AUDIO_TYPE,
174 JackPortIsInput, 0);
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);
179 return AVERROR(EIO);
180 }
181 }
182
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);
187
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);
327c439f
DB
192 if (!self->timefilter) {
193 jack_client_close(self->client);
194 return AVERROR(ENOMEM);
195 }
80ff8a16
OG
196
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));
bc1eace1
VG
201 if (!self->new_pkts) {
202 jack_client_close(self->client);
203 return AVERROR(ENOMEM);
204 }
80ff8a16
OG
205 if ((test = supply_new_packets(self, context))) {
206 jack_client_close(self->client);
207 return test;
208 }
209
210 return 0;
211
212}
213
214static void free_pkt_fifo(AVFifoBuffer *fifo)
215{
216 AVPacket pkt;
217 while (av_fifo_size(fifo)) {
218 av_fifo_generic_read(fifo, &pkt, sizeof(pkt), NULL);
ce70f28a 219 av_packet_unref(&pkt);
80ff8a16
OG
220 }
221 av_fifo_free(fifo);
222}
223
224static void stop_jack(JackData *self)
225{
226 if (self->client) {
227 if (self->activated)
228 jack_deactivate(self->client);
229 jack_client_close(self->client);
230 }
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);
236}
237
6e9651d1 238static int audio_read_header(AVFormatContext *context)
80ff8a16
OG
239{
240 JackData *self = context->priv_data;
241 AVStream *stream;
242 int test;
243
a7c93dae 244 if ((test = start_jack(context)))
80ff8a16
OG
245 return test;
246
3b3bbdd3 247 stream = avformat_new_stream(context, NULL);
80ff8a16
OG
248 if (!stream) {
249 stop_jack(self);
250 return AVERROR(ENOMEM);
251 }
252
9200514a 253 stream->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
63613fe6 254#if HAVE_BIGENDIAN
9200514a 255 stream->codecpar->codec_id = AV_CODEC_ID_PCM_F32BE;
80ff8a16 256#else
9200514a 257 stream->codecpar->codec_id = AV_CODEC_ID_PCM_F32LE;
80ff8a16 258#endif
9200514a
AK
259 stream->codecpar->sample_rate = self->sample_rate;
260 stream->codecpar->channels = self->nports;
80ff8a16 261
c3f9ebf7 262 avpriv_set_pts_info(stream, 64, 1, 1000000); /* 64 bits pts in us */
80ff8a16
OG
263 return 0;
264}
265
266static int audio_read_packet(AVFormatContext *context, AVPacket *pkt)
267{
268 JackData *self = context->priv_data;
269 struct timespec timeout = {0, 0};
270 int test;
271
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)) {
278 self->activated = 1;
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);
282 } else {
283 av_log(context, AV_LOG_ERROR, "Unable to activate JACK client\n");
284 return AVERROR(EIO);
285 }
286 }
287
da9cea77 288 /* Wait for a packet coming back from process_callback(), if one isn't available yet */
80ff8a16
OG
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");
294 } else {
2cd28693
LB
295 char errbuf[128];
296 int ret = AVERROR(errno);
297 av_strerror(ret, errbuf, sizeof(errbuf));
80ff8a16 298 av_log(context, AV_LOG_ERROR, "Error while waiting for audio packet: %s\n",
2cd28693 299 errbuf);
80ff8a16
OG
300 }
301 if (!self->client)
302 av_log(context, AV_LOG_ERROR, "Input error: JACK server is gone\n");
303
304 return AVERROR(EIO);
305 }
306
307 if (self->pkt_xrun) {
308 av_log(context, AV_LOG_WARNING, "Audio packet xrun\n");
309 self->pkt_xrun = 0;
310 }
311
312 if (self->jack_xrun) {
313 av_log(context, AV_LOG_WARNING, "JACK xrun\n");
314 self->jack_xrun = 0;
315 }
316
317 /* Retrieve the packet filled with audio data by process_callback() */
318 av_fifo_generic_read(self->filled_pkts, pkt, sizeof(*pkt), NULL);
319
320 if ((test = supply_new_packets(self, context)))
321 return test;
322
323 return 0;
324}
325
326static int audio_read_close(AVFormatContext *context)
327{
328 JackData *self = context->priv_data;
329 stop_jack(self);
330 return 0;
331}
332
a7c93dae
AK
333#define OFFSET(x) offsetof(JackData, x)
334static const AVOption options[] = {
e6153f17 335 { "channels", "Number of audio channels.", OFFSET(nports), AV_OPT_TYPE_INT, { .i64 = 2 }, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
a7c93dae
AK
336 { NULL },
337};
338
339static const AVClass jack_indev_class = {
340 .class_name = "JACK indev",
341 .item_name = av_default_item_name,
342 .option = options,
343 .version = LIBAVUTIL_VERSION_INT,
344};
345
c6610a21 346AVInputFormat ff_jack_demuxer = {
30b4ee79
DB
347 .name = "jack",
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,
80ff8a16 355};