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/bswap.h"
39 #include "decklink_common.h"
42 IDeckLinkIterator *CreateDeckLinkIteratorInstance(void)
44 IDeckLinkIterator *iter;
46 if (CoInitialize(NULL) < 0) {
47 av_log(NULL, AV_LOG_ERROR, "COM initialization failed.\n");
51 if (CoCreateInstance(CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL,
52 IID_IDeckLinkIterator, (void**) &iter) != S_OK) {
53 av_log(NULL, AV_LOG_ERROR, "DeckLink drivers not installed.\n");
62 static char *dup_wchar_to_utf8(wchar_t *w)
65 int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
66 s = (char *) av_malloc(l);
68 WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
71 #define DECKLINK_STR OLECHAR *
72 #define DECKLINK_STRDUP dup_wchar_to_utf8
73 #define DECKLINK_FREE(s) SysFreeString(s)
74 #define DECKLINK_BOOL BOOL
75 #elif defined(__APPLE__)
76 static char *dup_cfstring_to_utf8(CFStringRef w)
79 CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
82 #define DECKLINK_STR const __CFString *
83 #define DECKLINK_STRDUP dup_cfstring_to_utf8
84 #define DECKLINK_FREE(s) free((void *) s)
85 #define DECKLINK_BOOL bool
87 #define DECKLINK_STR const char *
88 #define DECKLINK_STRDUP av_strdup
89 /* free() is needed for a string returned by the DeckLink SDL. */
90 #define DECKLINK_FREE(s) free((void *) s)
91 #define DECKLINK_BOOL bool
94 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
96 DECKLINK_STR tmpDisplayName;
97 HRESULT hr = This->GetDisplayName(&tmpDisplayName);
100 *displayName = DECKLINK_STRDUP(tmpDisplayName);
101 DECKLINK_FREE(tmpDisplayName);
105 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
107 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
108 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
109 BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
110 int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
111 const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
112 int64_t supported_connections = 0;
116 res = ctx->attr->GetInt(attr_id, &supported_connections);
118 av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
119 return AVERROR_EXTERNAL;
121 if ((supported_connections & bmd_input) != bmd_input) {
122 av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
123 return AVERROR(ENOSYS);
125 res = ctx->cfg->SetInt(cfg_id, bmd_input);
127 av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
128 return AVERROR_EXTERNAL;
134 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
136 if (field_order == AV_FIELD_UNKNOWN)
138 if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
140 if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
142 if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
147 int ff_decklink_set_format(AVFormatContext *avctx,
148 int width, int height,
149 int tb_num, int tb_den,
150 enum AVFieldOrder field_order,
151 decklink_direction_t direction, int num)
153 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
154 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
155 BMDDisplayModeSupport support;
156 IDeckLinkDisplayModeIterator *itermode;
157 IDeckLinkDisplayMode *mode;
161 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\n",
162 width, height, tb_num, tb_den, field_order, direction, num);
164 if (ctx->duplex_mode) {
165 DECKLINK_BOOL duplex_supported = false;
167 if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
168 duplex_supported = false;
170 if (duplex_supported) {
171 res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
173 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
175 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
177 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);
189 res = ctx->dli->GetDisplayModeIterator (&itermode);
191 res = ctx->dlo->GetDisplayModeIterator (&itermode);
195 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
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 BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
207 mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
208 AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
210 if ((bmd_width == width &&
211 bmd_height == height &&
212 !av_cmp_q(mode_tb, target_tb) &&
213 field_order_eq(field_order, bmd_field_dominance)) || i == num) {
214 ctx->bmd_mode = mode->GetDisplayMode();
215 ctx->bmd_width = bmd_width;
216 ctx->bmd_height = bmd_height;
217 ctx->bmd_tb_den = bmd_tb_den;
218 ctx->bmd_tb_num = bmd_tb_num;
219 ctx->bmd_field_dominance = bmd_field_dominance;
220 av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
221 bmd_width, bmd_height, 1/av_q2d(mode_tb),
222 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
231 if (ctx->bmd_mode == bmdModeUnknown)
233 if (direction == DIRECTION_IN) {
234 if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
235 bmdVideoOutputFlagDefault,
236 &support, NULL) != S_OK)
239 if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
240 bmdVideoOutputFlagDefault,
241 &support, NULL) != S_OK)
244 if (support == bmdDisplayModeSupported)
250 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
251 return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
254 int ff_decklink_list_devices(AVFormatContext *avctx)
256 IDeckLink *dl = NULL;
257 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
259 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
262 av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink devices:\n");
263 while (iter->Next(&dl) == S_OK) {
264 const char *displayName;
265 ff_decklink_get_display_name(dl, &displayName);
266 av_log(avctx, AV_LOG_INFO, "\t'%s'\n", displayName);
267 av_free((void *) displayName);
274 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
276 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
277 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
278 IDeckLinkDisplayModeIterator *itermode;
279 IDeckLinkDisplayMode *mode;
280 uint32_t format_code;
284 if (direction == DIRECTION_IN) {
286 ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
289 ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
292 res = ctx->dli->GetDisplayModeIterator (&itermode);
294 res = ctx->dlo->GetDisplayModeIterator (&itermode);
298 av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
302 av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tmode\tformat_code\tdescription",
304 while (itermode->Next(&mode) == S_OK) {
305 BMDTimeValue tb_num, tb_den;
306 mode->GetFrameRate(&tb_num, &tb_den);
307 format_code = av_bswap32(mode->GetDisplayMode());
308 av_log(avctx, AV_LOG_INFO, "\n\t%d\t%.4s\t\t%ldx%ld at %d/%d fps",
309 ++i, (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
310 (int) tb_den, (int) tb_num);
311 switch (mode->GetFieldDominance()) {
312 case bmdLowerFieldFirst:
313 av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
314 case bmdUpperFieldFirst:
315 av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
319 av_log(avctx, AV_LOG_INFO, "\n");
326 void ff_decklink_cleanup(AVFormatContext *avctx)
328 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
329 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
336 ctx->attr->Release();
343 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
345 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
346 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
347 IDeckLink *dl = NULL;
348 IDeckLinkIterator *iter = CreateDeckLinkIteratorInstance();
350 av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
351 return AVERROR_EXTERNAL;
354 while (iter->Next(&dl) == S_OK) {
355 const char *displayName;
356 ff_decklink_get_display_name(dl, &displayName);
357 if (!strcmp(name, displayName)) {
358 av_free((void *)displayName);
362 av_free((void *)displayName);
367 return AVERROR(ENXIO);
369 if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
370 av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
371 ff_decklink_cleanup(avctx);
372 return AVERROR_EXTERNAL;
375 if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
376 av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
377 ff_decklink_cleanup(avctx);
378 return AVERROR_EXTERNAL;