git.sesse.net Git - nageru/blob - nageru/decklink/DeckLinkAPIModes.h

   1 /* -LICENSE-START-
   2 ** Copyright (c) 2018 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     bmdModeHD1080p50                                             = /* 'Hp50' */ 0x48703530,
  73     bmdModeHD1080p5994                                           = /* 'Hp59' */ 0x48703539,
  74     bmdModeHD1080p6000                                           = /* 'Hp60' */ 0x48703630,     // N.B. This _really_ is 60.00 Hz.
  75     bmdModeHD1080i50                                             = /* 'Hi50' */ 0x48693530,
  76     bmdModeHD1080i5994                                           = /* 'Hi59' */ 0x48693539,
  77     bmdModeHD1080i6000                                           = /* 'Hi60' */ 0x48693630,     // N.B. This _really_ is 60.00 Hz.
  78
  79     /* HD 720 Modes */
  80
  81     bmdModeHD720p50                                              = /* 'hp50' */ 0x68703530,
  82     bmdModeHD720p5994                                            = /* 'hp59' */ 0x68703539,
  83     bmdModeHD720p60                                              = /* 'hp60' */ 0x68703630,
  84
  85     /* 2K Modes */
  86
  87     bmdMode2k2398                                                = /* '2k23' */ 0x326B3233,
  88     bmdMode2k24                                                  = /* '2k24' */ 0x326B3234,
  89     bmdMode2k25                                                  = /* '2k25' */ 0x326B3235,
  90
  91     /* 2K DCI Modes */
  92
  93     bmdMode2kDCI2398                                             = /* '2d23' */ 0x32643233,
  94     bmdMode2kDCI24                                               = /* '2d24' */ 0x32643234,
  95     bmdMode2kDCI25                                               = /* '2d25' */ 0x32643235,
  96     bmdMode2kDCI2997                                             = /* '2d29' */ 0x32643239,
  97     bmdMode2kDCI30                                               = /* '2d30' */ 0x32643330,
  98     bmdMode2kDCI50                                               = /* '2d50' */ 0x32643530,
  99     bmdMode2kDCI5994                                             = /* '2d59' */ 0x32643539,
 100     bmdMode2kDCI60                                               = /* '2d60' */ 0x32643630,
 101
 102     /* 4K UHD Modes */
 103
 104     bmdMode4K2160p2398                                           = /* '4k23' */ 0x346B3233,
 105     bmdMode4K2160p24                                             = /* '4k24' */ 0x346B3234,
 106     bmdMode4K2160p25                                             = /* '4k25' */ 0x346B3235,
 107     bmdMode4K2160p2997                                           = /* '4k29' */ 0x346B3239,
 108     bmdMode4K2160p30                                             = /* '4k30' */ 0x346B3330,
 109     bmdMode4K2160p50                                             = /* '4k50' */ 0x346B3530,
 110     bmdMode4K2160p5994                                           = /* '4k59' */ 0x346B3539,
 111     bmdMode4K2160p60                                             = /* '4k60' */ 0x346B3630,
 112
 113     /* 4K DCI Modes */
 114
 115     bmdMode4kDCI2398                                             = /* '4d23' */ 0x34643233,
 116     bmdMode4kDCI24                                               = /* '4d24' */ 0x34643234,
 117     bmdMode4kDCI25                                               = /* '4d25' */ 0x34643235,
 118     bmdMode4kDCI2997                                             = /* '4d29' */ 0x34643239,
 119     bmdMode4kDCI30                                               = /* '4d30' */ 0x34643330,
 120     bmdMode4kDCI50                                               = /* '4d50' */ 0x34643530,
 121     bmdMode4kDCI5994                                             = /* '4d59' */ 0x34643539,
 122     bmdMode4kDCI60                                               = /* '4d60' */ 0x34643630,
 123
 124     /* 8K UHD Modes */
 125
 126     bmdMode8K4320p2398                                           = /* '8k23' */ 0x386B3233,
 127     bmdMode8K4320p24                                             = /* '8k24' */ 0x386B3234,
 128     bmdMode8K4320p25                                             = /* '8k25' */ 0x386B3235,
 129     bmdMode8K4320p2997                                           = /* '8k29' */ 0x386B3239,
 130     bmdMode8K4320p30                                             = /* '8k30' */ 0x386B3330,
 131     bmdMode8K4320p50                                             = /* '8k50' */ 0x386B3530,
 132     bmdMode8K4320p5994                                           = /* '8k59' */ 0x386B3539,
 133     bmdMode8K4320p60                                             = /* '8k60' */ 0x386B3630,
 134
 135     /* 8K DCI Modes */
 136
 137     bmdMode8kDCI2398                                             = /* '8d23' */ 0x38643233,
 138     bmdMode8kDCI24                                               = /* '8d24' */ 0x38643234,
 139     bmdMode8kDCI25                                               = /* '8d25' */ 0x38643235,
 140     bmdMode8kDCI2997                                             = /* '8d29' */ 0x38643239,
 141     bmdMode8kDCI30                                               = /* '8d30' */ 0x38643330,
 142     bmdMode8kDCI50                                               = /* '8d50' */ 0x38643530,
 143     bmdMode8kDCI5994                                             = /* '8d59' */ 0x38643539,
 144     bmdMode8kDCI60                                               = /* '8d60' */ 0x38643630,
 145
 146     /* RAW Modes for Cintel (input only) */
 147
 148     bmdModeCintelRAW                                             = /* 'rwci' */ 0x72776369,     // Frame size up to 4096x3072, variable frame rate
 149     bmdModeCintelCompressedRAW                                   = /* 'rwcc' */ 0x72776363,     // Frame size up to 4096x3072, variable frame rate
 150
 151     /* Special Modes */
 152
 153     bmdModeUnknown                                               = /* 'iunk' */ 0x69756E6B
 154 };
 155
 156 /* Enum BMDFieldDominance - Video field dominance */
 157
 158 typedef uint32_t BMDFieldDominance;
 159 enum _BMDFieldDominance {
 160     bmdUnknownFieldDominance                                     = 0,
 161     bmdLowerFieldFirst                                           = /* 'lowr' */ 0x6C6F7772,
 162     bmdUpperFieldFirst                                           = /* 'uppr' */ 0x75707072,
 163     bmdProgressiveFrame                                          = /* 'prog' */ 0x70726F67,
 164     bmdProgressiveSegmentedFrame                                 = /* 'psf ' */ 0x70736620
 165 };
 166
 167 /* Enum BMDPixelFormat - Video pixel formats supported for output/input */
 168
 169 typedef uint32_t BMDPixelFormat;
 170 enum _BMDPixelFormat {
 171     bmdFormat8BitYUV                                             = /* '2vuy' */ 0x32767579,
 172     bmdFormat10BitYUV                                            = /* 'v210' */ 0x76323130,
 173     bmdFormat8BitARGB                                            = 32,
 174     bmdFormat8BitBGRA                                            = /* 'BGRA' */ 0x42475241,
 175     bmdFormat10BitRGB                                            = /* 'r210' */ 0x72323130,     // Big-endian RGB 10-bit per component with SMPTE video levels (64-960). Packed as 2:10:10:10
 176     bmdFormat12BitRGB                                            = /* 'R12B' */ 0x52313242,     // Big-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component
 177     bmdFormat12BitRGBLE                                          = /* 'R12L' */ 0x5231324C,     // Little-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component
 178     bmdFormat10BitRGBXLE                                         = /* 'R10l' */ 0x5231306C,     // Little-endian 10-bit RGB with SMPTE video levels (64-940)
 179     bmdFormat10BitRGBX                                           = /* 'R10b' */ 0x52313062,     // Big-endian 10-bit RGB with SMPTE video levels (64-940)
 180     bmdFormatH265                                                = /* 'hev1' */ 0x68657631,     // High Efficiency Video Coding (HEVC/h.265)
 181
 182     /* AVID DNxHR */
 183
 184     bmdFormatDNxHR                                               = /* 'AVdh' */ 0x41566468,
 185
 186     /* Cintel formats */
 187
 188     bmdFormat12BitRAWGRBG                                        = /* 'r12p' */ 0x72313270,     // 12-bit RAW data for bayer pattern GRBG
 189     bmdFormat12BitRAWJPEG                                        = /* 'r16p' */ 0x72313670      // 12-bit RAW data arranged in tiles and JPEG compressed
 190 };
 191
 192 /* Enum BMDDisplayModeFlags - Flags to describe the characteristics of an IDeckLinkDisplayMode. */
 193
 194 typedef uint32_t BMDDisplayModeFlags;
 195 enum _BMDDisplayModeFlags {
 196     bmdDisplayModeSupports3D                                     = 1 << 0,
 197     bmdDisplayModeColorspaceRec601                               = 1 << 1,
 198     bmdDisplayModeColorspaceRec709                               = 1 << 2,
 199     bmdDisplayModeColorspaceRec2020                              = 1 << 3
 200 };
 201
 202 // Forward Declarations
 203
 204 class IDeckLinkDisplayModeIterator;
 205 class IDeckLinkDisplayMode;
 206
 207 /* Interface IDeckLinkDisplayModeIterator - enumerates over supported input/output display modes. */
 208
 209 class BMD_PUBLIC IDeckLinkDisplayModeIterator : public IUnknown
 210 {
 211 public:
 212     virtual HRESULT Next (/* out */ IDeckLinkDisplayMode **deckLinkDisplayMode) = 0;
 213
 214 protected:
 215     virtual ~IDeckLinkDisplayModeIterator () {} // call Release method to drop reference count
 216 };
 217
 218 /* Interface IDeckLinkDisplayMode - represents a display mode */
 219
 220 class BMD_PUBLIC IDeckLinkDisplayMode : public IUnknown
 221 {
 222 public:
 223     virtual HRESULT GetName (/* out */ const char **name) = 0;
 224     virtual BMDDisplayMode GetDisplayMode (void) = 0;
 225     virtual long GetWidth (void) = 0;
 226     virtual long GetHeight (void) = 0;
 227     virtual HRESULT GetFrameRate (/* out */ BMDTimeValue *frameDuration, /* out */ BMDTimeScale *timeScale) = 0;
 228     virtual BMDFieldDominance GetFieldDominance (void) = 0;
 229     virtual BMDDisplayModeFlags GetFlags (void) = 0;
 230
 231 protected:
 232     virtual ~IDeckLinkDisplayMode () {} // call Release method to drop reference count
 233 };
 234
 235 /* Functions */
 236
 237 extern "C" {
 238
 239
 240 }
 241
 242
 243 #endif /* defined(BMD_DECKLINKAPIMODES_H) */