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"
42 #include "decklink_common.h"
45 IDeckLinkIterator *CreateDeckLinkIteratorInstance(void)
47 IDeckLinkIterator *iter;
49 if (CoInitialize(NULL) < 0) {
50 av_log(NULL, AV_LOG_ERROR, "COM initialization failed.\n");
54 if (CoCreateInstance(CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL,
55 IID_IDeckLinkIterator, (void**) &iter) != S_OK) {
56 av_log(NULL, AV_LOG_ERROR, "DeckLink drivers not installed.\n");
65 static char *dup_wchar_to_utf8(wchar_t *w)
68 int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
69 s = (char *) av_malloc(l);
71 WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
74 #define DECKLINK_STR OLECHAR *
75 #define DECKLINK_STRDUP dup_wchar_to_utf8
76 #define DECKLINK_FREE(s) SysFreeString(s)
77 #define DECKLINK_BOOL BOOL
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) free((void *) s)
88 #define DECKLINK_BOOL bool
90 #define DECKLINK_STR const char *
91 #define DECKLINK_STRDUP av_strdup
92 /* free() is needed for a string returned by the DeckLink SDL. */
93 #define DECKLINK_FREE(s) free((void *) s)
94 #define DECKLINK_BOOL bool
97 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
99 DECKLINK_STR tmpDisplayName;
100 HRESULT hr = This->GetDisplayName(&tmpDisplayName);
103 *displayName = DECKLINK_STRDUP(tmpDisplayName);
104 DECKLINK_FREE(tmpDisplayName);
108 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
110 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
111 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
112 BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
113 int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
114 const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
115 int64_t supported_connections = 0;
119 res = ctx->attr->GetInt(attr_id, &supported_connections);
121 av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
122 return AVERROR_EXTERNAL;
124 if ((supported_connections & bmd_input) != bmd_input) {
125 av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
126 return AVERROR(ENOSYS);
128 res = ctx->cfg->SetInt(cfg_id, bmd_input);
130 av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
131 return AVERROR_EXTERNAL;
137 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
139 if (field_order == AV_FIELD_UNKNOWN)
141 if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
143 if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
145 if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
150 int ff_decklink_set_format(AVFormatContext *avctx,
151 int width, int height,
152 int tb_num, int tb_den,
153 enum AVFieldOrder field_order,
154 decklink_direction_t direction, int num)
156 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
157 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
158 BMDDisplayModeSupport support;
159 IDeckLinkDisplayModeIterator *itermode;
160 IDeckLinkDisplayMode *mode;
164 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",
165 width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
167 if (ctx->duplex_mode) {
168 DECKLINK_BOOL duplex_supported = false;
170 if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
171 duplex_supported = false;
173 if (duplex_supported) {
174 res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
176 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
178 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
180 av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
184 if (direction == DIRECTION_IN) {
186 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
189 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
192 res = ctx->dli->GetDisplayModeIterator (&itermode);
194 res = ctx->dlo->GetDisplayModeIterator (&itermode);
198 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
202 char format_buf[] = " ";
203 if (cctx->format_code)
204 memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
205 BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
206 AVRational target_tb = av_make_q(tb_num, tb_den);
207 ctx->bmd_mode = bmdModeUnknown;
208 while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
209 BMDTimeValue bmd_tb_num, bmd_tb_den;
210 int bmd_width = mode->GetWidth();
211 int bmd_height = mode->GetHeight();
212 BMDDisplayMode bmd_mode = mode->GetDisplayMode();
213 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
215 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
216 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
218 if ((bmd_width == width &&
219 bmd_height == height &&
220 !av_cmp_q(mode_tb, target_tb) &&
221 field_order_eq(field_order, bmd_field_dominance))
223 || target_mode == bmd_mode) {
224 ctx->bmd_mode = bmd_mode;
225 ctx->bmd_width = bmd_width;
226 ctx->bmd_height = bmd_height;
227 ctx->bmd_tb_den = bmd_tb_den;
228 ctx->bmd_tb_num = bmd_tb_num;
229 ctx->bmd_field_dominance = bmd_field_dominance;
230 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
231 bmd_width, bmd_height, 1/av_q2d(mode_tb),
232 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
241 if (ctx->bmd_mode == bmdModeUnknown)
243 if (direction == DIRECTION_IN) {
244 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
245 bmdVideoOutputFlagDefault,
246 &support, NULL) != S_OK)
249 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
250 bmdVideoOutputFlagDefault,
251 &support, NULL) != S_OK)
254 if (support == bmdDisplayModeSupported)
260 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
261 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
264 int ff_decklink_list_devices(AVFormatContext *avctx)
266 IDeckLink *dl = NULL;
267 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
269 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
272 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink devices:\n");
273 while (iter->Next(&dl) == S_OK) {
274 const char *displayName;
275 ff_decklink_get_display_name(dl, &displayName);
276 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", displayName);
277 av_free((void *) displayName);
284 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
286 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
287 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
288 IDeckLinkDisplayModeIterator *itermode;
289 IDeckLinkDisplayMode *mode;
290 uint32_t format_code;
293 if (direction == DIRECTION_IN) {
295 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
298 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
301 res = ctx->dli->GetDisplayModeIterator (&itermode);
303 res = ctx->dlo->GetDisplayModeIterator (&itermode);
307 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
311 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
313 while (itermode->Next(&mode) == S_OK) {
314 BMDTimeValue tb_num, tb_den;
315 mode->GetFrameRate(&tb_num, &tb_den);
316 format_code = av_bswap32(mode->GetDisplayMode());
317 av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
318 (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
319 (int) tb_den, (int) tb_num);
320 switch (mode->GetFieldDominance()) {
321 case bmdLowerFieldFirst:
322 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
323 case bmdUpperFieldFirst:
324 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
328 av_log(avctx, AV_LOG_INFO, "\n");
335 void ff_decklink_cleanup(AVFormatContext *avctx)
337 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
338 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
345 ctx->attr->Release();
352 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
354 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
355 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
356 IDeckLink *dl = NULL;
357 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
359 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
360 return AVERROR_EXTERNAL;
363 while (iter->Next(&dl) == S_OK) {
364 const char *displayName;
365 ff_decklink_get_display_name(dl, &displayName);
366 if (!strcmp(name, displayName)) {
367 av_free((void *)displayName);
371 av_free((void *)displayName);
376 return AVERROR(ENXIO);
378 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
379 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
380 ff_decklink_cleanup(avctx);
381 return AVERROR_EXTERNAL;
384 if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
385 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
386 ff_decklink_cleanup(avctx);
387 return AVERROR_EXTERNAL;