jack.c 12 KB

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