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"
57 IDeckLinkIterator *CreateDeckLinkIteratorInstance(void)
59 IDeckLinkIterator *iter;
61 if (CoInitialize(NULL) < 0) {
62 av_log(NULL, AV_LOG_ERROR, "COM initialization failed.\n");
66 if (CoCreateInstance(CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL,
67 IID_IDeckLinkIterator, (void**) &iter) != S_OK) {
68 av_log(NULL, AV_LOG_ERROR, "DeckLink drivers not installed.\n");
77 static char *dup_wchar_to_utf8(wchar_t *w)
80 int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
81 s = (char *) av_malloc(l);
83 WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
86 #define DECKLINK_STR OLECHAR *
87 #define DECKLINK_STRDUP dup_wchar_to_utf8
88 #define DECKLINK_FREE(s) SysFreeString(s)
89 #elif defined(__APPLE__)
90 static char *dup_cfstring_to_utf8(CFStringRef w)
93 CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
96 #define DECKLINK_STR const __CFString *
97 #define DECKLINK_STRDUP dup_cfstring_to_utf8
98 #define DECKLINK_FREE(s) CFRelease(s)
100 #define DECKLINK_STR const char *
101 #define DECKLINK_STRDUP av_strdup
102 /* free() is needed for a string returned by the DeckLink SDL. */
103 #define DECKLINK_FREE(s) free((void *) s)
106 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
108 DECKLINK_STR tmpDisplayName;
109 HRESULT hr = This->GetDisplayName(&tmpDisplayName);
112 *displayName = DECKLINK_STRDUP(tmpDisplayName);
113 DECKLINK_FREE(tmpDisplayName);
117 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
119 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
120 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
121 BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
122 int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
123 const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
124 int64_t supported_connections = 0;
128 res = ctx->attr->GetInt(attr_id, &supported_connections);
130 av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
131 return AVERROR_EXTERNAL;
133 if ((supported_connections & bmd_input) != bmd_input) {
134 av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
135 return AVERROR(ENOSYS);
137 res = ctx->cfg->SetInt(cfg_id, bmd_input);
139 av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
140 return AVERROR_EXTERNAL;
146 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
148 if (field_order == AV_FIELD_UNKNOWN)
150 if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
152 if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
154 if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
159 int ff_decklink_set_configs(AVFormatContext *avctx,
160 decklink_direction_t direction) {
161 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
162 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
165 if (ctx->duplex_mode) {
166 DECKLINK_BOOL duplex_supported = false;
168 if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
169 duplex_supported = false;
171 if (duplex_supported) {
172 res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
174 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
176 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
178 av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
181 if (direction == DIRECTION_IN) {
183 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
186 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
193 int ff_decklink_set_format(AVFormatContext *avctx,
194 int width, int height,
195 int tb_num, int tb_den,
196 enum AVFieldOrder field_order,
197 decklink_direction_t direction, int num)
199 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
200 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
201 BMDDisplayModeSupport support;
202 IDeckLinkDisplayModeIterator *itermode;
203 IDeckLinkDisplayMode *mode;
207 av_log(avctx, AV_LOG_DEBUG, "Trying to find mode for frame size %dx%d, frame timing %d/%d, field order %d, direction %d, mode number %d, format code %s\n",
208 width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
210 if (direction == DIRECTION_IN) {
211 res = ctx->dli->GetDisplayModeIterator (&itermode);
213 res = ctx->dlo->GetDisplayModeIterator (&itermode);
217 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
221 char format_buf[] = " ";
222 if (cctx->format_code)
223 memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
224 BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
225 AVRational target_tb = av_make_q(tb_num, tb_den);
226 ctx->bmd_mode = bmdModeUnknown;
227 while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
228 BMDTimeValue bmd_tb_num, bmd_tb_den;
229 int bmd_width = mode->GetWidth();
230 int bmd_height = mode->GetHeight();
231 BMDDisplayMode bmd_mode = mode->GetDisplayMode();
232 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
234 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
235 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
237 if ((bmd_width == width &&
238 bmd_height == height &&
239 !av_cmp_q(mode_tb, target_tb) &&
240 field_order_eq(field_order, bmd_field_dominance))
242 || target_mode == bmd_mode) {
243 ctx->bmd_mode = bmd_mode;
244 ctx->bmd_width = bmd_width;
245 ctx->bmd_height = bmd_height;
246 ctx->bmd_tb_den = bmd_tb_den;
247 ctx->bmd_tb_num = bmd_tb_num;
248 ctx->bmd_field_dominance = bmd_field_dominance;
249 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
250 bmd_width, bmd_height, 1/av_q2d(mode_tb),
251 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
260 if (ctx->bmd_mode == bmdModeUnknown)
262 if (direction == DIRECTION_IN) {
263 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
264 bmdVideoOutputFlagDefault,
265 &support, NULL) != S_OK)
268 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
269 bmdVideoOutputFlagDefault,
270 &support, NULL) != S_OK)
273 if (support == bmdDisplayModeSupported)
279 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
280 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
283 int ff_decklink_list_devices(AVFormatContext *avctx,
284 struct AVDeviceInfoList *device_list,
285 int show_inputs, int show_outputs)
287 IDeckLink *dl = NULL;
288 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
292 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
296 while (ret == 0 && iter->Next(&dl) == S_OK) {
297 IDeckLinkOutput *output_config;
298 IDeckLinkInput *input_config;
299 const char *displayName;
300 AVDeviceInfo *new_device = NULL;
303 ff_decklink_get_display_name(dl, &displayName);
306 if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
307 output_config->Release();
313 if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
314 input_config->Release();
320 new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
322 ret = AVERROR(ENOMEM);
325 new_device->device_name = av_strdup(displayName);
326 if (!new_device->device_name) {
327 ret = AVERROR(ENOMEM);
331 new_device->device_description = av_strdup(displayName);
332 if (!new_device->device_description) {
333 av_freep(&new_device->device_name);
334 ret = AVERROR(ENOMEM);
338 if ((ret = av_dynarray_add_nofree(&device_list->devices,
339 &device_list->nb_devices, new_device)) < 0) {
340 av_freep(&new_device->device_name);
341 av_freep(&new_device->device_description);
342 av_freep(&new_device);
348 av_freep(&displayName);
355 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
356 output to av_log() and exits (for backward compatibility with the
357 "-list_devices" argument). */
358 void ff_decklink_list_devices_legacy(AVFormatContext *avctx,
359 int show_inputs, int show_outputs)
361 struct AVDeviceInfoList *device_list = NULL;
364 device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
368 ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
370 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
371 show_inputs ? "input" : "output");
372 for (int i = 0; i < device_list->nb_devices; i++) {
373 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_name);
376 avdevice_free_list_devices(&device_list);
379 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
381 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
382 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
383 IDeckLinkDisplayModeIterator *itermode;
384 IDeckLinkDisplayMode *mode;
385 uint32_t format_code;
388 if (direction == DIRECTION_IN) {
390 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
393 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
396 res = ctx->dli->GetDisplayModeIterator (&itermode);
398 res = ctx->dlo->GetDisplayModeIterator (&itermode);
402 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
406 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
408 while (itermode->Next(&mode) == S_OK) {
409 BMDTimeValue tb_num, tb_den;
410 mode->GetFrameRate(&tb_num, &tb_den);
411 format_code = av_bswap32(mode->GetDisplayMode());
412 av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
413 (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
414 (int) tb_den, (int) tb_num);
415 switch (mode->GetFieldDominance()) {
416 case bmdLowerFieldFirst:
417 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
418 case bmdUpperFieldFirst:
419 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
423 av_log(avctx, AV_LOG_INFO, "\n");
430 void ff_decklink_cleanup(AVFormatContext *avctx)
432 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
433 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
440 ctx->attr->Release();
447 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
449 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
450 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
451 IDeckLink *dl = NULL;
452 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
454 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
455 return AVERROR_EXTERNAL;
458 while (iter->Next(&dl) == S_OK) {
459 const char *displayName;
460 ff_decklink_get_display_name(dl, &displayName);
461 if (!strcmp(name, displayName)) {
462 av_free((void *)displayName);
466 av_free((void *)displayName);
471 return AVERROR(ENXIO);
473 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
474 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
475 ff_decklink_cleanup(avctx);
476 return AVERROR_EXTERNAL;
479 if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
480 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
481 ff_decklink_cleanup(avctx);
482 return AVERROR_EXTERNAL;