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_DECKLINKAPI_v8_1_H 29 #define BMD_DECKLINKAPI_v8_1_H 30 31 #include "DeckLinkAPI.h" 32 33 34 // Interface ID Declarations 35 36 #define IID_IDeckLinkDeckControlStatusCallback_v8_1 /* E5F693C1-4283-4716-B18F-C1431521955B */ (REFIID){0xE5,0xF6,0x93,0xC1,0x42,0x83,0x47,0x16,0xB1,0x8F,0xC1,0x43,0x15,0x21,0x95,0x5B} 37 #define IID_IDeckLinkDeckControl_v8_1 /* 522A9E39-0F3C-4742-94EE-D80DE335DA1D */ (REFIID){0x52,0x2A,0x9E,0x39,0x0F,0x3C,0x47,0x42,0x94,0xEE,0xD8,0x0D,0xE3,0x35,0xDA,0x1D} 38 39 40 /* Enum BMDDeckControlVTRControlState_v8_1 - VTR Control state */ 41 42 typedef uint32_t BMDDeckControlVTRControlState_v8_1; 43 enum _BMDDeckControlVTRControlState_v8_1 { 44 bmdDeckControlNotInVTRControlMode_v8_1 = 'nvcm', 45 bmdDeckControlVTRControlPlaying_v8_1 = 'vtrp', 46 bmdDeckControlVTRControlRecording_v8_1 = 'vtrr', 47 bmdDeckControlVTRControlStill_v8_1 = 'vtra', 48 bmdDeckControlVTRControlSeeking_v8_1 = 'vtrs', 49 bmdDeckControlVTRControlStopped_v8_1 = 'vtro' 50 }; 51 52 53 /* Interface IDeckLinkDeckControlStatusCallback_v8_1 - Deck control state change callback. */ 54 55 class IDeckLinkDeckControlStatusCallback_v8_1 : public IUnknown 56 { 57 public: 58 virtual HRESULT TimecodeUpdate (/* in */ BMDTimecodeBCD currentTimecode) = 0; 59 virtual HRESULT VTRControlStateChanged (/* in */ BMDDeckControlVTRControlState_v8_1 newState, /* in */ BMDDeckControlError error) = 0; 60 virtual HRESULT DeckControlEventReceived (/* in */ BMDDeckControlEvent event, /* in */ BMDDeckControlError error) = 0; 61 virtual HRESULT DeckControlStatusChanged (/* in */ BMDDeckControlStatusFlags flags, /* in */ uint32_t mask) = 0; 62 63 protected: 64 virtual ~IDeckLinkDeckControlStatusCallback_v8_1 () {}; // call Release method to drop reference count 65 }; 66 67 /* Interface IDeckLinkDeckControl_v8_1 - Deck Control main interface */ 68 69 class IDeckLinkDeckControl_v8_1 : public IUnknown 70 { 71 public: 72 virtual HRESULT Open (/* in */ BMDTimeScale timeScale, /* in */ BMDTimeValue timeValue, /* in */ bool timecodeIsDropFrame, /* out */ BMDDeckControlError *error) = 0; 73 virtual HRESULT Close (/* in */ bool standbyOn) = 0; 74 virtual HRESULT GetCurrentState (/* out */ BMDDeckControlMode *mode, /* out */ BMDDeckControlVTRControlState_v8_1 *vtrControlState, /* out */ BMDDeckControlStatusFlags *flags) = 0; 75 virtual HRESULT SetStandby (/* in */ bool standbyOn) = 0; 76 virtual HRESULT SendCommand (/* in */ uint8_t *inBuffer, /* in */ uint32_t inBufferSize, /* out */ uint8_t *outBuffer, /* out */ uint32_t *outDataSize, /* in */ uint32_t outBufferSize, /* out */ BMDDeckControlError *error) = 0; 77 virtual HRESULT Play (/* out */ BMDDeckControlError *error) = 0; 78 virtual HRESULT Stop (/* out */ BMDDeckControlError *error) = 0; 79 virtual HRESULT TogglePlayStop (/* out */ BMDDeckControlError *error) = 0; 80 virtual HRESULT Eject (/* out */ BMDDeckControlError *error) = 0; 81 virtual HRESULT GoToTimecode (/* in */ BMDTimecodeBCD timecode, /* out */ BMDDeckControlError *error) = 0; 82 virtual HRESULT FastForward (/* in */ bool viewTape, /* out */ BMDDeckControlError *error) = 0; 83 virtual HRESULT Rewind (/* in */ bool viewTape, /* out */ BMDDeckControlError *error) = 0; 84 virtual HRESULT StepForward (/* out */ BMDDeckControlError *error) = 0; 85 virtual HRESULT StepBack (/* out */ BMDDeckControlError *error) = 0; 86 virtual HRESULT Jog (/* in */ double rate, /* out */ BMDDeckControlError *error) = 0; 87 virtual HRESULT Shuttle (/* in */ double rate, /* out */ BMDDeckControlError *error) = 0; 88 virtual HRESULT GetTimecodeString (/* out */ CFStringRef *currentTimeCode, /* out */ BMDDeckControlError *error) = 0; 89 virtual HRESULT GetTimecode (/* out */ IDeckLinkTimecode **currentTimecode, /* out */ BMDDeckControlError *error) = 0; 90 virtual HRESULT GetTimecodeBCD (/* out */ BMDTimecodeBCD *currentTimecode, /* out */ BMDDeckControlError *error) = 0; 91 virtual HRESULT SetPreroll (/* in */ uint32_t prerollSeconds) = 0; 92 virtual HRESULT GetPreroll (/* out */ uint32_t *prerollSeconds) = 0; 93 virtual HRESULT SetExportOffset (/* in */ int32_t exportOffsetFields) = 0; 94 virtual HRESULT GetExportOffset (/* out */ int32_t *exportOffsetFields) = 0; 95 virtual HRESULT GetManualExportOffset (/* out */ int32_t *deckManualExportOffsetFields) = 0; 96 virtual HRESULT SetCaptureOffset (/* in */ int32_t captureOffsetFields) = 0; 97 virtual HRESULT GetCaptureOffset (/* out */ int32_t *captureOffsetFields) = 0; 98 virtual HRESULT StartExport (/* in */ BMDTimecodeBCD inTimecode, /* in */ BMDTimecodeBCD outTimecode, /* in */ BMDDeckControlExportModeOpsFlags exportModeOps, /* out */ BMDDeckControlError *error) = 0; 99 virtual HRESULT StartCapture (/* in */ bool useVITC, /* in */ BMDTimecodeBCD inTimecode, /* in */ BMDTimecodeBCD outTimecode, /* out */ BMDDeckControlError *error) = 0; 100 virtual HRESULT GetDeviceID (/* out */ uint16_t *deviceId, /* out */ BMDDeckControlError *error) = 0; 101 virtual HRESULT Abort (void) = 0; 102 virtual HRESULT CrashRecordStart (/* out */ BMDDeckControlError *error) = 0; 103 virtual HRESULT CrashRecordStop (/* out */ BMDDeckControlError *error) = 0; 104 virtual HRESULT SetCallback (/* in */ IDeckLinkDeckControlStatusCallback_v8_1 *callback) = 0; 105 106 protected: 107 virtual ~IDeckLinkDeckControl_v8_1 () {}; // call Release method to drop reference count 108 }; 109 110 111 #endif // BMD_DECKLINKAPI_v8_1_H 112
