FFmpeg  4.3
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 #include "libavutil/thread.h"
33 #include "decklink_common_c.h"
34 #if CONFIG_LIBKLVANC
35 #include "libklvanc/vanc.h"
36 #endif
37 
38 #ifdef _WIN32
39 #define DECKLINK_BOOL BOOL
40 #else
41 #define DECKLINK_BOOL bool
42 #endif
43 
44 #ifdef _WIN32
45 static char *dup_wchar_to_utf8(wchar_t *w)
46 {
47  char *s = NULL;
48  int l = WideCharToMultiByte(CP_UTF8, 0, w, -1, 0, 0, 0, 0);
49  s = (char *) av_malloc(l);
50  if (s)
51  WideCharToMultiByte(CP_UTF8, 0, w, -1, s, l, 0, 0);
52  return s;
53 }
54 #define DECKLINK_STR OLECHAR *
55 #define DECKLINK_STRDUP dup_wchar_to_utf8
56 #define DECKLINK_FREE(s) SysFreeString(s)
57 #elif defined(__APPLE__)
58 static char *dup_cfstring_to_utf8(CFStringRef w)
59 {
60  char s[256];
61  CFStringGetCString(w, s, 255, kCFStringEncodingUTF8);
62  return av_strdup(s);
63 }
64 #define DECKLINK_STR const __CFString *
65 #define DECKLINK_STRDUP dup_cfstring_to_utf8
66 #define DECKLINK_FREE(s) CFRelease(s)
67 #else
68 #define DECKLINK_STR const char *
69 #define DECKLINK_STRDUP av_strdup
70 /* free() is needed for a string returned by the DeckLink SDL. */
71 #define DECKLINK_FREE(s) free((void *) s)
72 #endif
73 
76 
77 typedef struct AVPacketQueue {
80  unsigned long long size;
85  int64_t max_q_size;
87 
88 struct decklink_ctx {
89  /* DeckLink SDK interfaces */
90  IDeckLink *dl;
91  IDeckLinkOutput *dlo;
92  IDeckLinkInput *dli;
93  IDeckLinkConfiguration *cfg;
96 
97  /* DeckLink mode information */
98  BMDTimeValue bmd_tb_den;
99  BMDTimeValue bmd_tb_num;
100  BMDDisplayMode bmd_mode;
101  BMDVideoConnection video_input;
102  BMDAudioConnection audio_input;
103  BMDTimecodeFormat tc_format;
108 
109  /* Capture buffer queue */
111 
112  /* Streams present */
113  int audio;
114  int video;
115 
116  /* Status */
118  int64_t last_pts;
119  unsigned long frameCount;
120  unsigned int dropped;
125 
126  /* Options */
129  int64_t teletext_lines;
130  double preroll;
135  BMDPixelFormat raw_format;
136 
139 
144 
145 #if CONFIG_LIBKLVANC
146  struct klvanc_context_s *vanc_ctx;
147 #endif
148 
149  int channels;
151  unsigned long tc_seen; // used with option wait_for_tc
152 };
153 
155 
156 #ifdef _WIN32
157 #if BLACKMAGIC_DECKLINK_API_VERSION < 0x0a040000
158 typedef unsigned long buffercount_type;
159 #else
160 typedef unsigned int buffercount_type;
161 #endif
162 IDeckLinkIterator *CreateDeckLinkIteratorInstance(void);
163 #else
164 typedef uint32_t buffercount_type;
165 #endif
166 
167 static const BMDAudioConnection decklink_audio_connection_map[] = {
168  (BMDAudioConnection)0,
169  bmdAudioConnectionEmbedded,
170  bmdAudioConnectionAESEBU,
171  bmdAudioConnectionAnalog,
172  bmdAudioConnectionAnalogXLR,
173  bmdAudioConnectionAnalogRCA,
174  bmdAudioConnectionMicrophone,
175 };
176 
177 static const BMDVideoConnection decklink_video_connection_map[] = {
178  (BMDVideoConnection)0,
179  bmdVideoConnectionSDI,
180  bmdVideoConnectionHDMI,
181  bmdVideoConnectionOpticalSDI,
182  bmdVideoConnectionComponent,
183  bmdVideoConnectionComposite,
184  bmdVideoConnectionSVideo,
185 };
186 
187 static const BMDTimecodeFormat decklink_timecode_format_map[] = {
188  (BMDTimecodeFormat)0,
189  bmdTimecodeRP188VITC1,
190  bmdTimecodeRP188VITC2,
191  bmdTimecodeRP188LTC,
192  bmdTimecodeRP188Any,
193  bmdTimecodeVITC,
194  bmdTimecodeVITCField2,
195  bmdTimecodeSerial,
196 };
197 
199 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);
201 int ff_decklink_list_devices(AVFormatContext *avctx, struct AVDeviceInfoList *device_list, int show_inputs, int show_outputs);
202 void ff_decklink_list_devices_legacy(AVFormatContext *avctx, int show_inputs, int show_outputs);
205 int ff_decklink_init_device(AVFormatContext *avctx, const char* name);
206 
207 #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
thread.h
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:31
width
#define width
AVPacketQueue
Definition: decklink_common.h:77
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVFormatContext
Format I/O context.
Definition: avformat.h:1335
NULL
#define NULL
Definition: coverity.c:32
AVPacketQueue::last_pkt
AVPacketList * last_pkt
Definition: decklink_common.h:78
height
#define height
dup_wchar_to_utf8
static char * dup_wchar_to_utf8(wchar_t *w)
Definition: dshow.c:132
pthread_cond_t
Definition: os2threads.h:58
AVPacketQueue::cond
pthread_cond_t cond
Definition: decklink_common.h:83
AVStream
Stream structure.
Definition: avformat.h:865
AVDeviceInfoList
List of devices.
Definition: avdevice.h:460
w
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo ug o o w
Definition: fate.txt:150
AVPacketQueue::size
unsigned long long size
Definition: decklink_common.h:80
AVPacketQueue::nb_packets
int nb_packets
Definition: decklink_common.h:79
AVPacketQueue::abort_request
int abort_request
Definition: decklink_common.h:81
av_strdup
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:253
AVPacketQueue::avctx
AVFormatContext * avctx
Definition: decklink_common.h:84
AVPacketQueue::mutex
pthread_mutex_t mutex
Definition: decklink_common.h:82
AVFieldOrder
AVFieldOrder
Definition: codec_par.h:36
AVPacketQueue::first_pkt
AVPacketList * first_pkt
Definition: decklink_common.h:78
AVPacketQueue::max_q_size
int64_t max_q_size
Definition: decklink_common.h:85
AVPacketList
Definition: avformat.h:2008