FFmpeg
decklink_common.h
Go to the documentation of this file.
1 /*
2  * Blackmagic DeckLink common code
3  * Copyright (c) 2013-2014 Ramiro Polla, Luca Barbato, Deti Fliegl
4  * Copyright (c) 2017 Akamai Technologies, Inc.
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #ifndef AVDEVICE_DECKLINK_COMMON_H
24 #define AVDEVICE_DECKLINK_COMMON_H
25 
26 #include <DeckLinkAPIVersion.h>
27 #if BLACKMAGIC_DECKLINK_API_VERSION < 0x0b000000
28 #define IID_IDeckLinkProfileAttributes IID_IDeckLinkAttributes
29 #define IDeckLinkProfileAttributes IDeckLinkAttributes
30 #endif
31 
32 extern "C" {
34 #include "libavfilter/ccfifo.h"
35 }
36 #include "libavutil/thread.h"
37 #include "decklink_common_c.h"
38 #if CONFIG_LIBKLVANC
39 #include "libklvanc/vanc.h"
40 #endif
41 
42 #ifdef _WIN32
43 #define DECKLINK_BOOL BOOL
44 #else
45 #define DECKLINK_BOOL bool
46 #endif
47 
48 #ifdef _WIN32
49 static char *dup_wchar_to_utf8(wchar_t *w)
50 {
51  char *s = NULL;
52  int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
53  s = (char *) av_malloc(l);
54  if (s)
55  WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
56  return s;
57 }
58 #define DECKLINK_STR OLECHAR *
59 #define DECKLINK_STRDUP dup_wchar_to_utf8
60 #define DECKLINK_FREE(s) SysFreeString(s)
61 #elif defined(__APPLE__)
62 static char *dup_cfstring_to_utf8(CFStringRef w)
63 {
64  char s[256];
65  CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
66  return av_strdup(s);
67 }
68 #define DECKLINK_STR const __CFString *
69 #define DECKLINK_STRDUP dup_cfstring_to_utf8
70 #define DECKLINK_FREE(s) CFRelease(s)
71 #else
72 #define DECKLINK_STR const char *
73 #define DECKLINK_STRDUP av_strdup
74 /* free() is needed for a string returned by the DeckLink SDL. */
75 #define DECKLINK_FREE(s) free((void *) s)
76 #endif
77 
80 
81 typedef struct DecklinkPacketQueue {
84  unsigned long long size;
89  int64_t max_q_size;
91 
92 struct decklink_ctx {
93  /* DeckLink SDK interfaces */
94  IDeckLink *dl;
95  IDeckLinkOutput *dlo;
96  IDeckLinkInput *dli;
97  IDeckLinkConfiguration *cfg;
100 
101  /* DeckLink mode information */
102  BMDTimeValue bmd_tb_den;
103  BMDTimeValue bmd_tb_num;
104  BMDDisplayMode bmd_mode;
105  BMDVideoConnection video_input;
106  BMDAudioConnection audio_input;
107  BMDTimecodeFormat tc_format;
112 
113  /* Capture buffer queue */
115 
116  CCFifo cc_fifo; ///< closed captions
117 
118  /* Output VANC queue */
120 
121  /* Streams present */
122  int audio;
123  int video;
124 
125  /* Status */
127  int64_t first_pts;
128  int64_t last_pts;
129  unsigned long frameCount;
130  unsigned int dropped;
136 
137  /* Options */
141  int64_t teletext_lines;
142  double preroll;
144  BMDLinkConfiguration link;
148  BMDPixelFormat raw_format;
149 
152 
157 
158 #if CONFIG_LIBKLVANC
159  struct klvanc_context_s *vanc_ctx;
160 #endif
161 
162  int channels;
164  unsigned long tc_seen; // used with option wait_for_tc
165 };
166 
168 
169 static const BMDPixelFormat decklink_raw_format_map[] = {
170  (BMDPixelFormat)0,
171  bmdFormat8BitYUV,
172  bmdFormat10BitYUV,
173  bmdFormat8BitARGB,
174  bmdFormat8BitBGRA,
175  bmdFormat10BitRGB,
176 };
177 
178 static const BMDAudioConnection decklink_audio_connection_map[] = {
179  (BMDAudioConnection)0,
180  bmdAudioConnectionEmbedded,
181  bmdAudioConnectionAESEBU,
182  bmdAudioConnectionAnalog,
183  bmdAudioConnectionAnalogXLR,
184  bmdAudioConnectionAnalogRCA,
185  bmdAudioConnectionMicrophone,
186 };
187 
188 static const BMDVideoConnection decklink_video_connection_map[] = {
189  (BMDVideoConnection)0,
190  bmdVideoConnectionSDI,
191  bmdVideoConnectionHDMI,
192  bmdVideoConnectionOpticalSDI,
193  bmdVideoConnectionComponent,
194  bmdVideoConnectionComposite,
195  bmdVideoConnectionSVideo,
196 };
197 
198 static const BMDTimecodeFormat decklink_timecode_format_map[] = {
199  (BMDTimecodeFormat)0,
200  bmdTimecodeRP188VITC1,
201  bmdTimecodeRP188VITC2,
202  bmdTimecodeRP188LTC,
203  bmdTimecodeRP188Any,
204  bmdTimecodeVITC,
205  bmdTimecodeVITCField2,
206  bmdTimecodeSerial,
207 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
208  bmdTimecodeRP188HighFrameRate,
209 #else
210  (BMDTimecodeFormat)0,
211 #endif
212 };
213 
214 static const BMDLinkConfiguration decklink_link_conf_map[] = {
215  (BMDLinkConfiguration)0,
216  bmdLinkConfigurationSingleLink,
217  bmdLinkConfigurationDualLink,
218  bmdLinkConfigurationQuadLink
219 };
220 
221 #if BLACKMAGIC_DECKLINK_API_VERSION >= 0x0b000000
222 static const BMDProfileID decklink_profile_id_map[] = {
223  (BMDProfileID)0,
224  bmdProfileTwoSubDevicesHalfDuplex,
225  bmdProfileOneSubDeviceFullDuplex,
226  bmdProfileOneSubDeviceHalfDuplex,
227  bmdProfileTwoSubDevicesFullDuplex,
228  bmdProfileFourSubDevicesHalfDuplex,
229 };
230 #endif
231 
233 int ff_decklink_set_format(AVFormatContext *avctx, int width, int height, int tb_num, int tb_den, enum AVFieldOrder field_order, decklink_direction_t direction = DIRECTION_OUT);
235 int ff_decklink_list_devices(AVFormatContext *avctx, struct AVDeviceInfoList *device_list, int show_inputs, int show_outputs);
236 void ff_decklink_list_devices_legacy(AVFormatContext *avctx, int show_inputs, int show_outputs);
239 int ff_decklink_init_device(AVFormatContext *avctx, const char* name);
240 
241 void ff_decklink_packet_queue_init(AVFormatContext *avctx, DecklinkPacketQueue *q, int64_t queue_size);
248 
249 #endif /* AVDEVICE_DECKLINK_COMMON_H */
pthread_mutex_t
_fmutex pthread_mutex_t
Definition: os2threads.h:53
name
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option name
Definition: writing_filters.txt:88
DecklinkPacketQueue::abort_request
int abort_request
Definition: decklink_common.h:85
AVFieldOrder
AVFieldOrder
Definition: defs.h:198
thread.h
w
uint8_t w
Definition: llviddspenc.c:38
PacketList
Definition: packet_internal.h:33
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
pkt
AVPacket * pkt
Definition: movenc.c:59
width
#define width
DecklinkPacketQueue::cond
pthread_cond_t cond
Definition: decklink_common.h:87
s
#define s(width, name)
Definition: cbs_vp9.c:198
AVFormatContext
Format I/O context.
Definition: avformat.h:1363
DecklinkPacketQueue::nb_packets
int nb_packets
Definition: decklink_common.h:83
NULL
#define NULL
Definition: coverity.c:32
DecklinkPacketQueue::avctx
AVFormatContext * avctx
Definition: decklink_common.h:88
CCFifo
Definition: ccfifo.h:40
DecklinkPacketQueue::pkt_list
PacketList pkt_list
Definition: decklink_common.h:82
DecklinkPacketQueue
Definition: decklink_common.h:81
DecklinkPacketQueue::size
unsigned long long size
Definition: decklink_common.h:84
height
#define height
dup_wchar_to_utf8
static char * dup_wchar_to_utf8(wchar_t *w)
Definition: dshow.c:312
pthread_cond_t
Definition: os2threads.h:58
AVStream
Stream structure.
Definition: avformat.h:841
AVDeviceInfoList
List of devices.
Definition: avdevice.h:343
av_strdup
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:270
packet_internal.h
AVPacket
This structure stores compressed data.
Definition: packet.h:499
DecklinkPacketQueue::max_q_size
int64_t max_q_size
Definition: decklink_common.h:89
block
The exact code depends on how similar the blocks are and how related they are to the block
Definition: filter_design.txt:207
ccfifo.h
DecklinkPacketQueue::mutex
pthread_mutex_t mutex
Definition: decklink_common.h:86