git.sesse.net Git - ffmpeg/blob - libavdevice/decklink_common.cpp

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