ntv2windriverinterface.h

Go to the documentation of this file.

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

#include "ajaexport.h"
#include "ajatypes.h"
#include <assert.h>
#include <stdio.h>
#include <string.h>
#include <tchar.h>
#include <ks.h>
#include <ksmedia.h>
#include <Setupapi.h>
#include <cfgmgr32.h>
#include "psapi.h"

#include "ntv2driverinterface.h"
#include "ntv2winpublicinterface.h"
#include "ntv2devicefeatures.h"
#include <vector>


class AJAExport CNTV2WinDriverInterface : public CNTV2DriverInterface
{
    public:
                    CNTV2WinDriverInterface();  
        virtual     ~CNTV2WinDriverInterface(); 

    public:
        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    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    ConfigureInterrupt (const bool bEnable, const INTERRUPT_ENUMS eInterruptType);
        AJA_VIRTUAL bool    ConfigureSubscription (const bool bSubscribe, const INTERRUPT_ENUMS eInterruptType, PULWord & hSubcription);
        AJA_VIRTUAL bool    GetInterruptCount (const INTERRUPT_ENUMS eInterrupt, ULWord & outCount);
        AJA_VIRTUAL bool    WaitForInterrupt (const INTERRUPT_ENUMS eInterruptType, const ULWord timeOutMs = 50);

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

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

        // Management of downloaded Xilinx bitfile
        AJA_VIRTUAL bool DriverGetBitFileInformation (BITFILE_INFO_STRUCT & outBitfileInfo,  const NTV2BitFileType inBitfileType = NTV2_VideoProcBitFile);
        AJA_VIRTUAL bool DriverSetBitFileInformation (const BITFILE_INFO_STRUCT & inBitfileInfo);

        AJA_VIRTUAL bool RestoreHardwareProcampRegisters (void);

#if !defined(NTV2_DEPRECATE_16_0)
        AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool SetStrictTiming(ULWord strictTiming))  {(void)strictTiming; return false;} 
        AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetStrictTiming(ULWord* strictTiming)){(void)strictTiming; return false;}  
        AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetStreamingApplication(ULWord & outAppType, int32_t & outPID))    {return CNTV2DriverInterface::GetStreamingApplication(outAppType,outPID);}                          
        AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetStreamingApplication(ULWord * pAppType, int32_t * pPID))        {return pAppType && pPID ? CNTV2DriverInterface::GetStreamingApplication(*pAppType,*pPID) : false;} 
        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(bool MapMemory(PVOID pvUserVa, ULWord ulNumBytes, bool bMap, ULWord* ulUser = NULL));  
        AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool DmaUnlock(void));         
        AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool CompleteMemoryForDMA(ULWord * pFrameBuffer)); 
        AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool PrepareMemoryForDMA(ULWord * pFrameBuffer, const ULWord ulNumBytes)); 
#endif  //  !defined(NTV2_DEPRECATE_16_0)
#if !defined(NTV2_DEPRECATE_17_6)
        AJA_VIRTUAL inline bool NTV2_DEPRECATED_17_6(HevcSendMessage(HevcMessageHeader* pMsg))  {(void)pMsg; return false;} 
#endif

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

    //  MEMBER DATA
    protected:
        PSP_DEVICE_INTERFACE_DETAIL_DATA _pspDevIFaceDetailData;
        SP_DEVINFO_DATA _spDevInfoData;
        HDEVINFO        _hDevInfoSet;
        HANDLE          _hDevice;
        GUID            _GUID_PROPSET;
        ULWord          _previousAudioState;
        ULWord          _previousAudioSelection;
#if !defined(NTV2_DEPRECATE_16_0)
        typedef std::vector<ULWord *>   DMA_LOCKED_VEC;
        DMA_LOCKED_VEC  _vecDmaLocked;  // OEM save locked memory addresses in vector
#endif  //  !defined(NTV2_DEPRECATE_16_0)
};  //  CNTV2WinDriverInterface

#endif  //  NTV2WINDRIVERINTERFACE_H