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 HRESULT ff_decklink_get_display_name(IDeckLink *This, const char **displayName)
81 {
82  DECKLINK_STR tmpDisplayName;
83  HRESULT hr = This->GetDisplayName(&tmpDisplayName);
84  if (hr != S_OK)
85  return hr;
86  *displayName = DECKLINK_STRDUP(tmpDisplayName);
87  DECKLINK_FREE(tmpDisplayName);
88  return hr;
89 }
90 
91 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
92 {
93  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
94  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
95  BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
96  int64_t bmd_input = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
97  const char *type_name = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
98  int64_t supported_connections = 0;
99  HRESULT res;
100 
101  if (bmd_input) {
102  res = ctx->attr->GetInt(attr_id, &supported_connections);
103  if (res != S_OK) {
104  av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
105  return AVERROR_EXTERNAL;
106  }
107  if ((supported_connections & bmd_input) != bmd_input) {
108  av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
109  return AVERROR(ENOSYS);
110  }
111  res = ctx->cfg->SetInt(cfg_id, bmd_input);
112  if (res != S_OK) {
113  av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
114  return AVERROR_EXTERNAL;
115  }
116  }
117  return 0;
118 }
119 
120 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
121 {
122  if (field_order == AV_FIELD_UNKNOWN)
123  return true;
124  if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
125  return true;
126  if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
127  return true;
128  if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
129  return true;
130  return false;
131 }
132 
134  decklink_direction_t direction) {
135  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
136  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
137  HRESULT res;
138 
139  if (ctx->duplex_mode) {
140  DECKLINK_BOOL duplex_supported = false;
141 
142  if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
143  duplex_supported = false;
144 
145  if (duplex_supported) {
146  res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
147  if (res != S_OK)
148  av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
149  else
150  av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
151  } else {
152  av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
153  }
154  }
155  if (direction == DIRECTION_IN) {
156  int ret;
157  ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
158  if (ret < 0)
159  return ret;
160  ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
161  if (ret < 0)
162  return ret;
163  }
164  return 0;
165 }
166 
168  int width, int height,
169  int tb_num, int tb_den,
170  enum AVFieldOrder field_order,
171  decklink_direction_t direction, int num)
172 {
173  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
174  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
175  BMDDisplayModeSupport support;
176  IDeckLinkDisplayModeIterator *itermode;
177  IDeckLinkDisplayMode *mode;
178  int i = 1;
179  HRESULT res;
180 
181  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",
182  width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
183 
184  if (direction == DIRECTION_IN) {
185  res = ctx->dli->GetDisplayModeIterator (&itermode);
186  } else {
187  res = ctx->dlo->GetDisplayModeIterator (&itermode);
188  }
189 
190  if (res!= S_OK) {
191  av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
192  return AVERROR(EIO);
193  }
194 
195  char format_buf[] = " ";
196  if (cctx->format_code)
197  memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
198  BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
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  BMDDisplayMode bmd_mode = mode->GetDisplayMode();
206  BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
207 
208  mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
209  AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
210 
211  if ((bmd_width == width &&
212  bmd_height == height &&
213  !av_cmp_q(mode_tb, target_tb) &&
214  field_order_eq(field_order, bmd_field_dominance))
215  || i == num
216  || target_mode == bmd_mode) {
217  ctx->bmd_mode = bmd_mode;
218  ctx->bmd_width = bmd_width;
219  ctx->bmd_height = bmd_height;
220  ctx->bmd_tb_den = bmd_tb_den;
221  ctx->bmd_tb_num = bmd_tb_num;
222  ctx->bmd_field_dominance = bmd_field_dominance;
223  av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
224  bmd_width, bmd_height, 1/av_q2d(mode_tb),
225  (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
226  }
227 
228  mode->Release();
229  i++;
230  }
231 
232  itermode->Release();
233 
234  if (ctx->bmd_mode == bmdModeUnknown)
235  return -1;
236  if (direction == DIRECTION_IN) {
237  if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
238  bmdVideoOutputFlagDefault,
239  &support, NULL) != S_OK)
240  return -1;
241  } else {
242  if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, bmdFormat8BitYUV,
243  bmdVideoOutputFlagDefault,
244  &support, NULL) != S_OK)
245  return -1;
246  }
247  if (support == bmdDisplayModeSupported)
248  return 0;
249 
250  return -1;
251 }
252 
254  return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
255 }
256 
258  struct AVDeviceInfoList *device_list,
259  int show_inputs, int show_outputs)
260 {
261  IDeckLink *dl = NULL;
262  IDeckLinkIterator *iter = decklink_create_iterator(avctx);
263  int ret = 0;
264 
265  if (!iter)
266  return AVERROR(EIO);
267 
268  while (ret == 0 && iter->Next(&dl) == S_OK) {
269  IDeckLinkOutput *output_config;
270  IDeckLinkInput *input_config;
271  const char *displayName;
272  AVDeviceInfo *new_device = NULL;
273  int add = 0;
274 
275  ff_decklink_get_display_name(dl, &displayName);
276 
277  if (show_outputs) {
278  if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
279  output_config->Release();
280  add = 1;
281  }
282  }
283 
284  if (show_inputs) {
285  if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
286  input_config->Release();
287  add = 1;
288  }
289  }
290 
291  if (add == 1) {
292  new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
293  if (!new_device) {
294  ret = AVERROR(ENOMEM);
295  goto next;
296  }
297 
298  new_device->device_name = av_strdup(displayName);
299  new_device->device_description = av_strdup(displayName);
300 
301  if (!new_device->device_name ||
302  !new_device->device_description ||
303  av_dynarray_add_nofree(&device_list->devices, &device_list->nb_devices, new_device) < 0) {
304  ret = AVERROR(ENOMEM);
305  av_freep(&new_device->device_name);
306  av_freep(&new_device->device_description);
307  av_freep(&new_device);
308  goto next;
309  }
310  }
311 
312  next:
313  av_freep(&displayName);
314  dl->Release();
315  }
316  iter->Release();
317  return ret;
318 }
319 
320 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
321  output to av_log() and exits (for backward compatibility with the
322  "-list_devices" argument). */
324  int show_inputs, int show_outputs)
325 {
326  struct AVDeviceInfoList *device_list = NULL;
327  int ret;
328 
329  device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
330  if (!device_list)
331  return;
332 
333  ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
334  if (ret == 0) {
335  av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
336  show_inputs ? "input" : "output");
337  for (int i = 0; i < device_list->nb_devices; i++) {
338  av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_name);
339  }
340  }
341  avdevice_free_list_devices(&device_list);
342 }
343 
345 {
346  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
347  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
348  IDeckLinkDisplayModeIterator *itermode;
349  IDeckLinkDisplayMode *mode;
350  uint32_t format_code;
351  HRESULT res;
352 
353  if (direction == DIRECTION_IN) {
354  int ret;
355  ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
356  if (ret < 0)
357  return ret;
358  ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
359  if (ret < 0)
360  return ret;
361  res = ctx->dli->GetDisplayModeIterator (&itermode);
362  } else {
363  res = ctx->dlo->GetDisplayModeIterator (&itermode);
364  }
365 
366  if (res!= S_OK) {
367  av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
368  return AVERROR(EIO);
369  }
370 
371  av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
372  avctx->url);
373  while (itermode->Next(&mode) == S_OK) {
374  BMDTimeValue tb_num, tb_den;
375  mode->GetFrameRate(&tb_num, &tb_den);
376  format_code = av_bswap32(mode->GetDisplayMode());
377  av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
378  (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
379  (int) tb_den, (int) tb_num);
380  switch (mode->GetFieldDominance()) {
381  case bmdLowerFieldFirst:
382  av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
383  case bmdUpperFieldFirst:
384  av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
385  }
386  mode->Release();
387  }
388  av_log(avctx, AV_LOG_INFO, "\n");
389 
390  itermode->Release();
391 
392  return 0;
393 }
394 
396 {
397  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
398  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
399 
400  if (ctx->dli)
401  ctx->dli->Release();
402  if (ctx->dlo)
403  ctx->dlo->Release();
404  if (ctx->attr)
405  ctx->attr->Release();
406  if (ctx->cfg)
407  ctx->cfg->Release();
408  if (ctx->dl)
409  ctx->dl->Release();
410 }
411 
413 {
414  struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
415  struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
416  IDeckLink *dl = NULL;
417  IDeckLinkIterator *iter = decklink_create_iterator(avctx);
418  if (!iter)
419  return AVERROR_EXTERNAL;
420 
421  while (iter->Next(&dl) == S_OK) {
422  const char *displayName;
423  ff_decklink_get_display_name(dl, &displayName);
424  if (!strcmp(name, displayName)) {
425  av_free((void *)displayName);
426  ctx->dl = dl;
427  break;
428  }
429  av_free((void *)displayName);
430  dl->Release();
431  }
432  iter->Release();
433  if (!ctx->dl)
434  return AVERROR(ENXIO);
435 
436  if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
437  av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
438  ff_decklink_cleanup(avctx);
439  return AVERROR_EXTERNAL;
440  }
441 
442  if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
443  av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
444  ff_decklink_cleanup(avctx);
445  return AVERROR_EXTERNAL;
446  }
447 
448  return 0;
449 }
#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
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
#define FFMIN(a, b)
Definition: common.h:96
AVFormatContext * ctx
Definition: movenc.c:48
#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:1499
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