• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* -LICENSE-START-
2 ** Copyright (c) 2019 Blackmagic Design
3 **
4 ** Permission is hereby granted, free of charge, to any person or organization
5 ** obtaining a copy of the software and accompanying documentation covered by
6 ** this license (the "Software") to use, reproduce, display, distribute,
7 ** execute, and transmit the Software, and to prepare derivative works of the
8 ** Software, and to permit third-parties to whom the Software is furnished to
9 ** do so, all subject to the following:
10 **
11 ** The copyright notices in the Software and this entire statement, including
12 ** the above license grant, this restriction and the following disclaimer,
13 ** must be included in all copies of the Software, in whole or in part, and
14 ** all derivative works of the Software, unless such copies or derivative
15 ** works are solely in the form of machine-executable object code generated by
16 ** a source language processor.
17 **
18 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 ** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 ** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
21 ** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
22 ** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
23 ** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 ** DEALINGS IN THE SOFTWARE.
25 ** -LICENSE-END-
26 */
27 
28 #ifndef BMD_DECKLINKAPIMODES_H
29 #define BMD_DECKLINKAPIMODES_H
30 
31 
32 #ifndef BMD_CONST
33     #if defined(_MSC_VER)
34         #define BMD_CONST __declspec(selectany) static const
35     #else
36         #define BMD_CONST static const
37     #endif
38 #endif
39 
40 #ifndef BMD_PUBLIC
41 	#define BMD_PUBLIC
42 #endif
43 
44 // Type Declarations
45 
46 
47 // Interface ID Declarations
48 
49 BMD_CONST REFIID IID_IDeckLinkDisplayModeIterator                 = /* 9C88499F-F601-4021-B80B-032E4EB41C35 */ {0x9C,0x88,0x49,0x9F,0xF6,0x01,0x40,0x21,0xB8,0x0B,0x03,0x2E,0x4E,0xB4,0x1C,0x35};
50 BMD_CONST REFIID IID_IDeckLinkDisplayMode                         = /* 3EB2C1AB-0A3D-4523-A3AD-F40D7FB14E78 */ {0x3E,0xB2,0xC1,0xAB,0x0A,0x3D,0x45,0x23,0xA3,0xAD,0xF4,0x0D,0x7F,0xB1,0x4E,0x78};
51 
52 /* Enum BMDDisplayMode - Video display modes */
53 
54 typedef uint32_t BMDDisplayMode;
55 enum _BMDDisplayMode {
56 
57     /* SD Modes */
58 
59     bmdModeNTSC                                                  = /* 'ntsc' */ 0x6E747363,
60     bmdModeNTSC2398                                              = /* 'nt23' */ 0x6E743233,	// 3:2 pulldown
61     bmdModePAL                                                   = /* 'pal ' */ 0x70616C20,
62     bmdModeNTSCp                                                 = /* 'ntsp' */ 0x6E747370,
63     bmdModePALp                                                  = /* 'palp' */ 0x70616C70,
64 
65     /* HD 1080 Modes */
66 
67     bmdModeHD1080p2398                                           = /* '23ps' */ 0x32337073,
68     bmdModeHD1080p24                                             = /* '24ps' */ 0x32347073,
69     bmdModeHD1080p25                                             = /* 'Hp25' */ 0x48703235,
70     bmdModeHD1080p2997                                           = /* 'Hp29' */ 0x48703239,
71     bmdModeHD1080p30                                             = /* 'Hp30' */ 0x48703330,
72     bmdModeHD1080p4795                                           = /* 'Hp47' */ 0x48703437,
73     bmdModeHD1080p48                                             = /* 'Hp48' */ 0x48703438,
74     bmdModeHD1080p50                                             = /* 'Hp50' */ 0x48703530,
75     bmdModeHD1080p5994                                           = /* 'Hp59' */ 0x48703539,
76     bmdModeHD1080p6000                                           = /* 'Hp60' */ 0x48703630,	// N.B. This _really_ is 60.00 Hz.
77     bmdModeHD1080p9590                                           = /* 'Hp95' */ 0x48703935,
78     bmdModeHD1080p96                                             = /* 'Hp96' */ 0x48703936,
79     bmdModeHD1080p100                                            = /* 'Hp10' */ 0x48703130,
80     bmdModeHD1080p11988                                          = /* 'Hp11' */ 0x48703131,
81     bmdModeHD1080p120                                            = /* 'Hp12' */ 0x48703132,
82     bmdModeHD1080i50                                             = /* 'Hi50' */ 0x48693530,
83     bmdModeHD1080i5994                                           = /* 'Hi59' */ 0x48693539,
84     bmdModeHD1080i6000                                           = /* 'Hi60' */ 0x48693630,	// N.B. This _really_ is 60.00 Hz.
85 
86     /* HD 720 Modes */
87 
88     bmdModeHD720p50                                              = /* 'hp50' */ 0x68703530,
89     bmdModeHD720p5994                                            = /* 'hp59' */ 0x68703539,
90     bmdModeHD720p60                                              = /* 'hp60' */ 0x68703630,
91 
92     /* 2K Modes */
93 
94     bmdMode2k2398                                                = /* '2k23' */ 0x326B3233,
95     bmdMode2k24                                                  = /* '2k24' */ 0x326B3234,
96     bmdMode2k25                                                  = /* '2k25' */ 0x326B3235,
97 
98     /* 2K DCI Modes */
99 
100     bmdMode2kDCI2398                                             = /* '2d23' */ 0x32643233,
101     bmdMode2kDCI24                                               = /* '2d24' */ 0x32643234,
102     bmdMode2kDCI25                                               = /* '2d25' */ 0x32643235,
103     bmdMode2kDCI2997                                             = /* '2d29' */ 0x32643239,
104     bmdMode2kDCI30                                               = /* '2d30' */ 0x32643330,
105     bmdMode2kDCI4795                                             = /* '2d47' */ 0x32643437,
106     bmdMode2kDCI48                                               = /* '2d48' */ 0x32643438,
107     bmdMode2kDCI50                                               = /* '2d50' */ 0x32643530,
108     bmdMode2kDCI5994                                             = /* '2d59' */ 0x32643539,
109     bmdMode2kDCI60                                               = /* '2d60' */ 0x32643630,
110     bmdMode2kDCI9590                                             = /* '2d95' */ 0x32643935,
111     bmdMode2kDCI96                                               = /* '2d96' */ 0x32643936,
112     bmdMode2kDCI100                                              = /* '2d10' */ 0x32643130,
113     bmdMode2kDCI11988                                            = /* '2d11' */ 0x32643131,
114     bmdMode2kDCI120                                              = /* '2d12' */ 0x32643132,
115 
116     /* 4K UHD Modes */
117 
118     bmdMode4K2160p2398                                           = /* '4k23' */ 0x346B3233,
119     bmdMode4K2160p24                                             = /* '4k24' */ 0x346B3234,
120     bmdMode4K2160p25                                             = /* '4k25' */ 0x346B3235,
121     bmdMode4K2160p2997                                           = /* '4k29' */ 0x346B3239,
122     bmdMode4K2160p30                                             = /* '4k30' */ 0x346B3330,
123     bmdMode4K2160p4795                                           = /* '4k47' */ 0x346B3437,
124     bmdMode4K2160p48                                             = /* '4k48' */ 0x346B3438,
125     bmdMode4K2160p50                                             = /* '4k50' */ 0x346B3530,
126     bmdMode4K2160p5994                                           = /* '4k59' */ 0x346B3539,
127     bmdMode4K2160p60                                             = /* '4k60' */ 0x346B3630,
128     bmdMode4K2160p9590                                           = /* '4k95' */ 0x346B3935,
129     bmdMode4K2160p96                                             = /* '4k96' */ 0x346B3936,
130     bmdMode4K2160p100                                            = /* '4k10' */ 0x346B3130,
131     bmdMode4K2160p11988                                          = /* '4k11' */ 0x346B3131,
132     bmdMode4K2160p120                                            = /* '4k12' */ 0x346B3132,
133 
134     /* 4K DCI Modes */
135 
136     bmdMode4kDCI2398                                             = /* '4d23' */ 0x34643233,
137     bmdMode4kDCI24                                               = /* '4d24' */ 0x34643234,
138     bmdMode4kDCI25                                               = /* '4d25' */ 0x34643235,
139     bmdMode4kDCI2997                                             = /* '4d29' */ 0x34643239,
140     bmdMode4kDCI30                                               = /* '4d30' */ 0x34643330,
141     bmdMode4kDCI4795                                             = /* '4d47' */ 0x34643437,
142     bmdMode4kDCI48                                               = /* '4d48' */ 0x34643438,
143     bmdMode4kDCI50                                               = /* '4d50' */ 0x34643530,
144     bmdMode4kDCI5994                                             = /* '4d59' */ 0x34643539,
145     bmdMode4kDCI60                                               = /* '4d60' */ 0x34643630,
146     bmdMode4kDCI9590                                             = /* '4d95' */ 0x34643935,
147     bmdMode4kDCI96                                               = /* '4d96' */ 0x34643936,
148     bmdMode4kDCI100                                              = /* '4d10' */ 0x34643130,
149     bmdMode4kDCI11988                                            = /* '4d11' */ 0x34643131,
150     bmdMode4kDCI120                                              = /* '4d12' */ 0x34643132,
151 
152     /* 8K UHD Modes */
153 
154     bmdMode8K4320p2398                                           = /* '8k23' */ 0x386B3233,
155     bmdMode8K4320p24                                             = /* '8k24' */ 0x386B3234,
156     bmdMode8K4320p25                                             = /* '8k25' */ 0x386B3235,
157     bmdMode8K4320p2997                                           = /* '8k29' */ 0x386B3239,
158     bmdMode8K4320p30                                             = /* '8k30' */ 0x386B3330,
159     bmdMode8K4320p4795                                           = /* '8k47' */ 0x386B3437,
160     bmdMode8K4320p48                                             = /* '8k48' */ 0x386B3438,
161     bmdMode8K4320p50                                             = /* '8k50' */ 0x386B3530,
162     bmdMode8K4320p5994                                           = /* '8k59' */ 0x386B3539,
163     bmdMode8K4320p60                                             = /* '8k60' */ 0x386B3630,
164 
165     /* 8K DCI Modes */
166 
167     bmdMode8kDCI2398                                             = /* '8d23' */ 0x38643233,
168     bmdMode8kDCI24                                               = /* '8d24' */ 0x38643234,
169     bmdMode8kDCI25                                               = /* '8d25' */ 0x38643235,
170     bmdMode8kDCI2997                                             = /* '8d29' */ 0x38643239,
171     bmdMode8kDCI30                                               = /* '8d30' */ 0x38643330,
172     bmdMode8kDCI4795                                             = /* '8d47' */ 0x38643437,
173     bmdMode8kDCI48                                               = /* '8d48' */ 0x38643438,
174     bmdMode8kDCI50                                               = /* '8d50' */ 0x38643530,
175     bmdMode8kDCI5994                                             = /* '8d59' */ 0x38643539,
176     bmdMode8kDCI60                                               = /* '8d60' */ 0x38643630,
177 
178     /* PC Modes */
179 
180     bmdMode640x480p60                                            = /* 'vga6' */ 0x76676136,
181     bmdMode800x600p60                                            = /* 'svg6' */ 0x73766736,
182     bmdMode1440x900p50                                           = /* 'wxg5' */ 0x77786735,
183     bmdMode1440x900p60                                           = /* 'wxg6' */ 0x77786736,
184     bmdMode1440x1080p50                                          = /* 'sxg5' */ 0x73786735,
185     bmdMode1440x1080p60                                          = /* 'sxg6' */ 0x73786736,
186     bmdMode1600x1200p50                                          = /* 'uxg5' */ 0x75786735,
187     bmdMode1600x1200p60                                          = /* 'uxg6' */ 0x75786736,
188     bmdMode1920x1200p50                                          = /* 'wux5' */ 0x77757835,
189     bmdMode1920x1200p60                                          = /* 'wux6' */ 0x77757836,
190     bmdMode1920x1440p50                                          = /* '1945' */ 0x31393435,
191     bmdMode1920x1440p60                                          = /* '1946' */ 0x31393436,
192     bmdMode2560x1440p50                                          = /* 'wqh5' */ 0x77716835,
193     bmdMode2560x1440p60                                          = /* 'wqh6' */ 0x77716836,
194     bmdMode2560x1600p50                                          = /* 'wqx5' */ 0x77717835,
195     bmdMode2560x1600p60                                          = /* 'wqx6' */ 0x77717836,
196 
197     /* RAW Modes for Cintel (input only) */
198 
199     bmdModeCintelRAW                                             = /* 'rwci' */ 0x72776369,	// Frame size up to 4096x3072, variable frame rate
200     bmdModeCintelCompressedRAW                                   = /* 'rwcc' */ 0x72776363,	// Frame size up to 4096x3072, variable frame rate
201 
202     /* Special Modes */
203 
204     bmdModeUnknown                                               = /* 'iunk' */ 0x69756E6B
205 };
206 
207 /* Enum BMDFieldDominance - Video field dominance */
208 
209 typedef uint32_t BMDFieldDominance;
210 enum _BMDFieldDominance {
211     bmdUnknownFieldDominance                                     = 0,
212     bmdLowerFieldFirst                                           = /* 'lowr' */ 0x6C6F7772,
213     bmdUpperFieldFirst                                           = /* 'uppr' */ 0x75707072,
214     bmdProgressiveFrame                                          = /* 'prog' */ 0x70726F67,
215     bmdProgressiveSegmentedFrame                                 = /* 'psf ' */ 0x70736620
216 };
217 
218 /* Enum BMDPixelFormat - Video pixel formats supported for output/input */
219 
220 typedef uint32_t BMDPixelFormat;
221 enum _BMDPixelFormat {
222     bmdFormatUnspecified                                         = 0,
223     bmdFormat8BitYUV                                             = /* '2vuy' */ 0x32767579,
224     bmdFormat10BitYUV                                            = /* 'v210' */ 0x76323130,
225     bmdFormat8BitARGB                                            = 32,
226     bmdFormat8BitBGRA                                            = /* 'BGRA' */ 0x42475241,
227     bmdFormat10BitRGB                                            = /* 'r210' */ 0x72323130,	// Big-endian RGB 10-bit per component with SMPTE video levels (64-960). Packed as 2:10:10:10
228     bmdFormat12BitRGB                                            = /* 'R12B' */ 0x52313242,	// Big-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component
229     bmdFormat12BitRGBLE                                          = /* 'R12L' */ 0x5231324C,	// Little-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component
230     bmdFormat10BitRGBXLE                                         = /* 'R10l' */ 0x5231306C,	// Little-endian 10-bit RGB with SMPTE video levels (64-940)
231     bmdFormat10BitRGBX                                           = /* 'R10b' */ 0x52313062,	// Big-endian 10-bit RGB with SMPTE video levels (64-940)
232     bmdFormatH265                                                = /* 'hev1' */ 0x68657631,	// High Efficiency Video Coding (HEVC/h.265)
233 
234     /* AVID DNxHR */
235 
236     bmdFormatDNxHR                                               = /* 'AVdh' */ 0x41566468,
237 
238     /* Cintel formats */
239 
240     bmdFormat12BitRAWGRBG                                        = /* 'r12p' */ 0x72313270,	// 12-bit RAW data for bayer pattern GRBG
241     bmdFormat12BitRAWJPEG                                        = /* 'r16p' */ 0x72313670	// 12-bit RAW data arranged in tiles and JPEG compressed
242 };
243 
244 /* Enum BMDDisplayModeFlags - Flags to describe the characteristics of an IDeckLinkDisplayMode. */
245 
246 typedef uint32_t BMDDisplayModeFlags;
247 enum _BMDDisplayModeFlags {
248     bmdDisplayModeSupports3D                                     = 1 << 0,
249     bmdDisplayModeColorspaceRec601                               = 1 << 1,
250     bmdDisplayModeColorspaceRec709                               = 1 << 2,
251     bmdDisplayModeColorspaceRec2020                              = 1 << 3
252 };
253 
254 // Forward Declarations
255 
256 class IDeckLinkDisplayModeIterator;
257 class IDeckLinkDisplayMode;
258 
259 /* Interface IDeckLinkDisplayModeIterator - enumerates over supported input/output display modes. */
260 
261 class BMD_PUBLIC IDeckLinkDisplayModeIterator : public IUnknown
262 {
263 public:
264     virtual HRESULT Next (/* out */ IDeckLinkDisplayMode **deckLinkDisplayMode) = 0;
265 
266 protected:
~IDeckLinkDisplayModeIterator()267     virtual ~IDeckLinkDisplayModeIterator () {} // call Release method to drop reference count
268 };
269 
270 /* Interface IDeckLinkDisplayMode - represents a display mode */
271 
272 class BMD_PUBLIC IDeckLinkDisplayMode : public IUnknown
273 {
274 public:
275     virtual HRESULT GetName (/* out */ const char **name) = 0;
276     virtual BMDDisplayMode GetDisplayMode (void) = 0;
277     virtual long GetWidth (void) = 0;
278     virtual long GetHeight (void) = 0;
279     virtual HRESULT GetFrameRate (/* out */ BMDTimeValue *frameDuration, /* out */ BMDTimeScale *timeScale) = 0;
280     virtual BMDFieldDominance GetFieldDominance (void) = 0;
281     virtual BMDDisplayModeFlags GetFlags (void) = 0;
282 
283 protected:
~IDeckLinkDisplayMode()284     virtual ~IDeckLinkDisplayMode () {} // call Release method to drop reference count
285 };
286 
287 /* Functions */
288 
289 extern "C" {
290 
291 
292 }
293 
294 
295 #endif /* defined(BMD_DECKLINKAPIMODES_H) */
296