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 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
82 DECKLINK_STR tmpDisplayName;
83 HRESULT hr = This->GetDisplayName(&tmpDisplayName);
86 *displayName = DECKLINK_STRDUP(tmpDisplayName);
87 DECKLINK_FREE(tmpDisplayName);
91 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
93 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
94 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
95 BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
96 int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
97 const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
98 int64_t supported_connections = 0;
102 res = ctx->attr->GetInt(attr_id, &supported_connections);
104 av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
105 return AVERROR_EXTERNAL;
107 if ((supported_connections & bmd_input) != bmd_input) {
108 av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
109 return AVERROR(ENOSYS);
111 res = ctx->cfg->SetInt(cfg_id, bmd_input);
113 av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
114 return AVERROR_EXTERNAL;
120 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
122 if (field_order == AV_FIELD_UNKNOWN)
124 if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
126 if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
128 if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
133 int ff_decklink_set_configs(AVFormatContext *avctx,
134 decklink_direction_t direction) {
135 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
136 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
139 if (ctx->duplex_mode) {
140 DECKLINK_BOOL duplex_supported = false;
142 if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
143 duplex_supported = false;
145 if (duplex_supported) {
146 res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
148 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
150 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
152 av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
155 if (direction == DIRECTION_IN) {
157 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
160 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
167 int ff_decklink_set_format(AVFormatContext *avctx,
168 int width, int height,
169 int tb_num, int tb_den,
170 enum AVFieldOrder field_order,
171 decklink_direction_t direction, int num)
173 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
174 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
175 BMDDisplayModeSupport support;
176 IDeckLinkDisplayModeIterator *itermode;
177 IDeckLinkDisplayMode *mode;
181 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",
182 width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
184 if (direction == DIRECTION_IN) {
185 res = ctx->dli->GetDisplayModeIterator (&itermode);
187 res = ctx->dlo->GetDisplayModeIterator (&itermode);
191 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
195 char format_buf[] = " ";
196 if (cctx->format_code)
197 memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
198 BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
199 AVRational target_tb = av_make_q(tb_num, tb_den);
200 ctx->bmd_mode = bmdModeUnknown;
201 while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
202 BMDTimeValue bmd_tb_num, bmd_tb_den;
203 int bmd_width = mode->GetWidth();
204 int bmd_height = mode->GetHeight();
205 BMDDisplayMode bmd_mode = mode->GetDisplayMode();
206 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
208 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
209 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
211 if ((bmd_width == width &&
212 bmd_height == height &&
213 !av_cmp_q(mode_tb, target_tb) &&
214 field_order_eq(field_order, bmd_field_dominance))
216 || target_mode == bmd_mode) {
217 ctx->bmd_mode = bmd_mode;
218 ctx->bmd_width = bmd_width;
219 ctx->bmd_height = bmd_height;
220 ctx->bmd_tb_den = bmd_tb_den;
221 ctx->bmd_tb_num = bmd_tb_num;
222 ctx->bmd_field_dominance = bmd_field_dominance;
223 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
224 bmd_width, bmd_height, 1/av_q2d(mode_tb),
225 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
234 if (ctx->bmd_mode == bmdModeUnknown)
236 if (direction == DIRECTION_IN) {
237 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
238 bmdVideoOutputFlagDefault,
239 &support, NULL) != S_OK)
242 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
243 bmdVideoOutputFlagDefault,
244 &support, NULL) != S_OK)
247 if (support == bmdDisplayModeSupported)
253 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
254 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
257 int ff_decklink_list_devices(AVFormatContext *avctx,
258 struct AVDeviceInfoList *device_list,
259 int show_inputs, int show_outputs)
261 IDeckLink *dl = NULL;
262 IDeckLinkIterator *iter = decklink_create_iterator(avctx);
268 while (ret == 0 && iter->Next(&dl) == S_OK) {
269 IDeckLinkOutput *output_config;
270 IDeckLinkInput *input_config;
271 const char *displayName;
272 AVDeviceInfo *new_device = NULL;
275 ff_decklink_get_display_name(dl, &displayName);
278 if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
279 output_config->Release();
285 if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
286 input_config->Release();
292 new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
294 ret = AVERROR(ENOMEM);
298 new_device->device_name = av_strdup(displayName);
299 new_device->device_description = av_strdup(displayName);
301 if (!new_device->device_name ||
302 !new_device->device_description ||
303 av_dynarray_add_nofree(&device_list->devices, &device_list->nb_devices, new_device) < 0) {
304 ret = AVERROR(ENOMEM);
305 av_freep(&new_device->device_name);
306 av_freep(&new_device->device_description);
307 av_freep(&new_device);
313 av_freep(&displayName);
320 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
321 output to av_log() and exits (for backward compatibility with the
322 "-list_devices" argument). */
323 void ff_decklink_list_devices_legacy(AVFormatContext *avctx,
324 int show_inputs, int show_outputs)
326 struct AVDeviceInfoList *device_list = NULL;
329 device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
333 ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
335 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
336 show_inputs ? "input" : "output");
337 for (int i = 0; i < device_list->nb_devices; i++) {
338 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_name);
341 avdevice_free_list_devices(&device_list);
344 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
346 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
347 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
348 IDeckLinkDisplayModeIterator *itermode;
349 IDeckLinkDisplayMode *mode;
350 uint32_t format_code;
353 if (direction == DIRECTION_IN) {
355 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
358 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
361 res = ctx->dli->GetDisplayModeIterator (&itermode);
363 res = ctx->dlo->GetDisplayModeIterator (&itermode);
367 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
371 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
373 while (itermode->Next(&mode) == S_OK) {
374 BMDTimeValue tb_num, tb_den;
375 mode->GetFrameRate(&tb_num, &tb_den);
376 format_code = av_bswap32(mode->GetDisplayMode());
377 av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
378 (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
379 (int) tb_den, (int) tb_num);
380 switch (mode->GetFieldDominance()) {
381 case bmdLowerFieldFirst:
382 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
383 case bmdUpperFieldFirst:
384 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
388 av_log(avctx, AV_LOG_INFO, "\n");
395 void ff_decklink_cleanup(AVFormatContext *avctx)
397 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
398 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
405 ctx->attr->Release();
412 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
414 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
415 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
416 IDeckLink *dl = NULL;
417 IDeckLinkIterator *iter = decklink_create_iterator(avctx);
419 return AVERROR_EXTERNAL;
421 while (iter->Next(&dl) == S_OK) {
422 const char *displayName;
423 ff_decklink_get_display_name(dl, &displayName);
424 if (!strcmp(name, displayName)) {
425 av_free((void *)displayName);
429 av_free((void *)displayName);
434 return AVERROR(ENXIO);
436 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
437 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
438 ff_decklink_cleanup(avctx);
439 return AVERROR_EXTERNAL;
442 if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
443 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
444 ff_decklink_cleanup(avctx);
445 return AVERROR_EXTERNAL;