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>
26 #include "libavformat/avformat.h"
27 #include "libavformat/internal.h"
28 #include "libavutil/avutil.h"
29 #include "libavutil/common.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/time.h"
32 #include "libavutil/mathematics.h"
38 #include "decklink_common.h"
39 #include "decklink_dec.h"
42 static uint8_t calc_parity_and_line_offset(int line)
44 uint8_t ret = (line < 313) << 5;
45 if (line >= 7 && line <= 22)
47 if (line >= 320 && line <= 335)
52 int teletext_data_unit_from_vbi_data(int line, uint8_t *src, uint8_t *tgt)
54 vbi_bit_slicer slicer;
56 vbi_bit_slicer_init(&slicer, 720, 13500000, 6937500, 6937500, 0x00aaaae4, 0xffff, 18, 6, 42 * 8, VBI_MODULATION_NRZ_MSB, VBI_PIXFMT_UYVY);
58 if (vbi_bit_slice(&slicer, src, tgt + 4) == FALSE)
61 tgt[0] = 0x02; // data_unit_id
62 tgt[1] = 0x2c; // data_unit_length
63 tgt[2] = calc_parity_and_line_offset(line); // field_parity, line_offset
64 tgt[3] = 0xe4; // framing code
70 static void avpacket_queue_init(AVFormatContext *avctx, AVPacketQueue *q)
72 memset(q, 0, sizeof(AVPacketQueue));
73 pthread_mutex_init(&q->mutex, NULL);
74 pthread_cond_init(&q->cond, NULL);
78 static void avpacket_queue_flush(AVPacketQueue *q)
80 AVPacketList *pkt, *pkt1;
82 pthread_mutex_lock(&q->mutex);
83 for (pkt = q->first_pkt; pkt != NULL; pkt = pkt1) {
85 av_packet_unref(&pkt->pkt);
92 pthread_mutex_unlock(&q->mutex);
95 static void avpacket_queue_end(AVPacketQueue *q)
97 avpacket_queue_flush(q);
98 pthread_mutex_destroy(&q->mutex);
99 pthread_cond_destroy(&q->cond);
102 static unsigned long long avpacket_queue_size(AVPacketQueue *q)
104 unsigned long long size;
105 pthread_mutex_lock(&q->mutex);
107 pthread_mutex_unlock(&q->mutex);
111 static int avpacket_queue_put(AVPacketQueue *q, AVPacket *pkt)
115 // Drop Packet if queue size is > 1GB
116 if (avpacket_queue_size(q) > 1024 * 1024 * 1024 ) {
117 av_log(q->avctx, AV_LOG_WARNING, "Decklink input buffer overrun!\n");
120 /* duplicate the packet */
121 if (av_dup_packet(pkt) < 0) {
125 pkt1 = (AVPacketList *)av_malloc(sizeof(AVPacketList));
132 pthread_mutex_lock(&q->mutex);
137 q->last_pkt->next = pkt1;
142 q->size += pkt1->pkt.size + sizeof(*pkt1);
144 pthread_cond_signal(&q->cond);
146 pthread_mutex_unlock(&q->mutex);
150 static int avpacket_queue_get(AVPacketQueue *q, AVPacket *pkt, int block)
155 pthread_mutex_lock(&q->mutex);
160 q->first_pkt = pkt1->next;
165 q->size -= pkt1->pkt.size + sizeof(*pkt1);
174 pthread_cond_wait(&q->cond, &q->mutex);
177 pthread_mutex_unlock(&q->mutex);
181 class decklink_input_callback : public IDeckLinkInputCallback
184 decklink_input_callback(AVFormatContext *_avctx);
185 ~decklink_input_callback();
187 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
188 virtual ULONG STDMETHODCALLTYPE AddRef(void);
189 virtual ULONG STDMETHODCALLTYPE Release(void);
190 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents, IDeckLinkDisplayMode*, BMDDetectedVideoInputFormatFlags);
191 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame*, IDeckLinkAudioInputPacket*);
195 pthread_mutex_t m_mutex;
196 AVFormatContext *avctx;
199 int64_t initial_video_pts;
200 int64_t initial_audio_pts;
203 decklink_input_callback::decklink_input_callback(AVFormatContext *_avctx) : m_refCount(0)
206 decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
207 ctx = (struct decklink_ctx *)cctx->ctx;
209 initial_audio_pts = initial_video_pts = AV_NOPTS_VALUE;
210 pthread_mutex_init(&m_mutex, NULL);
213 decklink_input_callback::~decklink_input_callback()
215 pthread_mutex_destroy(&m_mutex);
218 ULONG decklink_input_callback::AddRef(void)
220 pthread_mutex_lock(&m_mutex);
222 pthread_mutex_unlock(&m_mutex);
224 return (ULONG)m_refCount;
227 ULONG decklink_input_callback::Release(void)
229 pthread_mutex_lock(&m_mutex);
231 pthread_mutex_unlock(&m_mutex);
233 if (m_refCount == 0) {
238 return (ULONG)m_refCount;
241 static int64_t get_pkt_pts(IDeckLinkVideoInputFrame *videoFrame,
242 IDeckLinkAudioInputPacket *audioFrame,
244 DecklinkPtsSource pts_src,
245 AVRational time_base, int64_t *initial_pts)
247 int64_t pts = AV_NOPTS_VALUE;
248 BMDTimeValue bmd_pts;
249 BMDTimeValue bmd_duration;
250 HRESULT res = E_INVALIDARG;
254 res = audioFrame->GetPacketTime(&bmd_pts, time_base.den);
258 res = videoFrame->GetStreamTime(&bmd_pts, &bmd_duration, time_base.den);
260 case PTS_SRC_REFERENCE:
262 res = videoFrame->GetHardwareReferenceTimestamp(time_base.den, &bmd_pts, &bmd_duration);
264 case PTS_SRC_WALLCLOCK:
265 pts = av_rescale_q(wallclock, AV_TIME_BASE_Q, time_base);
269 pts = bmd_pts / time_base.num;
271 if (pts != AV_NOPTS_VALUE && *initial_pts == AV_NOPTS_VALUE)
273 if (*initial_pts != AV_NOPTS_VALUE)
279 HRESULT decklink_input_callback::VideoInputFrameArrived(
280 IDeckLinkVideoInputFrame *videoFrame, IDeckLinkAudioInputPacket *audioFrame)
283 void *audioFrameBytes;
284 BMDTimeValue frameTime;
285 BMDTimeValue frameDuration;
286 int64_t wallclock = 0;
289 if (ctx->audio_pts_source == PTS_SRC_WALLCLOCK || ctx->video_pts_source == PTS_SRC_WALLCLOCK)
290 wallclock = av_gettime_relative();
292 // Handle Video Frame
295 av_init_packet(&pkt);
296 if (ctx->frameCount % 25 == 0) {
297 unsigned long long qsize = avpacket_queue_size(&ctx->queue);
298 av_log(avctx, AV_LOG_DEBUG,
299 "Frame received (#%lu) - Valid (%liB) - QSize %fMB\n",
301 videoFrame->GetRowBytes() * videoFrame->GetHeight(),
302 (double)qsize / 1024 / 1024);
305 videoFrame->GetBytes(&frameBytes);
306 videoFrame->GetStreamTime(&frameTime, &frameDuration,
307 ctx->video_st->time_base.den);
309 if (videoFrame->GetFlags() & bmdFrameHasNoInputSource) {
310 if (ctx->draw_bars && videoFrame->GetPixelFormat() == bmdFormat8BitYUV) {
312 0xEA80EA80, 0xD292D210, 0xA910A9A5, 0x90229035,
313 0x6ADD6ACA, 0x51EF515A, 0x286D28EF, 0x10801080 };
314 int width = videoFrame->GetWidth();
315 int height = videoFrame->GetHeight();
316 unsigned *p = (unsigned *)frameBytes;
318 for (int y = 0; y < height; y++) {
319 for (int x = 0; x < width; x += 2)
320 *p++ = bars[(x * 8) / width];
325 av_log(avctx, AV_LOG_WARNING, "Frame received (#%lu) - No input signal detected "
326 "- Frames dropped %u\n", ctx->frameCount, ++ctx->dropped);
331 av_log(avctx, AV_LOG_WARNING, "Frame received (#%lu) - Input returned "
332 "- Frames dropped %u\n", ctx->frameCount, ++ctx->dropped);
337 pkt.pts = get_pkt_pts(videoFrame, audioFrame, wallclock, ctx->video_pts_source, ctx->video_st->time_base, &initial_video_pts);
340 pkt.duration = frameDuration;
341 //To be made sure it still applies
342 pkt.flags |= AV_PKT_FLAG_KEY;
343 pkt.stream_index = ctx->video_st->index;
344 pkt.data = (uint8_t *)frameBytes;
345 pkt.size = videoFrame->GetRowBytes() *
346 videoFrame->GetHeight();
347 //fprintf(stderr,"Video Frame size %d ts %d\n", pkt.size, pkt.pts);
350 if (!no_video && ctx->teletext_lines && videoFrame->GetPixelFormat() == bmdFormat8BitYUV && videoFrame->GetWidth() == 720) {
351 IDeckLinkVideoFrameAncillary *vanc;
353 uint8_t txt_buf0[1611]; // max 35 * 46 bytes decoded teletext lines + 1 byte data_identifier
354 uint8_t *txt_buf = txt_buf0;
356 if (videoFrame->GetAncillaryData(&vanc) == S_OK) {
358 int64_t line_mask = 1;
359 txt_buf[0] = 0x10; // data_identifier - EBU_data
361 for (i = 6; i < 336; i++, line_mask <<= 1) {
363 if ((ctx->teletext_lines & line_mask) && vanc->GetBufferForVerticalBlankingLine(i, (void**)&buf) == S_OK) {
364 if (teletext_data_unit_from_vbi_data(i, buf, txt_buf) >= 0)
371 if (txt_buf - txt_buf0 > 1) {
372 int stuffing_units = (4 - ((45 + txt_buf - txt_buf0) / 46) % 4) % 4;
373 while (stuffing_units--) {
374 memset(txt_buf, 0xff, 46);
375 txt_buf[1] = 0x2c; // data_unit_length
378 av_init_packet(&txt_pkt);
379 txt_pkt.pts = pkt.pts;
380 txt_pkt.dts = pkt.dts;
381 txt_pkt.stream_index = ctx->teletext_st->index;
382 txt_pkt.data = txt_buf0;
383 txt_pkt.size = txt_buf - txt_buf0;
384 if (avpacket_queue_put(&ctx->queue, &txt_pkt) < 0) {
392 if (avpacket_queue_put(&ctx->queue, &pkt) < 0) {
397 // Handle Audio Frame
400 BMDTimeValue audio_pts;
401 av_init_packet(&pkt);
404 pkt.size = audioFrame->GetSampleFrameCount() * ctx->audio_st->codecpar->channels * (16 / 8);
405 audioFrame->GetBytes(&audioFrameBytes);
406 audioFrame->GetPacketTime(&audio_pts, ctx->audio_st->time_base.den);
407 pkt.pts = get_pkt_pts(videoFrame, audioFrame, wallclock, ctx->audio_pts_source, ctx->audio_st->time_base, &initial_audio_pts);
410 //fprintf(stderr,"Audio Frame size %d ts %d\n", pkt.size, pkt.pts);
411 pkt.flags |= AV_PKT_FLAG_KEY;
412 pkt.stream_index = ctx->audio_st->index;
413 pkt.data = (uint8_t *)audioFrameBytes;
415 if (avpacket_queue_put(&ctx->queue, &pkt) < 0) {
423 HRESULT decklink_input_callback::VideoInputFormatChanged(
424 BMDVideoInputFormatChangedEvents events, IDeckLinkDisplayMode *mode,
425 BMDDetectedVideoInputFormatFlags)
430 static HRESULT decklink_start_input(AVFormatContext *avctx)
432 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
433 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
435 ctx->input_callback = new decklink_input_callback(avctx);
436 ctx->dli->SetCallback(ctx->input_callback);
437 return ctx->dli->StartStreams();
442 av_cold int ff_decklink_read_close(AVFormatContext *avctx)
444 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
445 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
447 if (ctx->capture_started) {
448 ctx->dli->StopStreams();
449 ctx->dli->DisableVideoInput();
450 ctx->dli->DisableAudioInput();
453 ff_decklink_cleanup(avctx);
454 avpacket_queue_end(&ctx->queue);
456 av_freep(&cctx->ctx);
461 av_cold int ff_decklink_read_header(AVFormatContext *avctx)
463 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
464 struct decklink_ctx *ctx;
472 ctx = (struct decklink_ctx *) av_mallocz(sizeof(struct decklink_ctx));
474 return AVERROR(ENOMEM);
475 ctx->list_devices = cctx->list_devices;
476 ctx->list_formats = cctx->list_formats;
477 ctx->teletext_lines = cctx->teletext_lines;
478 ctx->preroll = cctx->preroll;
479 ctx->duplex_mode = cctx->duplex_mode;
480 if (cctx->video_input > 0 && (unsigned int)cctx->video_input < FF_ARRAY_ELEMS(decklink_video_connection_map))
481 ctx->video_input = decklink_video_connection_map[cctx->video_input];
482 if (cctx->audio_input > 0 && (unsigned int)cctx->audio_input < FF_ARRAY_ELEMS(decklink_audio_connection_map))
483 ctx->audio_input = decklink_audio_connection_map[cctx->audio_input];
484 ctx->audio_pts_source = cctx->audio_pts_source;
485 ctx->video_pts_source = cctx->video_pts_source;
486 ctx->draw_bars = cctx->draw_bars;
490 if (ctx->teletext_lines) {
491 av_log(avctx, AV_LOG_ERROR, "Libzvbi support is needed for capturing teletext, please recompile FFmpeg.\n");
492 return AVERROR(ENOSYS);
496 /* Check audio channel option for valid values: 2, 8 or 16 */
497 switch (cctx->audio_channels) {
503 av_log(avctx, AV_LOG_ERROR, "Value of channels option must be one of 2, 8 or 16\n");
504 return AVERROR(EINVAL);
507 /* List available devices. */
508 if (ctx->list_devices) {
509 ff_decklink_list_devices(avctx);
513 strcpy (fname, avctx->filename);
514 tmp=strchr (fname, '@');
516 av_log(avctx, AV_LOG_WARNING, "The @mode syntax is deprecated and will be removed. Please use the -format_code option.\n");
517 mode_num = atoi (tmp+1);
521 ret = ff_decklink_init_device(avctx, fname);
525 /* Get input device. */
526 if (ctx->dl->QueryInterface(IID_IDeckLinkInput, (void **) &ctx->dli) != S_OK) {
527 av_log(avctx, AV_LOG_ERROR, "Could not open input device from '%s'\n",
533 /* List supported formats. */
534 if (ctx->list_formats) {
535 ff_decklink_list_formats(avctx, DIRECTION_IN);
540 if (mode_num > 0 || cctx->format_code) {
541 if (ff_decklink_set_format(avctx, DIRECTION_IN, mode_num) < 0) {
542 av_log(avctx, AV_LOG_ERROR, "Could not set mode number %d or format code %s for %s\n",
543 mode_num, (cctx->format_code) ? cctx->format_code : "(unset)", fname);
550 st = avformat_new_stream(avctx, NULL);
552 av_log(avctx, AV_LOG_ERROR, "Cannot add stream\n");
553 ret = AVERROR(ENOMEM);
556 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
557 st->codecpar->codec_id = AV_CODEC_ID_PCM_S16LE;
558 st->codecpar->sample_rate = bmdAudioSampleRate48kHz;
559 st->codecpar->channels = cctx->audio_channels;
560 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
563 st = avformat_new_stream(avctx, NULL);
565 av_log(avctx, AV_LOG_ERROR, "Cannot add stream\n");
566 ret = AVERROR(ENOMEM);
569 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
570 st->codecpar->width = ctx->bmd_width;
571 st->codecpar->height = ctx->bmd_height;
573 st->time_base.den = ctx->bmd_tb_den;
574 st->time_base.num = ctx->bmd_tb_num;
575 av_stream_set_r_frame_rate(st, av_make_q(st->time_base.den, st->time_base.num));
578 st->codecpar->codec_id = AV_CODEC_ID_V210;
579 st->codecpar->codec_tag = MKTAG('V', '2', '1', '0');
580 st->codecpar->bit_rate = av_rescale(ctx->bmd_width * ctx->bmd_height * 64, st->time_base.den, st->time_base.num * 3);
582 st->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
583 st->codecpar->format = AV_PIX_FMT_UYVY422;
584 st->codecpar->codec_tag = MKTAG('U', 'Y', 'V', 'Y');
585 st->codecpar->bit_rate = av_rescale(ctx->bmd_width * ctx->bmd_height * 16, st->time_base.den, st->time_base.num);
588 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
592 if (ctx->teletext_lines) {
593 st = avformat_new_stream(avctx, NULL);
595 av_log(avctx, AV_LOG_ERROR, "Cannot add stream\n");
596 ret = AVERROR(ENOMEM);
599 st->codecpar->codec_type = AVMEDIA_TYPE_SUBTITLE;
600 st->time_base.den = ctx->bmd_tb_den;
601 st->time_base.num = ctx->bmd_tb_num;
602 st->codecpar->codec_id = AV_CODEC_ID_DVB_TELETEXT;
603 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
604 ctx->teletext_st = st;
607 av_log(avctx, AV_LOG_VERBOSE, "Using %d input audio channels\n", ctx->audio_st->codecpar->channels);
608 result = ctx->dli->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType16bitInteger, ctx->audio_st->codecpar->channels);
610 if (result != S_OK) {
611 av_log(avctx, AV_LOG_ERROR, "Cannot enable audio input\n");
616 result = ctx->dli->EnableVideoInput(ctx->bmd_mode,
617 cctx->v210 ? bmdFormat10BitYUV : bmdFormat8BitYUV,
618 bmdVideoInputFlagDefault);
620 if (result != S_OK) {
621 av_log(avctx, AV_LOG_ERROR, "Cannot enable video input\n");
626 avpacket_queue_init (avctx, &ctx->queue);
628 if (decklink_start_input (avctx) != S_OK) {
629 av_log(avctx, AV_LOG_ERROR, "Cannot start input stream\n");
637 ff_decklink_cleanup(avctx);
641 int ff_decklink_read_packet(AVFormatContext *avctx, AVPacket *pkt)
643 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
644 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
645 AVFrame *frame = ctx->video_st->codec->coded_frame;
647 avpacket_queue_get(&ctx->queue, pkt, 1);
648 if (frame && (ctx->bmd_field_dominance == bmdUpperFieldFirst || ctx->bmd_field_dominance == bmdLowerFieldFirst)) {
649 frame->interlaced_frame = 1;
650 if (ctx->bmd_field_dominance == bmdUpperFieldFirst) {
651 frame->top_field_first = 1;