git.sesse.net Git - kdenlive/blob - src/blackmagic/include/DeckLinkAPIConfiguration.h

   1 /* -LICENSE-START-
   2 ** Copyright (c) 2011 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 // Type Declarations
  32
  33
  34 // Interface ID Declarations
  35
  36 #define IID_IDeckLinkConfiguration                       /* C679A35B-610C-4D09-B748-1D0478100FC0 */ (REFIID){0xC6,0x79,0xA3,0x5B,0x61,0x0C,0x4D,0x09,0xB7,0x48,0x1D,0x04,0x78,0x10,0x0F,0xC0}
  37
  38 /* Enum BMDDeckLinkConfigurationID - DeckLink Configuration ID */
  39
  40 typedef uint32_t BMDDeckLinkConfigurationID;
  41 enum _BMDDeckLinkConfigurationID {
  42
  43     /* Serial port Flags */
  44
  45     bmdDeckLinkConfigSwapSerialRxTx                              = /* 'ssrt' */ 0x73737274,
  46
  47     /* Video Input/Output Flags */
  48
  49     bmdDeckLinkConfigUse1080pNotPsF                              = /* 'fpro' */ 0x6670726F,
  50
  51     /* Video Input/Output Integers */
  52
  53     bmdDeckLinkConfigHDMI3DPackingFormat                         = /* '3dpf' */ 0x33647066,
  54     bmdDeckLinkConfigBypass                                      = /* 'byps' */ 0x62797073,
  55
  56     /* Audio Input/Output Flags */
  57
  58     bmdDeckLinkConfigAnalogAudioConsumerLevels                   = /* 'aacl' */ 0x6161636C,
  59
  60     /* Video output flags */
  61
  62     bmdDeckLinkConfigFieldFlickerRemoval                         = /* 'fdfr' */ 0x66646672,
  63     bmdDeckLinkConfigHD1080p24ToHD1080i5994Conversion            = /* 'to59' */ 0x746F3539,
  64     bmdDeckLinkConfig444SDIVideoOutput                           = /* '444o' */ 0x3434346F,
  65     bmdDeckLinkConfig3GBpsVideoOutput                            = /* '3gbs' */ 0x33676273,
  66     bmdDeckLinkConfigBlackVideoOutputDuringCapture               = /* 'bvoc' */ 0x62766F63,
  67     bmdDeckLinkConfigLowLatencyVideoOutput                       = /* 'llvo' */ 0x6C6C766F,
  68
  69     /* Video Output Integers */
  70
  71     bmdDeckLinkConfigVideoOutputConnection                       = /* 'vocn' */ 0x766F636E,
  72     bmdDeckLinkConfigVideoOutputConversionMode                   = /* 'vocm' */ 0x766F636D,
  73     bmdDeckLinkConfigAnalogVideoOutputFlags                      = /* 'avof' */ 0x61766F66,
  74     bmdDeckLinkConfigReferenceInputTimingOffset                  = /* 'glot' */ 0x676C6F74,
  75     bmdDeckLinkConfigVideoOutputIdleOperation                    = /* 'voio' */ 0x766F696F,
  76
  77     /* Video Output Floats */
  78
  79     bmdDeckLinkConfigVideoOutputComponentLumaGain                = /* 'oclg' */ 0x6F636C67,
  80     bmdDeckLinkConfigVideoOutputComponentChromaBlueGain          = /* 'occb' */ 0x6F636362,
  81     bmdDeckLinkConfigVideoOutputComponentChromaRedGain           = /* 'occr' */ 0x6F636372,
  82     bmdDeckLinkConfigVideoOutputCompositeLumaGain                = /* 'oilg' */ 0x6F696C67,
  83     bmdDeckLinkConfigVideoOutputCompositeChromaGain              = /* 'oicg' */ 0x6F696367,
  84     bmdDeckLinkConfigVideoOutputSVideoLumaGain                   = /* 'oslg' */ 0x6F736C67,
  85     bmdDeckLinkConfigVideoOutputSVideoChromaGain                 = /* 'oscg' */ 0x6F736367,
  86
  87     /* Video Input Flags */
  88
  89     bmdDeckLinkConfigVideoInputScanning                          = /* 'visc' */ 0x76697363,     // Applicable to H264 Pro Recorder only
  90
  91     /* Video Input Integers */
  92
  93     bmdDeckLinkConfigVideoInputConnection                        = /* 'vicn' */ 0x7669636E,
  94     bmdDeckLinkConfigAnalogVideoInputFlags                       = /* 'avif' */ 0x61766966,
  95     bmdDeckLinkConfigVideoInputConversionMode                    = /* 'vicm' */ 0x7669636D,
  96     bmdDeckLinkConfig32PulldownSequenceInitialTimecodeFrame      = /* 'pdif' */ 0x70646966,
  97     bmdDeckLinkConfigVANCSourceLine1Mapping                      = /* 'vsl1' */ 0x76736C31,
  98     bmdDeckLinkConfigVANCSourceLine2Mapping                      = /* 'vsl2' */ 0x76736C32,
  99     bmdDeckLinkConfigVANCSourceLine3Mapping                      = /* 'vsl3' */ 0x76736C33,
 100
 101     /* Video Input Floats */
 102
 103     bmdDeckLinkConfigVideoInputComponentLumaGain                 = /* 'iclg' */ 0x69636C67,
 104     bmdDeckLinkConfigVideoInputComponentChromaBlueGain           = /* 'iccb' */ 0x69636362,
 105     bmdDeckLinkConfigVideoInputComponentChromaRedGain            = /* 'iccr' */ 0x69636372,
 106     bmdDeckLinkConfigVideoInputCompositeLumaGain                 = /* 'iilg' */ 0x69696C67,
 107     bmdDeckLinkConfigVideoInputCompositeChromaGain               = /* 'iicg' */ 0x69696367,
 108     bmdDeckLinkConfigVideoInputSVideoLumaGain                    = /* 'islg' */ 0x69736C67,
 109     bmdDeckLinkConfigVideoInputSVideoChromaGain                  = /* 'iscg' */ 0x69736367,
 110
 111     /* Audio Input Integers */
 112
 113     bmdDeckLinkConfigAudioInputConnection                        = /* 'aicn' */ 0x6169636E,
 114
 115     /* Audio Input Floats */
 116
 117     bmdDeckLinkConfigAnalogAudioInputScaleChannel1               = /* 'ais1' */ 0x61697331,
 118     bmdDeckLinkConfigAnalogAudioInputScaleChannel2               = /* 'ais2' */ 0x61697332,
 119     bmdDeckLinkConfigAnalogAudioInputScaleChannel3               = /* 'ais3' */ 0x61697333,
 120     bmdDeckLinkConfigAnalogAudioInputScaleChannel4               = /* 'ais4' */ 0x61697334,
 121     bmdDeckLinkConfigDigitalAudioInputScale                      = /* 'dais' */ 0x64616973,
 122
 123     /* Audio Output Integers */
 124
 125     bmdDeckLinkConfigAudioOutputAESAnalogSwitch                  = /* 'aoaa' */ 0x616F6161,
 126
 127     /* Audio Output Floats */
 128
 129     bmdDeckLinkConfigAnalogAudioOutputScaleChannel1              = /* 'aos1' */ 0x616F7331,
 130     bmdDeckLinkConfigAnalogAudioOutputScaleChannel2              = /* 'aos2' */ 0x616F7332,
 131     bmdDeckLinkConfigAnalogAudioOutputScaleChannel3              = /* 'aos3' */ 0x616F7333,
 132     bmdDeckLinkConfigAnalogAudioOutputScaleChannel4              = /* 'aos4' */ 0x616F7334,
 133     bmdDeckLinkConfigDigitalAudioOutputScale                     = /* 'daos' */ 0x64616F73
 134 };
 135
 136 // Forward Declarations
 137
 138 class IDeckLinkConfiguration;
 139
 140 /* Interface IDeckLinkConfiguration - DeckLink Configuration interface */
 141
 142 class IDeckLinkConfiguration : public IUnknown
 143 {
 144 public:
 145     virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0;
 146     virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0;
 147     virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0;
 148     virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0;
 149     virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0;
 150     virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0;
 151     virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char *value) = 0;
 152     virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char **value) = 0;
 153     virtual HRESULT WriteConfigurationToPreferences (void) = 0;
 154
 155 protected:
 156     virtual ~IDeckLinkConfiguration () {}; // call Release method to drop reference count
 157 };
 158
 159 /* Functions */
 160
 161 extern "C" {
 162
 163
 164 };
 165
 166
 167 #endif /* defined(BMD_DECKLINKAPICONFIGURATION_H) */