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