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");
77 IDeckLinkAPIInformation *api;
80 if (CoCreateInstance(CLSID_CDeckLinkAPIInformation, NULL, CLSCTX_ALL,
81 IID_IDeckLinkAPIInformation, (void**) &api) != S_OK) {
85 api = CreateDeckLinkAPIInformationInstance();
87 if (api && api->GetInt(BMDDeckLinkAPIVersion, &version) == S_OK) {
88 if (version < BLACKMAGIC_DECKLINK_API_VERSION)
89 av_log(avctx, AV_LOG_WARNING, "Installed DeckLink drivers are too old and may be incompatible with the SDK this module was built against. "
90 "Make sure you have DeckLink drivers " BLACKMAGIC_DECKLINK_API_VERSION_STRING " or newer installed.\n");
92 av_log(avctx, AV_LOG_ERROR, "Failed to check installed DeckLink API version.\n");
101 static int decklink_get_attr_string(IDeckLink *dl, BMDDeckLinkAttributeID cfg_id, const char **s)
105 IDeckLinkProfileAttributes *attr;
107 if (dl->QueryInterface(IID_IDeckLinkProfileAttributes, (void **)&attr) != S_OK)
108 return AVERROR_EXTERNAL;
109 hr = attr->GetString(cfg_id, &tmp);
112 *s = DECKLINK_STRDUP(tmp);
115 return AVERROR(ENOMEM);
116 } else if (hr == E_FAIL) {
117 return AVERROR_EXTERNAL;
122 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
124 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
125 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
126 BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
127 int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
128 const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
129 int64_t supported_connections = 0;
133 res = ctx->attr->GetInt(attr_id, &supported_connections);
135 av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
136 return AVERROR_EXTERNAL;
138 if ((supported_connections & bmd_input) != bmd_input) {
139 av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
140 return AVERROR(ENOSYS);
142 res = ctx->cfg->SetInt(cfg_id, bmd_input);
144 av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
145 return AVERROR_EXTERNAL;
151 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
153 if (field_order == AV_FIELD_UNKNOWN)
155 if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
157 if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
159 if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
164 int ff_decklink_set_configs(AVFormatContext *avctx,
165 decklink_direction_t direction) {
166 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
167 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
170 if (ctx->duplex_mode) {
171 DECKLINK_BOOL duplex_supported = false;
173 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
174 IDeckLinkProfileManager *manager = NULL;
175 if (ctx->dl->QueryInterface(IID_IDeckLinkProfileManager, (void **)&manager) == S_OK)
176 duplex_supported = true;
178 if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
179 duplex_supported = false;
182 if (duplex_supported) {
183 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
184 IDeckLinkProfile *profile = NULL;
185 BMDProfileID bmd_profile_id = ctx->duplex_mode == 2 ? bmdProfileOneSubDeviceFullDuplex : bmdProfileTwoSubDevicesHalfDuplex;
186 res = manager->GetProfile(bmd_profile_id, &profile);
188 res = profile->SetActive();
193 res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
196 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
198 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
200 av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
203 if (direction == DIRECTION_IN) {
205 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
208 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
212 if (direction == DIRECTION_OUT && cctx->timing_offset != INT_MIN) {
213 res = ctx->cfg->SetInt(bmdDeckLinkConfigReferenceInputTimingOffset, cctx->timing_offset);
215 av_log(avctx, AV_LOG_WARNING, "Setting timing offset failed.\n");
220 int ff_decklink_set_format(AVFormatContext *avctx,
221 int width, int height,
222 int tb_num, int tb_den,
223 enum AVFieldOrder field_order,
224 decklink_direction_t direction)
226 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
227 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
228 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
229 DECKLINK_BOOL support;
231 BMDDisplayModeSupport support;
233 IDeckLinkDisplayModeIterator *itermode;
234 IDeckLinkDisplayMode *mode;
238 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",
239 width, height, tb_num, tb_den, field_order, direction, cctx->format_code ? cctx->format_code : "(unset)");
241 if (direction == DIRECTION_IN) {
242 res = ctx->dli->GetDisplayModeIterator (&itermode);
244 res = ctx->dlo->GetDisplayModeIterator (&itermode);
248 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
252 char format_buf[] = " ";
253 if (cctx->format_code)
254 memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
255 BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
256 AVRational target_tb = av_make_q(tb_num, tb_den);
257 ctx->bmd_mode = bmdModeUnknown;
258 while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
259 BMDTimeValue bmd_tb_num, bmd_tb_den;
260 int bmd_width = mode->GetWidth();
261 int bmd_height = mode->GetHeight();
262 BMDDisplayMode bmd_mode = mode->GetDisplayMode();
263 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
265 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
266 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
268 if ((bmd_width == width &&
269 bmd_height == height &&
270 !av_cmp_q(mode_tb, target_tb) &&
271 field_order_eq(field_order, bmd_field_dominance))
272 || target_mode == bmd_mode) {
273 ctx->bmd_mode = bmd_mode;
274 ctx->bmd_width = bmd_width;
275 ctx->bmd_height = bmd_height;
276 ctx->bmd_tb_den = bmd_tb_den;
277 ctx->bmd_tb_num = bmd_tb_num;
278 ctx->bmd_field_dominance = bmd_field_dominance;
279 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
280 bmd_width, bmd_height, 1/av_q2d(mode_tb),
281 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
290 if (ctx->bmd_mode == bmdModeUnknown)
293 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b050000
294 if (direction == DIRECTION_IN) {
295 BMDDisplayMode actualMode = ctx->bmd_mode;
296 if (ctx->dli->DoesSupportVideoMode(ctx->video_input, ctx->bmd_mode, ctx->raw_format,
297 bmdNoVideoInputConversion, bmdSupportedVideoModeDefault,
298 &actualMode, &support) != S_OK || !support || ctx->bmd_mode != actualMode)
301 BMDDisplayMode actualMode = ctx->bmd_mode;
302 if (ctx->dlo->DoesSupportVideoMode(bmdVideoConnectionUnspecified, ctx->bmd_mode, ctx->raw_format,
303 bmdNoVideoOutputConversion, bmdSupportedVideoModeDefault,
304 &actualMode, &support) != S_OK || !support || ctx->bmd_mode != actualMode)
308 #elif BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
309 if (direction == DIRECTION_IN) {
310 if (ctx->dli->DoesSupportVideoMode(ctx->video_input, ctx->bmd_mode, ctx->raw_format,
311 bmdSupportedVideoModeDefault,
315 BMDDisplayMode actualMode = ctx->bmd_mode;
316 if (ctx->dlo->DoesSupportVideoMode(bmdVideoConnectionUnspecified, ctx->bmd_mode, ctx->raw_format,
317 bmdSupportedVideoModeDefault,
318 &actualMode, &support) != S_OK || !support || ctx->bmd_mode != actualMode) {
326 if (direction == DIRECTION_IN) {
327 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
328 bmdVideoOutputFlagDefault,
329 &support, NULL) != S_OK)
332 if (!ctx->supports_vanc || ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
334 &support, NULL) != S_OK || support != bmdDisplayModeSupported) {
335 /* Try without VANC enabled */
336 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
337 bmdVideoOutputFlagDefault,
338 &support, NULL) != S_OK) {
341 ctx->supports_vanc = 0;
345 if (support == bmdDisplayModeSupported)
352 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction) {
353 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction);
356 int ff_decklink_list_devices(AVFormatContext *avctx,
357 struct AVDeviceInfoList *device_list,
358 int show_inputs, int show_outputs)
360 IDeckLink *dl = NULL;
361 IDeckLinkIterator *iter = decklink_create_iterator(avctx);
367 while (ret == 0 && iter->Next(&dl) == S_OK) {
368 IDeckLinkOutput *output_config;
369 IDeckLinkInput *input_config;
370 const char *display_name = NULL;
371 const char *unique_name = NULL;
372 AVDeviceInfo *new_device = NULL;
375 ret = decklink_get_attr_string(dl, BMDDeckLinkDisplayName, &display_name);
378 ret = decklink_get_attr_string(dl, BMDDeckLinkDeviceHandle, &unique_name);
383 if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
384 output_config->Release();
390 if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
391 input_config->Release();
397 new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
399 ret = AVERROR(ENOMEM);
403 new_device->device_name = av_strdup(unique_name ? unique_name : display_name);
404 new_device->device_description = av_strdup(display_name);
406 if (!new_device->device_name ||
407 !new_device->device_description ||
408 av_dynarray_add_nofree(&device_list->devices, &device_list->nb_devices, new_device) < 0) {
409 ret = AVERROR(ENOMEM);
410 av_freep(&new_device->device_name);
411 av_freep(&new_device->device_description);
412 av_freep(&new_device);
418 av_freep(&display_name);
419 av_freep(&unique_name);
426 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
427 output to av_log() and exits (for backward compatibility with the
428 "-list_devices" argument). */
429 void ff_decklink_list_devices_legacy(AVFormatContext *avctx,
430 int show_inputs, int show_outputs)
432 struct AVDeviceInfoList *device_list = NULL;
435 device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
439 ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
441 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
442 show_inputs ? "input" : "output");
443 for (int i = 0; i < device_list->nb_devices; i++) {
444 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_description);
447 avdevice_free_list_devices(&device_list);
450 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
452 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
453 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
454 IDeckLinkDisplayModeIterator *itermode;
455 IDeckLinkDisplayMode *mode;
456 uint32_t format_code;
459 if (direction == DIRECTION_IN) {
461 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
464 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
467 res = ctx->dli->GetDisplayModeIterator (&itermode);
469 res = ctx->dlo->GetDisplayModeIterator (&itermode);
473 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
477 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
479 while (itermode->Next(&mode) == S_OK) {
480 BMDTimeValue tb_num, tb_den;
481 mode->GetFrameRate(&tb_num, &tb_den);
482 format_code = av_bswap32(mode->GetDisplayMode());
483 av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
484 (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
485 (int) tb_den, (int) tb_num);
486 switch (mode->GetFieldDominance()) {
487 case bmdLowerFieldFirst:
488 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
489 case bmdUpperFieldFirst:
490 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
494 av_log(avctx, AV_LOG_INFO, "\n");
501 void ff_decklink_cleanup(AVFormatContext *avctx)
503 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
504 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
511 ctx->attr->Release();
518 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
520 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
521 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
522 IDeckLink *dl = NULL;
523 IDeckLinkIterator *iter = decklink_create_iterator(avctx);
525 return AVERROR_EXTERNAL;
527 while (iter->Next(&dl) == S_OK) {
528 const char *display_name = NULL;
529 const char *unique_name = NULL;
530 decklink_get_attr_string(dl, BMDDeckLinkDisplayName, &display_name);
531 decklink_get_attr_string(dl, BMDDeckLinkDeviceHandle, &unique_name);
532 if (display_name && !strcmp(name, display_name) || unique_name && !strcmp(name, unique_name)) {
533 av_free((void *)unique_name);
534 av_free((void *)display_name);
538 av_free((void *)display_name);
539 av_free((void *)unique_name);
544 return AVERROR(ENXIO);
546 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
547 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
548 ff_decklink_cleanup(avctx);
549 return AVERROR_EXTERNAL;
552 if (ctx->dl->QueryInterface(IID_IDeckLinkProfileAttributes, (void **)&ctx->attr) != S_OK) {
553 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
554 ff_decklink_cleanup(avctx);
555 return AVERROR_EXTERNAL;