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 #include <DeckLinkAPIDispatch.cpp>
36 #include "libavformat/avformat.h"
37 #include "libavutil/imgutils.h"
38 #include "libavutil/intreadwrite.h"
39 #include "libavutil/bswap.h"
43 #include "decklink_common.h"
46 IDeckLinkIterator *CreateDeckLinkIteratorInstance(void)
48 IDeckLinkIterator *iter;
50 if (CoInitialize(NULL) < 0) {
51 av_log(NULL, AV_LOG_ERROR, "COM initialization failed.\n");
55 if (CoCreateInstance(CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL,
56 IID_IDeckLinkIterator, (void**) &iter) != S_OK) {
57 av_log(NULL, AV_LOG_ERROR, "DeckLink drivers not installed.\n");
66 static char *dup_wchar_to_utf8(wchar_t *w)
69 int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
70 s = (char *) av_malloc(l);
72 WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
75 #define DECKLINK_STR OLECHAR *
76 #define DECKLINK_STRDUP dup_wchar_to_utf8
77 #define DECKLINK_FREE(s) SysFreeString(s)
78 #elif defined(__APPLE__)
79 static char *dup_cfstring_to_utf8(CFStringRef w)
82 CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
85 #define DECKLINK_STR const __CFString *
86 #define DECKLINK_STRDUP dup_cfstring_to_utf8
87 #define DECKLINK_FREE(s) CFRelease(s)
89 #define DECKLINK_STR const char *
90 #define DECKLINK_STRDUP av_strdup
91 /* free() is needed for a string returned by the DeckLink SDL. */
92 #define DECKLINK_FREE(s) free((void *) s)
95 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
97 DECKLINK_STR tmpDisplayName;
98 HRESULT hr = This->GetDisplayName(&tmpDisplayName);
101 *displayName = DECKLINK_STRDUP(tmpDisplayName);
102 DECKLINK_FREE(tmpDisplayName);
106 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
108 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
109 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
110 BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
111 int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
112 const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
113 int64_t supported_connections = 0;
117 res = ctx->attr->GetInt(attr_id, &supported_connections);
119 av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
120 return AVERROR_EXTERNAL;
122 if ((supported_connections & bmd_input) != bmd_input) {
123 av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
124 return AVERROR(ENOSYS);
126 res = ctx->cfg->SetInt(cfg_id, bmd_input);
128 av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
129 return AVERROR_EXTERNAL;
135 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
137 if (field_order == AV_FIELD_UNKNOWN)
139 if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
141 if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
143 if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
148 int ff_decklink_set_configs(AVFormatContext *avctx,
149 decklink_direction_t direction) {
150 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
151 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
154 if (ctx->duplex_mode) {
155 DECKLINK_BOOL duplex_supported = false;
157 if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
158 duplex_supported = false;
160 if (duplex_supported) {
161 res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
163 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
165 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
167 av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
170 if (direction == DIRECTION_IN) {
172 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
175 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
182 int ff_decklink_set_format(AVFormatContext *avctx,
183 int width, int height,
184 int tb_num, int tb_den,
185 enum AVFieldOrder field_order,
186 decklink_direction_t direction, int num)
188 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
189 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
190 BMDDisplayModeSupport support;
191 IDeckLinkDisplayModeIterator *itermode;
192 IDeckLinkDisplayMode *mode;
196 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",
197 width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
199 if (direction == DIRECTION_IN) {
200 res = ctx->dli->GetDisplayModeIterator (&itermode);
202 res = ctx->dlo->GetDisplayModeIterator (&itermode);
206 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
210 char format_buf[] = " ";
211 if (cctx->format_code)
212 memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
213 BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
214 AVRational target_tb = av_make_q(tb_num, tb_den);
215 ctx->bmd_mode = bmdModeUnknown;
216 while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
217 BMDTimeValue bmd_tb_num, bmd_tb_den;
218 int bmd_width = mode->GetWidth();
219 int bmd_height = mode->GetHeight();
220 BMDDisplayMode bmd_mode = mode->GetDisplayMode();
221 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
223 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
224 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
226 if ((bmd_width == width &&
227 bmd_height == height &&
228 !av_cmp_q(mode_tb, target_tb) &&
229 field_order_eq(field_order, bmd_field_dominance))
231 || target_mode == bmd_mode) {
232 ctx->bmd_mode = bmd_mode;
233 ctx->bmd_width = bmd_width;
234 ctx->bmd_height = bmd_height;
235 ctx->bmd_tb_den = bmd_tb_den;
236 ctx->bmd_tb_num = bmd_tb_num;
237 ctx->bmd_field_dominance = bmd_field_dominance;
238 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
239 bmd_width, bmd_height, 1/av_q2d(mode_tb),
240 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
249 if (ctx->bmd_mode == bmdModeUnknown)
251 if (direction == DIRECTION_IN) {
252 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
253 bmdVideoOutputFlagDefault,
254 &support, NULL) != S_OK)
257 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
258 bmdVideoOutputFlagDefault,
259 &support, NULL) != S_OK)
262 if (support == bmdDisplayModeSupported)
268 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
269 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
272 int ff_decklink_list_devices(AVFormatContext *avctx,
273 struct AVDeviceInfoList *device_list,
274 int show_inputs, int show_outputs)
276 IDeckLink *dl = NULL;
277 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
281 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
285 while (ret == 0 && iter->Next(&dl) == S_OK) {
286 IDeckLinkOutput *output_config;
287 IDeckLinkInput *input_config;
288 const char *displayName;
289 AVDeviceInfo *new_device = NULL;
292 ff_decklink_get_display_name(dl, &displayName);
295 if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
296 output_config->Release();
302 if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
303 input_config->Release();
309 new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
311 ret = AVERROR(ENOMEM);
314 new_device->device_name = av_strdup(displayName);
315 if (!new_device->device_name) {
316 ret = AVERROR(ENOMEM);
320 new_device->device_description = av_strdup(displayName);
321 if (!new_device->device_description) {
322 av_freep(&new_device->device_name);
323 ret = AVERROR(ENOMEM);
327 if ((ret = av_dynarray_add_nofree(&device_list->devices,
328 &device_list->nb_devices, new_device)) < 0) {
329 av_freep(&new_device->device_name);
330 av_freep(&new_device->device_description);
331 av_freep(&new_device);
337 av_freep(&displayName);
344 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
345 output to av_log() and exits (for backward compatibility with the
346 "-list_devices" argument). */
347 void ff_decklink_list_devices_legacy(AVFormatContext *avctx,
348 int show_inputs, int show_outputs)
350 struct AVDeviceInfoList *device_list = NULL;
353 device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
357 ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
359 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
360 show_inputs ? "input" : "output");
361 for (int i = 0; i < device_list->nb_devices; i++) {
362 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_name);
365 avdevice_free_list_devices(&device_list);
368 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
370 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
371 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
372 IDeckLinkDisplayModeIterator *itermode;
373 IDeckLinkDisplayMode *mode;
374 uint32_t format_code;
377 if (direction == DIRECTION_IN) {
379 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
382 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
385 res = ctx->dli->GetDisplayModeIterator (&itermode);
387 res = ctx->dlo->GetDisplayModeIterator (&itermode);
391 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
395 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
397 while (itermode->Next(&mode) == S_OK) {
398 BMDTimeValue tb_num, tb_den;
399 mode->GetFrameRate(&tb_num, &tb_den);
400 format_code = av_bswap32(mode->GetDisplayMode());
401 av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
402 (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
403 (int) tb_den, (int) tb_num);
404 switch (mode->GetFieldDominance()) {
405 case bmdLowerFieldFirst:
406 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
407 case bmdUpperFieldFirst:
408 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
412 av_log(avctx, AV_LOG_INFO, "\n");
419 void ff_decklink_cleanup(AVFormatContext *avctx)
421 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
422 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
429 ctx->attr->Release();
436 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
438 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
439 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
440 IDeckLink *dl = NULL;
441 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
443 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
444 return AVERROR_EXTERNAL;
447 while (iter->Next(&dl) == S_OK) {
448 const char *displayName;
449 ff_decklink_get_display_name(dl, &displayName);
450 if (!strcmp(name, displayName)) {
451 av_free((void *)displayName);
455 av_free((void *)displayName);
460 return AVERROR(ENXIO);
462 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
463 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
464 ff_decklink_cleanup(avctx);
465 return AVERROR_EXTERNAL;
468 if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
469 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
470 ff_decklink_cleanup(avctx);
471 return AVERROR_EXTERNAL;