2 * Blackmagic DeckLink output
3 * Copyright (c) 2013-2014 Ramiro Polla, 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 internal.h first to avoid conflict between winsock.h (used by
23 * DeckLink headers) and winsock2.h (used by libavformat) in MSVC++ builds */
25 #include "libavformat/internal.h"
28 #include <DeckLinkAPI.h>
30 #include <DeckLinkAPI_i.c>
32 /* The file provided by the SDK is known to be missing prototypes, which doesn't
33 cause issues with GCC since the warning doesn't apply to C++ files. However
34 Clang does complain (and warnings are treated as errors), so suppress the
35 warning just for this one file */
37 #pragma clang diagnostic push
38 #pragma clang diagnostic ignored "-Wmissing-prototypes"
40 #include <DeckLinkAPIDispatch.cpp>
42 #pragma clang diagnostic pop
47 #include "libavformat/avformat.h"
48 #include "libavutil/imgutils.h"
49 #include "libavutil/intreadwrite.h"
50 #include "libavutil/bswap.h"
54 #include "decklink_common.h"
56 static IDeckLinkIterator
*decklink_create_iterator(AVFormatContext
*avctx
)
58 IDeckLinkIterator
*iter
;
61 if (CoInitialize(NULL
) < 0) {
62 av_log(avctx
, AV_LOG_ERROR
, "COM initialization failed.\n");
66 if (CoCreateInstance(CLSID_CDeckLinkIterator
, NULL
, CLSCTX_ALL
,
67 IID_IDeckLinkIterator
, (void**) &iter
) != S_OK
) {
71 iter
= CreateDeckLinkIteratorInstance();
74 av_log(avctx
, AV_LOG_ERROR
, "Could not create DeckLink iterator. "
75 "Make sure you have DeckLink drivers " BLACKMAGIC_DECKLINK_API_VERSION_STRING
" or newer installed.\n");
80 static int decklink_get_attr_string(IDeckLink
*dl
, BMDDeckLinkAttributeID cfg_id
, const char **s
)
84 IDeckLinkProfileAttributes
*attr
;
86 if (dl
->QueryInterface(IID_IDeckLinkProfileAttributes
, (void **)&attr
) != S_OK
)
87 return AVERROR_EXTERNAL
;
88 hr
= attr
->GetString(cfg_id
, &tmp
);
91 *s
= DECKLINK_STRDUP(tmp
);
94 return AVERROR(ENOMEM
);
95 } else if (hr
== E_FAIL
) {
96 return AVERROR_EXTERNAL
;
101 static int decklink_select_input(AVFormatContext
*avctx
, BMDDeckLinkConfigurationID cfg_id
)
103 struct decklink_cctx
*cctx
= (struct decklink_cctx
*)avctx
->priv_data
;
104 struct decklink_ctx
*ctx
= (struct decklink_ctx
*)cctx
->ctx
;
105 BMDDeckLinkAttributeID attr_id
= (cfg_id
== bmdDeckLinkConfigAudioInputConnection
) ? BMDDeckLinkAudioInputConnections
: BMDDeckLinkVideoInputConnections
;
106 int64_t bmd_input
= (cfg_id
== bmdDeckLinkConfigAudioInputConnection
) ? (int64_t)ctx
->audio_input
: (int64_t)ctx
->video_input
;
107 const char *type_name
= (cfg_id
== bmdDeckLinkConfigAudioInputConnection
) ? "audio" : "video";
108 int64_t supported_connections
= 0;
112 res
= ctx
->attr
->GetInt(attr_id
, &supported_connections
);
114 av_log(avctx
, AV_LOG_ERROR
, "Failed to query supported %s inputs.\n", type_name
);
115 return AVERROR_EXTERNAL
;
117 if ((supported_connections
& bmd_input
) != bmd_input
) {
118 av_log(avctx
, AV_LOG_ERROR
, "Device does not support selected %s input.\n", type_name
);
119 return AVERROR(ENOSYS
);
121 res
= ctx
->cfg
->SetInt(cfg_id
, bmd_input
);
123 av_log(avctx
, AV_LOG_ERROR
, "Failed to select %s input.\n", type_name
);
124 return AVERROR_EXTERNAL
;
130 static DECKLINK_BOOL
field_order_eq(enum AVFieldOrder field_order
, BMDFieldDominance bmd_field_order
)
132 if (field_order
== AV_FIELD_UNKNOWN
)
134 if ((field_order
== AV_FIELD_TT
|| field_order
== AV_FIELD_TB
) && bmd_field_order
== bmdUpperFieldFirst
)
136 if ((field_order
== AV_FIELD_BB
|| field_order
== AV_FIELD_BT
) && bmd_field_order
== bmdLowerFieldFirst
)
138 if (field_order
== AV_FIELD_PROGRESSIVE
&& (bmd_field_order
== bmdProgressiveFrame
|| bmd_field_order
== bmdProgressiveSegmentedFrame
))
143 int ff_decklink_set_configs(AVFormatContext
*avctx
,
144 decklink_direction_t direction
) {
145 struct decklink_cctx
*cctx
= (struct decklink_cctx
*)avctx
->priv_data
;
146 struct decklink_ctx
*ctx
= (struct decklink_ctx
*)cctx
->ctx
;
149 if (ctx
->duplex_mode
) {
150 DECKLINK_BOOL duplex_supported
= false;
152 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
153 IDeckLinkProfileManager
*manager
= NULL
;
154 if (ctx
->dl
->QueryInterface(IID_IDeckLinkProfileManager
, (void **)&manager
) == S_OK
)
155 duplex_supported
= true;
157 if (ctx
->attr
->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration
, &duplex_supported
) != S_OK
)
158 duplex_supported
= false;
161 if (duplex_supported
) {
162 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
163 IDeckLinkProfile
*profile
= NULL
;
164 BMDProfileID bmd_profile_id
= ctx
->duplex_mode
== 2 ? bmdProfileOneSubDeviceFullDuplex
: bmdProfileTwoSubDevicesHalfDuplex
;
165 res
= manager
->GetProfile(bmd_profile_id
, &profile
);
167 res
= profile
->SetActive();
172 res
= ctx
->cfg
->SetInt(bmdDeckLinkConfigDuplexMode
, ctx
->duplex_mode
== 2 ? bmdDuplexModeFull
: bmdDuplexModeHalf
);
175 av_log(avctx
, AV_LOG_WARNING
, "Setting duplex mode failed.\n");
177 av_log(avctx
, AV_LOG_VERBOSE
, "Successfully set duplex mode to %s duplex.\n", ctx
->duplex_mode
== 2 ? "full" : "half");
179 av_log(avctx
, AV_LOG_WARNING
, "Unable to set duplex mode, because it is not supported.\n");
182 if (direction
== DIRECTION_IN
) {
184 ret
= decklink_select_input(avctx
, bmdDeckLinkConfigAudioInputConnection
);
187 ret
= decklink_select_input(avctx
, bmdDeckLinkConfigVideoInputConnection
);
191 if (direction
== DIRECTION_OUT
&& cctx
->timing_offset
!= INT_MIN
) {
192 res
= ctx
->cfg
->SetInt(bmdDeckLinkConfigReferenceInputTimingOffset
, cctx
->timing_offset
);
194 av_log(avctx
, AV_LOG_WARNING
, "Setting timing offset failed.\n");
199 int ff_decklink_set_format(AVFormatContext
*avctx
,
200 int width
, int height
,
201 int tb_num
, int tb_den
,
202 enum AVFieldOrder field_order
,
203 decklink_direction_t direction
)
205 struct decklink_cctx
*cctx
= (struct decklink_cctx
*)avctx
->priv_data
;
206 struct decklink_ctx
*ctx
= (struct decklink_ctx
*)cctx
->ctx
;
207 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
208 DECKLINK_BOOL support
;
210 BMDDisplayModeSupport support
;
212 IDeckLinkDisplayModeIterator
*itermode
;
213 IDeckLinkDisplayMode
*mode
;
217 av_log(avctx
, AV_LOG_DEBUG
, "Trying to find mode for frame size %dx%d, frame timing %d/%d, field order %d, direction %d, format code %s\n",
218 width
, height
, tb_num
, tb_den
, field_order
, direction
, cctx
->format_code
? cctx
->format_code
: "(unset)");
220 if (direction
== DIRECTION_IN
) {
221 res
= ctx
->dli
->GetDisplayModeIterator (&itermode
);
223 res
= ctx
->dlo
->GetDisplayModeIterator (&itermode
);
227 av_log(avctx
, AV_LOG_ERROR
, "Could not get Display Mode Iterator\n");
231 char format_buf
[] = " ";
232 if (cctx
->format_code
)
233 memcpy(format_buf
, cctx
->format_code
, FFMIN(strlen(cctx
->format_code
), sizeof(format_buf
)));
234 BMDDisplayMode target_mode
= (BMDDisplayMode
)AV_RB32(format_buf
);
235 AVRational target_tb
= av_make_q(tb_num
, tb_den
);
236 ctx
->bmd_mode
= bmdModeUnknown
;
237 while ((ctx
->bmd_mode
== bmdModeUnknown
) && itermode
->Next(&mode
) == S_OK
) {
238 BMDTimeValue bmd_tb_num
, bmd_tb_den
;
239 int bmd_width
= mode
->GetWidth();
240 int bmd_height
= mode
->GetHeight();
241 BMDDisplayMode bmd_mode
= mode
->GetDisplayMode();
242 BMDFieldDominance bmd_field_dominance
= mode
->GetFieldDominance();
244 mode
->GetFrameRate(&bmd_tb_num
, &bmd_tb_den
);
245 AVRational mode_tb
= av_make_q(bmd_tb_num
, bmd_tb_den
);
247 if ((bmd_width
== width
&&
248 bmd_height
== height
&&
249 !av_cmp_q(mode_tb
, target_tb
) &&
250 field_order_eq(field_order
, bmd_field_dominance
))
251 || target_mode
== bmd_mode
) {
252 ctx
->bmd_mode
= bmd_mode
;
253 ctx
->bmd_width
= bmd_width
;
254 ctx
->bmd_height
= bmd_height
;
255 ctx
->bmd_tb_den
= bmd_tb_den
;
256 ctx
->bmd_tb_num
= bmd_tb_num
;
257 ctx
->bmd_field_dominance
= bmd_field_dominance
;
258 av_log(avctx
, AV_LOG_INFO
, "Found Decklink mode %d x %d with rate %.2f%s\n",
259 bmd_width
, bmd_height
, 1/av_q2d(mode_tb
),
260 (ctx
->bmd_field_dominance
==bmdLowerFieldFirst
|| ctx
->bmd_field_dominance
==bmdUpperFieldFirst
)?"(i)":"");
269 if (ctx
->bmd_mode
== bmdModeUnknown
)
272 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b050000
273 if (direction
== DIRECTION_IN
) {
274 BMDDisplayMode actualMode
= ctx
->bmd_mode
;
275 if (ctx
->dli
->DoesSupportVideoMode(ctx
->video_input
, ctx
->bmd_mode
, (BMDPixelFormat
) cctx
->raw_format
,
276 bmdNoVideoInputConversion
, bmdSupportedVideoModeDefault
,
277 &actualMode
, &support
) != S_OK
|| !support
|| ctx
->bmd_mode
!= actualMode
)
280 BMDDisplayMode actualMode
= ctx
->bmd_mode
;
281 if (ctx
->dlo
->DoesSupportVideoMode(bmdVideoConnectionUnspecified
, ctx
->bmd_mode
, ctx
->raw_format
,
282 bmdNoVideoOutputConversion
, bmdSupportedVideoModeDefault
,
283 &actualMode
, &support
) != S_OK
|| !support
|| ctx
->bmd_mode
!= actualMode
)
287 #elif BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
288 if (direction
== DIRECTION_IN
) {
289 if (ctx
->dli
->DoesSupportVideoMode(ctx
->video_input
, ctx
->bmd_mode
, (BMDPixelFormat
) cctx
->raw_format
,
290 bmdSupportedVideoModeDefault
,
294 BMDDisplayMode actualMode
= ctx
->bmd_mode
;
295 if (ctx
->dlo
->DoesSupportVideoMode(bmdVideoConnectionUnspecified
, ctx
->bmd_mode
, ctx
->raw_format
,
296 bmdSupportedVideoModeDefault
,
297 &actualMode
, &support
) != S_OK
|| !support
|| ctx
->bmd_mode
!= actualMode
) {
305 if (direction
== DIRECTION_IN
) {
306 if (ctx
->dli
->DoesSupportVideoMode(ctx
->bmd_mode
, (BMDPixelFormat
) cctx
->raw_format
,
307 bmdVideoOutputFlagDefault
,
308 &support
, NULL
) != S_OK
)
311 if (!ctx
->supports_vanc
|| ctx
->dlo
->DoesSupportVideoMode(ctx
->bmd_mode
, ctx
->raw_format
,
313 &support
, NULL
) != S_OK
|| support
!= bmdDisplayModeSupported
) {
314 /* Try without VANC enabled */
315 if (ctx
->dlo
->DoesSupportVideoMode(ctx
->bmd_mode
, ctx
->raw_format
,
316 bmdVideoOutputFlagDefault
,
317 &support
, NULL
) != S_OK
) {
320 ctx
->supports_vanc
= 0;
324 if (support
== bmdDisplayModeSupported
)
331 int ff_decklink_set_format(AVFormatContext
*avctx
, decklink_direction_t direction
) {
332 return ff_decklink_set_format(avctx
, 0, 0, 0, 0, AV_FIELD_UNKNOWN
, direction
);
335 int ff_decklink_list_devices(AVFormatContext
*avctx
,
336 struct AVDeviceInfoList
*device_list
,
337 int show_inputs
, int show_outputs
)
339 IDeckLink
*dl
= NULL
;
340 IDeckLinkIterator
*iter
= decklink_create_iterator(avctx
);
346 while (ret
== 0 && iter
->Next(&dl
) == S_OK
) {
347 IDeckLinkOutput
*output_config
;
348 IDeckLinkInput
*input_config
;
349 const char *display_name
= NULL
;
350 const char *unique_name
= NULL
;
351 AVDeviceInfo
*new_device
= NULL
;
354 ret
= decklink_get_attr_string(dl
, BMDDeckLinkDisplayName
, &display_name
);
357 ret
= decklink_get_attr_string(dl
, BMDDeckLinkDeviceHandle
, &unique_name
);
362 if (dl
->QueryInterface(IID_IDeckLinkOutput
, (void **)&output_config
) == S_OK
) {
363 output_config
->Release();
369 if (dl
->QueryInterface(IID_IDeckLinkInput
, (void **)&input_config
) == S_OK
) {
370 input_config
->Release();
376 new_device
= (AVDeviceInfo
*) av_mallocz(sizeof(AVDeviceInfo
));
378 ret
= AVERROR(ENOMEM
);
382 new_device
->device_name
= av_strdup(unique_name
? unique_name
: display_name
);
383 new_device
->device_description
= av_strdup(display_name
);
385 if (!new_device
->device_name
||
386 !new_device
->device_description
||
387 av_dynarray_add_nofree(&device_list
->devices
, &device_list
->nb_devices
, new_device
) < 0) {
388 ret
= AVERROR(ENOMEM
);
389 av_freep(&new_device
->device_name
);
390 av_freep(&new_device
->device_description
);
391 av_freep(&new_device
);
397 av_freep(&display_name
);
398 av_freep(&unique_name
);
405 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
406 output to av_log() and exits (for backward compatibility with the
407 "-list_devices" argument). */
408 void ff_decklink_list_devices_legacy(AVFormatContext
*avctx
,
409 int show_inputs
, int show_outputs
)
411 struct AVDeviceInfoList
*device_list
= NULL
;
414 device_list
= (struct AVDeviceInfoList
*) av_mallocz(sizeof(AVDeviceInfoList
));
418 ret
= ff_decklink_list_devices(avctx
, device_list
, show_inputs
, show_outputs
);
420 av_log(avctx
, AV_LOG_INFO
, "Blackmagic DeckLink %s devices:\n",
421 show_inputs
? "input" : "output");
422 for (int i
= 0; i
< device_list
->nb_devices
; i
++) {
423 av_log(avctx
, AV_LOG_INFO
, "\t'%s'\n", device_list
->devices
[i
]->device_description
);
426 avdevice_free_list_devices(&device_list
);
429 int ff_decklink_list_formats(AVFormatContext
*avctx
, decklink_direction_t direction
)
431 struct decklink_cctx
*cctx
= (struct decklink_cctx
*)avctx
->priv_data
;
432 struct decklink_ctx
*ctx
= (struct decklink_ctx
*)cctx
->ctx
;
433 IDeckLinkDisplayModeIterator
*itermode
;
434 IDeckLinkDisplayMode
*mode
;
435 uint32_t format_code
;
438 if (direction
== DIRECTION_IN
) {
440 ret
= decklink_select_input(avctx
, bmdDeckLinkConfigAudioInputConnection
);
443 ret
= decklink_select_input(avctx
, bmdDeckLinkConfigVideoInputConnection
);
446 res
= ctx
->dli
->GetDisplayModeIterator (&itermode
);
448 res
= ctx
->dlo
->GetDisplayModeIterator (&itermode
);
452 av_log(avctx
, AV_LOG_ERROR
, "Could not get Display Mode Iterator\n");
456 av_log(avctx
, AV_LOG_INFO
, "Supported formats for '%s':\n\tformat_code\tdescription",
458 while (itermode
->Next(&mode
) == S_OK
) {
459 BMDTimeValue tb_num
, tb_den
;
460 mode
->GetFrameRate(&tb_num
, &tb_den
);
461 format_code
= av_bswap32(mode
->GetDisplayMode());
462 av_log(avctx
, AV_LOG_INFO
, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
463 (char*) &format_code
, mode
->GetWidth(), mode
->GetHeight(),
464 (int) tb_den
, (int) tb_num
);
465 switch (mode
->GetFieldDominance()) {
466 case bmdLowerFieldFirst
:
467 av_log(avctx
, AV_LOG_INFO
, " (interlaced, lower field first)"); break;
468 case bmdUpperFieldFirst
:
469 av_log(avctx
, AV_LOG_INFO
, " (interlaced, upper field first)"); break;
473 av_log(avctx
, AV_LOG_INFO
, "\n");
480 void ff_decklink_cleanup(AVFormatContext
*avctx
)
482 struct decklink_cctx
*cctx
= (struct decklink_cctx
*)avctx
->priv_data
;
483 struct decklink_ctx
*ctx
= (struct decklink_ctx
*)cctx
->ctx
;
490 ctx
->attr
->Release();
497 int ff_decklink_init_device(AVFormatContext
*avctx
, const char* name
)
499 struct decklink_cctx
*cctx
= (struct decklink_cctx
*)avctx
->priv_data
;
500 struct decklink_ctx
*ctx
= (struct decklink_ctx
*)cctx
->ctx
;
501 IDeckLink
*dl
= NULL
;
502 IDeckLinkIterator
*iter
= decklink_create_iterator(avctx
);
504 return AVERROR_EXTERNAL
;
506 while (iter
->Next(&dl
) == S_OK
) {
507 const char *display_name
= NULL
;
508 const char *unique_name
= NULL
;
509 decklink_get_attr_string(dl
, BMDDeckLinkDisplayName
, &display_name
);
510 decklink_get_attr_string(dl
, BMDDeckLinkDeviceHandle
, &unique_name
);
511 if (display_name
&& !strcmp(name
, display_name
) || unique_name
&& !strcmp(name
, unique_name
)) {
512 av_free((void *)unique_name
);
513 av_free((void *)display_name
);
517 av_free((void *)display_name
);
518 av_free((void *)unique_name
);
523 return AVERROR(ENXIO
);
525 if (ctx
->dl
->QueryInterface(IID_IDeckLinkConfiguration
, (void **)&ctx
->cfg
) != S_OK
) {
526 av_log(avctx
, AV_LOG_ERROR
, "Could not get configuration interface for '%s'\n", name
);
527 ff_decklink_cleanup(avctx
);
528 return AVERROR_EXTERNAL
;
531 if (ctx
->dl
->QueryInterface(IID_IDeckLinkProfileAttributes
, (void **)&ctx
->attr
) != S_OK
) {
532 av_log(avctx
, AV_LOG_ERROR
, "Could not get attributes interface for '%s'\n", name
);
533 ff_decklink_cleanup(avctx
);
534 return AVERROR_EXTERNAL
;