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