yading@10: /* yading@10: * JACK Audio Connection Kit input device yading@10: * Copyright (c) 2009 Samalyse yading@10: * Author: Olivier Guilyardi yading@10: * yading@10: * This file is part of FFmpeg. yading@10: * yading@10: * FFmpeg is free software; you can redistribute it and/or yading@10: * modify it under the terms of the GNU Lesser General Public yading@10: * License as published by the Free Software Foundation; either yading@10: * version 2.1 of the License, or (at your option) any later version. yading@10: * yading@10: * FFmpeg is distributed in the hope that it will be useful, yading@10: * but WITHOUT ANY WARRANTY; without even the implied warranty of yading@10: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU yading@10: * Lesser General Public License for more details. yading@10: * yading@10: * You should have received a copy of the GNU Lesser General Public yading@10: * License along with FFmpeg; if not, write to the Free Software yading@10: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA yading@10: */ yading@10: yading@10: #include "config.h" yading@10: #include yading@10: #include yading@10: yading@10: #include "libavutil/log.h" yading@10: #include "libavutil/fifo.h" yading@10: #include "libavutil/opt.h" yading@10: #include "libavutil/time.h" yading@10: #include "libavcodec/avcodec.h" yading@10: #include "libavformat/avformat.h" yading@10: #include "libavformat/internal.h" yading@10: #include "timefilter.h" yading@10: #include "avdevice.h" yading@10: yading@10: /** yading@10: * Size of the internal FIFO buffers as a number of audio packets yading@10: */ yading@10: #define FIFO_PACKETS_NUM 16 yading@10: yading@10: typedef struct { yading@10: AVClass *class; yading@10: jack_client_t * client; yading@10: int activated; yading@10: sem_t packet_count; yading@10: jack_nframes_t sample_rate; yading@10: jack_nframes_t buffer_size; yading@10: jack_port_t ** ports; yading@10: int nports; yading@10: TimeFilter * timefilter; yading@10: AVFifoBuffer * new_pkts; yading@10: AVFifoBuffer * filled_pkts; yading@10: int pkt_xrun; yading@10: int jack_xrun; yading@10: } JackData; yading@10: yading@10: static int process_callback(jack_nframes_t nframes, void *arg) yading@10: { yading@10: /* Warning: this function runs in realtime. One mustn't allocate memory here yading@10: * or do any other thing that could block. */ yading@10: yading@10: int i, j; yading@10: JackData *self = arg; yading@10: float * buffer; yading@10: jack_nframes_t latency, cycle_delay; yading@10: AVPacket pkt; yading@10: float *pkt_data; yading@10: double cycle_time; yading@10: yading@10: if (!self->client) yading@10: return 0; yading@10: yading@10: /* The approximate delay since the hardware interrupt as a number of frames */ yading@10: cycle_delay = jack_frames_since_cycle_start(self->client); yading@10: yading@10: /* Retrieve filtered cycle time */ yading@10: cycle_time = ff_timefilter_update(self->timefilter, yading@10: av_gettime() / 1000000.0 - (double) cycle_delay / self->sample_rate, yading@10: self->buffer_size); yading@10: yading@10: /* Check if an empty packet is available, and if there's enough space to send it back once filled */ yading@10: if ((av_fifo_size(self->new_pkts) < sizeof(pkt)) || (av_fifo_space(self->filled_pkts) < sizeof(pkt))) { yading@10: self->pkt_xrun = 1; yading@10: return 0; yading@10: } yading@10: yading@10: /* Retrieve empty (but allocated) packet */ yading@10: av_fifo_generic_read(self->new_pkts, &pkt, sizeof(pkt), NULL); yading@10: yading@10: pkt_data = (float *) pkt.data; yading@10: latency = 0; yading@10: yading@10: /* Copy and interleave audio data from the JACK buffer into the packet */ yading@10: for (i = 0; i < self->nports; i++) { yading@10: #if HAVE_JACK_PORT_GET_LATENCY_RANGE yading@10: jack_latency_range_t range; yading@10: jack_port_get_latency_range(self->ports[i], JackCaptureLatency, &range); yading@10: latency += range.max; yading@10: #else yading@10: latency += jack_port_get_total_latency(self->client, self->ports[i]); yading@10: #endif yading@10: buffer = jack_port_get_buffer(self->ports[i], self->buffer_size); yading@10: for (j = 0; j < self->buffer_size; j++) yading@10: pkt_data[j * self->nports + i] = buffer[j]; yading@10: } yading@10: yading@10: /* Timestamp the packet with the cycle start time minus the average latency */ yading@10: pkt.pts = (cycle_time - (double) latency / (self->nports * self->sample_rate)) * 1000000.0; yading@10: yading@10: /* Send the now filled packet back, and increase packet counter */ yading@10: av_fifo_generic_write(self->filled_pkts, &pkt, sizeof(pkt), NULL); yading@10: sem_post(&self->packet_count); yading@10: yading@10: return 0; yading@10: } yading@10: yading@10: static void shutdown_callback(void *arg) yading@10: { yading@10: JackData *self = arg; yading@10: self->client = NULL; yading@10: } yading@10: yading@10: static int xrun_callback(void *arg) yading@10: { yading@10: JackData *self = arg; yading@10: self->jack_xrun = 1; yading@10: ff_timefilter_reset(self->timefilter); yading@10: return 0; yading@10: } yading@10: yading@10: static int supply_new_packets(JackData *self, AVFormatContext *context) yading@10: { yading@10: AVPacket pkt; yading@10: int test, pkt_size = self->buffer_size * self->nports * sizeof(float); yading@10: yading@10: /* Supply the process callback with new empty packets, by filling the new yading@10: * packets FIFO buffer with as many packets as possible. process_callback() yading@10: * can't do this by itself, because it can't allocate memory in realtime. */ yading@10: while (av_fifo_space(self->new_pkts) >= sizeof(pkt)) { yading@10: if ((test = av_new_packet(&pkt, pkt_size)) < 0) { yading@10: av_log(context, AV_LOG_ERROR, "Could not create packet of size %d\n", pkt_size); yading@10: return test; yading@10: } yading@10: av_fifo_generic_write(self->new_pkts, &pkt, sizeof(pkt), NULL); yading@10: } yading@10: return 0; yading@10: } yading@10: yading@10: static int start_jack(AVFormatContext *context) yading@10: { yading@10: JackData *self = context->priv_data; yading@10: jack_status_t status; yading@10: int i, test; yading@10: yading@10: /* Register as a JACK client, using the context filename as client name. */ yading@10: self->client = jack_client_open(context->filename, JackNullOption, &status); yading@10: if (!self->client) { yading@10: av_log(context, AV_LOG_ERROR, "Unable to register as a JACK client\n"); yading@10: return AVERROR(EIO); yading@10: } yading@10: yading@10: sem_init(&self->packet_count, 0, 0); yading@10: yading@10: self->sample_rate = jack_get_sample_rate(self->client); yading@10: self->ports = av_malloc(self->nports * sizeof(*self->ports)); yading@10: self->buffer_size = jack_get_buffer_size(self->client); yading@10: yading@10: /* Register JACK ports */ yading@10: for (i = 0; i < self->nports; i++) { yading@10: char str[16]; yading@10: snprintf(str, sizeof(str), "input_%d", i + 1); yading@10: self->ports[i] = jack_port_register(self->client, str, yading@10: JACK_DEFAULT_AUDIO_TYPE, yading@10: JackPortIsInput, 0); yading@10: if (!self->ports[i]) { yading@10: av_log(context, AV_LOG_ERROR, "Unable to register port %s:%s\n", yading@10: context->filename, str); yading@10: jack_client_close(self->client); yading@10: return AVERROR(EIO); yading@10: } yading@10: } yading@10: yading@10: /* Register JACK callbacks */ yading@10: jack_set_process_callback(self->client, process_callback, self); yading@10: jack_on_shutdown(self->client, shutdown_callback, self); yading@10: jack_set_xrun_callback(self->client, xrun_callback, self); yading@10: yading@10: /* Create time filter */ yading@10: self->timefilter = ff_timefilter_new (1.0 / self->sample_rate, self->buffer_size, 1.5); yading@10: yading@10: /* Create FIFO buffers */ yading@10: self->filled_pkts = av_fifo_alloc(FIFO_PACKETS_NUM * sizeof(AVPacket)); yading@10: /* New packets FIFO with one extra packet for safety against underruns */ yading@10: self->new_pkts = av_fifo_alloc((FIFO_PACKETS_NUM + 1) * sizeof(AVPacket)); yading@10: if ((test = supply_new_packets(self, context))) { yading@10: jack_client_close(self->client); yading@10: return test; yading@10: } yading@10: yading@10: return 0; yading@10: yading@10: } yading@10: yading@10: static void free_pkt_fifo(AVFifoBuffer *fifo) yading@10: { yading@10: AVPacket pkt; yading@10: while (av_fifo_size(fifo)) { yading@10: av_fifo_generic_read(fifo, &pkt, sizeof(pkt), NULL); yading@10: av_free_packet(&pkt); yading@10: } yading@10: av_fifo_free(fifo); yading@10: } yading@10: yading@10: static void stop_jack(JackData *self) yading@10: { yading@10: if (self->client) { yading@10: if (self->activated) yading@10: jack_deactivate(self->client); yading@10: jack_client_close(self->client); yading@10: } yading@10: sem_destroy(&self->packet_count); yading@10: free_pkt_fifo(self->new_pkts); yading@10: free_pkt_fifo(self->filled_pkts); yading@10: av_freep(&self->ports); yading@10: ff_timefilter_destroy(self->timefilter); yading@10: } yading@10: yading@10: static int audio_read_header(AVFormatContext *context) yading@10: { yading@10: JackData *self = context->priv_data; yading@10: AVStream *stream; yading@10: int test; yading@10: yading@10: if ((test = start_jack(context))) yading@10: return test; yading@10: yading@10: stream = avformat_new_stream(context, NULL); yading@10: if (!stream) { yading@10: stop_jack(self); yading@10: return AVERROR(ENOMEM); yading@10: } yading@10: yading@10: stream->codec->codec_type = AVMEDIA_TYPE_AUDIO; yading@10: #if HAVE_BIGENDIAN yading@10: stream->codec->codec_id = AV_CODEC_ID_PCM_F32BE; yading@10: #else yading@10: stream->codec->codec_id = AV_CODEC_ID_PCM_F32LE; yading@10: #endif yading@10: stream->codec->sample_rate = self->sample_rate; yading@10: stream->codec->channels = self->nports; yading@10: yading@10: avpriv_set_pts_info(stream, 64, 1, 1000000); /* 64 bits pts in us */ yading@10: return 0; yading@10: } yading@10: yading@10: static int audio_read_packet(AVFormatContext *context, AVPacket *pkt) yading@10: { yading@10: JackData *self = context->priv_data; yading@10: struct timespec timeout = {0, 0}; yading@10: int test; yading@10: yading@10: /* Activate the JACK client on first packet read. Activating the JACK client yading@10: * means that process_callback() starts to get called at regular interval. yading@10: * If we activate it in audio_read_header(), we're actually reading audio data yading@10: * from the device before instructed to, and that may result in an overrun. */ yading@10: if (!self->activated) { yading@10: if (!jack_activate(self->client)) { yading@10: self->activated = 1; yading@10: av_log(context, AV_LOG_INFO, yading@10: "JACK client registered and activated (rate=%dHz, buffer_size=%d frames)\n", yading@10: self->sample_rate, self->buffer_size); yading@10: } else { yading@10: av_log(context, AV_LOG_ERROR, "Unable to activate JACK client\n"); yading@10: return AVERROR(EIO); yading@10: } yading@10: } yading@10: yading@10: /* Wait for a packet coming back from process_callback(), if one isn't available yet */ yading@10: timeout.tv_sec = av_gettime() / 1000000 + 2; yading@10: if (sem_timedwait(&self->packet_count, &timeout)) { yading@10: if (errno == ETIMEDOUT) { yading@10: av_log(context, AV_LOG_ERROR, yading@10: "Input error: timed out when waiting for JACK process callback output\n"); yading@10: } else { yading@10: av_log(context, AV_LOG_ERROR, "Error while waiting for audio packet: %s\n", yading@10: strerror(errno)); yading@10: } yading@10: if (!self->client) yading@10: av_log(context, AV_LOG_ERROR, "Input error: JACK server is gone\n"); yading@10: yading@10: return AVERROR(EIO); yading@10: } yading@10: yading@10: if (self->pkt_xrun) { yading@10: av_log(context, AV_LOG_WARNING, "Audio packet xrun\n"); yading@10: self->pkt_xrun = 0; yading@10: } yading@10: yading@10: if (self->jack_xrun) { yading@10: av_log(context, AV_LOG_WARNING, "JACK xrun\n"); yading@10: self->jack_xrun = 0; yading@10: } yading@10: yading@10: /* Retrieve the packet filled with audio data by process_callback() */ yading@10: av_fifo_generic_read(self->filled_pkts, pkt, sizeof(*pkt), NULL); yading@10: yading@10: if ((test = supply_new_packets(self, context))) yading@10: return test; yading@10: yading@10: return 0; yading@10: } yading@10: yading@10: static int audio_read_close(AVFormatContext *context) yading@10: { yading@10: JackData *self = context->priv_data; yading@10: stop_jack(self); yading@10: return 0; yading@10: } yading@10: yading@10: #define OFFSET(x) offsetof(JackData, x) yading@10: static const AVOption options[] = { yading@10: { "channels", "Number of audio channels.", OFFSET(nports), AV_OPT_TYPE_INT, { .i64 = 2 }, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM }, yading@10: { NULL }, yading@10: }; yading@10: yading@10: static const AVClass jack_indev_class = { yading@10: .class_name = "JACK indev", yading@10: .item_name = av_default_item_name, yading@10: .option = options, yading@10: .version = LIBAVUTIL_VERSION_INT, yading@10: }; yading@10: yading@10: AVInputFormat ff_jack_demuxer = { yading@10: .name = "jack", yading@10: .long_name = NULL_IF_CONFIG_SMALL("JACK Audio Connection Kit"), yading@10: .priv_data_size = sizeof(JackData), yading@10: .read_header = audio_read_header, yading@10: .read_packet = audio_read_packet, yading@10: .read_close = audio_read_close, yading@10: .flags = AVFMT_NOFILE, yading@10: .priv_class = &jack_indev_class, yading@10: };