ntv2macdriverinterface.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef NTV2MACDRIVERINTERFACE_H
#define NTV2MACDRIVERINTERFACE_H


#include "ntv2publicinterface.h"
#include "ntv2macpublicinterface.h"
#include "ntv2driverinterface.h"

//#define OPEN_UNSUPPORTED_DEVICES  //  Define to open device, even if it's not support (see NTV2GetSupportedDevices)


class CNTV2MacDriverInterface : public CNTV2DriverInterface
{
    public:
                        CNTV2MacDriverInterface();  
    AJA_VIRTUAL         ~CNTV2MacDriverInterface(); 

    AJA_VIRTUAL bool    WriteRegister (const ULWord inRegNum,  const ULWord inValue,  const ULWord inMask = 0xFFFFFFFF,  const ULWord inShift = 0);
    AJA_VIRTUAL bool    ReadRegister (const ULWord inRegNum,  ULWord & outValue,  const ULWord inMask = 0xFFFFFFFF,  const ULWord inShift = 0);

    AJA_VIRTUAL bool    AcquireStreamForApplication (ULWord inApplicationType, int32_t inProcessID);
    AJA_VIRTUAL bool    ReleaseStreamForApplication (ULWord inApplicationType, int32_t inProcessID);
    AJA_VIRTUAL bool    AcquireStreamForApplicationWithReference (ULWord inApplicationType, int32_t inProcessID);
    AJA_VIRTUAL bool    ReleaseStreamForApplicationWithReference (ULWord inApplicationType, int32_t inProcessID);
    AJA_VIRTUAL bool    SetStreamingApplication (const ULWord appType, const int32_t pid);
    AJA_VIRTUAL bool    GetStreamingApplication (ULWord & outAppType, int32_t & outProcessID);

    AJA_VIRTUAL bool    WaitForInterrupt (const INTERRUPT_ENUMS type,  const ULWord timeout = 50);
    AJA_VIRTUAL bool    GetInterruptCount (const INTERRUPT_ENUMS eInterrupt, ULWord & outCount);
    AJA_VIRTUAL bool    WaitForChangeEvent (UInt32 timeout = 0);
    AJA_VIRTUAL bool    DmaTransfer (const NTV2DMAEngine inDMAEngine,
                                    const bool      inIsRead,
                                    const ULWord    inFrameNumber,
                                    ULWord *        pFrameBuffer,
                                    const ULWord    inCardOffsetBytes,
                                    const ULWord    inByteCount,
                                    const bool      inSynchronous = true);

    AJA_VIRTUAL bool    DmaTransfer (const NTV2DMAEngine inDMAEngine,
                                    const bool inIsRead,
                                    const ULWord inFrameNumber,
                                    ULWord * pFrameBuffer,
                                    const ULWord inCardOffsetBytes,
                                    const ULWord inByteCount,
                                    const ULWord inNumSegments,
                                    const ULWord inSegmentHostPitch,
                                    const ULWord inSegmentCardPitch,
                                    const bool inSynchronous = true);

    AJA_VIRTUAL bool    DmaTransfer (const NTV2DMAEngine inDMAEngine,
                                    const NTV2Channel inDMAChannel,
                                    const bool inIsTarget,
                                    const ULWord inFrameNumber,
                                    const ULWord inCardOffsetBytes,
                                    const ULWord inByteCount,
                                    const ULWord inNumSegments,
                                    const ULWord inSegmentHostPitch,
                                    const ULWord inSegmentCardPitch,
                                    const PCHANNEL_P2P_STRUCT & inP2PData);

    AJA_VIRTUAL bool    AutoCirculate (AUTOCIRCULATE_DATA & autoCircData);
    AJA_VIRTUAL bool    NTV2Message (NTV2_HEADER * pInMessage);
    AJA_VIRTUAL bool    ControlDriverDebugMessages (NTV2_DriverDebugMessageSet /*msgSet*/, bool /*enable*/) {return false;}

#if !defined(NTV2_DEPRECATE_16_0)
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetStreamingApplication(ULWord * pAppType, int32_t * pPID))   {return pAppType && pPID ? GetStreamingApplication(*pAppType,*pPID) : false;}   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool SystemControl(void* dataPtr, SystemControlCode systemControlCode));       
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(void Sleep(int))           {}      
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapFrameBuffers(void));       
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapFrameBuffers(void));     
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapRegisters(void));          
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapRegisters(void));        
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapXena2Flash(void));         
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapXena2Flash(void));       
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(ULWord GetPCISlotNumber(void) const);  
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapMemory(const MemoryType memType, void **memPtr));  
#endif  //  !defined(NTV2_DEPRECATE_16_0)

    AJA_VIRTUAL bool    SetAudioOutputMode(NTV2_GlobalAudioPlaybackMode mode);
    AJA_VIRTUAL bool    GetAudioOutputMode(NTV2_GlobalAudioPlaybackMode* mode);

    AJA_VIRTUAL bool    KernelLog( void* dataPtr, UInt32 dataSize );
    AJA_VIRTUAL bool    ConfigureInterrupt( bool /*bEnable*/, INTERRUPT_ENUMS /*eInterruptType*/ ) {return true;}
    AJA_VIRTUAL std::string GetConnectionType (void) const  {return IsOpen() && !IsRemote()  ?  (mIsDEXT ? "DEXT" : "KEXT")  :  "";}    //  New in SDK 17.0

#if !defined(NTV2_NULL_DEVICE)
    protected:
        AJA_VIRTUAL bool    OpenLocalPhysical (const UWord inDeviceIndex);
        AJA_VIRTUAL bool    CloseLocalPhysical (void);
#endif  //  !defined(NTV2_NULL_DEVICE)

private:
    bool            mIsDEXT;        //  Uses DEXT interface?
    AJA_VIRTUAL inline io_connect_t GetIOConnect (void) const   {return mConnection;}   //  For internal use only
    io_connect_t    mConnection;    //  My io_connect_t

    // 64 bit thunking - only for structures that contain pointers
    AJA_VIRTUAL void CopyTo_AUTOCIRCULATE_DATA_64 (AUTOCIRCULATE_DATA *p, AUTOCIRCULATE_DATA_64 *p64);
    AJA_VIRTUAL void CopyTo_AUTOCIRCULATE_DATA (AUTOCIRCULATE_DATA_64 *p64, AUTOCIRCULATE_DATA *p);
    AJA_VIRTUAL void CopyTo_AUTOCIRCULATE_TRANSFER_STRUCT_64 (AUTOCIRCULATE_TRANSFER_STRUCT *p, AUTOCIRCULATE_TRANSFER_STRUCT_64 *p64);
    AJA_VIRTUAL void CopyTo_AUTOCIRCULATE_TASK_STRUCT_64 (AUTOCIRCULATE_TASK_STRUCT *p, AUTOCIRCULATE_TASK_STRUCT_64 *p64);
    AJA_VIRTUAL void CopyTo_AUTOCIRCULATE_TRANSFER_STRUCT (AUTOCIRCULATE_TRANSFER_STRUCT_64 *p64, AUTOCIRCULATE_TRANSFER_STRUCT *p);

};  //  CNTV2MacDriverInterface

#endif  //  NTV2MACDRIVERINTERFACE_H