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 /* 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 static int decklink_get_attr_string(IDeckLink *dl, BMDDeckLinkAttributeID cfg_id, const char **s)
  81 {
  82     DECKLINK_STR tmp;
  83     HRESULT hr;
  84     IDeckLinkAttributes *attr;
  85     *s = NULL;
  86     if (dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&attr) != S_OK)
  87         return AVERROR_EXTERNAL;
  88     hr = attr->GetString(cfg_id, &tmp);
  89     attr->Release();
  90     if (hr == S_OK) {
  91         *s = DECKLINK_STRDUP(tmp);
  92         DECKLINK_FREE(tmp);
  93         if (!*s)
  94             return AVERROR(ENOMEM);
  95     } else if (hr == E_FAIL) {
  96         return AVERROR_EXTERNAL;
  97     }
  98     return 0;
  99 }
 100
 101 static int decklink_select_input(AVFormatContext *avctx, BMDDeckLinkConfigurationID cfg_id)
 102 {
 103     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 104     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 105     BMDDeckLinkAttributeID attr_id = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? BMDDeckLinkAudioInputConnections : BMDDeckLinkVideoInputConnections;
 106     int64_t bmd_input              = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? (int64_t)ctx->audio_input : (int64_t)ctx->video_input;
 107     const char *type_name          = (cfg_id == bmdDeckLinkConfigAudioInputConnection) ? "audio" : "video";
 108     int64_t supported_connections = 0;
 109     HRESULT res;
 110
 111     if (bmd_input) {
 112         res = ctx->attr->GetInt(attr_id, &supported_connections);
 113         if (res != S_OK) {
 114             av_log(avctx, AV_LOG_ERROR, "Failed to query supported %s inputs.\n", type_name);
 115             return AVERROR_EXTERNAL;
 116         }
 117         if ((supported_connections & bmd_input) != bmd_input) {
 118             av_log(avctx, AV_LOG_ERROR, "Device does not support selected %s input.\n", type_name);
 119             return AVERROR(ENOSYS);
 120         }
 121         res = ctx->cfg->SetInt(cfg_id, bmd_input);
 122         if (res != S_OK) {
 123             av_log(avctx, AV_LOG_ERROR, "Failed to select %s input.\n", type_name);
 124             return AVERROR_EXTERNAL;
 125         }
 126     }
 127     return 0;
 128 }
 129
 130 static DECKLINK_BOOL field_order_eq(enum AVFieldOrder field_order, BMDFieldDominance bmd_field_order)
 131 {
 132     if (field_order == AV_FIELD_UNKNOWN)
 133         return true;
 134     if ((field_order == AV_FIELD_TT || field_order == AV_FIELD_TB) && bmd_field_order == bmdUpperFieldFirst)
 135         return true;
 136     if ((field_order == AV_FIELD_BB || field_order == AV_FIELD_BT) && bmd_field_order == bmdLowerFieldFirst)
 137         return true;
 138     if (field_order == AV_FIELD_PROGRESSIVE && (bmd_field_order == bmdProgressiveFrame || bmd_field_order == bmdProgressiveSegmentedFrame))
 139         return true;
 140     return false;
 141 }
 142
 143 int ff_decklink_set_configs(AVFormatContext *avctx,
 144                             decklink_direction_t direction) {
 145     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 146     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 147     HRESULT res;
 148
 149     if (ctx->duplex_mode) {
 150         DECKLINK_BOOL duplex_supported = false;
 151
 152         if (ctx->attr->GetFlag(BMDDeckLinkSupportsDuplexModeConfiguration, &duplex_supported) != S_OK)
 153             duplex_supported = false;
 154
 155         if (duplex_supported) {
 156             res = ctx->cfg->SetInt(bmdDeckLinkConfigDuplexMode, ctx->duplex_mode == 2 ? bmdDuplexModeFull : bmdDuplexModeHalf);
 157             if (res != S_OK)
 158                 av_log(avctx, AV_LOG_WARNING, "Setting duplex mode failed.\n");
 159             else
 160                 av_log(avctx, AV_LOG_VERBOSE, "Successfully set duplex mode to %s duplex.\n", ctx->duplex_mode == 2 ? "full" : "half");
 161         } else {
 162             av_log(avctx, AV_LOG_WARNING, "Unable to set duplex mode, because it is not supported.\n");
 163         }
 164     }
 165     if (direction == DIRECTION_IN) {
 166         int ret;
 167         ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
 168         if (ret < 0)
 169             return ret;
 170         ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
 171         if (ret < 0)
 172             return ret;
 173     }
 174     if (direction == DIRECTION_OUT && cctx->timing_offset != INT_MIN) {
 175         res = ctx->cfg->SetInt(bmdDeckLinkConfigReferenceInputTimingOffset, cctx->timing_offset);
 176         if (res != S_OK)
 177             av_log(avctx, AV_LOG_WARNING, "Setting timing offset failed.\n");
 178     }
 179     return 0;
 180 }
 181
 182 int ff_decklink_set_format(AVFormatContext *avctx,
 183                                int width, int height,
 184                                int tb_num, int tb_den,
 185                                enum AVFieldOrder field_order,
 186                                decklink_direction_t direction, int num)
 187 {
 188     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 189     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 190     BMDDisplayModeSupport support;
 191     IDeckLinkDisplayModeIterator *itermode;
 192     IDeckLinkDisplayMode *mode;
 193     int i = 1;
 194     HRESULT res;
 195
 196     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",
 197         width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
 198
 199     if (direction == DIRECTION_IN) {
 200         res = ctx->dli->GetDisplayModeIterator (&itermode);
 201     } else {
 202         res = ctx->dlo->GetDisplayModeIterator (&itermode);
 203     }
 204
 205     if (res!= S_OK) {
 206             av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
 207             return AVERROR(EIO);
 208     }
 209
 210     char format_buf[] = "    ";
 211     if (cctx->format_code)
 212         memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
 213     BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
 214     AVRational target_tb = av_make_q(tb_num, tb_den);
 215     ctx->bmd_mode = bmdModeUnknown;
 216     while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
 217         BMDTimeValue bmd_tb_num, bmd_tb_den;
 218         int bmd_width  = mode->GetWidth();
 219         int bmd_height = mode->GetHeight();
 220         BMDDisplayMode bmd_mode = mode->GetDisplayMode();
 221         BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
 222
 223         mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
 224         AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
 225
 226         if ((bmd_width == width &&
 227              bmd_height == height &&
 228              !av_cmp_q(mode_tb, target_tb) &&
 229              field_order_eq(field_order, bmd_field_dominance))
 230              || i == num
 231              || target_mode == bmd_mode) {
 232             ctx->bmd_mode   = bmd_mode;
 233             ctx->bmd_width  = bmd_width;
 234             ctx->bmd_height = bmd_height;
 235             ctx->bmd_tb_den = bmd_tb_den;
 236             ctx->bmd_tb_num = bmd_tb_num;
 237             ctx->bmd_field_dominance = bmd_field_dominance;
 238             av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
 239                 bmd_width, bmd_height, 1/av_q2d(mode_tb),
 240                 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
 241         }
 242
 243         mode->Release();
 244         i++;
 245     }
 246
 247     itermode->Release();
 248
 249     if (ctx->bmd_mode == bmdModeUnknown)
 250         return -1;
 251     if (direction == DIRECTION_IN) {
 252         if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
 253                                            bmdVideoOutputFlagDefault,
 254                                            &support, NULL) != S_OK)
 255             return -1;
 256     } else {
 257         if (!ctx->supports_vanc || ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
 258                                                                   bmdVideoOutputVANC,
 259                                                                   &support, NULL) != S_OK) {
 260             /* Try without VANC enabled */
 261             if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
 262                                                bmdVideoOutputFlagDefault,
 263                                                &support, NULL) != S_OK) {
 264                 return -1;
 265             }
 266             ctx->supports_vanc = 0;
 267         }
 268
 269     }
 270     if (support == bmdDisplayModeSupported)
 271         return 0;
 272
 273     return -1;
 274 }
 275
 276 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
 277     return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
 278 }
 279
 280 int ff_decklink_list_devices(AVFormatContext *avctx,
 281                              struct AVDeviceInfoList *device_list,
 282                              int show_inputs, int show_outputs)
 283 {
 284     IDeckLink *dl = NULL;
 285     IDeckLinkIterator *iter = decklink_create_iterator(avctx);
 286     int ret = 0;
 287
 288     if (!iter)
 289         return AVERROR(EIO);
 290
 291     while (ret == 0 && iter->Next(&dl) == S_OK) {
 292         IDeckLinkOutput *output_config;
 293         IDeckLinkInput *input_config;
 294         const char *display_name = NULL;
 295         const char *unique_name = NULL;
 296         AVDeviceInfo *new_device = NULL;
 297         int add = 0;
 298
 299         ret = decklink_get_attr_string(dl, BMDDeckLinkDisplayName, &display_name);
 300         if (ret < 0)
 301             goto next;
 302         ret = decklink_get_attr_string(dl, BMDDeckLinkDeviceHandle, &unique_name);
 303         if (ret < 0)
 304             goto next;
 305
 306         if (show_outputs) {
 307             if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
 308                 output_config->Release();
 309                 add = 1;
 310             }
 311         }
 312
 313         if (show_inputs) {
 314             if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
 315                 input_config->Release();
 316                 add = 1;
 317             }
 318         }
 319
 320         if (add == 1) {
 321             new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
 322             if (!new_device) {
 323                 ret = AVERROR(ENOMEM);
 324                 goto next;
 325             }
 326
 327             new_device->device_name = av_strdup(unique_name ? unique_name : display_name);
 328             new_device->device_description = av_strdup(display_name);
 329
 330             if (!new_device->device_name ||
 331                 !new_device->device_description ||
 332                 av_dynarray_add_nofree(&device_list->devices, &device_list->nb_devices, new_device) < 0) {
 333                 ret = AVERROR(ENOMEM);
 334                 av_freep(&new_device->device_name);
 335                 av_freep(&new_device->device_description);
 336                 av_freep(&new_device);
 337                 goto next;
 338             }
 339         }
 340
 341     next:
 342         av_freep(&display_name);
 343         av_freep(&unique_name);
 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). */
 353 void ff_decklink_list_devices_legacy(AVFormatContext *avctx,
 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_description);
 369         }
 370     }
 371     avdevice_free_list_devices(&device_list);
 372 }
 373
 374 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
 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
 425 void ff_decklink_cleanup(AVFormatContext *avctx)
 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
 442 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
 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 *display_name = NULL;
 453         const char *unique_name = NULL;
 454         decklink_get_attr_string(dl, BMDDeckLinkDisplayName, &display_name);
 455         decklink_get_attr_string(dl, BMDDeckLinkDeviceHandle, &unique_name);
 456         if (display_name && !strcmp(name, display_name) || unique_name && !strcmp(name, unique_name)) {
 457             av_free((void *)unique_name);
 458             av_free((void *)display_name);
 459             ctx->dl = dl;
 460             break;
 461         }
 462         av_free((void *)display_name);
 463         av_free((void *)unique_name);
 464         dl->Release();
 465     }
 466     iter->Release();
 467     if (!ctx->dl)
 468         return AVERROR(ENXIO);
 469
 470     if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
 471         av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
 472         ff_decklink_cleanup(avctx);
 473         return AVERROR_EXTERNAL;
 474     }
 475
 476     if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
 477         av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
 478         ff_decklink_cleanup(avctx);
 479         return AVERROR_EXTERNAL;
 480     }
 481
 482     return 0;
 483 }