src/third_party/decklink/mac/include/DeckLinkAPI_v7_3.h

   1 /* -LICENSE-START-
   2 ** Copyright (c) 2009 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 /* DeckLinkAPI_v7_3.h */
  29
  30 #ifndef __DeckLink_API_v7_3_h__
  31 #define __DeckLink_API_v7_3_h__
  32
  33 #include "DeckLinkAPI.h"
  34 #include "DeckLinkAPI_v7_6.h"
  35
  36 /* Interface ID Declarations */
  37
  38 #define IID_IDeckLinkInputCallback_v7_3                  /* FD6F311D-4D00-444B-9ED4-1F25B5730AD0 */ (REFIID){0xFD,0x6F,0x31,0x1D,0x4D,0x00,0x44,0x4B,0x9E,0xD4,0x1F,0x25,0xB5,0x73,0x0A,0xD0}
  39 #define IID_IDeckLinkOutput_v7_3                         /* 271C65E3-C323-4344-A30F-D908BCB20AA3 */ (REFIID){0x27,0x1C,0x65,0xE3,0xC3,0x23,0x43,0x44,0xA3,0x0F,0xD9,0x08,0xBC,0xB2,0x0A,0xA3}
  40 #define IID_IDeckLinkInput_v7_3                          /* 4973F012-9925-458C-871C-18774CDBBECB */ (REFIID){0x49,0x73,0xF0,0x12,0x99,0x25,0x45,0x8C,0x87,0x1C,0x18,0x77,0x4C,0xDB,0xBE,0xCB}
  41 #define IID_IDeckLinkVideoInputFrame_v7_3                /* CF317790-2894-11DE-8C30-0800200C9A66 */ (REFIID){0xCF,0x31,0x77,0x90,0x28,0x94,0x11,0xDE,0x8C,0x30,0x08,0x00,0x20,0x0C,0x9A,0x66}
  42
  43 /* End Interface ID Declarations */
  44
  45 #if defined(__cplusplus)
  46
  47 /* Forward Declarations */
  48
  49 class IDeckLinkVideoInputFrame_v7_3;
  50
  51 /* End Forward Declarations */
  52
  53
  54 /* Interface IDeckLinkOutput - Created by QueryInterface from IDeckLink. */
  55
  56 class IDeckLinkOutput_v7_3 : public IUnknown
  57 {
  58 public:
  59     virtual HRESULT DoesSupportVideoMode (BMDDisplayMode displayMode, BMDPixelFormat pixelFormat, /* out */ BMDDisplayModeSupport *result) = 0;
  60     virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator_v7_6 **iterator) = 0;
  61
  62     virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback *previewCallback) = 0;
  63
  64     /* Video Output */
  65
  66     virtual HRESULT EnableVideoOutput (BMDDisplayMode displayMode, BMDVideoOutputFlags flags) = 0;
  67     virtual HRESULT DisableVideoOutput (void) = 0;
  68
  69     virtual HRESULT SetVideoOutputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator *theAllocator) = 0;
  70     virtual HRESULT CreateVideoFrame (int32_t width, int32_t height, int32_t rowBytes, BMDPixelFormat pixelFormat, BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame_v7_6 **outFrame) = 0;
  71     virtual HRESULT CreateAncillaryData (BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary **outBuffer) = 0;
  72
  73     virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame_v7_6 *theFrame) = 0;
  74     virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame_v7_6 *theFrame, BMDTimeValue displayTime, BMDTimeValue displayDuration, BMDTimeScale timeScale) = 0;
  75     virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback *theCallback) = 0;
  76     virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t *bufferedFrameCount) = 0;
  77
  78     /* Audio Output */
  79
  80     virtual HRESULT EnableAudioOutput (BMDAudioSampleRate sampleRate, BMDAudioSampleType sampleType, uint32_t channelCount, BMDAudioOutputStreamType streamType) = 0;
  81     virtual HRESULT DisableAudioOutput (void) = 0;
  82
  83     virtual HRESULT WriteAudioSamplesSync (/* in */ void *buffer, uint32_t sampleFrameCount, /* out */ uint32_t *sampleFramesWritten) = 0;
  84
  85     virtual HRESULT BeginAudioPreroll (void) = 0;
  86     virtual HRESULT EndAudioPreroll (void) = 0;
  87     virtual HRESULT ScheduleAudioSamples (/* in */ void *buffer, uint32_t sampleFrameCount, BMDTimeValue streamTime, BMDTimeScale timeScale, /* out */ uint32_t *sampleFramesWritten) = 0;
  88
  89     virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t *bufferedSampleFrameCount) = 0;
  90     virtual HRESULT FlushBufferedAudioSamples (void) = 0;
  91
  92     virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback *theCallback) = 0;
  93
  94     /* Output Control */
  95
  96     virtual HRESULT StartScheduledPlayback (BMDTimeValue playbackStartTime, BMDTimeScale timeScale, double playbackSpeed) = 0;
  97     virtual HRESULT StopScheduledPlayback (BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue *actualStopTime, BMDTimeScale timeScale) = 0;
  98     virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool *active) = 0;
  99     virtual HRESULT GetHardwareReferenceClock (BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *elapsedTimeSinceSchedulerBegan) = 0;
 100
 101 protected:
 102     virtual ~IDeckLinkOutput_v7_3 () {}; // call Release method to drop reference count
 103 };
 104
 105 /* End Interface IDeckLinkOutput */
 106
 107
 108 /* Interface IDeckLinkInputCallback - Frame arrival callback. */
 109
 110 class IDeckLinkInputCallback_v7_3 : public IUnknown
 111 {
 112 public:
 113     virtual HRESULT VideoInputFormatChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode_v7_6 *newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0;
 114     virtual HRESULT VideoInputFrameArrived (/* in */ IDeckLinkVideoInputFrame_v7_3 *videoFrame, /* in */ IDeckLinkAudioInputPacket *audioPacket) = 0;
 115
 116 protected:
 117     virtual ~IDeckLinkInputCallback_v7_3 () {}; // call Release method to drop reference count
 118 };
 119
 120 /* End Interface IDeckLinkInputCallback */
 121
 122
 123 /* Interface IDeckLinkInput - Created by QueryInterface from IDeckLink. */
 124
 125 class IDeckLinkInput_v7_3 : public IUnknown
 126 {
 127 public:
 128     virtual HRESULT DoesSupportVideoMode (BMDDisplayMode displayMode, BMDPixelFormat pixelFormat, /* out */ BMDDisplayModeSupport *result) = 0;
 129     virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator_v7_6 **iterator) = 0;
 130
 131     virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback *previewCallback) = 0;
 132
 133     /* Video Input */
 134
 135     virtual HRESULT EnableVideoInput (BMDDisplayMode displayMode, BMDPixelFormat pixelFormat, BMDVideoInputFlags flags) = 0;
 136     virtual HRESULT DisableVideoInput (void) = 0;
 137     virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t *availableFrameCount) = 0;
 138
 139     /* Audio Input */
 140
 141     virtual HRESULT EnableAudioInput (BMDAudioSampleRate sampleRate, BMDAudioSampleType sampleType, uint32_t channelCount) = 0;
 142     virtual HRESULT DisableAudioInput (void) = 0;
 143     virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t *availableSampleFrameCount) = 0;
 144
 145     /* Input Control */
 146
 147     virtual HRESULT StartStreams (void) = 0;
 148     virtual HRESULT StopStreams (void) = 0;
 149     virtual HRESULT PauseStreams (void) = 0;
 150     virtual HRESULT FlushStreams (void) = 0;
 151     virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback_v7_3 *theCallback) = 0;
 152
 153 protected:
 154     virtual ~IDeckLinkInput_v7_3 () {}; // call Release method to drop reference count
 155 };
 156
 157 /* End Interface IDeckLinkInput */
 158
 159 /* Interface IDeckLinkVideoInputFrame - Provided by the IDeckLinkVideoInput frame arrival callback. */
 160
 161 class IDeckLinkVideoInputFrame_v7_3 : public IDeckLinkVideoFrame_v7_6
 162 {
 163 public:
 164     virtual HRESULT GetStreamTime (/* out */ BMDTimeValue *frameTime, /* out */ BMDTimeValue *frameDuration, BMDTimeScale timeScale) = 0;
 165
 166 protected:
 167     virtual ~IDeckLinkVideoInputFrame_v7_3 () {}; // call Release method to drop reference count
 168 };
 169
 170 /* End Interface IDeckLinkVideoInputFrame */
 171
 172 #endif      // defined(__cplusplus)
 173 #endif      // __DeckLink_API_v7_3_h__