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', 60 bmdModeNTSC2398 = 'nt23', // 3:2 pulldown 61 bmdModePAL = 'pal ', 62 bmdModeNTSCp = 'ntsp', 63 bmdModePALp = 'palp', 64 65 /* HD 1080 Modes */ 66 67 bmdModeHD1080p2398 = '23ps', 68 bmdModeHD1080p24 = '24ps', 69 bmdModeHD1080p25 = 'Hp25', 70 bmdModeHD1080p2997 = 'Hp29', 71 bmdModeHD1080p30 = 'Hp30', 72 bmdModeHD1080p4795 = 'Hp47', 73 bmdModeHD1080p48 = 'Hp48', 74 bmdModeHD1080p50 = 'Hp50', 75 bmdModeHD1080p5994 = 'Hp59', 76 bmdModeHD1080p6000 = 'Hp60', // N.B. This _really_ is 60.00 Hz. 77 bmdModeHD1080p9590 = 'Hp95', 78 bmdModeHD1080p96 = 'Hp96', 79 bmdModeHD1080p100 = 'Hp10', 80 bmdModeHD1080p11988 = 'Hp11', 81 bmdModeHD1080p120 = 'Hp12', 82 bmdModeHD1080i50 = 'Hi50', 83 bmdModeHD1080i5994 = 'Hi59', 84 bmdModeHD1080i6000 = 'Hi60', // N.B. This _really_ is 60.00 Hz. 85 86 /* HD 720 Modes */ 87 88 bmdModeHD720p50 = 'hp50', 89 bmdModeHD720p5994 = 'hp59', 90 bmdModeHD720p60 = 'hp60', 91 92 /* 2K Modes */ 93 94 bmdMode2k2398 = '2k23', 95 bmdMode2k24 = '2k24', 96 bmdMode2k25 = '2k25', 97 98 /* 2K DCI Modes */ 99 100 bmdMode2kDCI2398 = '2d23', 101 bmdMode2kDCI24 = '2d24', 102 bmdMode2kDCI25 = '2d25', 103 bmdMode2kDCI2997 = '2d29', 104 bmdMode2kDCI30 = '2d30', 105 bmdMode2kDCI4795 = '2d47', 106 bmdMode2kDCI48 = '2d48', 107 bmdMode2kDCI50 = '2d50', 108 bmdMode2kDCI5994 = '2d59', 109 bmdMode2kDCI60 = '2d60', 110 bmdMode2kDCI9590 = '2d95', 111 bmdMode2kDCI96 = '2d96', 112 bmdMode2kDCI100 = '2d10', 113 bmdMode2kDCI11988 = '2d11', 114 bmdMode2kDCI120 = '2d12', 115 116 /* 4K UHD Modes */ 117 118 bmdMode4K2160p2398 = '4k23', 119 bmdMode4K2160p24 = '4k24', 120 bmdMode4K2160p25 = '4k25', 121 bmdMode4K2160p2997 = '4k29', 122 bmdMode4K2160p30 = '4k30', 123 bmdMode4K2160p4795 = '4k47', 124 bmdMode4K2160p48 = '4k48', 125 bmdMode4K2160p50 = '4k50', 126 bmdMode4K2160p5994 = '4k59', 127 bmdMode4K2160p60 = '4k60', 128 bmdMode4K2160p9590 = '4k95', 129 bmdMode4K2160p96 = '4k96', 130 bmdMode4K2160p100 = '4k10', 131 bmdMode4K2160p11988 = '4k11', 132 bmdMode4K2160p120 = '4k12', 133 134 /* 4K DCI Modes */ 135 136 bmdMode4kDCI2398 = '4d23', 137 bmdMode4kDCI24 = '4d24', 138 bmdMode4kDCI25 = '4d25', 139 bmdMode4kDCI2997 = '4d29', 140 bmdMode4kDCI30 = '4d30', 141 bmdMode4kDCI4795 = '4d47', 142 bmdMode4kDCI48 = '4d48', 143 bmdMode4kDCI50 = '4d50', 144 bmdMode4kDCI5994 = '4d59', 145 bmdMode4kDCI60 = '4d60', 146 bmdMode4kDCI9590 = '4d95', 147 bmdMode4kDCI96 = '4d96', 148 bmdMode4kDCI100 = '4d10', 149 bmdMode4kDCI11988 = '4d11', 150 bmdMode4kDCI120 = '4d12', 151 152 /* 8K UHD Modes */ 153 154 bmdMode8K4320p2398 = '8k23', 155 bmdMode8K4320p24 = '8k24', 156 bmdMode8K4320p25 = '8k25', 157 bmdMode8K4320p2997 = '8k29', 158 bmdMode8K4320p30 = '8k30', 159 bmdMode8K4320p4795 = '8k47', 160 bmdMode8K4320p48 = '8k48', 161 bmdMode8K4320p50 = '8k50', 162 bmdMode8K4320p5994 = '8k59', 163 bmdMode8K4320p60 = '8k60', 164 165 /* 8K DCI Modes */ 166 167 bmdMode8kDCI2398 = '8d23', 168 bmdMode8kDCI24 = '8d24', 169 bmdMode8kDCI25 = '8d25', 170 bmdMode8kDCI2997 = '8d29', 171 bmdMode8kDCI30 = '8d30', 172 bmdMode8kDCI4795 = '8d47', 173 bmdMode8kDCI48 = '8d48', 174 bmdMode8kDCI50 = '8d50', 175 bmdMode8kDCI5994 = '8d59', 176 bmdMode8kDCI60 = '8d60', 177 178 /* PC Modes */ 179 180 bmdMode640x480p60 = 'vga6', 181 bmdMode800x600p60 = 'svg6', 182 bmdMode1440x900p50 = 'wxg5', 183 bmdMode1440x900p60 = 'wxg6', 184 bmdMode1440x1080p50 = 'sxg5', 185 bmdMode1440x1080p60 = 'sxg6', 186 bmdMode1600x1200p50 = 'uxg5', 187 bmdMode1600x1200p60 = 'uxg6', 188 bmdMode1920x1200p50 = 'wux5', 189 bmdMode1920x1200p60 = 'wux6', 190 bmdMode1920x1440p50 = '1945', 191 bmdMode1920x1440p60 = '1946', 192 bmdMode2560x1440p50 = 'wqh5', 193 bmdMode2560x1440p60 = 'wqh6', 194 bmdMode2560x1600p50 = 'wqx5', 195 bmdMode2560x1600p60 = 'wqx6', 196 197 /* RAW Modes for Cintel (input only) */ 198 199 bmdModeCintelRAW = 'rwci', // Frame size up to 4096x3072, variable frame rate 200 bmdModeCintelCompressedRAW = 'rwcc', // Frame size up to 4096x3072, variable frame rate 201 202 /* Special Modes */ 203 204 bmdModeUnknown = 'iunk' 205 }; 206 207 /* Enum BMDFieldDominance - Video field dominance */ 208 209 typedef uint32_t BMDFieldDominance; 210 enum _BMDFieldDominance { 211 bmdUnknownFieldDominance = 0, 212 bmdLowerFieldFirst = 'lowr', 213 bmdUpperFieldFirst = 'uppr', 214 bmdProgressiveFrame = 'prog', 215 bmdProgressiveSegmentedFrame = 'psf ' 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', 224 bmdFormat10BitYUV = 'v210', 225 bmdFormat8BitARGB = 32, 226 bmdFormat8BitBGRA = 'BGRA', 227 bmdFormat10BitRGB = 'r210', // Big-endian RGB 10-bit per component with SMPTE video levels (64-960). Packed as 2:10:10:10 228 bmdFormat12BitRGB = 'R12B', // Big-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component 229 bmdFormat12BitRGBLE = 'R12L', // Little-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component 230 bmdFormat10BitRGBXLE = 'R10l', // Little-endian 10-bit RGB with SMPTE video levels (64-940) 231 bmdFormat10BitRGBX = 'R10b', // Big-endian 10-bit RGB with SMPTE video levels (64-940) 232 bmdFormatH265 = 'hev1', // High Efficiency Video Coding (HEVC/h.265) 233 234 /* AVID DNxHR */ 235 236 bmdFormatDNxHR = 'AVdh', 237 238 /* Cintel formats */ 239 240 bmdFormat12BitRAWGRBG = 'r12p', // 12-bit RAW data for bayer pattern GRBG 241 bmdFormat12BitRAWJPEG = 'r16p' // 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 */ CFStringRef *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