third_party/decklink/mac/include/DeckLinkAPIConfiguration.h

   1 /* -LICENSE-START-
   2 ** Copyright (c) 2014 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_DECKLINKAPICONFIGURATION_H
  29 #define BMD_DECKLINKAPICONFIGURATION_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 // Type Declarations
  41
  42
  43 // Interface ID Declarations
  44
  45 BMD_CONST REFIID IID_IDeckLinkConfiguration                       = /* CB71734A-FE37-4E8D-8E13-802133A1C3F2 */ {0xCB,0x71,0x73,0x4A,0xFE,0x37,0x4E,0x8D,0x8E,0x13,0x80,0x21,0x33,0xA1,0xC3,0xF2};
  46
  47 /* Enum BMDDeckLinkConfigurationID - DeckLink Configuration ID */
  48
  49 typedef uint32_t BMDDeckLinkConfigurationID;
  50 enum _BMDDeckLinkConfigurationID {
  51
  52     /* Serial port Flags */
  53
  54     bmdDeckLinkConfigSwapSerialRxTx                              = 'ssrt',
  55
  56     /* Video Input/Output Flags */
  57
  58     bmdDeckLinkConfigUse1080pNotPsF                              = 'fpro',
  59
  60     /* Video Input/Output Integers */
  61
  62     bmdDeckLinkConfigHDMI3DPackingFormat                         = '3dpf',
  63     bmdDeckLinkConfigBypass                                      = 'byps',
  64     bmdDeckLinkConfigClockTimingAdjustment                       = 'ctad',
  65
  66     /* Audio Input/Output Flags */
  67
  68     bmdDeckLinkConfigAnalogAudioConsumerLevels                   = 'aacl',
  69
  70     /* Video output flags */
  71
  72     bmdDeckLinkConfigFieldFlickerRemoval                         = 'fdfr',
  73     bmdDeckLinkConfigHD1080p24ToHD1080i5994Conversion            = 'to59',
  74     bmdDeckLinkConfig444SDIVideoOutput                           = '444o',
  75     bmdDeckLinkConfigBlackVideoOutputDuringCapture               = 'bvoc',
  76     bmdDeckLinkConfigLowLatencyVideoOutput                       = 'llvo',
  77     bmdDeckLinkConfigDownConversionOnAllAnalogOutput             = 'caao',
  78     bmdDeckLinkConfigSMPTELevelAOutput                           = 'smta',
  79
  80     /* Video Output Integers */
  81
  82     bmdDeckLinkConfigVideoOutputConnection                       = 'vocn',
  83     bmdDeckLinkConfigVideoOutputConversionMode                   = 'vocm',
  84     bmdDeckLinkConfigAnalogVideoOutputFlags                      = 'avof',
  85     bmdDeckLinkConfigReferenceInputTimingOffset                  = 'glot',
  86     bmdDeckLinkConfigVideoOutputIdleOperation                    = 'voio',
  87     bmdDeckLinkConfigDefaultVideoOutputMode                      = 'dvom',
  88     bmdDeckLinkConfigDefaultVideoOutputModeFlags                 = 'dvof',
  89     bmdDeckLinkConfigSDIOutputLinkConfiguration                  = 'solc',
  90
  91     /* Video Output Floats */
  92
  93     bmdDeckLinkConfigVideoOutputComponentLumaGain                = 'oclg',
  94     bmdDeckLinkConfigVideoOutputComponentChromaBlueGain          = 'occb',
  95     bmdDeckLinkConfigVideoOutputComponentChromaRedGain           = 'occr',
  96     bmdDeckLinkConfigVideoOutputCompositeLumaGain                = 'oilg',
  97     bmdDeckLinkConfigVideoOutputCompositeChromaGain              = 'oicg',
  98     bmdDeckLinkConfigVideoOutputSVideoLumaGain                   = 'oslg',
  99     bmdDeckLinkConfigVideoOutputSVideoChromaGain                 = 'oscg',
 100
 101     /* Video Input Flags */
 102
 103     bmdDeckLinkConfigVideoInputScanning                          = 'visc',      // Applicable to H264 Pro Recorder only
 104     bmdDeckLinkConfigUseDedicatedLTCInput                        = 'dltc',      // Use timecode from LTC input instead of SDI stream
 105
 106     /* Video Input Integers */
 107
 108     bmdDeckLinkConfigVideoInputConnection                        = 'vicn',
 109     bmdDeckLinkConfigAnalogVideoInputFlags                       = 'avif',
 110     bmdDeckLinkConfigVideoInputConversionMode                    = 'vicm',
 111     bmdDeckLinkConfig32PulldownSequenceInitialTimecodeFrame      = 'pdif',
 112     bmdDeckLinkConfigVANCSourceLine1Mapping                      = 'vsl1',
 113     bmdDeckLinkConfigVANCSourceLine2Mapping                      = 'vsl2',
 114     bmdDeckLinkConfigVANCSourceLine3Mapping                      = 'vsl3',
 115     bmdDeckLinkConfigCapturePassThroughMode                      = 'cptm',
 116
 117     /* Video Input Floats */
 118
 119     bmdDeckLinkConfigVideoInputComponentLumaGain                 = 'iclg',
 120     bmdDeckLinkConfigVideoInputComponentChromaBlueGain           = 'iccb',
 121     bmdDeckLinkConfigVideoInputComponentChromaRedGain            = 'iccr',
 122     bmdDeckLinkConfigVideoInputCompositeLumaGain                 = 'iilg',
 123     bmdDeckLinkConfigVideoInputCompositeChromaGain               = 'iicg',
 124     bmdDeckLinkConfigVideoInputSVideoLumaGain                    = 'islg',
 125     bmdDeckLinkConfigVideoInputSVideoChromaGain                  = 'iscg',
 126
 127     /* Audio Input Integers */
 128
 129     bmdDeckLinkConfigAudioInputConnection                        = 'aicn',
 130
 131     /* Audio Input Floats */
 132
 133     bmdDeckLinkConfigAnalogAudioInputScaleChannel1               = 'ais1',
 134     bmdDeckLinkConfigAnalogAudioInputScaleChannel2               = 'ais2',
 135     bmdDeckLinkConfigAnalogAudioInputScaleChannel3               = 'ais3',
 136     bmdDeckLinkConfigAnalogAudioInputScaleChannel4               = 'ais4',
 137     bmdDeckLinkConfigDigitalAudioInputScale                      = 'dais',
 138
 139     /* Audio Output Integers */
 140
 141     bmdDeckLinkConfigAudioOutputAESAnalogSwitch                  = 'aoaa',
 142
 143     /* Audio Output Floats */
 144
 145     bmdDeckLinkConfigAnalogAudioOutputScaleChannel1              = 'aos1',
 146     bmdDeckLinkConfigAnalogAudioOutputScaleChannel2              = 'aos2',
 147     bmdDeckLinkConfigAnalogAudioOutputScaleChannel3              = 'aos3',
 148     bmdDeckLinkConfigAnalogAudioOutputScaleChannel4              = 'aos4',
 149     bmdDeckLinkConfigDigitalAudioOutputScale                     = 'daos',
 150
 151     /* Device Information Strings */
 152
 153     bmdDeckLinkConfigDeviceInformationLabel                      = 'dila',
 154     bmdDeckLinkConfigDeviceInformationSerialNumber               = 'disn',
 155     bmdDeckLinkConfigDeviceInformationCompany                    = 'dico',
 156     bmdDeckLinkConfigDeviceInformationPhone                      = 'diph',
 157     bmdDeckLinkConfigDeviceInformationEmail                      = 'diem',
 158     bmdDeckLinkConfigDeviceInformationDate                       = 'dida'
 159 };
 160
 161 // Forward Declarations
 162
 163 class IDeckLinkConfiguration;
 164
 165 /* Interface IDeckLinkConfiguration - DeckLink Configuration interface */
 166
 167 class IDeckLinkConfiguration : public IUnknown
 168 {
 169 public:
 170     virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0;
 171     virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0;
 172     virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0;
 173     virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0;
 174     virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0;
 175     virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0;
 176     virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ CFStringRef value) = 0;
 177     virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ CFStringRef *value) = 0;
 178     virtual HRESULT WriteConfigurationToPreferences (void) = 0;
 179
 180 protected:
 181     virtual ~IDeckLinkConfiguration () {} // call Release method to drop reference count
 182 };
 183
 184 /* Functions */
 185
 186 extern "C" {
 187
 188
 189 }
 190
 191
 192 #endif /* defined(BMD_DECKLINKAPICONFIGURATION_H) */