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_DECKLINKAPI_H 29 #define BMD_DECKLINKAPI_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 /* DeckLink API */ 45 46 #include <stdint.h> 47 #include "LinuxCOM.h" 48 49 #include "DeckLinkAPITypes.h" 50 #include "DeckLinkAPIModes.h" 51 #include "DeckLinkAPIDiscovery.h" 52 #include "DeckLinkAPIConfiguration.h" 53 #include "DeckLinkAPIDeckControl.h" 54 55 #define BLACKMAGIC_DECKLINK_API_MAGIC 1 56 57 // Type Declarations 58 59 60 // Interface ID Declarations 61 62 BMD_CONST REFIID IID_IDeckLinkVideoOutputCallback = /* 20AA5225-1958-47CB-820B-80A8D521A6EE */ {0x20,0xAA,0x52,0x25,0x19,0x58,0x47,0xCB,0x82,0x0B,0x80,0xA8,0xD5,0x21,0xA6,0xEE}; 63 BMD_CONST REFIID IID_IDeckLinkInputCallback = /* DD04E5EC-7415-42AB-AE4A-E80C4DFC044A */ {0xDD,0x04,0xE5,0xEC,0x74,0x15,0x42,0xAB,0xAE,0x4A,0xE8,0x0C,0x4D,0xFC,0x04,0x4A}; 64 BMD_CONST REFIID IID_IDeckLinkEncoderInputCallback = /* ACF13E61-F4A0-4974-A6A7-59AFF6268B31 */ {0xAC,0xF1,0x3E,0x61,0xF4,0xA0,0x49,0x74,0xA6,0xA7,0x59,0xAF,0xF6,0x26,0x8B,0x31}; 65 BMD_CONST REFIID IID_IDeckLinkMemoryAllocator = /* B36EB6E7-9D29-4AA8-92EF-843B87A289E8 */ {0xB3,0x6E,0xB6,0xE7,0x9D,0x29,0x4A,0xA8,0x92,0xEF,0x84,0x3B,0x87,0xA2,0x89,0xE8}; 66 BMD_CONST REFIID IID_IDeckLinkAudioOutputCallback = /* 403C681B-7F46-4A12-B993-2BB127084EE6 */ {0x40,0x3C,0x68,0x1B,0x7F,0x46,0x4A,0x12,0xB9,0x93,0x2B,0xB1,0x27,0x08,0x4E,0xE6}; 67 BMD_CONST REFIID IID_IDeckLinkIterator = /* 50FB36CD-3063-4B73-BDBB-958087F2D8BA */ {0x50,0xFB,0x36,0xCD,0x30,0x63,0x4B,0x73,0xBD,0xBB,0x95,0x80,0x87,0xF2,0xD8,0xBA}; 68 BMD_CONST REFIID IID_IDeckLinkAPIInformation = /* 7BEA3C68-730D-4322-AF34-8A7152B532A4 */ {0x7B,0xEA,0x3C,0x68,0x73,0x0D,0x43,0x22,0xAF,0x34,0x8A,0x71,0x52,0xB5,0x32,0xA4}; 69 BMD_CONST REFIID IID_IDeckLinkOutput = /* 065A0F6C-C508-4D0D-B919-F5EB0EBFC96B */ {0x06,0x5A,0x0F,0x6C,0xC5,0x08,0x4D,0x0D,0xB9,0x19,0xF5,0xEB,0x0E,0xBF,0xC9,0x6B}; 70 BMD_CONST REFIID IID_IDeckLinkInput = /* 2A88CF76-F494-4216-A7EF-DC74EEB83882 */ {0x2A,0x88,0xCF,0x76,0xF4,0x94,0x42,0x16,0xA7,0xEF,0xDC,0x74,0xEE,0xB8,0x38,0x82}; 71 BMD_CONST REFIID IID_IDeckLinkHDMIInputEDID = /* ABBBACBC-45BC-4665-9D92-ACE6E5A97902 */ {0xAB,0xBB,0xAC,0xBC,0x45,0xBC,0x46,0x65,0x9D,0x92,0xAC,0xE6,0xE5,0xA9,0x79,0x02}; 72 BMD_CONST REFIID IID_IDeckLinkEncoderInput = /* F222551D-13DF-4FD8-B587-9D4F19EC12C9 */ {0xF2,0x22,0x55,0x1D,0x13,0xDF,0x4F,0xD8,0xB5,0x87,0x9D,0x4F,0x19,0xEC,0x12,0xC9}; 73 BMD_CONST REFIID IID_IDeckLinkVideoFrame = /* 3F716FE0-F023-4111-BE5D-EF4414C05B17 */ {0x3F,0x71,0x6F,0xE0,0xF0,0x23,0x41,0x11,0xBE,0x5D,0xEF,0x44,0x14,0xC0,0x5B,0x17}; 74 BMD_CONST REFIID IID_IDeckLinkMutableVideoFrame = /* 69E2639F-40DA-4E19-B6F2-20ACE815C390 */ {0x69,0xE2,0x63,0x9F,0x40,0xDA,0x4E,0x19,0xB6,0xF2,0x20,0xAC,0xE8,0x15,0xC3,0x90}; 75 BMD_CONST REFIID IID_IDeckLinkVideoFrame3DExtensions = /* DA0F7E4A-EDC7-48A8-9CDD-2DB51C729CD7 */ {0xDA,0x0F,0x7E,0x4A,0xED,0xC7,0x48,0xA8,0x9C,0xDD,0x2D,0xB5,0x1C,0x72,0x9C,0xD7}; 76 BMD_CONST REFIID IID_IDeckLinkVideoFrameMetadataExtensions = /* D5973DC9-6432-46D0-8F0B-2496F8A1238F */ {0xD5,0x97,0x3D,0xC9,0x64,0x32,0x46,0xD0,0x8F,0x0B,0x24,0x96,0xF8,0xA1,0x23,0x8F}; 77 BMD_CONST REFIID IID_IDeckLinkVideoInputFrame = /* 05CFE374-537C-4094-9A57-680525118F44 */ {0x05,0xCF,0xE3,0x74,0x53,0x7C,0x40,0x94,0x9A,0x57,0x68,0x05,0x25,0x11,0x8F,0x44}; 78 BMD_CONST REFIID IID_IDeckLinkAncillaryPacket = /* CC5BBF7E-029C-4D3B-9158-6000EF5E3670 */ {0xCC,0x5B,0xBF,0x7E,0x02,0x9C,0x4D,0x3B,0x91,0x58,0x60,0x00,0xEF,0x5E,0x36,0x70}; 79 BMD_CONST REFIID IID_IDeckLinkAncillaryPacketIterator = /* 3FC8994B-88FB-4C17-968F-9AAB69D964A7 */ {0x3F,0xC8,0x99,0x4B,0x88,0xFB,0x4C,0x17,0x96,0x8F,0x9A,0xAB,0x69,0xD9,0x64,0xA7}; 80 BMD_CONST REFIID IID_IDeckLinkVideoFrameAncillaryPackets = /* 6C186C0F-459E-41D8-AEE2-4812D81AEE68 */ {0x6C,0x18,0x6C,0x0F,0x45,0x9E,0x41,0xD8,0xAE,0xE2,0x48,0x12,0xD8,0x1A,0xEE,0x68}; 81 BMD_CONST REFIID IID_IDeckLinkVideoFrameAncillary = /* 732E723C-D1A4-4E29-9E8E-4A88797A0004 */ {0x73,0x2E,0x72,0x3C,0xD1,0xA4,0x4E,0x29,0x9E,0x8E,0x4A,0x88,0x79,0x7A,0x00,0x04}; 82 BMD_CONST REFIID IID_IDeckLinkEncoderPacket = /* B693F36C-316E-4AF1-B6C2-F389A4BCA620 */ {0xB6,0x93,0xF3,0x6C,0x31,0x6E,0x4A,0xF1,0xB6,0xC2,0xF3,0x89,0xA4,0xBC,0xA6,0x20}; 83 BMD_CONST REFIID IID_IDeckLinkEncoderVideoPacket = /* 4E7FD944-E8C7-4EAC-B8C0-7B77F80F5AE0 */ {0x4E,0x7F,0xD9,0x44,0xE8,0xC7,0x4E,0xAC,0xB8,0xC0,0x7B,0x77,0xF8,0x0F,0x5A,0xE0}; 84 BMD_CONST REFIID IID_IDeckLinkEncoderAudioPacket = /* 49E8EDC8-693B-4E14-8EF6-12C658F5A07A */ {0x49,0xE8,0xED,0xC8,0x69,0x3B,0x4E,0x14,0x8E,0xF6,0x12,0xC6,0x58,0xF5,0xA0,0x7A}; 85 BMD_CONST REFIID IID_IDeckLinkH265NALPacket = /* 639C8E0B-68D5-4BDE-A6D4-95F3AEAFF2E7 */ {0x63,0x9C,0x8E,0x0B,0x68,0xD5,0x4B,0xDE,0xA6,0xD4,0x95,0xF3,0xAE,0xAF,0xF2,0xE7}; 86 BMD_CONST REFIID IID_IDeckLinkAudioInputPacket = /* E43D5870-2894-11DE-8C30-0800200C9A66 */ {0xE4,0x3D,0x58,0x70,0x28,0x94,0x11,0xDE,0x8C,0x30,0x08,0x00,0x20,0x0C,0x9A,0x66}; 87 BMD_CONST REFIID IID_IDeckLinkScreenPreviewCallback = /* B1D3F49A-85FE-4C5D-95C8-0B5D5DCCD438 */ {0xB1,0xD3,0xF4,0x9A,0x85,0xFE,0x4C,0x5D,0x95,0xC8,0x0B,0x5D,0x5D,0xCC,0xD4,0x38}; 88 BMD_CONST REFIID IID_IDeckLinkGLScreenPreviewHelper = /* 504E2209-CAC7-4C1A-9FB4-C5BB6274D22F */ {0x50,0x4E,0x22,0x09,0xCA,0xC7,0x4C,0x1A,0x9F,0xB4,0xC5,0xBB,0x62,0x74,0xD2,0x2F}; 89 BMD_CONST REFIID IID_IDeckLinkNotificationCallback = /* B002A1EC-070D-4288-8289-BD5D36E5FF0D */ {0xB0,0x02,0xA1,0xEC,0x07,0x0D,0x42,0x88,0x82,0x89,0xBD,0x5D,0x36,0xE5,0xFF,0x0D}; 90 BMD_CONST REFIID IID_IDeckLinkNotification = /* B85DF4C8-BDF5-47C1-8064-28162EBDD4EB */ {0xB8,0x5D,0xF4,0xC8,0xBD,0xF5,0x47,0xC1,0x80,0x64,0x28,0x16,0x2E,0xBD,0xD4,0xEB}; 91 BMD_CONST REFIID IID_IDeckLinkProfileAttributes = /* 17D4BF8E-4911-473A-80A0-731CF6FF345B */ {0x17,0xD4,0xBF,0x8E,0x49,0x11,0x47,0x3A,0x80,0xA0,0x73,0x1C,0xF6,0xFF,0x34,0x5B}; 92 BMD_CONST REFIID IID_IDeckLinkProfileIterator = /* 29E5A8C0-8BE4-46EB-93AC-31DAAB5B7BF2 */ {0x29,0xE5,0xA8,0xC0,0x8B,0xE4,0x46,0xEB,0x93,0xAC,0x31,0xDA,0xAB,0x5B,0x7B,0xF2}; 93 BMD_CONST REFIID IID_IDeckLinkProfile = /* 16093466-674A-432B-9DA0-1AC2C5A8241C */ {0x16,0x09,0x34,0x66,0x67,0x4A,0x43,0x2B,0x9D,0xA0,0x1A,0xC2,0xC5,0xA8,0x24,0x1C}; 94 BMD_CONST REFIID IID_IDeckLinkProfileCallback = /* A4F9341E-97AA-4E04-8935-15F809898CEA */ {0xA4,0xF9,0x34,0x1E,0x97,0xAA,0x4E,0x04,0x89,0x35,0x15,0xF8,0x09,0x89,0x8C,0xEA}; 95 BMD_CONST REFIID IID_IDeckLinkProfileManager = /* 30D41429-3998-4B6D-84F8-78C94A797C6E */ {0x30,0xD4,0x14,0x29,0x39,0x98,0x4B,0x6D,0x84,0xF8,0x78,0xC9,0x4A,0x79,0x7C,0x6E}; 96 BMD_CONST REFIID IID_IDeckLinkStatus = /* 5F558200-4028-49BC-BEAC-DB3FA4A96E46 */ {0x5F,0x55,0x82,0x00,0x40,0x28,0x49,0xBC,0xBE,0xAC,0xDB,0x3F,0xA4,0xA9,0x6E,0x46}; 97 BMD_CONST REFIID IID_IDeckLinkKeyer = /* 89AFCAF5-65F8-421E-98F7-96FE5F5BFBA3 */ {0x89,0xAF,0xCA,0xF5,0x65,0xF8,0x42,0x1E,0x98,0xF7,0x96,0xFE,0x5F,0x5B,0xFB,0xA3}; 98 BMD_CONST REFIID IID_IDeckLinkVideoConversion = /* 3BBCB8A2-DA2C-42D9-B5D8-88083644E99A */ {0x3B,0xBC,0xB8,0xA2,0xDA,0x2C,0x42,0xD9,0xB5,0xD8,0x88,0x08,0x36,0x44,0xE9,0x9A}; 99 BMD_CONST REFIID IID_IDeckLinkDeviceNotificationCallback = /* 4997053B-0ADF-4CC8-AC70-7A50C4BE728F */ {0x49,0x97,0x05,0x3B,0x0A,0xDF,0x4C,0xC8,0xAC,0x70,0x7A,0x50,0xC4,0xBE,0x72,0x8F}; 100 BMD_CONST REFIID IID_IDeckLinkDiscovery = /* CDBF631C-BC76-45FA-B44D-C55059BC6101 */ {0xCD,0xBF,0x63,0x1C,0xBC,0x76,0x45,0xFA,0xB4,0x4D,0xC5,0x50,0x59,0xBC,0x61,0x01}; 101 102 /* Enum BMDVideoOutputFlags - Flags to control the output of ancillary data along with video. */ 103 104 typedef uint32_t BMDVideoOutputFlags; 105 enum _BMDVideoOutputFlags { 106 bmdVideoOutputFlagDefault = 0, 107 bmdVideoOutputVANC = 1 << 0, 108 bmdVideoOutputVITC = 1 << 1, 109 bmdVideoOutputRP188 = 1 << 2, 110 bmdVideoOutputDualStream3D = 1 << 4, 111 bmdVideoOutputSynchronizeToPlaybackGroup = 1 << 6 112 }; 113 114 /* Enum BMDSupportedVideoModeFlags - Flags to describe supported video mode */ 115 116 typedef uint32_t BMDSupportedVideoModeFlags; 117 enum _BMDSupportedVideoModeFlags { 118 bmdSupportedVideoModeDefault = 0, 119 bmdSupportedVideoModeKeying = 1 << 0, 120 bmdSupportedVideoModeDualStream3D = 1 << 1, 121 bmdSupportedVideoModeSDISingleLink = 1 << 2, 122 bmdSupportedVideoModeSDIDualLink = 1 << 3, 123 bmdSupportedVideoModeSDIQuadLink = 1 << 4, 124 bmdSupportedVideoModeInAnyProfile = 1 << 5 125 }; 126 127 /* Enum BMDPacketType - Type of packet */ 128 129 typedef uint32_t BMDPacketType; 130 enum _BMDPacketType { 131 bmdPacketTypeStreamInterruptedMarker = /* 'sint' */ 0x73696E74, // A packet of this type marks the time when a video stream was interrupted, for example by a disconnected cable 132 bmdPacketTypeStreamData = /* 'sdat' */ 0x73646174 // Regular stream data 133 }; 134 135 /* Enum BMDFrameFlags - Frame flags */ 136 137 typedef uint32_t BMDFrameFlags; 138 enum _BMDFrameFlags { 139 bmdFrameFlagDefault = 0, 140 bmdFrameFlagFlipVertical = 1 << 0, 141 bmdFrameContainsHDRMetadata = 1 << 1, 142 bmdFrameContainsCintelMetadata = 1 << 2, 143 144 /* Flags that are applicable only to instances of IDeckLinkVideoInputFrame */ 145 146 bmdFrameCapturedAsPsF = 1 << 30, 147 bmdFrameHasNoInputSource = 1 << 31 148 }; 149 150 /* Enum BMDVideoInputFlags - Flags applicable to video input */ 151 152 typedef uint32_t BMDVideoInputFlags; 153 enum _BMDVideoInputFlags { 154 bmdVideoInputFlagDefault = 0, 155 bmdVideoInputEnableFormatDetection = 1 << 0, 156 bmdVideoInputDualStream3D = 1 << 1, 157 bmdVideoInputSynchronizeToCaptureGroup = 1 << 2 158 }; 159 160 /* Enum BMDVideoInputFormatChangedEvents - Bitmask passed to the VideoInputFormatChanged notification to identify the properties of the input signal that have changed */ 161 162 typedef uint32_t BMDVideoInputFormatChangedEvents; 163 enum _BMDVideoInputFormatChangedEvents { 164 bmdVideoInputDisplayModeChanged = 1 << 0, 165 bmdVideoInputFieldDominanceChanged = 1 << 1, 166 bmdVideoInputColorspaceChanged = 1 << 2 167 }; 168 169 /* Enum BMDDetectedVideoInputFormatFlags - Flags passed to the VideoInputFormatChanged notification to describe the detected video input signal */ 170 171 typedef uint32_t BMDDetectedVideoInputFormatFlags; 172 enum _BMDDetectedVideoInputFormatFlags { 173 bmdDetectedVideoInputYCbCr422 = 1 << 0, 174 bmdDetectedVideoInputRGB444 = 1 << 1, 175 bmdDetectedVideoInputDualStream3D = 1 << 2 176 }; 177 178 /* Enum BMDDeckLinkCapturePassthroughMode - Enumerates whether the video output is electrically connected to the video input or if the clean switching mode is enabled */ 179 180 typedef uint32_t BMDDeckLinkCapturePassthroughMode; 181 enum _BMDDeckLinkCapturePassthroughMode { 182 bmdDeckLinkCapturePassthroughModeDisabled = /* 'pdis' */ 0x70646973, 183 bmdDeckLinkCapturePassthroughModeDirect = /* 'pdir' */ 0x70646972, 184 bmdDeckLinkCapturePassthroughModeCleanSwitch = /* 'pcln' */ 0x70636C6E 185 }; 186 187 /* Enum BMDOutputFrameCompletionResult - Frame Completion Callback */ 188 189 typedef uint32_t BMDOutputFrameCompletionResult; 190 enum _BMDOutputFrameCompletionResult { 191 bmdOutputFrameCompleted, 192 bmdOutputFrameDisplayedLate, 193 bmdOutputFrameDropped, 194 bmdOutputFrameFlushed 195 }; 196 197 /* Enum BMDReferenceStatus - GenLock input status */ 198 199 typedef uint32_t BMDReferenceStatus; 200 enum _BMDReferenceStatus { 201 bmdReferenceNotSupportedByHardware = 1 << 0, 202 bmdReferenceLocked = 1 << 1 203 }; 204 205 /* Enum BMDAudioFormat - Audio Format */ 206 207 typedef uint32_t BMDAudioFormat; 208 enum _BMDAudioFormat { 209 bmdAudioFormatPCM = /* 'lpcm' */ 0x6C70636D // Linear signed PCM samples 210 }; 211 212 /* Enum BMDAudioSampleRate - Audio sample rates supported for output/input */ 213 214 typedef uint32_t BMDAudioSampleRate; 215 enum _BMDAudioSampleRate { 216 bmdAudioSampleRate48kHz = 48000 217 }; 218 219 /* Enum BMDAudioSampleType - Audio sample sizes supported for output/input */ 220 221 typedef uint32_t BMDAudioSampleType; 222 enum _BMDAudioSampleType { 223 bmdAudioSampleType16bitInteger = 16, 224 bmdAudioSampleType32bitInteger = 32 225 }; 226 227 /* Enum BMDAudioOutputStreamType - Audio output stream type */ 228 229 typedef uint32_t BMDAudioOutputStreamType; 230 enum _BMDAudioOutputStreamType { 231 bmdAudioOutputStreamContinuous, 232 bmdAudioOutputStreamContinuousDontResample, 233 bmdAudioOutputStreamTimestamped 234 }; 235 236 /* Enum BMDAncillaryPacketFormat - Ancillary packet format */ 237 238 typedef uint32_t BMDAncillaryPacketFormat; 239 enum _BMDAncillaryPacketFormat { 240 bmdAncillaryPacketFormatUInt8 = /* 'ui08' */ 0x75693038, 241 bmdAncillaryPacketFormatUInt16 = /* 'ui16' */ 0x75693136, 242 bmdAncillaryPacketFormatYCbCr10 = /* 'v210' */ 0x76323130 243 }; 244 245 /* Enum BMDTimecodeFormat - Timecode formats for frame metadata */ 246 247 typedef uint32_t BMDTimecodeFormat; 248 enum _BMDTimecodeFormat { 249 bmdTimecodeRP188VITC1 = /* 'rpv1' */ 0x72707631, // RP188 timecode where DBB1 equals VITC1 (line 9) 250 bmdTimecodeRP188VITC2 = /* 'rp12' */ 0x72703132, // RP188 timecode where DBB1 equals VITC2 (line 9 for progressive or line 571 for interlaced/PsF) 251 bmdTimecodeRP188LTC = /* 'rplt' */ 0x72706C74, // RP188 timecode where DBB1 equals LTC (line 10) 252 bmdTimecodeRP188HighFrameRate = /* 'rphr' */ 0x72706872, // RP188 timecode where DBB1 is an HFRTC (SMPTE ST 12-3), the only timecode allowing the frame value to go above 30 253 bmdTimecodeRP188Any = /* 'rp18' */ 0x72703138, // Convenience for capture, returning the first valid timecode in {HFRTC (if supported), VITC1, LTC, VITC2} 254 bmdTimecodeVITC = /* 'vitc' */ 0x76697463, 255 bmdTimecodeVITCField2 = /* 'vit2' */ 0x76697432, 256 bmdTimecodeSerial = /* 'seri' */ 0x73657269 257 }; 258 259 /* Enum BMDAnalogVideoFlags - Analog video display flags */ 260 261 typedef uint32_t BMDAnalogVideoFlags; 262 enum _BMDAnalogVideoFlags { 263 bmdAnalogVideoFlagCompositeSetup75 = 1 << 0, 264 bmdAnalogVideoFlagComponentBetacamLevels = 1 << 1 265 }; 266 267 /* Enum BMDAudioOutputAnalogAESSwitch - Audio output Analog/AESEBU switch */ 268 269 typedef uint32_t BMDAudioOutputAnalogAESSwitch; 270 enum _BMDAudioOutputAnalogAESSwitch { 271 bmdAudioOutputSwitchAESEBU = /* 'aes ' */ 0x61657320, 272 bmdAudioOutputSwitchAnalog = /* 'anlg' */ 0x616E6C67 273 }; 274 275 /* Enum BMDVideoOutputConversionMode - Video/audio conversion mode */ 276 277 typedef uint32_t BMDVideoOutputConversionMode; 278 enum _BMDVideoOutputConversionMode { 279 bmdNoVideoOutputConversion = /* 'none' */ 0x6E6F6E65, 280 bmdVideoOutputLetterboxDownconversion = /* 'ltbx' */ 0x6C746278, 281 bmdVideoOutputAnamorphicDownconversion = /* 'amph' */ 0x616D7068, 282 bmdVideoOutputHD720toHD1080Conversion = /* '720c' */ 0x37323063, 283 bmdVideoOutputHardwareLetterboxDownconversion = /* 'HWlb' */ 0x48576C62, 284 bmdVideoOutputHardwareAnamorphicDownconversion = /* 'HWam' */ 0x4857616D, 285 bmdVideoOutputHardwareCenterCutDownconversion = /* 'HWcc' */ 0x48576363, 286 bmdVideoOutputHardware720p1080pCrossconversion = /* 'xcap' */ 0x78636170, 287 bmdVideoOutputHardwareAnamorphic720pUpconversion = /* 'ua7p' */ 0x75613770, 288 bmdVideoOutputHardwareAnamorphic1080iUpconversion = /* 'ua1i' */ 0x75613169, 289 bmdVideoOutputHardwareAnamorphic149To720pUpconversion = /* 'u47p' */ 0x75343770, 290 bmdVideoOutputHardwareAnamorphic149To1080iUpconversion = /* 'u41i' */ 0x75343169, 291 bmdVideoOutputHardwarePillarbox720pUpconversion = /* 'up7p' */ 0x75703770, 292 bmdVideoOutputHardwarePillarbox1080iUpconversion = /* 'up1i' */ 0x75703169 293 }; 294 295 /* Enum BMDVideoInputConversionMode - Video input conversion mode */ 296 297 typedef uint32_t BMDVideoInputConversionMode; 298 enum _BMDVideoInputConversionMode { 299 bmdNoVideoInputConversion = /* 'none' */ 0x6E6F6E65, 300 bmdVideoInputLetterboxDownconversionFromHD1080 = /* '10lb' */ 0x31306C62, 301 bmdVideoInputAnamorphicDownconversionFromHD1080 = /* '10am' */ 0x3130616D, 302 bmdVideoInputLetterboxDownconversionFromHD720 = /* '72lb' */ 0x37326C62, 303 bmdVideoInputAnamorphicDownconversionFromHD720 = /* '72am' */ 0x3732616D, 304 bmdVideoInputLetterboxUpconversion = /* 'lbup' */ 0x6C627570, 305 bmdVideoInputAnamorphicUpconversion = /* 'amup' */ 0x616D7570 306 }; 307 308 /* Enum BMDVideo3DPackingFormat - Video 3D packing format */ 309 310 typedef uint32_t BMDVideo3DPackingFormat; 311 enum _BMDVideo3DPackingFormat { 312 bmdVideo3DPackingSidebySideHalf = /* 'sbsh' */ 0x73627368, 313 bmdVideo3DPackingLinebyLine = /* 'lbyl' */ 0x6C62796C, 314 bmdVideo3DPackingTopAndBottom = /* 'tabo' */ 0x7461626F, 315 bmdVideo3DPackingFramePacking = /* 'frpk' */ 0x6672706B, 316 bmdVideo3DPackingLeftOnly = /* 'left' */ 0x6C656674, 317 bmdVideo3DPackingRightOnly = /* 'righ' */ 0x72696768 318 }; 319 320 /* Enum BMDIdleVideoOutputOperation - Video output operation when not playing video */ 321 322 typedef uint32_t BMDIdleVideoOutputOperation; 323 enum _BMDIdleVideoOutputOperation { 324 bmdIdleVideoOutputBlack = /* 'blac' */ 0x626C6163, 325 bmdIdleVideoOutputLastFrame = /* 'lafa' */ 0x6C616661 326 }; 327 328 /* Enum BMDVideoEncoderFrameCodingMode - Video frame coding mode */ 329 330 typedef uint32_t BMDVideoEncoderFrameCodingMode; 331 enum _BMDVideoEncoderFrameCodingMode { 332 bmdVideoEncoderFrameCodingModeInter = /* 'inte' */ 0x696E7465, 333 bmdVideoEncoderFrameCodingModeIntra = /* 'intr' */ 0x696E7472 334 }; 335 336 /* Enum BMDDNxHRLevel - DNxHR Levels */ 337 338 typedef uint32_t BMDDNxHRLevel; 339 enum _BMDDNxHRLevel { 340 bmdDNxHRLevelSQ = /* 'dnsq' */ 0x646E7371, 341 bmdDNxHRLevelLB = /* 'dnlb' */ 0x646E6C62, 342 bmdDNxHRLevelHQ = /* 'dnhq' */ 0x646E6871, 343 bmdDNxHRLevelHQX = /* 'dhqx' */ 0x64687178, 344 bmdDNxHRLevel444 = /* 'd444' */ 0x64343434 345 }; 346 347 /* Enum BMDLinkConfiguration - Video link configuration */ 348 349 typedef uint32_t BMDLinkConfiguration; 350 enum _BMDLinkConfiguration { 351 bmdLinkConfigurationSingleLink = /* 'lcsl' */ 0x6C63736C, 352 bmdLinkConfigurationDualLink = /* 'lcdl' */ 0x6C63646C, 353 bmdLinkConfigurationQuadLink = /* 'lcql' */ 0x6C63716C 354 }; 355 356 /* Enum BMDDeviceInterface - Device interface type */ 357 358 typedef uint32_t BMDDeviceInterface; 359 enum _BMDDeviceInterface { 360 bmdDeviceInterfacePCI = /* 'pci ' */ 0x70636920, 361 bmdDeviceInterfaceUSB = /* 'usb ' */ 0x75736220, 362 bmdDeviceInterfaceThunderbolt = /* 'thun' */ 0x7468756E 363 }; 364 365 /* Enum BMDColorspace - Colorspace */ 366 367 typedef uint32_t BMDColorspace; 368 enum _BMDColorspace { 369 bmdColorspaceRec601 = /* 'r601' */ 0x72363031, 370 bmdColorspaceRec709 = /* 'r709' */ 0x72373039, 371 bmdColorspaceRec2020 = /* '2020' */ 0x32303230 372 }; 373 374 /* Enum BMDDynamicRange - SDR or HDR */ 375 376 typedef uint32_t BMDDynamicRange; 377 enum _BMDDynamicRange { 378 bmdDynamicRangeSDR = 0, 379 bmdDynamicRangeHDRStaticPQ = 1 << 29, // SMPTE ST 2084 380 bmdDynamicRangeHDRStaticHLG = 1 << 30 // ITU-R BT.2100-0 381 }; 382 383 /* Enum BMDDeckLinkHDMIInputEDIDID - DeckLink HDMI Input EDID ID */ 384 385 typedef uint32_t BMDDeckLinkHDMIInputEDIDID; 386 enum _BMDDeckLinkHDMIInputEDIDID { 387 bmdDeckLinkHDMIInputEDIDDynamicRange = /* 'HIDy' */ 0x48494479 // Parameter is of type BMDDynamicRange. Default is (bmdDynamicRangeSDR|bmdDynamicRangeHDRStaticPQ) 388 }; 389 390 /* Enum BMDDeckLinkFrameMetadataID - DeckLink Frame Metadata ID */ 391 392 typedef uint32_t BMDDeckLinkFrameMetadataID; 393 enum _BMDDeckLinkFrameMetadataID { 394 bmdDeckLinkFrameMetadataColorspace = /* 'cspc' */ 0x63737063, // Colorspace of video frame (see BMDColorspace) 395 bmdDeckLinkFrameMetadataHDRElectroOpticalTransferFunc = /* 'eotf' */ 0x656F7466, // EOTF in range 0-7 as per CEA 861.3 396 bmdDeckLinkFrameMetadataCintelFilmType = /* 'cfty' */ 0x63667479, // Current film type 397 bmdDeckLinkFrameMetadataCintelFilmGauge = /* 'cfga' */ 0x63666761, // Current film gauge 398 bmdDeckLinkFrameMetadataCintelKeykodeLow = /* 'ckkl' */ 0x636B6B6C, // Raw keykode value - low 64 bits 399 bmdDeckLinkFrameMetadataCintelKeykodeHigh = /* 'ckkh' */ 0x636B6B68, // Raw keykode value - high 64 bits 400 bmdDeckLinkFrameMetadataCintelTile1Size = /* 'ct1s' */ 0x63743173, // Size in bytes of compressed raw tile 1 401 bmdDeckLinkFrameMetadataCintelTile2Size = /* 'ct2s' */ 0x63743273, // Size in bytes of compressed raw tile 2 402 bmdDeckLinkFrameMetadataCintelTile3Size = /* 'ct3s' */ 0x63743373, // Size in bytes of compressed raw tile 3 403 bmdDeckLinkFrameMetadataCintelTile4Size = /* 'ct4s' */ 0x63743473, // Size in bytes of compressed raw tile 4 404 bmdDeckLinkFrameMetadataCintelImageWidth = /* 'IWPx' */ 0x49575078, // Width in pixels of image 405 bmdDeckLinkFrameMetadataCintelImageHeight = /* 'IHPx' */ 0x49485078, // Height in pixels of image 406 bmdDeckLinkFrameMetadataCintelLinearMaskingRedInRed = /* 'mrir' */ 0x6D726972, // Red in red linear masking parameter 407 bmdDeckLinkFrameMetadataCintelLinearMaskingGreenInRed = /* 'mgir' */ 0x6D676972, // Green in red linear masking parameter 408 bmdDeckLinkFrameMetadataCintelLinearMaskingBlueInRed = /* 'mbir' */ 0x6D626972, // Blue in red linear masking parameter 409 bmdDeckLinkFrameMetadataCintelLinearMaskingRedInGreen = /* 'mrig' */ 0x6D726967, // Red in green linear masking parameter 410 bmdDeckLinkFrameMetadataCintelLinearMaskingGreenInGreen = /* 'mgig' */ 0x6D676967, // Green in green linear masking parameter 411 bmdDeckLinkFrameMetadataCintelLinearMaskingBlueInGreen = /* 'mbig' */ 0x6D626967, // Blue in green linear masking parameter 412 bmdDeckLinkFrameMetadataCintelLinearMaskingRedInBlue = /* 'mrib' */ 0x6D726962, // Red in blue linear masking parameter 413 bmdDeckLinkFrameMetadataCintelLinearMaskingGreenInBlue = /* 'mgib' */ 0x6D676962, // Green in blue linear masking parameter 414 bmdDeckLinkFrameMetadataCintelLinearMaskingBlueInBlue = /* 'mbib' */ 0x6D626962, // Blue in blue linear masking parameter 415 bmdDeckLinkFrameMetadataCintelLogMaskingRedInRed = /* 'mlrr' */ 0x6D6C7272, // Red in red log masking parameter 416 bmdDeckLinkFrameMetadataCintelLogMaskingGreenInRed = /* 'mlgr' */ 0x6D6C6772, // Green in red log masking parameter 417 bmdDeckLinkFrameMetadataCintelLogMaskingBlueInRed = /* 'mlbr' */ 0x6D6C6272, // Blue in red log masking parameter 418 bmdDeckLinkFrameMetadataCintelLogMaskingRedInGreen = /* 'mlrg' */ 0x6D6C7267, // Red in green log masking parameter 419 bmdDeckLinkFrameMetadataCintelLogMaskingGreenInGreen = /* 'mlgg' */ 0x6D6C6767, // Green in green log masking parameter 420 bmdDeckLinkFrameMetadataCintelLogMaskingBlueInGreen = /* 'mlbg' */ 0x6D6C6267, // Blue in green log masking parameter 421 bmdDeckLinkFrameMetadataCintelLogMaskingRedInBlue = /* 'mlrb' */ 0x6D6C7262, // Red in blue log masking parameter 422 bmdDeckLinkFrameMetadataCintelLogMaskingGreenInBlue = /* 'mlgb' */ 0x6D6C6762, // Green in blue log masking parameter 423 bmdDeckLinkFrameMetadataCintelLogMaskingBlueInBlue = /* 'mlbb' */ 0x6D6C6262, // Blue in blue log masking parameter 424 bmdDeckLinkFrameMetadataCintelFilmFrameRate = /* 'cffr' */ 0x63666672, // Film frame rate 425 bmdDeckLinkFrameMetadataHDRDisplayPrimariesRedX = /* 'hdrx' */ 0x68647278, // Red display primaries in range 0.0 - 1.0 426 bmdDeckLinkFrameMetadataHDRDisplayPrimariesRedY = /* 'hdry' */ 0x68647279, // Red display primaries in range 0.0 - 1.0 427 bmdDeckLinkFrameMetadataHDRDisplayPrimariesGreenX = /* 'hdgx' */ 0x68646778, // Green display primaries in range 0.0 - 1.0 428 bmdDeckLinkFrameMetadataHDRDisplayPrimariesGreenY = /* 'hdgy' */ 0x68646779, // Green display primaries in range 0.0 - 1.0 429 bmdDeckLinkFrameMetadataHDRDisplayPrimariesBlueX = /* 'hdbx' */ 0x68646278, // Blue display primaries in range 0.0 - 1.0 430 bmdDeckLinkFrameMetadataHDRDisplayPrimariesBlueY = /* 'hdby' */ 0x68646279, // Blue display primaries in range 0.0 - 1.0 431 bmdDeckLinkFrameMetadataHDRWhitePointX = /* 'hdwx' */ 0x68647778, // White point in range 0.0 - 1.0 432 bmdDeckLinkFrameMetadataHDRWhitePointY = /* 'hdwy' */ 0x68647779, // White point in range 0.0 - 1.0 433 bmdDeckLinkFrameMetadataHDRMaxDisplayMasteringLuminance = /* 'hdml' */ 0x68646D6C, // Max display mastering luminance in range 1 cd/m2 - 65535 cd/m2 434 bmdDeckLinkFrameMetadataHDRMinDisplayMasteringLuminance = /* 'hmil' */ 0x686D696C, // Min display mastering luminance in range 0.0001 cd/m2 - 6.5535 cd/m2 435 bmdDeckLinkFrameMetadataHDRMaximumContentLightLevel = /* 'mcll' */ 0x6D636C6C, // Maximum Content Light Level in range 1 cd/m2 - 65535 cd/m2 436 bmdDeckLinkFrameMetadataHDRMaximumFrameAverageLightLevel = /* 'fall' */ 0x66616C6C, // Maximum Frame Average Light Level in range 1 cd/m2 - 65535 cd/m2 437 bmdDeckLinkFrameMetadataCintelOffsetToApplyHorizontal = /* 'otah' */ 0x6F746168, // Horizontal offset (pixels) to be applied to image 438 bmdDeckLinkFrameMetadataCintelOffsetToApplyVertical = /* 'otav' */ 0x6F746176, // Vertical offset (pixels) to be applied to image 439 bmdDeckLinkFrameMetadataCintelGainRed = /* 'LfRd' */ 0x4C665264, // Red gain parameter to apply after log 440 bmdDeckLinkFrameMetadataCintelGainGreen = /* 'LfGr' */ 0x4C664772, // Green gain parameter to apply after log 441 bmdDeckLinkFrameMetadataCintelGainBlue = /* 'LfBl' */ 0x4C66426C, // Blue gain parameter to apply after log 442 bmdDeckLinkFrameMetadataCintelLiftRed = /* 'GnRd' */ 0x476E5264, // Red lift parameter to apply after log and gain 443 bmdDeckLinkFrameMetadataCintelLiftGreen = /* 'GnGr' */ 0x476E4772, // Green lift parameter to apply after log and gain 444 bmdDeckLinkFrameMetadataCintelLiftBlue = /* 'GnBl' */ 0x476E426C, // Blue lift parameter to apply after log and gain 445 bmdDeckLinkFrameMetadataCintelHDRGainRed = /* 'HGRd' */ 0x48475264, // Red gain parameter to apply to linear data for HDR Combination 446 bmdDeckLinkFrameMetadataCintelHDRGainGreen = /* 'HGGr' */ 0x48474772, // Green gain parameter to apply to linear data for HDR Combination 447 bmdDeckLinkFrameMetadataCintelHDRGainBlue = /* 'HGBl' */ 0x4847426C // Blue gain parameter to apply to linear data for HDR Combination 448 }; 449 450 /* Enum BMDProfileID - Identifies a profile */ 451 452 typedef uint32_t BMDProfileID; 453 enum _BMDProfileID { 454 bmdProfileOneSubDeviceFullDuplex = /* '1dfd' */ 0x31646664, 455 bmdProfileOneSubDeviceHalfDuplex = /* '1dhd' */ 0x31646864, 456 bmdProfileTwoSubDevicesFullDuplex = /* '2dfd' */ 0x32646664, 457 bmdProfileTwoSubDevicesHalfDuplex = /* '2dhd' */ 0x32646864, 458 bmdProfileFourSubDevicesHalfDuplex = /* '4dhd' */ 0x34646864 459 }; 460 461 /* Enum BMDHDMITimecodePacking - Packing form of timecode on HDMI */ 462 463 typedef uint32_t BMDHDMITimecodePacking; 464 enum _BMDHDMITimecodePacking { 465 bmdHDMITimecodePackingIEEEOUI000085 = 0x00008500, 466 bmdHDMITimecodePackingIEEEOUI080046 = 0x08004601, 467 bmdHDMITimecodePackingIEEEOUI5CF9F0 = 0x5CF9F003 468 }; 469 470 /* Enum BMDDeckLinkAttributeID - DeckLink Attribute ID */ 471 472 typedef uint32_t BMDDeckLinkAttributeID; 473 enum _BMDDeckLinkAttributeID { 474 475 /* Flags */ 476 477 BMDDeckLinkSupportsInternalKeying = /* 'keyi' */ 0x6B657969, 478 BMDDeckLinkSupportsExternalKeying = /* 'keye' */ 0x6B657965, 479 BMDDeckLinkSupportsInputFormatDetection = /* 'infd' */ 0x696E6664, 480 BMDDeckLinkHasReferenceInput = /* 'hrin' */ 0x6872696E, 481 BMDDeckLinkHasSerialPort = /* 'hspt' */ 0x68737074, 482 BMDDeckLinkHasAnalogVideoOutputGain = /* 'avog' */ 0x61766F67, 483 BMDDeckLinkCanOnlyAdjustOverallVideoOutputGain = /* 'ovog' */ 0x6F766F67, 484 BMDDeckLinkHasVideoInputAntiAliasingFilter = /* 'aafl' */ 0x6161666C, 485 BMDDeckLinkHasBypass = /* 'byps' */ 0x62797073, 486 BMDDeckLinkSupportsClockTimingAdjustment = /* 'ctad' */ 0x63746164, 487 BMDDeckLinkSupportsFullFrameReferenceInputTimingOffset = /* 'frin' */ 0x6672696E, 488 BMDDeckLinkSupportsSMPTELevelAOutput = /* 'lvla' */ 0x6C766C61, 489 BMDDeckLinkSupportsDualLinkSDI = /* 'sdls' */ 0x73646C73, 490 BMDDeckLinkSupportsQuadLinkSDI = /* 'sqls' */ 0x73716C73, 491 BMDDeckLinkSupportsIdleOutput = /* 'idou' */ 0x69646F75, 492 BMDDeckLinkVANCRequires10BitYUVVideoFrames = /* 'vioY' */ 0x76696F59, // Legacy product requires v210 active picture for IDeckLinkVideoFrameAncillaryPackets or 10-bit VANC 493 BMDDeckLinkHasLTCTimecodeInput = /* 'hltc' */ 0x686C7463, 494 BMDDeckLinkSupportsHDRMetadata = /* 'hdrm' */ 0x6864726D, 495 BMDDeckLinkSupportsColorspaceMetadata = /* 'cmet' */ 0x636D6574, 496 BMDDeckLinkSupportsHDMITimecode = /* 'htim' */ 0x6874696D, 497 BMDDeckLinkSupportsHighFrameRateTimecode = /* 'HFRT' */ 0x48465254, 498 BMDDeckLinkSupportsSynchronizeToCaptureGroup = /* 'stcg' */ 0x73746367, 499 BMDDeckLinkSupportsSynchronizeToPlaybackGroup = /* 'stpg' */ 0x73747067, 500 501 /* Integers */ 502 503 BMDDeckLinkMaximumAudioChannels = /* 'mach' */ 0x6D616368, 504 BMDDeckLinkMaximumAnalogAudioInputChannels = /* 'iach' */ 0x69616368, 505 BMDDeckLinkMaximumAnalogAudioOutputChannels = /* 'aach' */ 0x61616368, 506 BMDDeckLinkNumberOfSubDevices = /* 'nsbd' */ 0x6E736264, 507 BMDDeckLinkSubDeviceIndex = /* 'subi' */ 0x73756269, 508 BMDDeckLinkPersistentID = /* 'peid' */ 0x70656964, 509 BMDDeckLinkDeviceGroupID = /* 'dgid' */ 0x64676964, 510 BMDDeckLinkTopologicalID = /* 'toid' */ 0x746F6964, 511 BMDDeckLinkVideoOutputConnections = /* 'vocn' */ 0x766F636E, // Returns a BMDVideoConnection bit field 512 BMDDeckLinkVideoInputConnections = /* 'vicn' */ 0x7669636E, // Returns a BMDVideoConnection bit field 513 BMDDeckLinkAudioOutputConnections = /* 'aocn' */ 0x616F636E, // Returns a BMDAudioConnection bit field 514 BMDDeckLinkAudioInputConnections = /* 'aicn' */ 0x6169636E, // Returns a BMDAudioConnection bit field 515 BMDDeckLinkVideoIOSupport = /* 'vios' */ 0x76696F73, // Returns a BMDVideoIOSupport bit field 516 BMDDeckLinkDeckControlConnections = /* 'dccn' */ 0x6463636E, // Returns a BMDDeckControlConnection bit field 517 BMDDeckLinkDeviceInterface = /* 'dbus' */ 0x64627573, // Returns a BMDDeviceInterface 518 BMDDeckLinkAudioInputRCAChannelCount = /* 'airc' */ 0x61697263, 519 BMDDeckLinkAudioInputXLRChannelCount = /* 'aixc' */ 0x61697863, 520 BMDDeckLinkAudioOutputRCAChannelCount = /* 'aorc' */ 0x616F7263, 521 BMDDeckLinkAudioOutputXLRChannelCount = /* 'aoxc' */ 0x616F7863, 522 BMDDeckLinkProfileID = /* 'prid' */ 0x70726964, // Returns a BMDProfileID 523 BMDDeckLinkDuplex = /* 'dupx' */ 0x64757078, 524 525 /* Floats */ 526 527 BMDDeckLinkVideoInputGainMinimum = /* 'vigm' */ 0x7669676D, 528 BMDDeckLinkVideoInputGainMaximum = /* 'vigx' */ 0x76696778, 529 BMDDeckLinkVideoOutputGainMinimum = /* 'vogm' */ 0x766F676D, 530 BMDDeckLinkVideoOutputGainMaximum = /* 'vogx' */ 0x766F6778, 531 BMDDeckLinkMicrophoneInputGainMinimum = /* 'migm' */ 0x6D69676D, 532 BMDDeckLinkMicrophoneInputGainMaximum = /* 'migx' */ 0x6D696778, 533 534 /* Strings */ 535 536 BMDDeckLinkSerialPortDeviceName = /* 'slpn' */ 0x736C706E, 537 BMDDeckLinkVendorName = /* 'vndr' */ 0x766E6472, 538 BMDDeckLinkDisplayName = /* 'dspn' */ 0x6473706E, 539 BMDDeckLinkModelName = /* 'mdln' */ 0x6D646C6E, 540 BMDDeckLinkDeviceHandle = /* 'devh' */ 0x64657668 541 }; 542 543 /* Enum BMDDeckLinkAPIInformationID - DeckLinkAPI information ID */ 544 545 typedef uint32_t BMDDeckLinkAPIInformationID; 546 enum _BMDDeckLinkAPIInformationID { 547 BMDDeckLinkAPIVersion = /* 'vers' */ 0x76657273 548 }; 549 550 /* Enum BMDDeckLinkStatusID - DeckLink Status ID */ 551 552 typedef uint32_t BMDDeckLinkStatusID; 553 enum _BMDDeckLinkStatusID { 554 555 /* Integers */ 556 557 bmdDeckLinkStatusDetectedVideoInputMode = /* 'dvim' */ 0x6476696D, 558 bmdDeckLinkStatusDetectedVideoInputFlags = /* 'dvif' */ 0x64766966, 559 bmdDeckLinkStatusCurrentVideoInputMode = /* 'cvim' */ 0x6376696D, 560 bmdDeckLinkStatusCurrentVideoInputPixelFormat = /* 'cvip' */ 0x63766970, 561 bmdDeckLinkStatusCurrentVideoInputFlags = /* 'cvif' */ 0x63766966, 562 bmdDeckLinkStatusCurrentVideoOutputMode = /* 'cvom' */ 0x63766F6D, 563 bmdDeckLinkStatusCurrentVideoOutputFlags = /* 'cvof' */ 0x63766F66, 564 bmdDeckLinkStatusPCIExpressLinkWidth = /* 'pwid' */ 0x70776964, 565 bmdDeckLinkStatusPCIExpressLinkSpeed = /* 'plnk' */ 0x706C6E6B, 566 bmdDeckLinkStatusLastVideoOutputPixelFormat = /* 'opix' */ 0x6F706978, 567 bmdDeckLinkStatusReferenceSignalMode = /* 'refm' */ 0x7265666D, 568 bmdDeckLinkStatusReferenceSignalFlags = /* 'reff' */ 0x72656666, 569 bmdDeckLinkStatusBusy = /* 'busy' */ 0x62757379, 570 bmdDeckLinkStatusInterchangeablePanelType = /* 'icpt' */ 0x69637074, 571 bmdDeckLinkStatusDeviceTemperature = /* 'dtmp' */ 0x64746D70, 572 573 /* Flags */ 574 575 bmdDeckLinkStatusVideoInputSignalLocked = /* 'visl' */ 0x7669736C, 576 bmdDeckLinkStatusReferenceSignalLocked = /* 'refl' */ 0x7265666C, 577 bmdDeckLinkStatusReceivedEDID = /* 'edid' */ 0x65646964 578 }; 579 580 /* Enum BMDDeckLinkVideoStatusFlags - */ 581 582 typedef uint32_t BMDDeckLinkVideoStatusFlags; 583 enum _BMDDeckLinkVideoStatusFlags { 584 bmdDeckLinkVideoStatusPsF = 1 << 0, 585 bmdDeckLinkVideoStatusDualStream3D = 1 << 1 586 }; 587 588 /* Enum BMDDuplexMode - Duplex of the device */ 589 590 typedef uint32_t BMDDuplexMode; 591 enum _BMDDuplexMode { 592 bmdDuplexFull = /* 'dxfu' */ 0x64786675, 593 bmdDuplexHalf = /* 'dxha' */ 0x64786861, 594 bmdDuplexSimplex = /* 'dxsp' */ 0x64787370, 595 bmdDuplexInactive = /* 'dxin' */ 0x6478696E 596 }; 597 598 /* Enum BMDPanelType - The type of interchangeable panel */ 599 600 typedef uint32_t BMDPanelType; 601 enum _BMDPanelType { 602 bmdPanelNotDetected = /* 'npnl' */ 0x6E706E6C, 603 bmdPanelTeranexMiniSmartPanel = /* 'tmsm' */ 0x746D736D 604 }; 605 606 /* Enum BMDDeviceBusyState - Current device busy state */ 607 608 typedef uint32_t BMDDeviceBusyState; 609 enum _BMDDeviceBusyState { 610 bmdDeviceCaptureBusy = 1 << 0, 611 bmdDevicePlaybackBusy = 1 << 1, 612 bmdDeviceSerialPortBusy = 1 << 2 613 }; 614 615 /* Enum BMDVideoIOSupport - Device video input/output support */ 616 617 typedef uint32_t BMDVideoIOSupport; 618 enum _BMDVideoIOSupport { 619 bmdDeviceSupportsCapture = 1 << 0, 620 bmdDeviceSupportsPlayback = 1 << 1 621 }; 622 623 /* Enum BMD3DPreviewFormat - Linked Frame preview format */ 624 625 typedef uint32_t BMD3DPreviewFormat; 626 enum _BMD3DPreviewFormat { 627 bmd3DPreviewFormatDefault = /* 'defa' */ 0x64656661, 628 bmd3DPreviewFormatLeftOnly = /* 'left' */ 0x6C656674, 629 bmd3DPreviewFormatRightOnly = /* 'righ' */ 0x72696768, 630 bmd3DPreviewFormatSideBySide = /* 'side' */ 0x73696465, 631 bmd3DPreviewFormatTopBottom = /* 'topb' */ 0x746F7062 632 }; 633 634 /* Enum BMDNotifications - Events that can be subscribed through IDeckLinkNotification */ 635 636 typedef uint32_t BMDNotifications; 637 enum _BMDNotifications { 638 bmdPreferencesChanged = /* 'pref' */ 0x70726566, 639 bmdStatusChanged = /* 'stat' */ 0x73746174 640 }; 641 642 #if defined(__cplusplus) 643 644 // Forward Declarations 645 646 class IDeckLinkVideoOutputCallback; 647 class IDeckLinkInputCallback; 648 class IDeckLinkEncoderInputCallback; 649 class IDeckLinkMemoryAllocator; 650 class IDeckLinkAudioOutputCallback; 651 class IDeckLinkIterator; 652 class IDeckLinkAPIInformation; 653 class IDeckLinkOutput; 654 class IDeckLinkInput; 655 class IDeckLinkHDMIInputEDID; 656 class IDeckLinkEncoderInput; 657 class IDeckLinkVideoFrame; 658 class IDeckLinkMutableVideoFrame; 659 class IDeckLinkVideoFrame3DExtensions; 660 class IDeckLinkVideoFrameMetadataExtensions; 661 class IDeckLinkVideoInputFrame; 662 class IDeckLinkAncillaryPacket; 663 class IDeckLinkAncillaryPacketIterator; 664 class IDeckLinkVideoFrameAncillaryPackets; 665 class IDeckLinkVideoFrameAncillary; 666 class IDeckLinkEncoderPacket; 667 class IDeckLinkEncoderVideoPacket; 668 class IDeckLinkEncoderAudioPacket; 669 class IDeckLinkH265NALPacket; 670 class IDeckLinkAudioInputPacket; 671 class IDeckLinkScreenPreviewCallback; 672 class IDeckLinkGLScreenPreviewHelper; 673 class IDeckLinkNotificationCallback; 674 class IDeckLinkNotification; 675 class IDeckLinkProfileAttributes; 676 class IDeckLinkProfileIterator; 677 class IDeckLinkProfile; 678 class IDeckLinkProfileCallback; 679 class IDeckLinkProfileManager; 680 class IDeckLinkStatus; 681 class IDeckLinkKeyer; 682 class IDeckLinkVideoConversion; 683 class IDeckLinkDeviceNotificationCallback; 684 class IDeckLinkDiscovery; 685 686 /* Interface IDeckLinkVideoOutputCallback - Frame completion callback. */ 687 688 class BMD_PUBLIC IDeckLinkVideoOutputCallback : public IUnknown 689 { 690 public: 691 virtual HRESULT ScheduledFrameCompleted (/* in */ IDeckLinkVideoFrame *completedFrame, /* in */ BMDOutputFrameCompletionResult result) = 0; 692 virtual HRESULT ScheduledPlaybackHasStopped (void) = 0; 693 694 protected: ~IDeckLinkVideoOutputCallback()695 virtual ~IDeckLinkVideoOutputCallback () {} // call Release method to drop reference count 696 }; 697 698 /* Interface IDeckLinkInputCallback - Frame arrival callback. */ 699 700 class BMD_PUBLIC IDeckLinkInputCallback : public IUnknown 701 { 702 public: 703 virtual HRESULT VideoInputFormatChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode *newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0; 704 virtual HRESULT VideoInputFrameArrived (/* in */ IDeckLinkVideoInputFrame* videoFrame, /* in */ IDeckLinkAudioInputPacket* audioPacket) = 0; 705 706 protected: ~IDeckLinkInputCallback()707 virtual ~IDeckLinkInputCallback () {} // call Release method to drop reference count 708 }; 709 710 /* Interface IDeckLinkEncoderInputCallback - Frame arrival callback. */ 711 712 class BMD_PUBLIC IDeckLinkEncoderInputCallback : public IUnknown 713 { 714 public: 715 virtual HRESULT VideoInputSignalChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode *newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0; 716 virtual HRESULT VideoPacketArrived (/* in */ IDeckLinkEncoderVideoPacket* videoPacket) = 0; 717 virtual HRESULT AudioPacketArrived (/* in */ IDeckLinkEncoderAudioPacket* audioPacket) = 0; 718 719 protected: ~IDeckLinkEncoderInputCallback()720 virtual ~IDeckLinkEncoderInputCallback () {} // call Release method to drop reference count 721 }; 722 723 /* Interface IDeckLinkMemoryAllocator - Memory allocator for video frames. */ 724 725 class BMD_PUBLIC IDeckLinkMemoryAllocator : public IUnknown 726 { 727 public: 728 virtual HRESULT AllocateBuffer (/* in */ uint32_t bufferSize, /* out */ void **allocatedBuffer) = 0; 729 virtual HRESULT ReleaseBuffer (/* in */ void *buffer) = 0; 730 731 virtual HRESULT Commit (void) = 0; 732 virtual HRESULT Decommit (void) = 0; 733 }; 734 735 /* Interface IDeckLinkAudioOutputCallback - Optional callback to allow audio samples to be pulled as required. */ 736 737 class BMD_PUBLIC IDeckLinkAudioOutputCallback : public IUnknown 738 { 739 public: 740 virtual HRESULT RenderAudioSamples (/* in */ bool preroll) = 0; 741 }; 742 743 /* Interface IDeckLinkIterator - enumerates installed DeckLink hardware */ 744 745 class BMD_PUBLIC IDeckLinkIterator : public IUnknown 746 { 747 public: 748 virtual HRESULT Next (/* out */ IDeckLink **deckLinkInstance) = 0; 749 }; 750 751 /* Interface IDeckLinkAPIInformation - DeckLinkAPI attribute interface */ 752 753 class BMD_PUBLIC IDeckLinkAPIInformation : public IUnknown 754 { 755 public: 756 virtual HRESULT GetFlag (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ bool *value) = 0; 757 virtual HRESULT GetInt (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ int64_t *value) = 0; 758 virtual HRESULT GetFloat (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ double *value) = 0; 759 virtual HRESULT GetString (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ const char **value) = 0; 760 761 protected: ~IDeckLinkAPIInformation()762 virtual ~IDeckLinkAPIInformation () {} // call Release method to drop reference count 763 }; 764 765 /* Interface IDeckLinkOutput - Created by QueryInterface from IDeckLink. */ 766 767 class BMD_PUBLIC IDeckLinkOutput : public IUnknown 768 { 769 public: 770 virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of 0 is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode *actualMode, /* out */ bool *supported) = 0; 771 virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0; 772 virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0; 773 774 virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback *previewCallback) = 0; 775 776 /* Video Output */ 777 778 virtual HRESULT EnableVideoOutput (/* in */ BMDDisplayMode displayMode, /* in */ BMDVideoOutputFlags flags) = 0; 779 virtual HRESULT DisableVideoOutput (void) = 0; 780 781 virtual HRESULT SetVideoOutputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator *theAllocator) = 0; 782 virtual HRESULT CreateVideoFrame (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame **outFrame) = 0; 783 virtual HRESULT CreateAncillaryData (/* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary **outBuffer) = 0; // Use of IDeckLinkVideoFrameAncillaryPackets is preferred 784 785 virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame *theFrame) = 0; 786 virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame *theFrame, /* in */ BMDTimeValue displayTime, /* in */ BMDTimeValue displayDuration, /* in */ BMDTimeScale timeScale) = 0; 787 virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback *theCallback) = 0; 788 virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t *bufferedFrameCount) = 0; 789 790 /* Audio Output */ 791 792 virtual HRESULT EnableAudioOutput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount, /* in */ BMDAudioOutputStreamType streamType) = 0; 793 virtual HRESULT DisableAudioOutput (void) = 0; 794 795 virtual HRESULT WriteAudioSamplesSync (/* in */ void *buffer, /* in */ uint32_t sampleFrameCount, /* out */ uint32_t *sampleFramesWritten) = 0; 796 797 virtual HRESULT BeginAudioPreroll (void) = 0; 798 virtual HRESULT EndAudioPreroll (void) = 0; 799 virtual HRESULT ScheduleAudioSamples (/* in */ void *buffer, /* in */ uint32_t sampleFrameCount, /* in */ BMDTimeValue streamTime, /* in */ BMDTimeScale timeScale, /* out */ uint32_t *sampleFramesWritten) = 0; 800 801 virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t *bufferedSampleFrameCount) = 0; 802 virtual HRESULT FlushBufferedAudioSamples (void) = 0; 803 804 virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback *theCallback) = 0; 805 806 /* Output Control */ 807 808 virtual HRESULT StartScheduledPlayback (/* in */ BMDTimeValue playbackStartTime, /* in */ BMDTimeScale timeScale, /* in */ double playbackSpeed) = 0; 809 virtual HRESULT StopScheduledPlayback (/* in */ BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue *actualStopTime, /* in */ BMDTimeScale timeScale) = 0; 810 virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool *active) = 0; 811 virtual HRESULT GetScheduledStreamTime (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *streamTime, /* out */ double *playbackSpeed) = 0; 812 virtual HRESULT GetReferenceStatus (/* out */ BMDReferenceStatus *referenceStatus) = 0; 813 814 /* Hardware Timing */ 815 816 virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0; 817 virtual HRESULT GetFrameCompletionReferenceTimestamp (/* in */ IDeckLinkVideoFrame *theFrame, /* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *frameCompletionTimestamp) = 0; 818 819 protected: ~IDeckLinkOutput()820 virtual ~IDeckLinkOutput () {} // call Release method to drop reference count 821 }; 822 823 /* Interface IDeckLinkInput - Created by QueryInterface from IDeckLink. */ 824 825 class BMD_PUBLIC IDeckLinkInput : public IUnknown 826 { 827 public: 828 virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of 0 is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDSupportedVideoModeFlags flags, /* out */ bool *supported) = 0; 829 virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0; 830 virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0; 831 832 virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback *previewCallback) = 0; 833 834 /* Video Input */ 835 836 virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; 837 virtual HRESULT DisableVideoInput (void) = 0; 838 virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t *availableFrameCount) = 0; 839 virtual HRESULT SetVideoInputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator *theAllocator) = 0; 840 841 /* Audio Input */ 842 843 virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; 844 virtual HRESULT DisableAudioInput (void) = 0; 845 virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t *availableSampleFrameCount) = 0; 846 847 /* Input Control */ 848 849 virtual HRESULT StartStreams (void) = 0; 850 virtual HRESULT StopStreams (void) = 0; 851 virtual HRESULT PauseStreams (void) = 0; 852 virtual HRESULT FlushStreams (void) = 0; 853 virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback *theCallback) = 0; 854 855 /* Hardware Timing */ 856 857 virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0; 858 859 protected: ~IDeckLinkInput()860 virtual ~IDeckLinkInput () {} // call Release method to drop reference count 861 }; 862 863 /* Interface IDeckLinkHDMIInputEDID - Created by QueryInterface from IDeckLink. Releasing all references will restore EDID to default */ 864 865 class BMD_PUBLIC IDeckLinkHDMIInputEDID : public IUnknown 866 { 867 public: 868 virtual HRESULT SetInt (/* in */ BMDDeckLinkHDMIInputEDIDID cfgID, /* in */ int64_t value) = 0; 869 virtual HRESULT GetInt (/* in */ BMDDeckLinkHDMIInputEDIDID cfgID, /* out */ int64_t *value) = 0; 870 virtual HRESULT WriteToEDID (void) = 0; 871 872 protected: ~IDeckLinkHDMIInputEDID()873 virtual ~IDeckLinkHDMIInputEDID () {} // call Release method to drop reference count 874 }; 875 876 /* Interface IDeckLinkEncoderInput - Created by QueryInterface from IDeckLink. */ 877 878 class BMD_PUBLIC IDeckLinkEncoderInput : public IUnknown 879 { 880 public: 881 virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of 0 is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedCodec, /* in */ uint32_t requestedCodecProfile, /* in */ BMDSupportedVideoModeFlags flags, /* out */ bool *supported) = 0; 882 virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0; 883 virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0; 884 885 /* Video Input */ 886 887 virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; 888 virtual HRESULT DisableVideoInput (void) = 0; 889 virtual HRESULT GetAvailablePacketsCount (/* out */ uint32_t *availablePacketsCount) = 0; 890 virtual HRESULT SetMemoryAllocator (/* in */ IDeckLinkMemoryAllocator *theAllocator) = 0; 891 892 /* Audio Input */ 893 894 virtual HRESULT EnableAudioInput (/* in */ BMDAudioFormat audioFormat, /* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; 895 virtual HRESULT DisableAudioInput (void) = 0; 896 virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t *availableSampleFrameCount) = 0; 897 898 /* Input Control */ 899 900 virtual HRESULT StartStreams (void) = 0; 901 virtual HRESULT StopStreams (void) = 0; 902 virtual HRESULT PauseStreams (void) = 0; 903 virtual HRESULT FlushStreams (void) = 0; 904 virtual HRESULT SetCallback (/* in */ IDeckLinkEncoderInputCallback *theCallback) = 0; 905 906 /* Hardware Timing */ 907 908 virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0; 909 910 protected: ~IDeckLinkEncoderInput()911 virtual ~IDeckLinkEncoderInput () {} // call Release method to drop reference count 912 }; 913 914 /* Interface IDeckLinkVideoFrame - Interface to encapsulate a video frame; can be caller-implemented. */ 915 916 class BMD_PUBLIC IDeckLinkVideoFrame : public IUnknown 917 { 918 public: 919 virtual long GetWidth (void) = 0; 920 virtual long GetHeight (void) = 0; 921 virtual long GetRowBytes (void) = 0; 922 virtual BMDPixelFormat GetPixelFormat (void) = 0; 923 virtual BMDFrameFlags GetFlags (void) = 0; 924 virtual HRESULT GetBytes (/* out */ void **buffer) = 0; 925 926 virtual HRESULT GetTimecode (/* in */ BMDTimecodeFormat format, /* out */ IDeckLinkTimecode **timecode) = 0; 927 virtual HRESULT GetAncillaryData (/* out */ IDeckLinkVideoFrameAncillary **ancillary) = 0; // Use of IDeckLinkVideoFrameAncillaryPackets is preferred 928 929 protected: ~IDeckLinkVideoFrame()930 virtual ~IDeckLinkVideoFrame () {} // call Release method to drop reference count 931 }; 932 933 /* Interface IDeckLinkMutableVideoFrame - Created by IDeckLinkOutput::CreateVideoFrame. */ 934 935 class BMD_PUBLIC IDeckLinkMutableVideoFrame : public IDeckLinkVideoFrame 936 { 937 public: 938 virtual HRESULT SetFlags (/* in */ BMDFrameFlags newFlags) = 0; 939 940 virtual HRESULT SetTimecode (/* in */ BMDTimecodeFormat format, /* in */ IDeckLinkTimecode *timecode) = 0; 941 virtual HRESULT SetTimecodeFromComponents (/* in */ BMDTimecodeFormat format, /* in */ uint8_t hours, /* in */ uint8_t minutes, /* in */ uint8_t seconds, /* in */ uint8_t frames, /* in */ BMDTimecodeFlags flags) = 0; 942 virtual HRESULT SetAncillaryData (/* in */ IDeckLinkVideoFrameAncillary *ancillary) = 0; 943 virtual HRESULT SetTimecodeUserBits (/* in */ BMDTimecodeFormat format, /* in */ BMDTimecodeUserBits userBits) = 0; 944 945 protected: ~IDeckLinkMutableVideoFrame()946 virtual ~IDeckLinkMutableVideoFrame () {} // call Release method to drop reference count 947 }; 948 949 /* Interface IDeckLinkVideoFrame3DExtensions - Optional interface implemented on IDeckLinkVideoFrame to support 3D frames */ 950 951 class BMD_PUBLIC IDeckLinkVideoFrame3DExtensions : public IUnknown 952 { 953 public: 954 virtual BMDVideo3DPackingFormat Get3DPackingFormat (void) = 0; 955 virtual HRESULT GetFrameForRightEye (/* out */ IDeckLinkVideoFrame* *rightEyeFrame) = 0; 956 957 protected: ~IDeckLinkVideoFrame3DExtensions()958 virtual ~IDeckLinkVideoFrame3DExtensions () {} // call Release method to drop reference count 959 }; 960 961 /* Interface IDeckLinkVideoFrameMetadataExtensions - Optional interface implemented on IDeckLinkVideoFrame to support frame metadata such as HDMI HDR information */ 962 963 class BMD_PUBLIC IDeckLinkVideoFrameMetadataExtensions : public IUnknown 964 { 965 public: 966 virtual HRESULT GetInt (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ int64_t *value) = 0; 967 virtual HRESULT GetFloat (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ double *value) = 0; 968 virtual HRESULT GetFlag (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ bool* value) = 0; 969 virtual HRESULT GetString (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ const char **value) = 0; 970 971 protected: ~IDeckLinkVideoFrameMetadataExtensions()972 virtual ~IDeckLinkVideoFrameMetadataExtensions () {} // call Release method to drop reference count 973 }; 974 975 /* Interface IDeckLinkVideoInputFrame - Provided by the IDeckLinkVideoInput frame arrival callback. */ 976 977 class BMD_PUBLIC IDeckLinkVideoInputFrame : public IDeckLinkVideoFrame 978 { 979 public: 980 virtual HRESULT GetStreamTime (/* out */ BMDTimeValue *frameTime, /* out */ BMDTimeValue *frameDuration, /* in */ BMDTimeScale timeScale) = 0; 981 virtual HRESULT GetHardwareReferenceTimestamp (/* in */ BMDTimeScale timeScale, /* out */ BMDTimeValue *frameTime, /* out */ BMDTimeValue *frameDuration) = 0; 982 983 protected: ~IDeckLinkVideoInputFrame()984 virtual ~IDeckLinkVideoInputFrame () {} // call Release method to drop reference count 985 }; 986 987 /* Interface IDeckLinkAncillaryPacket - On output, user needs to implement this interface */ 988 989 class BMD_PUBLIC IDeckLinkAncillaryPacket : public IUnknown 990 { 991 public: 992 993 virtual HRESULT GetBytes (/* in */ BMDAncillaryPacketFormat format /* For output, only one format need be offered */, /* out */ const void **data /* Optional */, /* out */ uint32_t *size /* Optional */) = 0; 994 virtual uint8_t GetDID (void) = 0; 995 virtual uint8_t GetSDID (void) = 0; 996 virtual uint32_t GetLineNumber (void) = 0; // On output, zero is auto 997 virtual uint8_t GetDataStreamIndex (void) = 0; // Usually zero. Can only be 1 if non-SD and the first data stream is completely full 998 999 protected: ~IDeckLinkAncillaryPacket()1000 virtual ~IDeckLinkAncillaryPacket () {} // call Release method to drop reference count 1001 }; 1002 1003 /* Interface IDeckLinkAncillaryPacketIterator - Enumerates ancillary packets */ 1004 1005 class BMD_PUBLIC IDeckLinkAncillaryPacketIterator : public IUnknown 1006 { 1007 public: 1008 virtual HRESULT Next (/* out */ IDeckLinkAncillaryPacket **packet) = 0; 1009 1010 protected: ~IDeckLinkAncillaryPacketIterator()1011 virtual ~IDeckLinkAncillaryPacketIterator () {} // call Release method to drop reference count 1012 }; 1013 1014 /* Interface IDeckLinkVideoFrameAncillaryPackets - Obtained through QueryInterface() on an IDeckLinkVideoFrame object. */ 1015 1016 class BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets : public IUnknown 1017 { 1018 public: 1019 1020 virtual HRESULT GetPacketIterator (/* out */ IDeckLinkAncillaryPacketIterator **iterator) = 0; 1021 virtual HRESULT GetFirstPacketByID (/* in */ uint8_t DID, /* in */ uint8_t SDID, /* out */ IDeckLinkAncillaryPacket **packet) = 0; 1022 virtual HRESULT AttachPacket (/* in */ IDeckLinkAncillaryPacket *packet) = 0; // Implement IDeckLinkAncillaryPacket to output your own 1023 virtual HRESULT DetachPacket (/* in */ IDeckLinkAncillaryPacket *packet) = 0; 1024 virtual HRESULT DetachAllPackets (void) = 0; 1025 1026 protected: ~IDeckLinkVideoFrameAncillaryPackets()1027 virtual ~IDeckLinkVideoFrameAncillaryPackets () {} // call Release method to drop reference count 1028 }; 1029 1030 /* Interface IDeckLinkVideoFrameAncillary - Use of IDeckLinkVideoFrameAncillaryPackets is preferred. Obtained through QueryInterface() on an IDeckLinkVideoFrame object. */ 1031 1032 class BMD_PUBLIC IDeckLinkVideoFrameAncillary : public IUnknown 1033 { 1034 public: 1035 1036 virtual HRESULT GetBufferForVerticalBlankingLine (/* in */ uint32_t lineNumber, /* out */ void **buffer) = 0; // Pixels/rowbytes is same as display mode, except for above HD where it's 1920 pixels for UHD modes and 2048 pixels for DCI modes 1037 virtual BMDPixelFormat GetPixelFormat (void) = 0; 1038 virtual BMDDisplayMode GetDisplayMode (void) = 0; 1039 1040 protected: ~IDeckLinkVideoFrameAncillary()1041 virtual ~IDeckLinkVideoFrameAncillary () {} // call Release method to drop reference count 1042 }; 1043 1044 /* Interface IDeckLinkEncoderPacket - Interface to encapsulate an encoded packet. */ 1045 1046 class BMD_PUBLIC IDeckLinkEncoderPacket : public IUnknown 1047 { 1048 public: 1049 virtual HRESULT GetBytes (/* out */ void **buffer) = 0; 1050 virtual long GetSize (void) = 0; 1051 virtual HRESULT GetStreamTime (/* out */ BMDTimeValue *frameTime, /* in */ BMDTimeScale timeScale) = 0; 1052 virtual BMDPacketType GetPacketType (void) = 0; 1053 1054 protected: ~IDeckLinkEncoderPacket()1055 virtual ~IDeckLinkEncoderPacket () {} // call Release method to drop reference count 1056 }; 1057 1058 /* Interface IDeckLinkEncoderVideoPacket - Provided by the IDeckLinkEncoderInput video packet arrival callback. */ 1059 1060 class BMD_PUBLIC IDeckLinkEncoderVideoPacket : public IDeckLinkEncoderPacket 1061 { 1062 public: 1063 virtual BMDPixelFormat GetPixelFormat (void) = 0; 1064 virtual HRESULT GetHardwareReferenceTimestamp (/* in */ BMDTimeScale timeScale, /* out */ BMDTimeValue *frameTime, /* out */ BMDTimeValue *frameDuration) = 0; 1065 1066 virtual HRESULT GetTimecode (/* in */ BMDTimecodeFormat format, /* out */ IDeckLinkTimecode **timecode) = 0; 1067 1068 protected: ~IDeckLinkEncoderVideoPacket()1069 virtual ~IDeckLinkEncoderVideoPacket () {} // call Release method to drop reference count 1070 }; 1071 1072 /* Interface IDeckLinkEncoderAudioPacket - Provided by the IDeckLinkEncoderInput audio packet arrival callback. */ 1073 1074 class BMD_PUBLIC IDeckLinkEncoderAudioPacket : public IDeckLinkEncoderPacket 1075 { 1076 public: 1077 virtual BMDAudioFormat GetAudioFormat (void) = 0; 1078 1079 protected: ~IDeckLinkEncoderAudioPacket()1080 virtual ~IDeckLinkEncoderAudioPacket () {} // call Release method to drop reference count 1081 }; 1082 1083 /* Interface IDeckLinkH265NALPacket - Obtained through QueryInterface() on an IDeckLinkEncoderVideoPacket object */ 1084 1085 class BMD_PUBLIC IDeckLinkH265NALPacket : public IDeckLinkEncoderVideoPacket 1086 { 1087 public: 1088 virtual HRESULT GetUnitType (/* out */ uint8_t *unitType) = 0; 1089 virtual HRESULT GetBytesNoPrefix (/* out */ void **buffer) = 0; 1090 virtual long GetSizeNoPrefix (void) = 0; 1091 1092 protected: ~IDeckLinkH265NALPacket()1093 virtual ~IDeckLinkH265NALPacket () {} // call Release method to drop reference count 1094 }; 1095 1096 /* Interface IDeckLinkAudioInputPacket - Provided by the IDeckLinkInput callback. */ 1097 1098 class BMD_PUBLIC IDeckLinkAudioInputPacket : public IUnknown 1099 { 1100 public: 1101 virtual long GetSampleFrameCount (void) = 0; 1102 virtual HRESULT GetBytes (/* out */ void **buffer) = 0; 1103 virtual HRESULT GetPacketTime (/* out */ BMDTimeValue *packetTime, /* in */ BMDTimeScale timeScale) = 0; 1104 1105 protected: ~IDeckLinkAudioInputPacket()1106 virtual ~IDeckLinkAudioInputPacket () {} // call Release method to drop reference count 1107 }; 1108 1109 /* Interface IDeckLinkScreenPreviewCallback - Screen preview callback */ 1110 1111 class BMD_PUBLIC IDeckLinkScreenPreviewCallback : public IUnknown 1112 { 1113 public: 1114 virtual HRESULT DrawFrame (/* in */ IDeckLinkVideoFrame *theFrame) = 0; 1115 1116 protected: ~IDeckLinkScreenPreviewCallback()1117 virtual ~IDeckLinkScreenPreviewCallback () {} // call Release method to drop reference count 1118 }; 1119 1120 /* Interface IDeckLinkGLScreenPreviewHelper - Created with CoCreateInstance(). */ 1121 1122 class BMD_PUBLIC IDeckLinkGLScreenPreviewHelper : public IUnknown 1123 { 1124 public: 1125 1126 /* Methods must be called with OpenGL context set */ 1127 1128 virtual HRESULT InitializeGL (void) = 0; 1129 virtual HRESULT PaintGL (void) = 0; 1130 virtual HRESULT SetFrame (/* in */ IDeckLinkVideoFrame *theFrame) = 0; 1131 virtual HRESULT Set3DPreviewFormat (/* in */ BMD3DPreviewFormat previewFormat) = 0; 1132 1133 protected: ~IDeckLinkGLScreenPreviewHelper()1134 virtual ~IDeckLinkGLScreenPreviewHelper () {} // call Release method to drop reference count 1135 }; 1136 1137 /* Interface IDeckLinkNotificationCallback - DeckLink Notification Callback Interface */ 1138 1139 class BMD_PUBLIC IDeckLinkNotificationCallback : public IUnknown 1140 { 1141 public: 1142 virtual HRESULT Notify (/* in */ BMDNotifications topic, /* in */ uint64_t param1, /* in */ uint64_t param2) = 0; 1143 }; 1144 1145 /* Interface IDeckLinkNotification - DeckLink Notification interface */ 1146 1147 class BMD_PUBLIC IDeckLinkNotification : public IUnknown 1148 { 1149 public: 1150 virtual HRESULT Subscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback *theCallback) = 0; 1151 virtual HRESULT Unsubscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback *theCallback) = 0; 1152 1153 protected: ~IDeckLinkNotification()1154 virtual ~IDeckLinkNotification () {} // call Release method to drop reference count 1155 }; 1156 1157 /* Interface IDeckLinkProfileAttributes - Created by QueryInterface from an IDeckLinkProfile, or from IDeckLink. When queried from IDeckLink, interrogates the active profile */ 1158 1159 class BMD_PUBLIC IDeckLinkProfileAttributes : public IUnknown 1160 { 1161 public: 1162 virtual HRESULT GetFlag (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ bool *value) = 0; 1163 virtual HRESULT GetInt (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ int64_t *value) = 0; 1164 virtual HRESULT GetFloat (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ double *value) = 0; 1165 virtual HRESULT GetString (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ const char **value) = 0; 1166 1167 protected: ~IDeckLinkProfileAttributes()1168 virtual ~IDeckLinkProfileAttributes () {} // call Release method to drop reference count 1169 }; 1170 1171 /* Interface IDeckLinkProfileIterator - Enumerates IDeckLinkProfile interfaces */ 1172 1173 class BMD_PUBLIC IDeckLinkProfileIterator : public IUnknown 1174 { 1175 public: 1176 virtual HRESULT Next (/* out */ IDeckLinkProfile **profile) = 0; 1177 1178 protected: ~IDeckLinkProfileIterator()1179 virtual ~IDeckLinkProfileIterator () {} // call Release method to drop reference count 1180 }; 1181 1182 /* Interface IDeckLinkProfile - Represents the active profile when queried from IDeckLink */ 1183 1184 class BMD_PUBLIC IDeckLinkProfile : public IUnknown 1185 { 1186 public: 1187 virtual HRESULT GetDevice (/* out */ IDeckLink **device) = 0; // Device affected when this profile becomes active 1188 virtual HRESULT IsActive (/* out */ bool *isActive) = 0; 1189 virtual HRESULT SetActive (void) = 0; // Activating a profile will also change the profile on all devices enumerated by GetPeers(). Activation is not complete until IDeckLinkProfileCallback::ProfileActivated() is called 1190 virtual HRESULT GetPeers (/* out */ IDeckLinkProfileIterator **profileIterator) = 0; // Profiles of other devices activated with this profile 1191 1192 protected: ~IDeckLinkProfile()1193 virtual ~IDeckLinkProfile () {} // call Release method to drop reference count 1194 }; 1195 1196 /* Interface IDeckLinkProfileCallback - Receive notifications about profiles related to this device */ 1197 1198 class BMD_PUBLIC IDeckLinkProfileCallback : public IUnknown 1199 { 1200 public: 1201 virtual HRESULT ProfileChanging (/* in */ IDeckLinkProfile *profileToBeActivated, /* in */ bool streamsWillBeForcedToStop) = 0; // Called before this device changes profile. User has an opportunity for teardown if streamsWillBeForcedToStop 1202 virtual HRESULT ProfileActivated (/* in */ IDeckLinkProfile *activatedProfile) = 0; // Called after this device has been activated with a new profile 1203 1204 protected: ~IDeckLinkProfileCallback()1205 virtual ~IDeckLinkProfileCallback () {} // call Release method to drop reference count 1206 }; 1207 1208 /* Interface IDeckLinkProfileManager - Created by QueryInterface from IDeckLink when a device has multiple optional profiles */ 1209 1210 class BMD_PUBLIC IDeckLinkProfileManager : public IUnknown 1211 { 1212 public: 1213 virtual HRESULT GetProfiles (/* out */ IDeckLinkProfileIterator **profileIterator) = 0; // All available profiles for this device 1214 virtual HRESULT GetProfile (/* in */ BMDProfileID profileID, /* out */ IDeckLinkProfile **profile) = 0; 1215 virtual HRESULT SetCallback (/* in */ IDeckLinkProfileCallback *callback) = 0; 1216 1217 protected: ~IDeckLinkProfileManager()1218 virtual ~IDeckLinkProfileManager () {} // call Release method to drop reference count 1219 }; 1220 1221 /* Interface IDeckLinkStatus - DeckLink Status interface */ 1222 1223 class BMD_PUBLIC IDeckLinkStatus : public IUnknown 1224 { 1225 public: 1226 virtual HRESULT GetFlag (/* in */ BMDDeckLinkStatusID statusID, /* out */ bool *value) = 0; 1227 virtual HRESULT GetInt (/* in */ BMDDeckLinkStatusID statusID, /* out */ int64_t *value) = 0; 1228 virtual HRESULT GetFloat (/* in */ BMDDeckLinkStatusID statusID, /* out */ double *value) = 0; 1229 virtual HRESULT GetString (/* in */ BMDDeckLinkStatusID statusID, /* out */ const char **value) = 0; 1230 virtual HRESULT GetBytes (/* in */ BMDDeckLinkStatusID statusID, /* out */ void *buffer, /* in, out */ uint32_t *bufferSize) = 0; 1231 1232 protected: ~IDeckLinkStatus()1233 virtual ~IDeckLinkStatus () {} // call Release method to drop reference count 1234 }; 1235 1236 /* Interface IDeckLinkKeyer - DeckLink Keyer interface */ 1237 1238 class BMD_PUBLIC IDeckLinkKeyer : public IUnknown 1239 { 1240 public: 1241 virtual HRESULT Enable (/* in */ bool isExternal) = 0; 1242 virtual HRESULT SetLevel (/* in */ uint8_t level) = 0; 1243 virtual HRESULT RampUp (/* in */ uint32_t numberOfFrames) = 0; 1244 virtual HRESULT RampDown (/* in */ uint32_t numberOfFrames) = 0; 1245 virtual HRESULT Disable (void) = 0; 1246 1247 protected: ~IDeckLinkKeyer()1248 virtual ~IDeckLinkKeyer () {} // call Release method to drop reference count 1249 }; 1250 1251 /* Interface IDeckLinkVideoConversion - Created with CoCreateInstance(). */ 1252 1253 class BMD_PUBLIC IDeckLinkVideoConversion : public IUnknown 1254 { 1255 public: 1256 virtual HRESULT ConvertFrame (/* in */ IDeckLinkVideoFrame* srcFrame, /* in */ IDeckLinkVideoFrame* dstFrame) = 0; 1257 1258 protected: ~IDeckLinkVideoConversion()1259 virtual ~IDeckLinkVideoConversion () {} // call Release method to drop reference count 1260 }; 1261 1262 /* Interface IDeckLinkDeviceNotificationCallback - DeckLink device arrival/removal notification callbacks */ 1263 1264 class BMD_PUBLIC IDeckLinkDeviceNotificationCallback : public IUnknown 1265 { 1266 public: 1267 virtual HRESULT DeckLinkDeviceArrived (/* in */ IDeckLink* deckLinkDevice) = 0; 1268 virtual HRESULT DeckLinkDeviceRemoved (/* in */ IDeckLink* deckLinkDevice) = 0; 1269 1270 protected: ~IDeckLinkDeviceNotificationCallback()1271 virtual ~IDeckLinkDeviceNotificationCallback () {} // call Release method to drop reference count 1272 }; 1273 1274 /* Interface IDeckLinkDiscovery - DeckLink device discovery */ 1275 1276 class BMD_PUBLIC IDeckLinkDiscovery : public IUnknown 1277 { 1278 public: 1279 virtual HRESULT InstallDeviceNotifications (/* in */ IDeckLinkDeviceNotificationCallback* deviceNotificationCallback) = 0; 1280 virtual HRESULT UninstallDeviceNotifications (void) = 0; 1281 1282 protected: ~IDeckLinkDiscovery()1283 virtual ~IDeckLinkDiscovery () {} // call Release method to drop reference count 1284 }; 1285 1286 /* Functions */ 1287 1288 extern "C" { 1289 1290 IDeckLinkIterator* BMD_PUBLIC CreateDeckLinkIteratorInstance (void); 1291 IDeckLinkDiscovery* BMD_PUBLIC CreateDeckLinkDiscoveryInstance (void); 1292 IDeckLinkAPIInformation* BMD_PUBLIC CreateDeckLinkAPIInformationInstance (void); 1293 IDeckLinkGLScreenPreviewHelper* BMD_PUBLIC CreateOpenGLScreenPreviewHelper (void); 1294 IDeckLinkVideoConversion* BMD_PUBLIC CreateVideoConversionInstance (void); 1295 IDeckLinkVideoFrameAncillaryPackets* BMD_PUBLIC CreateVideoFrameAncillaryPacketsInstance (void); // For use when creating a custom IDeckLinkVideoFrame without wrapping IDeckLinkOutput::CreateVideoFrame 1296 1297 } 1298 1299 1300 #endif // defined(__cplusplus) 1301 #endif /* defined(BMD_DECKLINKAPI_H) */ 1302