2 * Blackmagic DeckLink input
3 * Copyright (c) 2013-2014 Luca Barbato, Deti Fliegl
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <DeckLinkAPI.h>
25 #include <semaphore.h>
29 #include "libavformat/avformat.h"
30 #include "libavformat/internal.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/common.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/time.h"
35 #include "libavutil/mathematics.h"
41 #include "decklink_common.h"
42 #include "decklink_dec.h"
45 static uint8_t calc_parity_and_line_offset(int line)
47 uint8_t ret = (line < 313) << 5;
48 if (line >= 7 && line <= 22)
50 if (line >= 320 && line <= 335)
55 int teletext_data_unit_from_vbi_data(int line, uint8_t *src, uint8_t *tgt)
57 vbi_bit_slicer slicer;
59 vbi_bit_slicer_init(&slicer, 720, 13500000, 6937500, 6937500, 0x00aaaae4, 0xffff, 18, 6, 42 * 8, VBI_MODULATION_NRZ_MSB, VBI_PIXFMT_UYVY);
61 if (vbi_bit_slice(&slicer, src, tgt + 4) == FALSE)
64 tgt[0] = 0x02; // data_unit_id
65 tgt[1] = 0x2c; // data_unit_length
66 tgt[2] = calc_parity_and_line_offset(line); // field_parity, line_offset
67 tgt[3] = 0xe4; // framing code
73 static void avpacket_queue_init(AVFormatContext *avctx, AVPacketQueue *q)
75 memset(q, 0, sizeof(AVPacketQueue));
76 pthread_mutex_init(&q->mutex, NULL);
77 pthread_cond_init(&q->cond, NULL);
81 static void avpacket_queue_flush(AVPacketQueue *q)
83 AVPacketList *pkt, *pkt1;
85 pthread_mutex_lock(&q->mutex);
86 for (pkt = q->first_pkt; pkt != NULL; pkt = pkt1) {
88 av_packet_unref(&pkt->pkt);
95 pthread_mutex_unlock(&q->mutex);
98 static void avpacket_queue_end(AVPacketQueue *q)
100 avpacket_queue_flush(q);
101 pthread_mutex_destroy(&q->mutex);
102 pthread_cond_destroy(&q->cond);
105 static unsigned long long avpacket_queue_size(AVPacketQueue *q)
107 unsigned long long size;
108 pthread_mutex_lock(&q->mutex);
110 pthread_mutex_unlock(&q->mutex);
114 static int avpacket_queue_put(AVPacketQueue *q, AVPacket *pkt)
118 // Drop Packet if queue size is > 1GB
119 if (avpacket_queue_size(q) > 1024 * 1024 * 1024 ) {
120 av_log(q->avctx, AV_LOG_WARNING, "Decklink input buffer overrun!\n");
123 /* duplicate the packet */
124 if (av_dup_packet(pkt) < 0) {
128 pkt1 = (AVPacketList *)av_malloc(sizeof(AVPacketList));
135 pthread_mutex_lock(&q->mutex);
140 q->last_pkt->next = pkt1;
145 q->size += pkt1->pkt.size + sizeof(*pkt1);
147 pthread_cond_signal(&q->cond);
149 pthread_mutex_unlock(&q->mutex);
153 static int avpacket_queue_get(AVPacketQueue *q, AVPacket *pkt, int block)
158 pthread_mutex_lock(&q->mutex);
163 q->first_pkt = pkt1->next;
168 q->size -= pkt1->pkt.size + sizeof(*pkt1);
177 pthread_cond_wait(&q->cond, &q->mutex);
180 pthread_mutex_unlock(&q->mutex);
184 class decklink_input_callback : public IDeckLinkInputCallback
187 decklink_input_callback(AVFormatContext *_avctx);
188 ~decklink_input_callback();
190 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
191 virtual ULONG STDMETHODCALLTYPE AddRef(void);
192 virtual ULONG STDMETHODCALLTYPE Release(void);
193 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents, IDeckLinkDisplayMode*, BMDDetectedVideoInputFormatFlags);
194 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame*, IDeckLinkAudioInputPacket*);
198 pthread_mutex_t m_mutex;
199 AVFormatContext *avctx;
202 int64_t initial_video_pts;
203 int64_t initial_audio_pts;
206 decklink_input_callback::decklink_input_callback(AVFormatContext *_avctx) : m_refCount(0)
209 decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
210 ctx = (struct decklink_ctx *)cctx->ctx;
212 initial_audio_pts = initial_video_pts = AV_NOPTS_VALUE;
213 pthread_mutex_init(&m_mutex, NULL);
216 decklink_input_callback::~decklink_input_callback()
218 pthread_mutex_destroy(&m_mutex);
221 ULONG decklink_input_callback::AddRef(void)
223 pthread_mutex_lock(&m_mutex);
225 pthread_mutex_unlock(&m_mutex);
227 return (ULONG)m_refCount;
230 ULONG decklink_input_callback::Release(void)
232 pthread_mutex_lock(&m_mutex);
234 pthread_mutex_unlock(&m_mutex);
236 if (m_refCount == 0) {
241 return (ULONG)m_refCount;
244 static int64_t get_pkt_pts(IDeckLinkVideoInputFrame *videoFrame,
245 IDeckLinkAudioInputPacket *audioFrame,
247 DecklinkPtsSource pts_src,
248 AVRational time_base, int64_t *initial_pts)
250 int64_t pts = AV_NOPTS_VALUE;
251 BMDTimeValue bmd_pts;
252 BMDTimeValue bmd_duration;
253 HRESULT res = E_INVALIDARG;
257 res = audioFrame->GetPacketTime(&bmd_pts, time_base.den);
261 res = videoFrame->GetStreamTime(&bmd_pts, &bmd_duration, time_base.den);
263 case PTS_SRC_REFERENCE:
265 res = videoFrame->GetHardwareReferenceTimestamp(time_base.den, &bmd_pts, &bmd_duration);
267 case PTS_SRC_WALLCLOCK:
268 pts = av_rescale_q(wallclock, AV_TIME_BASE_Q, time_base);
272 pts = bmd_pts / time_base.num;
274 if (pts != AV_NOPTS_VALUE && *initial_pts == AV_NOPTS_VALUE)
276 if (*initial_pts != AV_NOPTS_VALUE)
282 HRESULT decklink_input_callback::VideoInputFrameArrived(
283 IDeckLinkVideoInputFrame *videoFrame, IDeckLinkAudioInputPacket *audioFrame)
286 void *audioFrameBytes;
287 BMDTimeValue frameTime;
288 BMDTimeValue frameDuration;
289 int64_t wallclock = 0;
292 if (ctx->audio_pts_source == PTS_SRC_WALLCLOCK || ctx->video_pts_source == PTS_SRC_WALLCLOCK)
293 wallclock = av_gettime_relative();
295 // Handle Video Frame
298 av_init_packet(&pkt);
299 if (ctx->frameCount % 25 == 0) {
300 unsigned long long qsize = avpacket_queue_size(&ctx->queue);
301 av_log(avctx, AV_LOG_DEBUG,
302 "Frame received (#%lu) - Valid (%liB) - QSize %fMB\n",
304 videoFrame->GetRowBytes() * videoFrame->GetHeight(),
305 (double)qsize / 1024 / 1024);
308 videoFrame->GetBytes(&frameBytes);
309 videoFrame->GetStreamTime(&frameTime, &frameDuration,
310 ctx->video_st->time_base.den);
312 if (videoFrame->GetFlags() & bmdFrameHasNoInputSource) {
313 if (ctx->draw_bars && videoFrame->GetPixelFormat() == bmdFormat8BitYUV) {
315 0xEA80EA80, 0xD292D210, 0xA910A9A5, 0x90229035,
316 0x6ADD6ACA, 0x51EF515A, 0x286D28EF, 0x10801080 };
317 int width = videoFrame->GetWidth();
318 int height = videoFrame->GetHeight();
319 unsigned *p = (unsigned *)frameBytes;
321 for (int y = 0; y < height; y++) {
322 for (int x = 0; x < width; x += 2)
323 *p++ = bars[(x * 8) / width];
328 av_log(avctx, AV_LOG_WARNING, "Frame received (#%lu) - No input signal detected "
329 "- Frames dropped %u\n", ctx->frameCount, ++ctx->dropped);
334 av_log(avctx, AV_LOG_WARNING, "Frame received (#%lu) - Input returned "
335 "- Frames dropped %u\n", ctx->frameCount, ++ctx->dropped);
340 pkt.pts = get_pkt_pts(videoFrame, audioFrame, wallclock, ctx->video_pts_source, ctx->video_st->time_base, &initial_video_pts);
343 pkt.duration = frameDuration;
344 //To be made sure it still applies
345 pkt.flags |= AV_PKT_FLAG_KEY;
346 pkt.stream_index = ctx->video_st->index;
347 pkt.data = (uint8_t *)frameBytes;
348 pkt.size = videoFrame->GetRowBytes() *
349 videoFrame->GetHeight();
350 //fprintf(stderr,"Video Frame size %d ts %d\n", pkt.size, pkt.pts);
353 if (!no_video && ctx->teletext_lines && videoFrame->GetPixelFormat() == bmdFormat8BitYUV && videoFrame->GetWidth() == 720) {
354 IDeckLinkVideoFrameAncillary *vanc;
356 uint8_t txt_buf0[1611]; // max 35 * 46 bytes decoded teletext lines + 1 byte data_identifier
357 uint8_t *txt_buf = txt_buf0;
359 if (videoFrame->GetAncillaryData(&vanc) == S_OK) {
361 int64_t line_mask = 1;
362 txt_buf[0] = 0x10; // data_identifier - EBU_data
364 for (i = 6; i < 336; i++, line_mask <<= 1) {
366 if ((ctx->teletext_lines & line_mask) && vanc->GetBufferForVerticalBlankingLine(i, (void**)&buf) == S_OK) {
367 if (teletext_data_unit_from_vbi_data(i, buf, txt_buf) >= 0)
374 if (txt_buf - txt_buf0 > 1) {
375 int stuffing_units = (4 - ((45 + txt_buf - txt_buf0) / 46) % 4) % 4;
376 while (stuffing_units--) {
377 memset(txt_buf, 0xff, 46);
378 txt_buf[1] = 0x2c; // data_unit_length
381 av_init_packet(&txt_pkt);
382 txt_pkt.pts = pkt.pts;
383 txt_pkt.dts = pkt.dts;
384 txt_pkt.stream_index = ctx->teletext_st->index;
385 txt_pkt.data = txt_buf0;
386 txt_pkt.size = txt_buf - txt_buf0;
387 if (avpacket_queue_put(&ctx->queue, &txt_pkt) < 0) {
395 if (avpacket_queue_put(&ctx->queue, &pkt) < 0) {
400 // Handle Audio Frame
403 BMDTimeValue audio_pts;
404 av_init_packet(&pkt);
407 pkt.size = audioFrame->GetSampleFrameCount() * ctx->audio_st->codecpar->channels * (16 / 8);
408 audioFrame->GetBytes(&audioFrameBytes);
409 audioFrame->GetPacketTime(&audio_pts, ctx->audio_st->time_base.den);
410 pkt.pts = get_pkt_pts(videoFrame, audioFrame, wallclock, ctx->audio_pts_source, ctx->audio_st->time_base, &initial_audio_pts);
413 //fprintf(stderr,"Audio Frame size %d ts %d\n", pkt.size, pkt.pts);
414 pkt.flags |= AV_PKT_FLAG_KEY;
415 pkt.stream_index = ctx->audio_st->index;
416 pkt.data = (uint8_t *)audioFrameBytes;
418 if (avpacket_queue_put(&ctx->queue, &pkt) < 0) {
426 HRESULT decklink_input_callback::VideoInputFormatChanged(
427 BMDVideoInputFormatChangedEvents events, IDeckLinkDisplayMode *mode,
428 BMDDetectedVideoInputFormatFlags)
433 static HRESULT decklink_start_input(AVFormatContext *avctx)
435 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
436 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
438 ctx->input_callback = new decklink_input_callback(avctx);
439 ctx->dli->SetCallback(ctx->input_callback);
440 return ctx->dli->StartStreams();
445 av_cold int ff_decklink_read_close(AVFormatContext *avctx)
447 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
448 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
450 if (ctx->capture_started) {
451 ctx->dli->StopStreams();
452 ctx->dli->DisableVideoInput();
453 ctx->dli->DisableAudioInput();
456 ff_decklink_cleanup(avctx);
457 avpacket_queue_end(&ctx->queue);
459 av_freep(&cctx->ctx);
464 av_cold int ff_decklink_read_header(AVFormatContext *avctx)
466 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
467 struct decklink_ctx *ctx;
475 ctx = (struct decklink_ctx *) av_mallocz(sizeof(struct decklink_ctx));
477 return AVERROR(ENOMEM);
478 ctx->list_devices = cctx->list_devices;
479 ctx->list_formats = cctx->list_formats;
480 ctx->teletext_lines = cctx->teletext_lines;
481 ctx->preroll = cctx->preroll;
482 ctx->duplex_mode = cctx->duplex_mode;
483 if (cctx->video_input > 0 && (unsigned int)cctx->video_input < FF_ARRAY_ELEMS(decklink_video_connection_map))
484 ctx->video_input = decklink_video_connection_map[cctx->video_input];
485 if (cctx->audio_input > 0 && (unsigned int)cctx->audio_input < FF_ARRAY_ELEMS(decklink_audio_connection_map))
486 ctx->audio_input = decklink_audio_connection_map[cctx->audio_input];
487 ctx->audio_pts_source = cctx->audio_pts_source;
488 ctx->video_pts_source = cctx->video_pts_source;
489 ctx->draw_bars = cctx->draw_bars;
493 if (ctx->teletext_lines) {
494 av_log(avctx, AV_LOG_ERROR, "Libzvbi support is needed for capturing teletext, please recompile FFmpeg.\n");
495 return AVERROR(ENOSYS);
499 /* Check audio channel option for valid values: 2, 8 or 16 */
500 switch (cctx->audio_channels) {
506 av_log(avctx, AV_LOG_ERROR, "Value of channels option must be one of 2, 8 or 16\n");
507 return AVERROR(EINVAL);
510 /* List available devices. */
511 if (ctx->list_devices) {
512 ff_decklink_list_devices(avctx);
516 strcpy (fname, avctx->filename);
517 tmp=strchr (fname, '@');
519 av_log(avctx, AV_LOG_WARNING, "The @mode syntax is deprecated and will be removed. Please use the -format_code option.\n");
520 mode_num = atoi (tmp+1);
524 ret = ff_decklink_init_device(avctx, fname);
528 /* Get input device. */
529 if (ctx->dl->QueryInterface(IID_IDeckLinkInput, (void **) &ctx->dli) != S_OK) {
530 av_log(avctx, AV_LOG_ERROR, "Could not open input device from '%s'\n",
536 /* List supported formats. */
537 if (ctx->list_formats) {
538 ff_decklink_list_formats(avctx, DIRECTION_IN);
543 if (mode_num > 0 || cctx->format_code) {
544 if (ff_decklink_set_format(avctx, DIRECTION_IN, mode_num) < 0) {
545 av_log(avctx, AV_LOG_ERROR, "Could not set mode number %d or format code %s for %s\n",
546 mode_num, (cctx->format_code) ? cctx->format_code : "(unset)", fname);
553 st = avformat_new_stream(avctx, NULL);
555 av_log(avctx, AV_LOG_ERROR, "Cannot add stream\n");
556 ret = AVERROR(ENOMEM);
559 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
560 st->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
561 st->codecpar->sample_rate = bmdAudioSampleRate48kHz;
562 st->codecpar->channels = cctx->audio_channels;
563 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
566 st = avformat_new_stream(avctx, NULL);
568 av_log(avctx, AV_LOG_ERROR, "Cannot add stream\n");
569 ret = AVERROR(ENOMEM);
572 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
573 st->codecpar->width = ctx->bmd_width;
574 st->codecpar->height = ctx->bmd_height;
576 st->time_base.den = ctx->bmd_tb_den;
577 st->time_base.num = ctx->bmd_tb_num;
578 av_stream_set_r_frame_rate(st, av_make_q(st->time_base.den, st->time_base.num));
581 st->codecpar->codec_id = AV_CODEC_ID_V210;
582 st->codecpar->codec_tag = MKTAG('V', '2', '1', '0');
583 st->codecpar->bit_rate = av_rescale(ctx->bmd_width * ctx->bmd_height * 64, st->time_base.den, st->time_base.num * 3);
585 st->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
586 st->codecpar->format = AV_PIX_FMT_UYVY422;
587 st->codecpar->codec_tag = MKTAG('U', 'Y', 'V', 'Y');
588 st->codecpar->bit_rate = av_rescale(ctx->bmd_width * ctx->bmd_height * 16, st->time_base.den, st->time_base.num);
591 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
595 if (ctx->teletext_lines) {
596 st = avformat_new_stream(avctx, NULL);
598 av_log(avctx, AV_LOG_ERROR, "Cannot add stream\n");
599 ret = AVERROR(ENOMEM);
602 st->codecpar->codec_type = AVMEDIA_TYPE_SUBTITLE;
603 st->time_base.den = ctx->bmd_tb_den;
604 st->time_base.num = ctx->bmd_tb_num;
605 st->codecpar->codec_id = AV_CODEC_ID_DVB_TELETEXT;
606 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
607 ctx->teletext_st = st;
610 av_log(avctx, AV_LOG_VERBOSE, "Using %d input audio channels\n", ctx->audio_st->codecpar->channels);
611 result = ctx->dli->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType16bitInteger, ctx->audio_st->codecpar->channels);
613 if (result != S_OK) {
614 av_log(avctx, AV_LOG_ERROR, "Cannot enable audio input\n");
619 result = ctx->dli->EnableVideoInput(ctx->bmd_mode,
620 cctx->v210 ? bmdFormat10BitYUV : bmdFormat8BitYUV,
621 bmdVideoInputFlagDefault);
623 if (result != S_OK) {
624 av_log(avctx, AV_LOG_ERROR, "Cannot enable video input\n");
629 avpacket_queue_init (avctx, &ctx->queue);
631 if (decklink_start_input (avctx) != S_OK) {
632 av_log(avctx, AV_LOG_ERROR, "Cannot start input stream\n");
640 ff_decklink_cleanup(avctx);
644 int ff_decklink_read_packet(AVFormatContext *avctx, AVPacket *pkt)
646 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
647 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
648 AVFrame *frame = ctx->video_st->codec->coded_frame;
650 avpacket_queue_get(&ctx->queue, pkt, 1);
651 if (frame && (ctx->bmd_field_dominance == bmdUpperFieldFirst || ctx->bmd_field_dominance == bmdLowerFieldFirst)) {
652 frame->interlaced_frame = 1;
653 if (ctx->bmd_field_dominance == bmdUpperFieldFirst) {
654 frame->top_field_first = 1;