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 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     return 0;
 175 }
 176
 177 int ff_decklink_set_format(AVFormatContext *avctx,
 178                                int width, int height,
 179                                int tb_num, int tb_den,
 180                                enum AVFieldOrder field_order,
 181                                decklink_direction_t direction, int num)
 182 {
 183     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 184     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 185     BMDDisplayModeSupport support;
 186     IDeckLinkDisplayModeIterator *itermode;
 187     IDeckLinkDisplayMode *mode;
 188     int i = 1;
 189     HRESULT res;
 190
 191     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",
 192         width, height, tb_num, tb_den, field_order, direction, num, (cctx->format_code) ? cctx->format_code : "(unset)");
 193
 194     if (direction == DIRECTION_IN) {
 195         res = ctx->dli->GetDisplayModeIterator (&itermode);
 196     } else {
 197         res = ctx->dlo->GetDisplayModeIterator (&itermode);
 198     }
 199
 200     if (res!= S_OK) {
 201             av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
 202             return AVERROR(EIO);
 203     }
 204
 205     char format_buf[] = "    ";
 206     if (cctx->format_code)
 207         memcpy(format_buf, cctx->format_code, FFMIN(strlen(cctx->format_code), sizeof(format_buf)));
 208     BMDDisplayMode target_mode = (BMDDisplayMode)AV_RB32(format_buf);
 209     AVRational target_tb = av_make_q(tb_num, tb_den);
 210     ctx->bmd_mode = bmdModeUnknown;
 211     while ((ctx->bmd_mode == bmdModeUnknown) && itermode->Next(&mode) == S_OK) {
 212         BMDTimeValue bmd_tb_num, bmd_tb_den;
 213         int bmd_width  = mode->GetWidth();
 214         int bmd_height = mode->GetHeight();
 215         BMDDisplayMode bmd_mode = mode->GetDisplayMode();
 216         BMDFieldDominance bmd_field_dominance = mode->GetFieldDominance();
 217
 218         mode->GetFrameRate(&bmd_tb_num, &bmd_tb_den);
 219         AVRational mode_tb = av_make_q(bmd_tb_num, bmd_tb_den);
 220
 221         if ((bmd_width == width &&
 222              bmd_height == height &&
 223              !av_cmp_q(mode_tb, target_tb) &&
 224              field_order_eq(field_order, bmd_field_dominance))
 225              || i == num
 226              || target_mode == bmd_mode) {
 227             ctx->bmd_mode   = bmd_mode;
 228             ctx->bmd_width  = bmd_width;
 229             ctx->bmd_height = bmd_height;
 230             ctx->bmd_tb_den = bmd_tb_den;
 231             ctx->bmd_tb_num = bmd_tb_num;
 232             ctx->bmd_field_dominance = bmd_field_dominance;
 233             av_log(avctx, AV_LOG_INFO, "Found Decklink mode %d x %d with rate %.2f%s\n",
 234                 bmd_width, bmd_height, 1/av_q2d(mode_tb),
 235                 (ctx->bmd_field_dominance==bmdLowerFieldFirst || ctx->bmd_field_dominance==bmdUpperFieldFirst)?"(i)":"");
 236         }
 237
 238         mode->Release();
 239         i++;
 240     }
 241
 242     itermode->Release();
 243
 244     if (ctx->bmd_mode == bmdModeUnknown)
 245         return -1;
 246     if (direction == DIRECTION_IN) {
 247         if (ctx->dli->DoesSupportVideoMode(ctx->bmd_mode, (BMDPixelFormat) cctx->raw_format,
 248                                            bmdVideoOutputFlagDefault,
 249                                            &support, NULL) != S_OK)
 250             return -1;
 251     } else {
 252         if (!ctx->supports_vanc || ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
 253                                                                   bmdVideoOutputVANC,
 254                                                                   &support, NULL) != S_OK) {
 255             /* Try without VANC enabled */
 256             if (ctx->dlo->DoesSupportVideoMode(ctx->bmd_mode, ctx->raw_format,
 257                                                bmdVideoOutputFlagDefault,
 258                                                &support, NULL) != S_OK) {
 259                 return -1;
 260             }
 261             ctx->supports_vanc = 0;
 262         }
 263
 264     }
 265     if (support == bmdDisplayModeSupported)
 266         return 0;
 267
 268     return -1;
 269 }
 270
 271 int ff_decklink_set_format(AVFormatContext *avctx, decklink_direction_t direction, int num) {
 272     return ff_decklink_set_format(avctx, 0, 0, 0, 0, AV_FIELD_UNKNOWN, direction, num);
 273 }
 274
 275 int ff_decklink_list_devices(AVFormatContext *avctx,
 276                              struct AVDeviceInfoList *device_list,
 277                              int show_inputs, int show_outputs)
 278 {
 279     IDeckLink *dl = NULL;
 280     IDeckLinkIterator *iter = decklink_create_iterator(avctx);
 281     int ret = 0;
 282
 283     if (!iter)
 284         return AVERROR(EIO);
 285
 286     while (ret == 0 && iter->Next(&dl) == S_OK) {
 287         IDeckLinkOutput *output_config;
 288         IDeckLinkInput *input_config;
 289         const char *display_name = NULL;
 290         const char *unique_name = NULL;
 291         AVDeviceInfo *new_device = NULL;
 292         int add = 0;
 293
 294         ret = decklink_get_attr_string(dl, BMDDeckLinkDisplayName, &display_name);
 295         if (ret < 0)
 296             goto next;
 297         ret = decklink_get_attr_string(dl, BMDDeckLinkDeviceHandle, &unique_name);
 298         if (ret < 0)
 299             goto next;
 300
 301         if (show_outputs) {
 302             if (dl->QueryInterface(IID_IDeckLinkOutput, (void **)&output_config) == S_OK) {
 303                 output_config->Release();
 304                 add = 1;
 305             }
 306         }
 307
 308         if (show_inputs) {
 309             if (dl->QueryInterface(IID_IDeckLinkInput, (void **)&input_config) == S_OK) {
 310                 input_config->Release();
 311                 add = 1;
 312             }
 313         }
 314
 315         if (add == 1) {
 316             new_device = (AVDeviceInfo *) av_mallocz(sizeof(AVDeviceInfo));
 317             if (!new_device) {
 318                 ret = AVERROR(ENOMEM);
 319                 goto next;
 320             }
 321
 322             new_device->device_name = av_strdup(unique_name ? unique_name : display_name);
 323             new_device->device_description = av_strdup(display_name);
 324
 325             if (!new_device->device_name ||
 326                 !new_device->device_description ||
 327                 av_dynarray_add_nofree(&device_list->devices, &device_list->nb_devices, new_device) < 0) {
 328                 ret = AVERROR(ENOMEM);
 329                 av_freep(&new_device->device_name);
 330                 av_freep(&new_device->device_description);
 331                 av_freep(&new_device);
 332                 goto next;
 333             }
 334         }
 335
 336     next:
 337         av_freep(&display_name);
 338         av_freep(&unique_name);
 339         dl->Release();
 340     }
 341     iter->Release();
 342     return ret;
 343 }
 344
 345 /* This is a wrapper around the ff_decklink_list_devices() which dumps the
 346    output to av_log() and exits (for backward compatibility with the
 347    "-list_devices" argument). */
 348 void ff_decklink_list_devices_legacy(AVFormatContext *avctx,
 349                                      int show_inputs, int show_outputs)
 350 {
 351     struct AVDeviceInfoList *device_list = NULL;
 352     int ret;
 353
 354     device_list = (struct AVDeviceInfoList *) av_mallocz(sizeof(AVDeviceInfoList));
 355     if (!device_list)
 356         return;
 357
 358     ret = ff_decklink_list_devices(avctx, device_list, show_inputs, show_outputs);
 359     if (ret == 0) {
 360         av_log(avctx, AV_LOG_INFO, "Blackmagic DeckLink %s devices:\n",
 361                show_inputs ? "input" : "output");
 362         for (int i = 0; i < device_list->nb_devices; i++) {
 363             av_log(avctx, AV_LOG_INFO, "\t'%s'\n", device_list->devices[i]->device_description);
 364         }
 365     }
 366     avdevice_free_list_devices(&device_list);
 367 }
 368
 369 int ff_decklink_list_formats(AVFormatContext *avctx, decklink_direction_t direction)
 370 {
 371     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 372     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 373     IDeckLinkDisplayModeIterator *itermode;
 374     IDeckLinkDisplayMode *mode;
 375     uint32_t format_code;
 376     HRESULT res;
 377
 378     if (direction == DIRECTION_IN) {
 379         int ret;
 380         ret = decklink_select_input(avctx, bmdDeckLinkConfigAudioInputConnection);
 381         if (ret < 0)
 382             return ret;
 383         ret = decklink_select_input(avctx, bmdDeckLinkConfigVideoInputConnection);
 384         if (ret < 0)
 385             return ret;
 386         res = ctx->dli->GetDisplayModeIterator (&itermode);
 387     } else {
 388         res = ctx->dlo->GetDisplayModeIterator (&itermode);
 389     }
 390
 391     if (res!= S_OK) {
 392             av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
 393             return AVERROR(EIO);
 394     }
 395
 396     av_log(avctx, AV_LOG_INFO, "Supported formats for '%s':\n\tformat_code\tdescription",
 397                avctx->url);
 398     while (itermode->Next(&mode) == S_OK) {
 399         BMDTimeValue tb_num, tb_den;
 400         mode->GetFrameRate(&tb_num, &tb_den);
 401         format_code = av_bswap32(mode->GetDisplayMode());
 402         av_log(avctx, AV_LOG_INFO, "\n\t%.4s\t\t%ldx%ld at %d/%d fps",
 403                 (char*) &format_code, mode->GetWidth(), mode->GetHeight(),
 404                 (int) tb_den, (int) tb_num);
 405         switch (mode->GetFieldDominance()) {
 406         case bmdLowerFieldFirst:
 407         av_log(avctx, AV_LOG_INFO, " (interlaced, lower field first)"); break;
 408         case bmdUpperFieldFirst:
 409         av_log(avctx, AV_LOG_INFO, " (interlaced, upper field first)"); break;
 410         }
 411         mode->Release();
 412     }
 413     av_log(avctx, AV_LOG_INFO, "\n");
 414
 415     itermode->Release();
 416
 417     return 0;
 418 }
 419
 420 void ff_decklink_cleanup(AVFormatContext *avctx)
 421 {
 422     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 423     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 424
 425     if (ctx->dli)
 426         ctx->dli->Release();
 427     if (ctx->dlo)
 428         ctx->dlo->Release();
 429     if (ctx->attr)
 430         ctx->attr->Release();
 431     if (ctx->cfg)
 432         ctx->cfg->Release();
 433     if (ctx->dl)
 434         ctx->dl->Release();
 435 }
 436
 437 int ff_decklink_init_device(AVFormatContext *avctx, const char* name)
 438 {
 439     struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
 440     struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
 441     IDeckLink *dl = NULL;
 442     IDeckLinkIterator *iter = decklink_create_iterator(avctx);
 443     if (!iter)
 444         return AVERROR_EXTERNAL;
 445
 446     while (iter->Next(&dl) == S_OK) {
 447         const char *display_name = NULL;
 448         const char *unique_name = NULL;
 449         decklink_get_attr_string(dl, BMDDeckLinkDisplayName, &display_name);
 450         decklink_get_attr_string(dl, BMDDeckLinkDeviceHandle, &unique_name);
 451         if (display_name && !strcmp(name, display_name) || unique_name && !strcmp(name, unique_name)) {
 452             av_free((void *)unique_name);
 453             av_free((void *)display_name);
 454             ctx->dl = dl;
 455             break;
 456         }
 457         av_free((void *)display_name);
 458         av_free((void *)unique_name);
 459         dl->Release();
 460     }
 461     iter->Release();
 462     if (!ctx->dl)
 463         return AVERROR(ENXIO);
 464
 465     if (ctx->dl->QueryInterface(IID_IDeckLinkConfiguration, (void **)&ctx->cfg) != S_OK) {
 466         av_log(avctx, AV_LOG_ERROR, "Could not get configuration interface for '%s'\n", name);
 467         ff_decklink_cleanup(avctx);
 468         return AVERROR_EXTERNAL;
 469     }
 470
 471     if (ctx->dl->QueryInterface(IID_IDeckLinkAttributes, (void **)&ctx->attr) != S_OK) {
 472         av_log(avctx, AV_LOG_ERROR, "Could not get attributes interface for '%s'\n", name);
 473         ff_decklink_cleanup(avctx);
 474         return AVERROR_EXTERNAL;
 475     }
 476
 477     return 0;
 478 }