d6/d6a/ntv2devicescanner_8h_source.html

/* SPDX-License-Identifier: MIT */

#ifndef NTV2DEVICESCANNER_H

#define NTV2DEVICESCANNER_H


#include "ntv2audiodefines.h"

#include "ntv2card.h"

#include <vector>

#include <algorithm>


typedef std::vector <AudioSampleRateEnum>               NTV2AudioSampleRateList;

typedef NTV2AudioSampleRateList::const_iterator         NTV2AudioSampleRateListConstIter;

typedef NTV2AudioSampleRateList::iterator               NTV2AudioSampleRateListIter;


typedef std::vector <AudioChannelsPerFrameEnum>         NTV2AudioChannelsPerFrameList;

typedef NTV2AudioChannelsPerFrameList::const_iterator   NTV2AudioChannelsPerFrameListConstIter;

typedef NTV2AudioChannelsPerFrameList::iterator         NTV2AudioChannelsPerFrameListIter;


typedef std::vector <AudioSourceEnum>                   NTV2AudioSourceList;

typedef NTV2AudioSourceList::const_iterator             NTV2AudioSourceListConstIter;

typedef NTV2AudioSourceList::iterator                   NTV2AudioSourceListIter;


typedef std::vector <AudioBitsPerSampleEnum>            NTV2AudioBitsPerSampleList;

typedef NTV2AudioBitsPerSampleList::const_iterator      NTV2AudioBitsPerSampleListConstIter;

typedef NTV2AudioBitsPerSampleList::iterator            NTV2AudioBitsPerSampleListIter;


typedef struct NTV2DeviceInfo

{

    NTV2DeviceID                    deviceID;

    ULWord                          deviceIndex;

    ULWord                          pciSlot;

    uint64_t                        deviceSerialNumber;

    std::string                     deviceIdentifier;

    UWord                           numVidInputs;

    UWord                           numVidOutputs;

    UWord                           numAnlgVidInputs;

    UWord                           numAnlgVidOutputs;

    UWord                           numHDMIVidInputs;

    UWord                           numHDMIVidOutputs;

    UWord                           numInputConverters;

    UWord                           numOutputConverters;

    UWord                           numUpConverters;

    UWord                           numDownConverters;

    UWord                           downConverterDelay;

    bool                            isoConvertSupport;

    bool                            rateConvertSupport;

    bool                            dvcproHDSupport;

    bool                            qrezSupport;

    bool                            hdvSupport;

    bool                            quarterExpandSupport;

    bool                            vidProcSupport;

    bool                            dualLinkSupport;

    bool                            colorCorrectionSupport;

    bool                            programmableCSCSupport;

    bool                            rgbAlphaOutputSupport;

    bool                            breakoutBoxSupport;

    bool                            procAmpSupport;

    bool                            has2KSupport;

    bool                            has4KSupport;

    bool                            has8KSupport;

    bool                            has3GLevelConversion;

    bool                            proResSupport;

    bool                            sdi3GSupport;

    bool                            sdi12GSupport;

    bool                            ipSupport;

    bool                            biDirectionalSDI;

    bool                            ltcInSupport;

    bool                            ltcOutSupport;

    bool                            ltcInOnRefPort;

    bool                            stereoOutSupport;

    bool                            stereoInSupport;

    bool                            multiFormat;

    NTV2AudioSampleRateList         audioSampleRateList;

    NTV2AudioChannelsPerFrameList   audioNumChannelsList;

    NTV2AudioBitsPerSampleList      audioBitsPerSampleList;

    NTV2AudioSourceList             audioInSourceList;

    NTV2AudioSourceList             audioOutSourceList;

    UWord                           numAudioStreams;

    UWord                           numAnalogAudioInputChannels;

    UWord                           numAESAudioInputChannels;

    UWord                           numEmbeddedAudioInputChannels;

    UWord                           numHDMIAudioInputChannels;

    UWord                           numAnalogAudioOutputChannels;

    UWord                           numAESAudioOutputChannels;

    UWord                           numEmbeddedAudioOutputChannels;

    UWord                           numHDMIAudioOutputChannels;

    UWord                           numDMAEngines;

    UWord                           numSerialPorts;

    ULWord                          pingLED;


    AJAExport   bool operator == (const NTV2DeviceInfo & rhs) const;

    AJAExport   inline bool operator != (const NTV2DeviceInfo & rhs) const  { return !(*this == rhs); }


} NTV2DeviceInfo;


//  ostream operators


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioSampleRateList & inList);


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioChannelsPerFrameList & inList);


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioSourceList & inList);


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioBitsPerSampleList & inList);


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2DeviceInfo & inInfo);


typedef std::vector <NTV2DeviceInfo>        NTV2DeviceInfoList;

typedef NTV2DeviceInfoList::const_iterator  NTV2DeviceInfoListConstIter;    //  Const iterator shorthand

typedef NTV2DeviceInfoList::iterator        NTV2DeviceInfoListIter;         //  Iterator shorthand


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2DeviceInfoList & inList);


typedef struct {

    ULWord                          boardNumber;

    AudioSampleRateEnum             sampleRate;

    AudioChannelsPerFrameEnum       numChannels;

    AudioBitsPerSampleEnum          bitsPerSample;

    AudioSourceEnum                 sourceIn;

    AudioSourceEnum                 sourceOut;

} NTV2AudioPhysicalFormat;


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioPhysicalFormat & inFormat);


typedef std::vector <NTV2AudioPhysicalFormat>           NTV2AudioPhysicalFormatList;

typedef NTV2AudioPhysicalFormatList::const_iterator     NTV2AudioPhysicalFormatListConstIter;   //  Shorthand for const_iterator

typedef NTV2AudioPhysicalFormatList::iterator           NTV2AudioPhysicalFormatListIter;        //  Shorthand for iterator


AJAExport   std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioPhysicalFormatList & inList);


class AJAExport CNTV2DeviceScanner

{

//  Class Methods

public:

    static bool                                 GetDeviceAtIndex (const ULWord inDeviceIndexNumber, CNTV2Card & outDevice);


    static bool                                 GetFirstDeviceWithID (const NTV2DeviceID inDeviceID, CNTV2Card & outDevice);


    static bool                                 GetFirstDeviceWithName (const std::string & inNameSubString, CNTV2Card & outDevice);


    static bool                                 GetFirstDeviceWithSerial (const std::string & inSerialStr, CNTV2Card & outDevice);  //  New in SDK 16.0


    static bool                                 GetDeviceWithSerial (const uint64_t inSerialNumber, CNTV2Card & outDevice); //  New in SDK 16.0


    static bool                                 GetFirstDeviceFromArgument (const std::string & inArgument, CNTV2Card & outDevice);


    static bool                                 CompareDeviceInfoLists (const NTV2DeviceInfoList & inOldList,

                                                                        const NTV2DeviceInfoList & inNewList,

                                                                        NTV2DeviceInfoList & outDevicesAdded,

                                                                        NTV2DeviceInfoList & outDevicesRemoved);


    static std::string                          GetDeviceRefName (CNTV2Card & inDevice);    //  New in SDK 16.0


    static bool         IsLegalDecimalNumber (const std::string & inStr, const size_t inMaxLength = 2); //  New in SDK 16.0

    static uint64_t     IsLegalHexSerialNumber (const std::string & inStr); //  New in SDK 16.0     //  e.g. "0x3236333331375458"

    static bool         IsHexDigit (const char inChr);  //  New in SDK 16.0

    static bool         IsDecimalDigit (const char inChr);  //  New in SDK 16.0

    static bool         IsAlphaNumeric (const char inStr);  //  New in SDK 16.0


    static bool         IsAlphaNumeric (const std::string & inStr); //  New in SDK 16.0


    static bool         IsLegalSerialNumber (const std::string & inStr);    //  New in SDK 16.0


//  Instance Methods

public:

    //  Construction, Copying, Assigning

    explicit                            CNTV2DeviceScanner (const bool inScanNow = true);

    explicit                            CNTV2DeviceScanner (bool inScanNow, UWord inDeviceMask);


    explicit                            CNTV2DeviceScanner (const CNTV2DeviceScanner & inDeviceScanner);


    virtual     CNTV2DeviceScanner &    operator = (const CNTV2DeviceScanner & inDeviceScanner);


    //  Scanning

    virtual void    ScanHardware (void);

    virtual void    ScanHardware (UWord inDeviceMask);


    //  Inquiry

    virtual inline size_t                       GetNumDevices (void) const          { return GetDeviceInfoList ().size (); }


    virtual bool                                DeviceIDPresent (const NTV2DeviceID inDeviceID, const bool inRescan = false);


    virtual bool                                GetDeviceInfo (const ULWord inDeviceIndexNumber, NTV2DeviceInfo & outDeviceInfo, const bool inRescan = false);


    virtual inline NTV2DeviceInfoList &         GetDeviceInfoList (void)            { return _deviceInfoList; }


    virtual inline const NTV2DeviceInfoList &   GetDeviceInfoList (void) const      { return _deviceInfoList; }


    //  Sorting

    virtual void                                SortDeviceInfoList (void);


    virtual inline      ~CNTV2DeviceScanner ()                      { }


private:

    virtual void    SetAudioAttributes(NTV2DeviceInfo & inDeviceInfo, CNTV2Card & inDevice) const;

    virtual void    SetVideoAttributes (NTV2DeviceInfo & inDevicInfo);

    virtual void    DeepCopy (const CNTV2DeviceScanner & inDeviceScanner);


//  Instance Data

private:

    NTV2DeviceInfoList                  _deviceInfoList;


};  //  CNTV2DeviceScanner


#endif  //  NTV2DEVICESCANNER_H