FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
decklink_common.cpp
Go to the documentation of this file.
1 /*
2  * Blackmagic DeckLink output
3  * Copyright (c) 2013-2014 Ramiro Polla, Luca Barbato, Deti Fliegl
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 
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 */
24 extern "C" {
25 #include "libavformat/internal.h"
26 }
27 
28 #include <DeckLinkAPI.h>
29 #ifdef _WIN32
30 #include <DeckLinkAPI_i.c>
31 #else
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 */
36 #ifdef __clang__
37 #pragma clang diagnostic push
38 #pragma clang diagnostic ignored "-Wmissing-prototypes"
39 #endif
40 #include <DeckLinkAPIDispatch.cpp>
41 #ifdef __clang__
42 #pragma clang diagnostic pop
43 #endif
44 #endif
45 
46 extern "C" {
47 #include "libavformat/avformat.h"
48 #include "libavutil/imgutils.h"
49 #include "libavutil/intreadwrite.h"
50 #include "libavutil/bswap.h"
51 #include "avdevice.h"
52 }
53 
54 #include "decklink_common.h"
55 
56 static IDeckLinkIterator *decklink_create_iterator(AVFormatContext *avctx)
57 {
58  IDeckLinkIterator *iter;
59 
60 #ifdef _WIN32
61  if (CoInitialize(NULL) < 0) {
62  av_log(avctx, AV_LOG_ERROR, "COM initialization failed.\n");
63  return NULL;
64  }
65 
66  if (CoCreateInstance(CLSID_CDeckLinkIterator, NULL, CLSCTX_ALL,
67  IID_IDeckLinkIterator, (void**) &iter) != S_OK) {
68  iter = NULL;
69  }
70 #else
71  iter = CreateDeckLinkIteratorInstance();
72 #endif
73  if (!iter)
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");
76 
77  return iter;
78 }
79 
80 #ifdef _WIN32
81 static char *dup_wchar_to_utf8(wchar_t *w)
82 {
83  char *s = NULL;
84  int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
85  s = (char *) av_malloc(l);
86  if (s)
87  WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
88  return s;
89 }
90 #define DECKLINK_STR OLECHAR *
91 #define DECKLINK_STRDUP dup_wchar_to_utf8
92 #define DECKLINK_FREE(s) SysFreeString(s)
93 #elif defined(__APPLE__)
94 static char *dup_cfstring_to_utf8(CFStringRef w)
95 {
96  char s[256];
97  CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
98  return av_strdup(s);
99 }
100 #define DECKLINK_STR const __CFString *
101 #define DECKLINK_STRDUP dup_cfstring_to_utf8
102 #define DECKLINK_FREE(s) CFRelease(s)
103 #else
104 #define DECKLINK_STR const char *
105 #define DECKLINK_STRDUP av_strdup
106 /* free() is needed for a string returned by the DeckLink SDL. */
107 #define DECKLINK_FREE(s) free((void *) s)
108 #endif
109 
110 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
111 {
112  DECKLINK_STR tmpDisplayName;
113  HRESULT hr = This->GetDisplayName(&tmpDisplayName);
114  if (hr != S_OK)
115  return hr;
116  *displayName = DECKLINK_STRDUP(tmpDisplayName);
117  DECKLINK_FREE(tmpDisplayName);
118  return hr;
119 }
120 
121 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
122 {
123  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
124  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
125  BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
126  int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
127  const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
128  int64_t supported_connections = 0;
129  HRESULT res;
130 
131  if (bmd_input) {
132  res = ctx->attr->GetInt(attr_id, &supported_connections);
133  if (res != S_OK) {
134  av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
135  return AVERROR_EXTERNAL;
136  }
137  if ((supported_connections & bmd_input) != bmd_input) {
138  av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
139  return AVERROR(ENOSYS);
140  }
141  res = ctx->cfg->SetInt(cfg_id, bmd_input);
142  if (res != S_OK) {
143  av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
144  return AVERROR_EXTERNAL;
145  }
146  }
147  return 0;
148 }
149 
150 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
151 {
152  if (field_order == AV_FIELD_UNKNOWN)
153  return true;
154  if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
155  return true;
156  if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
157  return true;
158  if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
159  return true;
160  return false;
161 }
162 
164  decklink_direction_t direction) {
165  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
166  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
167  HRESULT res;
168 
169  if (ctx->duplex_mode) {
170  DECKLINK_BOOL duplex_supported = false;
171 
172  if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
173  duplex_supported = false;
174 
175  if (duplex_supported) {
176  res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
177  if (res != S_OK)
178  av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
179  else
180  av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
181  } else {
182  av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
183  }
184  }
185  if (direction == DIRECTION_IN) {
186  int ret;
187  ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
188  if (ret < 0)
189  return ret;
190  ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
191  if (ret < 0)
192  return ret;
193  }
194  return 0;
195 }
196 
198  int width, int height,
199  int tb_num, int tb_den,
200  enum AVFieldOrder field_order,
201  decklink_direction_t direction, int num)
202 {
203  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
204  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
205  BMDDisplayModeSupport support;
206  IDeckLinkDisplayModeIterator *itermode;
207  IDeckLinkDisplayMode *mode;
208  int i = 1;
209  HRESULT res;
210 
211  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",
212  width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
213 
214  if (direction == DIRECTION_IN) {
215  res = ctx->dli->GetDisplayModeIterator (&itermode);
216  } else {
217  res = ctx->dlo->GetDisplayModeIterator (&itermode);
218  }
219 
220  if (res!= S_OK) {
221  av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
222  return AVERROR(EIO);
223  }
224 
225  char format_buf[] = " ";
226  if (cctx->format_code)
227  memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
228  BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
229  AVRational target_tb = av_make_q(tb_num, tb_den);
230  ctx->bmd_mode = bmdModeUnknown;
231  while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
232  BMDTimeValue bmd_tb_num, bmd_tb_den;
233  int bmd_width = mode->GetWidth();
234  int bmd_height = mode->GetHeight();
235  BMDDisplayMode bmd_mode = mode->GetDisplayMode();
236  BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
237 
238  mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
239  AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
240 
241  if ((bmd_width == width &&
242  bmd_height == height &&
243  !av_cmp_q(mode_tb, target_tb) &&
244  field_order_eq(field_order, bmd_field_dominance))
245  || i == num
246  || target_mode == bmd_mode) {
247  ctx->bmd_mode = bmd_mode;
248  ctx->bmd_width = bmd_width;
249  ctx->bmd_height = bmd_height;
250  ctx->bmd_tb_den = bmd_tb_den;
251  ctx->bmd_tb_num = bmd_tb_num;
252  ctx->bmd_field_dominance = bmd_field_dominance;
253  av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
254  bmd_width, bmd_height, 1/av_q2d(mode_tb),
255  (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
256  }
257 
258  mode->Release();
259  i++;
260  }
261 
262  itermode->Release();
263 
264  if (ctx->bmd_mode == bmdModeUnknown)
265  return -1;
266  if (direction == DIRECTION_IN) {
267  if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
268  bmdVideoOutputFlagDefault,
269  &support, NULL) != S_OK)
270  return -1;
271  } else {
272  if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
273  bmdVideoOutputFlagDefault,
274  &support, NULL) != S_OK)
275  return -1;
276  }
277  if (support == bmdDisplayModeSupported)
278  return 0;
279 
280  return -1;
281 }
282 
284  return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
285 }
286 
288  struct AVDeviceInfoList *device_list,
289  int show_inputs, int show_outputs)
290 {
291  IDeckLink *dl = NULL;
292  IDeckLinkIterator *iter = decklink_create_iterator(avctx);
293  int ret = 0;
294 
295  if (!iter)
296  return AVERROR(EIO);
297 
298  while (ret == 0 && iter->Next(&dl) == S_OK) {
299  IDeckLinkOutput *output_config;
300  IDeckLinkInput *input_config;
301  const char *displayName;
302  AVDeviceInfo *new_device = NULL;
303  int add = 0;
304 
305  ff_decklink_get_display_name(dl, &displayName);
306 
307  if (show_outputs) {
308  if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
309  output_config->Release();
310  add = 1;
311  }
312  }
313 
314  if (show_inputs) {
315  if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
316  input_config->Release();
317  add = 1;
318  }
319  }
320 
321  if (add == 1) {
322  new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
323  if (!new_device) {
324  ret = AVERROR(ENOMEM);
325  goto next;
326  }
327 
328  new_device->device_name = av_strdup(displayName);
329  new_device->device_description = av_strdup(displayName);
330 
331  if (!new_device->device_name ||
332  !new_device->device_description ||
333  av_dynarray_add_nofree(&device_list->devices, &device_list->nb_devices, new_device) < 0) {
334  ret = AVERROR(ENOMEM);
335  av_freep(&new_device->device_name);
336  av_freep(&new_device->device_description);
337  av_freep(&new_device);
338  goto next;
339  }
340  }
341 
342  next:
343  av_freep(&displayName);
344  dl->Release();
345  }
346  iter->Release();
347  return ret;
348 }
349 
350 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
351  output to av_log() and exits (for backward compatibility with the
352  "-list_devices" argument). */
354  int show_inputs, int show_outputs)
355 {
356  struct AVDeviceInfoList *device_list = NULL;
357  int ret;
358 
359  device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
360  if (!device_list)
361  return;
362 
363  ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
364  if (ret == 0) {
365  av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
366  show_inputs ? "input" : "output");
367  for (int i = 0; i < device_list->nb_devices; i++) {
368  av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_name);
369  }
370  }
371  avdevice_free_list_devices(&device_list);
372 }
373 
375 {
376  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
377  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
378  IDeckLinkDisplayModeIterator *itermode;
379  IDeckLinkDisplayMode *mode;
380  uint32_t format_code;
381  HRESULT res;
382 
383  if (direction == DIRECTION_IN) {
384  int ret;
385  ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
386  if (ret < 0)
387  return ret;
388  ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
389  if (ret < 0)
390  return ret;
391  res = ctx->dli->GetDisplayModeIterator (&itermode);
392  } else {
393  res = ctx->dlo->GetDisplayModeIterator (&itermode);
394  }
395 
396  if (res!= S_OK) {
397  av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
398  return AVERROR(EIO);
399  }
400 
401  av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
402  avctx->url);
403  while (itermode->Next(&mode) == S_OK) {
404  BMDTimeValue tb_num, tb_den;
405  mode->GetFrameRate(&tb_num, &tb_den);
406  format_code = av_bswap32(mode->GetDisplayMode());
407  av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
408  (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
409  (int) tb_den, (int) tb_num);
410  switch (mode->GetFieldDominance()) {
411  case bmdLowerFieldFirst:
412  av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
413  case bmdUpperFieldFirst:
414  av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
415  }
416  mode->Release();
417  }
418  av_log(avctx, AV_LOG_INFO, "\n");
419 
420  itermode->Release();
421 
422  return 0;
423 }
424 
426 {
427  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
428  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
429 
430  if (ctx->dli)
431  ctx->dli->Release();
432  if (ctx->dlo)
433  ctx->dlo->Release();
434  if (ctx->attr)
435  ctx->attr->Release();
436  if (ctx->cfg)
437  ctx->cfg->Release();
438  if (ctx->dl)
439  ctx->dl->Release();
440 }
441 
443 {
444  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
445  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
446  IDeckLink *dl = NULL;
447  IDeckLinkIterator *iter = decklink_create_iterator(avctx);
448  if (!iter)
449  return AVERROR_EXTERNAL;
450 
451  while (iter->Next(&dl) == S_OK) {
452  const char *displayName;
453  ff_decklink_get_display_name(dl, &displayName);
454  if (!strcmp(name, displayName)) {
455  av_free((void *)displayName);
456  ctx->dl = dl;
457  break;
458  }
459  av_free((void *)displayName);
460  dl->Release();
461  }
462  iter->Release();
463  if (!ctx->dl)
464  return AVERROR(ENXIO);
465 
466  if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
467  av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
468  ff_decklink_cleanup(avctx);
469  return AVERROR_EXTERNAL;
470  }
471 
472  if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
473  av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
474  ff_decklink_cleanup(avctx);
475  return AVERROR_EXTERNAL;
476  }
477 
478  return 0;
479 }
#define NULL
Definition: coverity.c:32
Structure describes basic parameters of the device.
Definition: avdevice.h:452
#define S_OK
Definition: windows2linux.h:40
char * device_description
human friendly name
Definition: avdevice.h:454
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
char * device_name
device name, format depends on device
Definition: avdevice.h:453
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:236
Format I/O context.
Definition: avformat.h:1351
#define av_malloc(s)
void avdevice_free_list_devices(AVDeviceInfoList **device_list)
Convenient function to free result of avdevice_list_devices().
Definition: avdevice.c:250
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_RB32
Definition: bytestream.h:87
#define height
static double av_q2d(AVRational a)
Convert an AVRational to a double.
Definition: rational.h:104
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
int av_dynarray_add_nofree(void *tab_ptr, int *nb_ptr, void *elem)
Add an element to a dynamic array.
Definition: mem.c:294
#define av_log(a,...)
Main libavdevice API header.
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AVERROR(e)
Definition: error.h:43
char * url
input or output URL.
Definition: avformat.h:1447
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
uint16_t width
Definition: gdv.c:47
AVDeviceInfo ** devices
list of autodetected devices
Definition: avdevice.h:461
static char * dup_wchar_to_utf8(wchar_t *w)
Definition: dshow.c:132
#define FFMIN(a, b)
Definition: common.h:96
uint8_t w
Definition: llviddspenc.c:38
AVFormatContext * ctx
Definition: movenc.c:48
#define s(width, name)
Definition: cbs_vp9.c:257
#define AV_LOG_INFO
Standard information.
Definition: log.h:187
#define av_bswap32
Definition: bswap.h:33
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:251
static AVRational av_make_q(int num, int den)
Create an AVRational.
Definition: rational.h:71
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVFieldOrder
Definition: avcodec.h:1496
byte swapping routines
List of devices.
Definition: avdevice.h:460
DWORD HRESULT
static int av_cmp_q(AVRational a, AVRational b)
Compare two rationals.
Definition: rational.h:89
Main libavformat public API header.
int
#define av_free(p)
void * priv_data
Format private data.
Definition: avformat.h:1379
#define av_freep(p)
int nb_devices
number of autodetected devices
Definition: avdevice.h:462
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:57
mode
Use these values in ebur128_init (or'ed).
Definition: ebur128.h:83
const char * name
Definition: opengl_enc.c:103