ntv2devicescanner.h

Go to the documentation of this file.

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

#include "ajatypes.h"
#include "ntv2audiodefines.h"
#include "ntv2card.h"
#include <vector>

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                     serialNumber;                       
    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;
    bool                            isVirtualDevice=false;
    std::string                     vdevUrl;
    std::string                     vdevName;

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

} 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                                 GetVirtualDeviceWithName (const std::string & inNameString, CNTV2Card & outDevice, const bool inRescan = true);

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

    static bool                                 GetDeviceWithSerial (const std::string & inSerialNumber, CNTV2Card & outDevice); // New in SDK 17.5, replaced uint64_t version

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

    static size_t       GetNumDevices (void);   

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

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

#if !defined(NTV2_DEPRECATE_17_1)
    static NTV2_DEPRECATED_17_1(bool IsLegalDecimalNumber (const std::string & inStr, const size_t maxLen = 2)); 
    static NTV2_DEPRECATED_17_1(uint64_t IsLegalHexSerialNumber (const std::string & inStr)); 
    static NTV2_DEPRECATED_17_1(bool IsHexDigit (const char inChr));    
    static NTV2_DEPRECATED_17_1(bool IsDecimalDigit (const char inChr));    
    static NTV2_DEPRECATED_17_1(bool IsAlphaNumeric (const char inStr));    
    static NTV2_DEPRECATED_17_1(bool IsAlphaNumeric (const std::string & inStr)); 
#endif  //  !defined(NTV2_DEPRECATE_17_1)
#if !defined(NTV2_DEPRECATE_17_5)
    static NTV2_DEPRECATED_17_5(bool GetDeviceWithSerial (const uint64_t sn, CNTV2Card & dev)); 
#endif  //  !defined(NTV2_DEPRECATE_17_5)

    //  Instance Methods
    public:
        explicit            CNTV2DeviceScanner (const bool inScanNow = true);
#if !defined(NTV2_DEPRECATE_16_3)
        explicit            CNTV2DeviceScanner (bool inScanNow, UWord inDeviceMask);
#endif  //  !defined(NTV2_DEPRECATE_16_3)


        static void         ScanHardware (void);    
#if !defined(NTV2_DEPRECATE_17_1)
        static NTV2_DEPRECATED_17_1(void ScanHardware (const UWord inMask)) {(void)inMask;  ScanHardware();}    
#endif  //  !defined(NTV2_DEPRECATE_17_1)
        static bool     DeviceIDPresent (const NTV2DeviceID inDeviceID, const bool inRescan = false);   
        static bool     GetDeviceInfo (const ULWord inDeviceIndexNumber, NTV2DeviceInfo & outDeviceInfo, const bool inRescan = false);  
        static NTV2DeviceInfoList   GetDeviceInfoList (void);   
        static void     SortDeviceInfoList (void)   {}  
        static bool     CompareDeviceInfoLists (const NTV2DeviceInfoList & inOldList,
                                                const NTV2DeviceInfoList & inNewList,
                                                NTV2DeviceInfoList & outDevicesAdded,
                                                NTV2DeviceInfoList & outDevicesRemoved);
    private:
        static void     SetDeviceAttributes (NTV2DeviceInfo & inDeviceInfo, CNTV2Card & inDevice);
        static void     SetAudioAttributes (NTV2DeviceInfo & inDeviceInfo, CNTV2Card & inDevice);
        static bool     GetCP2DevList (NTV2DeviceInfoList& outVDevList);
        static bool     GetVDevList (NTV2DeviceInfoList& outVDevList);
};  //  CNTV2DeviceScanner

#endif  //  NTV2DEVICESCANNER_H