jack.c 11 KB

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