third_party/decklink/mac/include/DeckLinkAPI_v9_2.h

   1 /* -LICENSE-START-
   2 ** Copyright (c) 2012 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_v9_2_H
  29 #define BMD_DECKLINKAPI_v9_2_H
  30
  31 #include "DeckLinkAPI.h"
  32
  33
  34 // Interface ID Declarations
  35
  36 #define IID_IDeckLinkInput_v9_2                          /* 6D40EF78-28B9-4E21-990D-95BB7750A04F */ (REFIID){0x6D,0x40,0xEF,0x78,0x28,0xB9,0x4E,0x21,0x99,0x0D,0x95,0xBB,0x77,0x50,0xA0,0x4F}
  37
  38
  39 #if defined(__cplusplus)
  40
  41 /* Interface IDeckLinkInput - Created by QueryInterface from IDeckLink. */
  42
  43 class IDeckLinkInput_v9_2 : public IUnknown
  44 {
  45 public:
  46     virtual HRESULT DoesSupportVideoMode (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags, /* out */ BMDDisplayModeSupport *result, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0;
  47     virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0;
  48
  49     virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback *previewCallback) = 0;
  50
  51     /* Video Input */
  52
  53     virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0;
  54     virtual HRESULT DisableVideoInput (void) = 0;
  55     virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t *availableFrameCount) = 0;
  56
  57     /* Audio Input */
  58
  59     virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0;
  60     virtual HRESULT DisableAudioInput (void) = 0;
  61     virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t *availableSampleFrameCount) = 0;
  62
  63     /* Input Control */
  64
  65     virtual HRESULT StartStreams (void) = 0;
  66     virtual HRESULT StopStreams (void) = 0;
  67     virtual HRESULT PauseStreams (void) = 0;
  68     virtual HRESULT FlushStreams (void) = 0;
  69     virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback *theCallback) = 0;
  70
  71     /* Hardware Timing */
  72
  73     virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0;
  74
  75 protected:
  76     virtual ~IDeckLinkInput_v9_2 () {}; // call Release method to drop reference count
  77 };
  78
  79
  80 #endif      // defined(__cplusplus)
  81 #endif  // BMD_DECKLINKAPI_v9_2_H