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 <DeckLinkAPI.h>
24 #include <DeckLinkAPI_i.c>
26 #include <DeckLinkAPIDispatch.cpp>
30 #include <semaphore.h>
33 #include "libavformat/avformat.h"
34 #include "libavformat/internal.h"
35 #include "libavutil/imgutils.h"
36 #include "libavutil/intreadwrite.h"
37 #include "libavutil/bswap.h"
40 #include "decklink_common.h"
43 IDeckLinkIterator *CreateDeckLinkIteratorInstance(void)
45 IDeckLinkIterator *iter;
47 if (CoInitialize(NULL) < 0) {
48 av_log(NULL, AV_LOG_ERROR, "COM initialization failed.\n");
52 if (CoCreateInstance(CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL,
53 IID_IDeckLinkIterator, (void**) &iter) != S_OK) {
54 av_log(NULL, AV_LOG_ERROR, "DeckLink drivers not installed.\n");
63 static char *dup_wchar_to_utf8(wchar_t *w)
66 int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
67 s = (char *) av_malloc(l);
69 WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
72 #define DECKLINK_STR OLECHAR *
73 #define DECKLINK_STRDUP dup_wchar_to_utf8
74 #define DECKLINK_FREE(s) SysFreeString(s)
75 #define DECKLINK_BOOL BOOL
76 #elif defined(__APPLE__)
77 static char *dup_cfstring_to_utf8(CFStringRef w)
80 CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
83 #define DECKLINK_STR const __CFString *
84 #define DECKLINK_STRDUP dup_cfstring_to_utf8
85 #define DECKLINK_FREE(s) free((void *) s)
86 #define DECKLINK_BOOL bool
88 #define DECKLINK_STR const char *
89 #define DECKLINK_STRDUP av_strdup
90 /* free() is needed for a string returned by the DeckLink SDL. */
91 #define DECKLINK_FREE(s) free((void *) s)
92 #define DECKLINK_BOOL bool
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_format(AVFormatContext *avctx,
149 int width, int height,
150 int tb_num, int tb_den,
151 enum AVFieldOrder field_order,
152 decklink_direction_t direction, int num)
154 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
155 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
156 BMDDisplayModeSupport support;
157 IDeckLinkDisplayModeIterator *itermode;
158 IDeckLinkDisplayMode *mode;
162 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",
163 width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
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");
182 if (direction == DIRECTION_IN) {
184 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
187 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
190 res = ctx->dli->GetDisplayModeIterator (&itermode);
192 res = ctx->dlo->GetDisplayModeIterator (&itermode);
196 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
200 char format_buf[] = " ";
201 if (cctx->format_code)
202 memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
203 BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
204 AVRational target_tb = av_make_q(tb_num, tb_den);
205 ctx->bmd_mode = bmdModeUnknown;
206 while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
207 BMDTimeValue bmd_tb_num, bmd_tb_den;
208 int bmd_width = mode->GetWidth();
209 int bmd_height = mode->GetHeight();
210 BMDDisplayMode bmd_mode = mode->GetDisplayMode();
211 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
213 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
214 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
216 if ((bmd_width == width &&
217 bmd_height == height &&
218 !av_cmp_q(mode_tb, target_tb) &&
219 field_order_eq(field_order, bmd_field_dominance))
221 || target_mode == bmd_mode) {
222 ctx->bmd_mode = bmd_mode;
223 ctx->bmd_width = bmd_width;
224 ctx->bmd_height = bmd_height;
225 ctx->bmd_tb_den = bmd_tb_den;
226 ctx->bmd_tb_num = bmd_tb_num;
227 ctx->bmd_field_dominance = bmd_field_dominance;
228 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
229 bmd_width, bmd_height, 1/av_q2d(mode_tb),
230 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
239 if (ctx->bmd_mode == bmdModeUnknown)
241 if (direction == DIRECTION_IN) {
242 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
243 bmdVideoOutputFlagDefault,
244 &support, NULL) != S_OK)
247 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
248 bmdVideoOutputFlagDefault,
249 &support, NULL) != S_OK)
252 if (support == bmdDisplayModeSupported)
258 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
259 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
262 int ff_decklink_list_devices(AVFormatContext *avctx)
264 IDeckLink *dl = NULL;
265 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
267 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
270 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink devices:\n");
271 while (iter->Next(&dl) == S_OK) {
272 const char *displayName;
273 ff_decklink_get_display_name(dl, &displayName);
274 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", displayName);
275 av_free((void *) displayName);
282 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
284 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
285 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
286 IDeckLinkDisplayModeIterator *itermode;
287 IDeckLinkDisplayMode *mode;
288 uint32_t format_code;
292 if (direction == DIRECTION_IN) {
294 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
297 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
300 res = ctx->dli->GetDisplayModeIterator (&itermode);
302 res = ctx->dlo->GetDisplayModeIterator (&itermode);
306 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
310 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tmode\tformat_code\tdescription",
312 while (itermode->Next(&mode) == S_OK) {
313 BMDTimeValue tb_num, tb_den;
314 mode->GetFrameRate(&tb_num, &tb_den);
315 format_code = av_bswap32(mode->GetDisplayMode());
316 av_log(avctx, AV_LOG_INFO, "\n\t%d\t%.4s\t\t%ldx%ld at %d/%d fps",
317 ++i, (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
318 (int) tb_den, (int) tb_num);
319 switch (mode->GetFieldDominance()) {
320 case bmdLowerFieldFirst:
321 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
322 case bmdUpperFieldFirst:
323 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
327 av_log(avctx, AV_LOG_INFO, "\n");
334 void ff_decklink_cleanup(AVFormatContext *avctx)
336 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
337 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
344 ctx->attr->Release();
351 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
353 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
354 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
355 IDeckLink *dl = NULL;
356 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
358 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
359 return AVERROR_EXTERNAL;
362 while (iter->Next(&dl) == S_OK) {
363 const char *displayName;
364 ff_decklink_get_display_name(dl, &displayName);
365 if (!strcmp(name, displayName)) {
366 av_free((void *)displayName);
370 av_free((void *)displayName);
375 return AVERROR(ENXIO);
377 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
378 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
379 ff_decklink_cleanup(avctx);
380 return AVERROR_EXTERNAL;
383 if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
384 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
385 ff_decklink_cleanup(avctx);
386 return AVERROR_EXTERNAL;