ntv2devicescanner.cpp

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#include "ntv2devicescanner.h"
#include "ntv2devicefeatures.h"
#include "ntv2utils.h"
#include "ajabase/common/common.h"
#include "ajabase/system/debug.h"
#include "ajabase/system/lock.h"
#include <sstream>
#include "ajabase/system/info.h"
#include "ajabase/common/json.hpp"
#include <fstream>
#include "ajabase/system/file_io.h"

using namespace std;
using json = nlohmann::json;


#define VDFAIL(__x__)       AJA_sERROR  (AJA_DebugUnit_VDev, AJAFUNC << ": " << __x__)
#define VDWARN(__x__)       AJA_sWARNING(AJA_DebugUnit_VDev, AJAFUNC << ": " << __x__)
#define VDNOTE(__x__)       AJA_sNOTICE (AJA_DebugUnit_VDev, AJAFUNC << ": " << __x__)
#define VDINFO(__x__)       AJA_sINFO   (AJA_DebugUnit_VDev, AJAFUNC << ": " << __x__)
#define VDDBUG(__x__)       AJA_sDEBUG  (AJA_DebugUnit_VDev, AJAFUNC << ": " << __x__)

#define C2FAIL(__x__)       AJA_sERROR  (AJA_DebugUnit_CP2, AJAFUNC << ": " << __x__)
#define C2WARN(__x__)       AJA_sWARNING(AJA_DebugUnit_CP2, AJAFUNC << ": " << __x__)
#define C2NOTE(__x__)       AJA_sNOTICE (AJA_DebugUnit_CP2, AJAFUNC << ": " << __x__)
#define C2INFO(__x__)       AJA_sINFO   (AJA_DebugUnit_CP2, AJAFUNC << ": " << __x__)
#define C2DBUG(__x__)       AJA_sDEBUG  (AJA_DebugUnit_CP2, AJAFUNC << ": " << __x__)


#if !defined(NTV2_DEPRECATE_17_1)
    bool CNTV2DeviceScanner::IsHexDigit (const char inChr)
    {   static const string sHexDigits("0123456789ABCDEFabcdef");
        return sHexDigits.find(inChr) != string::npos;
    }

    bool CNTV2DeviceScanner::IsDecimalDigit (const char inChr)
    {   static const string sDecDigits("0123456789");
        return sDecDigits.find(inChr) != string::npos;
    }

    bool CNTV2DeviceScanner::IsAlphaNumeric (const char inChr)
    {   static const string sLegalChars("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz");
        return sLegalChars.find(inChr) != string::npos;
    }

    bool CNTV2DeviceScanner::IsLegalDecimalNumber (const string & inStr, const size_t inMaxLength)
    {
        return aja::is_legal_decimal_number(inStr, inMaxLength);
    }

    uint64_t CNTV2DeviceScanner::IsLegalHexSerialNumber (const string & inStr)  //  0x3236333331375458
    {
        return aja::is_legal_hex_serial_number(inStr);
    }

    bool CNTV2DeviceScanner::IsAlphaNumeric (const string & inStr)
    {
        for (size_t ndx(0);  ndx < inStr.size();  ndx++)
            if (!aja::is_alpha_numeric(inStr.at(ndx)))
                return false;
        return true;
    }
#endif  //  !defined(NTV2_DEPRECATE_17_1)

bool CNTV2DeviceScanner::IsLegalSerialNumber (const string & inStr)
{
    if (inStr.length() != 8  &&  inStr.length() != 9)
        return false;
    return aja::is_alpha_numeric(inStr);
}

static NTV2DeviceInfoList   sDevInfoList;
static AJALock              sDevInfoListLock;

size_t CNTV2DeviceScanner::GetNumDevices (void)
{
    AJAAutoLock tmpLock(&sDevInfoListLock);
    return sDevInfoList.size();
}

CNTV2DeviceScanner::CNTV2DeviceScanner (const bool inScanNow)
{
    if (inScanNow)
        ScanHardware();
}

    #if !defined(NTV2_DEPRECATE_16_3)
        CNTV2DeviceScanner::CNTV2DeviceScanner (bool inScanNow, UWord inDeviceMask)
        {
            (void)inDeviceMask;
            if (inScanNow)
                ScanHardware();
        }
    #endif  //  !defined(NTV2_DEPRECATE_16_3)

NTV2DeviceInfoList  GetDeviceInfoList (void)
{
    AJAAutoLock tmpLock(&sDevInfoListLock);
    return sDevInfoList;
}


void CNTV2DeviceScanner::ScanHardware (void)
{
    AJAAutoLock tmpLock(&sDevInfoListLock);
    sDevInfoList.clear();

    for (UWord boardNum(0);   ;   boardNum++)
    {
        CNTV2Card tmpDev(boardNum);
        if (!tmpDev.IsOpen())
            break;
        const NTV2DeviceID  deviceID (tmpDev.GetDeviceID());

        if (deviceID != DEVICE_ID_NOTFOUND)
        {
            ostringstream   oss;
            NTV2DeviceInfo  info;
            info.deviceIndex        = boardNum;
            info.deviceID           = deviceID;
            tmpDev.GetSerialNumberString(info.serialNumber);

            oss << ::NTV2DeviceIDToString (deviceID, tmpDev.IsSupported(kDeviceHasMicrophoneInput)) << " - " << boardNum;

            info.deviceIdentifier = oss.str();
            SetDeviceAttributes(info, tmpDev);
            SetAudioAttributes(info, tmpDev);
            sDevInfoList.push_back(info);
        }
        tmpDev.Close();
    }   //  boardNum loop

    GetVDevList(sDevInfoList);      //  For VKONA support
    GetCP2DevList(sDevInfoList);    //  For CP2 support
}   //  ScanHardware

bool CNTV2DeviceScanner::DeviceIDPresent (const NTV2DeviceID inDeviceID, const bool inRescan)
{
    AJAAutoLock tmpLock(&sDevInfoListLock);
    if (inRescan)
        ScanHardware();

    for (NTV2DeviceInfoListConstIter iter(sDevInfoList.begin());  iter != sDevInfoList.end();  ++iter)
        if (iter->deviceID == inDeviceID)
            return true;    //  Found!
    return false;   //  Not found

}   //  DeviceIDPresent


bool CNTV2DeviceScanner::GetDeviceInfo (const ULWord inDeviceIndexNumber, NTV2DeviceInfo & outDeviceInfo, const bool inRescan)
{
    AJAAutoLock tmpLock(&sDevInfoListLock);
    if (inRescan)
        ScanHardware();

    for (NTV2DeviceInfoListConstIter iter(sDevInfoList.begin()); iter != sDevInfoList.end(); ++iter)
        if (iter->deviceIndex == inDeviceIndexNumber)
        {
            outDeviceInfo = *iter;
            return true;    //  Found!
        }
    return false;   //  No devices with this index number

}   //  GetDeviceInfo

bool CNTV2DeviceScanner::GetDeviceAtIndex (const ULWord inDeviceIndexNumber, CNTV2Card & outDevice)
{
    outDevice.Close();
    AJAAutoLock tmpLock(&sDevInfoListLock);
    ScanHardware();
    for (NTV2DeviceInfoListConstIter iter(sDevInfoList.begin()); iter != sDevInfoList.end(); ++iter)
        if (iter->deviceIndex == inDeviceIndexNumber)
        {
            if (iter->isVirtualDevice)
                return outDevice.Open(iter->vdevUrl);
            else
                return outDevice.Open(UWord(inDeviceIndexNumber));
        }
    return false;   //  No devices with this index number

}   //  GetDeviceAtIndex


bool CNTV2DeviceScanner::GetFirstDeviceWithID (const NTV2DeviceID inDeviceID, CNTV2Card & outDevice)
{
    outDevice.Close();
    AJAAutoLock tmpLock(&sDevInfoListLock);
    ScanHardware();
    for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
        if (sDevInfoList.at(ndx).deviceID == inDeviceID)
        {
            if (sDevInfoList.at(ndx).isVirtualDevice)
                return outDevice.Open(sDevInfoList.at(ndx).vdevUrl);
            else
                return outDevice.Open(UWord(ndx));
        }
    return false;   //  Not found

}   //  GetFirstDeviceWithID


bool CNTV2DeviceScanner::GetFirstDeviceWithName (const string & inNameSubString, CNTV2Card & outDevice)
{
    outDevice.Close();
    AJAAutoLock tmpLock(&sDevInfoListLock);
    ScanHardware();
    string  nameSubString(inNameSubString);  aja::lower(nameSubString);
    for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
    {
        string deviceName(sDevInfoList.at(ndx).deviceIdentifier);  aja::lower(deviceName);
        if (deviceName.find(nameSubString) != string::npos)
        {
            if (sDevInfoList.at(ndx).isVirtualDevice)
                return outDevice.Open(sDevInfoList.at(ndx).vdevUrl);
            else
                return outDevice.Open(UWord(ndx));
        }
    }
    if (nameSubString == "io4kplus")
    {   //  Io4K+ == DNXIV...
        nameSubString = "avid dnxiv";
        for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
        {
            string deviceName(sDevInfoList.at(ndx).deviceIdentifier);  aja::lower(deviceName);
            if (deviceName.find(nameSubString) != string::npos)
            {
                if (sDevInfoList.at(ndx).isVirtualDevice)
                    return outDevice.Open(sDevInfoList.at(ndx).vdevUrl);
                else
                    return outDevice.Open(UWord(ndx));
            }
        }
    }
    return false;   //  Not found

}   //  GetFirstDeviceWithName

bool CNTV2DeviceScanner::GetVirtualDeviceWithName (const string & inNameString, CNTV2Card & outDevice, const bool inRescan)
{
    outDevice.Close();
    AJAAutoLock tmpLock(&sDevInfoListLock);
    if (inRescan)
        ScanHardware();
    string  nameString(inNameString);  aja::lower(nameString);
    for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
    {
        if (!sDevInfoList.at(ndx).isVirtualDevice)
            continue;
        string deviceName(sDevInfoList.at(ndx).vdevName);  aja::lower(deviceName);
        if (deviceName == nameString)
        {
            return outDevice.Open(sDevInfoList.at(ndx).vdevUrl);
        }
    }
    return false;   //  Not found
}

bool CNTV2DeviceScanner::GetFirstDeviceWithSerial (const string & inSerialStr, CNTV2Card & outDevice)
{
    outDevice.Close();
    AJAAutoLock tmpLock(&sDevInfoListLock);
    ScanHardware();
    string searchSerialStr(inSerialStr);  aja::lower(searchSerialStr);
    for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
    {
        string ser(sDevInfoList.at(ndx).serialNumber);  aja::lower(ser);
        if (ser.find(searchSerialStr) != string::npos)
        {
            if (sDevInfoList.at(ndx).isVirtualDevice)
                return outDevice.Open(sDevInfoList.at(ndx).vdevUrl);
            else
                return outDevice.Open(UWord(ndx));
        }
    }
    return false;
}


#if !defined(NTV2_DEPRECATE_17_5)
bool CNTV2DeviceScanner::GetDeviceWithSerial (const uint64_t inSerialNumber, CNTV2Card & outDevice)
{
    const string serNumStr(::SerialNum64ToString(inSerialNumber));
    return GetDeviceWithSerial(serNumStr, outDevice);
}
#endif  //  !defined(NTV2_DEPRECATE_17_5)

bool CNTV2DeviceScanner::GetDeviceWithSerial (const string & inSerialNumber, CNTV2Card & outDevice)
{
    outDevice.Close();
    AJAAutoLock tmpLock(&sDevInfoListLock);
    ScanHardware();
    for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
        if (sDevInfoList.at(ndx).serialNumber == inSerialNumber)
        {
            if (sDevInfoList.at(ndx).isVirtualDevice)
                return outDevice.Open(sDevInfoList.at(ndx).vdevUrl);
            else
                return outDevice.Open(UWord(ndx));
        }
    return false;
}


bool CNTV2DeviceScanner::GetFirstDeviceFromArgument (const string & inArgument, CNTV2Card & outDevice)
{
    outDevice.Close();
    if (inArgument.empty())
        return false;

    //  Special case:  'LIST' or '?'  ---  print an enumeration of available devices to stdout, then bail
    AJAAutoLock tmpLock(&sDevInfoListLock);
    ScanHardware();
    string upperArg(inArgument);  aja::upper(upperArg);
    if (upperArg == "LIST" || upperArg == "?")
    {
        if (sDevInfoList.empty())
            cout << "No devices detected" << endl;
        else
            cout << DEC(sDevInfoList.size()) << " available " << (sDevInfoList.size() == 1 ? "device:" : "devices:") << endl;
        for (size_t ndx(0);  ndx < sDevInfoList.size();  ndx++)
        {
            if (sDevInfoList.at(ndx).isVirtualDevice)
            {
                cout << DECN(ndx, 2) << " | " << setw(8) << "virtual";
                if (!sDevInfoList.at(ndx).vdevName.empty())
                    cout << " | " << setw(10) << sDevInfoList.at(ndx).vdevName;
                cout << " | " << sDevInfoList.at(ndx).vdevUrl << endl;
            }
            else
            {
                cout << DECN(ndx, 2) << " | " << setw(8) << "local";
                const string serNum(sDevInfoList.at(ndx).serialNumber);
                if (!serNum.empty())
                    cout << " | " << setw(10) << serNum;
                cout << " | " << setw(16) << ::NTV2DeviceIDToString(sDevInfoList.at(ndx).deviceID);
                cout << endl;
            }
        }
        return false;
    }

    for (NTV2DeviceInfoListConstIter iter (sDevInfoList.begin());  iter != sDevInfoList.end();  ++iter)
    {
        if (iter->isVirtualDevice)
        {   bool ok (false);
            if (to_string(iter->deviceIndex) == inArgument
                ||  iter->deviceIdentifier == inArgument
                ||  iter->vdevName == inArgument
                ||  (aja::is_legal_decimal_number(inArgument, inArgument.length())
                    && aja::is_legal_hex_serial_number(inArgument)
                    && iter->deviceID == NTV2DeviceID(stoi(inArgument))))
                        {
                            ok = outDevice.Open(iter->vdevUrl);
                            if (ok)
                                outDevice.setDeviceIndexNumber(UWord(iter->deviceIndex));   //  Patch _boardNumber
                            return ok;
                        }
            else if (IsLegalSerialNumber(inArgument))
                return outDevice.Open(inArgument);
            else if (inArgument.find("://") != string::npos)
                return outDevice.Open(inArgument);
        }
        else
        {
            if (to_string(iter->deviceIndex) == inArgument)
                return outDevice.Open(inArgument);
            else if (iter->deviceIdentifier == inArgument)
                return outDevice.Open(inArgument);
            else if (aja::is_legal_decimal_number(inArgument, inArgument.length()) && aja::is_legal_hex_serial_number(inArgument) && iter->deviceID == NTV2DeviceID(stoi(inArgument)))
                return outDevice.Open(inArgument);
            else if (IsLegalSerialNumber(inArgument))
                return outDevice.Open(inArgument);
            else if (inArgument.find("://") != string::npos)
                return outDevice.Open(inArgument);
        }
    }
    return outDevice.Open(inArgument);
}   //  GetFirstDeviceFromArgument


string CNTV2DeviceScanner::GetDeviceRefName (CNTV2Card & inDevice)
{   //  Name that will find given device via CNTV2DeviceScanner::GetFirstDeviceFromArgument
    if (!inDevice.IsOpen())
        return string();
    //  Nub address 1st...
    if (!inDevice.GetHostName().empty()  &&  inDevice.IsRemote())
        return inDevice.GetHostName();  //  Nub host/device

    //  Serial number 2nd...
    string str;
    if (inDevice.GetSerialNumberString(str))
        return str;

    //  Model name 3rd...
    str = ::NTV2DeviceIDToString(inDevice.GetDeviceID(), false);
    if (!str.empty() &&  str != "???")
        return str;

    //  Index number last...
    ostringstream oss;  oss << DEC(inDevice.GetIndexNumber());
    return oss.str();
}


ostream &   operator << (ostream & inOutStr, const NTV2DeviceInfoList & inList)
{
    for (NTV2DeviceInfoListConstIter iter(inList.begin());  iter != inList.end();  ++iter)
        inOutStr << " " << *iter;
    return inOutStr;

}   //  NTV2DeviceInfoList ostream operator <<


bool NTV2DeviceInfo::operator == (const NTV2DeviceInfo & second) const
{
    const NTV2DeviceInfo &  first   (*this);
    size_t                  diffs   (0);

    //  'memcmp' would be simpler, but because NTV2DeviceInfo has no constructor, the unfilled bytes in
    //  its "boardIdentifier" field are indeterminate, making it worthless for accurate comparisons.
    //  "boardSerialNumber" and boardNumber are the only required comparisons, but I also check boardType,
    //  boardID, and pciSlot for good measure...
    if (first.deviceID      !=  second.deviceID)        diffs++;
    if (first.deviceIndex   !=  second.deviceIndex)     diffs++;
    if (first.serialNumber  !=  second.serialNumber)    diffs++;
    if (first.pciSlot       !=  second.pciSlot)         diffs++;

    // Needs to be fixed now that deviceIdentifier is a std::string
    //#if defined (AJA_DEBUG)
    //  if (::strncmp (first.deviceIdentifier.c_str (), second.deviceIdentifier.c_str (), first.deviceIdentifier.length ())))   diffs++;
    //  if (diffs)
    //      {cout << "## DEBUG:  " << diffs << " diff(s):" << endl << "#### first ####" << endl << first << "#### second ####" << endl << second << endl;}
    //#endif    //  AJA_DEBUG

    return diffs ? false : true;

}   //  equality operator

NTV2DeviceInfo::NTV2DeviceInfo()
{
    deviceID                        = DEVICE_ID_INVALID;
    deviceIndex                     = 0;
    pciSlot                         = 0;
    deviceSerialNumber              = 0;
    serialNumber                    = "";
    numVidInputs                    = 0;
    numVidOutputs                   = 0;
    numAnlgVidInputs                = 0;
    numAnlgVidOutputs               = 0;
    numHDMIVidInputs                = 0;
    numHDMIVidOutputs               = 0;
    numInputConverters              = 0;
    numOutputConverters             = 0;
    numUpConverters                 = 0;
    numDownConverters               = 0;
    downConverterDelay              = 0;
    isoConvertSupport               = false;
    rateConvertSupport              = false;
    dvcproHDSupport                 = false;
    qrezSupport                     = false;
    hdvSupport                      = false;
    quarterExpandSupport            = false;
    vidProcSupport                  = false;
    dualLinkSupport                 = false;
    colorCorrectionSupport          = false;
    programmableCSCSupport          = false;
    rgbAlphaOutputSupport           = false;
    breakoutBoxSupport              = false;
    procAmpSupport                  = false;
    has2KSupport                    = false;
    has4KSupport                    = false;
    has8KSupport                    = false;
    has3GLevelConversion            = false;
    proResSupport                   = false;
    sdi3GSupport                    = false;
    sdi12GSupport                   = false;
    ipSupport                       = false;
    biDirectionalSDI                = false;
    ltcInSupport                    = false;
    ltcOutSupport                   = false;
    ltcInOnRefPort                  = false;
    stereoOutSupport                = false;
    stereoInSupport                 = false;
    multiFormat                     = false;
    numAudioStreams                 = 0;
    numAnalogAudioInputChannels     = 0;
    numAESAudioInputChannels        = 0;
    numEmbeddedAudioInputChannels   = 0;
    numHDMIAudioInputChannels       = 0;
    numAnalogAudioOutputChannels    = 0;
    numAESAudioOutputChannels       = 0;
    numEmbeddedAudioOutputChannels  = 0;
    numHDMIAudioOutputChannels      = 0;
    numDMAEngines                   = 0;
    numSerialPorts                  = 0;
    pingLED                         = 0;
    deviceIdentifier.clear();
    audioSampleRateList.clear();
    audioNumChannelsList.clear();
    audioBitsPerSampleList.clear();
    audioInSourceList.clear();
    audioOutSourceList.clear();
}

NTV2DeviceInfo::NTV2DeviceInfo (const NTV2DeviceInfo & info)
{
    if (&info != this)
        *this = info;
}


bool CNTV2DeviceScanner::CompareDeviceInfoLists (const NTV2DeviceInfoList & inOldList,
                                            const NTV2DeviceInfoList & inNewList,
                                            NTV2DeviceInfoList & outBoardsAdded,
                                            NTV2DeviceInfoList & outBoardsRemoved)
{
    NTV2DeviceInfoListConstIter oldIter (inOldList.begin ());
    NTV2DeviceInfoListConstIter newIter (inNewList.begin ());

    outBoardsAdded.clear ();
    outBoardsRemoved.clear ();

    while (true)
    {
        if (oldIter == inOldList.end () && newIter == inNewList.end ())
            break;  //  Done -- exit

        if (oldIter != inOldList.end () && newIter != inNewList.end ())
        {
            const NTV2DeviceInfo &  oldInfo (*oldIter),  newInfo (*newIter);

            if (oldInfo != newInfo)
            {
                //  Out with the old...
                outBoardsRemoved.push_back (oldInfo);

                //  In with the new...
                if (newInfo.deviceID && newInfo.deviceID != NTV2DeviceID(0xFFFFFFFF))
                    outBoardsAdded.push_back (newInfo);
            }   //  if mismatch

            ++oldIter;
            ++newIter;
            continue;   //  Move along

        }   //  if both valid

        if (oldIter != inOldList.end () && newIter == inNewList.end ())
        {
            outBoardsRemoved.push_back (*oldIter);
            ++oldIter;
            continue;   //  Move along
        }   //  old is valid, new is not valid

        if (oldIter == inOldList.end () && newIter != inNewList.end ())
        {
            if (newIter->deviceID && newIter->deviceID != NTV2DeviceID(0xFFFFFFFF))
                outBoardsAdded.push_back (*newIter);
            ++newIter;
            continue;   //  Move along
        }   //  old is not valid, new is valid

        NTV2_ASSERT(false && "should never get here");

    }   //  loop til break

    //  Return 'true' if there were any changes...
    return !outBoardsAdded.empty () || !outBoardsRemoved.empty ();

}   //  CompareDeviceInfoLists


ostream &   operator << (ostream & inOutStr, const NTV2AudioSampleRateList & inList)
{
    for (NTV2AudioSampleRateListConstIter iter (inList.begin ()); iter != inList.end (); ++iter)
        inOutStr << " " << *iter;

    return inOutStr;
}


ostream &   operator << (ostream & inOutStr, const NTV2AudioChannelsPerFrameList & inList)
{
    for (NTV2AudioChannelsPerFrameListConstIter iter (inList.begin ());  iter != inList.end ();  ++iter)
        inOutStr << " " << *iter;

    return inOutStr;
}


ostream &   operator << (ostream & inOutStr, const NTV2AudioSourceList & inList)
{
    for (NTV2AudioSourceListConstIter iter(inList.begin());  iter != inList.end();  ++iter)
        switch (*iter)  //  AudioSourceEnum
        {
            case kSourceSDI:    return inOutStr << " SDI";
            case kSourceAES:    return inOutStr << " AES";
            case kSourceADAT:   return inOutStr << " ADAT";
            case kSourceAnalog: return inOutStr << " Analog";
            case kSourceNone:   return inOutStr << " None";
            case kSourceAll:    return inOutStr << " All";
        }
    return inOutStr << " ???";
}


ostream &   operator << (ostream & inOutStr, const NTV2AudioBitsPerSampleList & inList)
{
    for (NTV2AudioBitsPerSampleListConstIter iter (inList.begin ());  iter != inList.end ();  ++iter)
        inOutStr << " " << *iter;

    return inOutStr;
}


ostream &   operator << (ostream & inOutStr, const NTV2DeviceInfo & inInfo)
{
    inOutStr    << "Device Info for '" << inInfo.deviceIdentifier << "'" << endl
                << "            Device Index Number: " << inInfo.deviceIndex << endl
                << "                      Device ID: 0x" << hex << inInfo.deviceID << dec << endl
                << "                  Serial Number: " << inInfo.serialNumber << endl
                << "                       PCI Slot: 0x" << hex << inInfo.pciSlot << dec << endl
                << "                   Video Inputs: " << inInfo.numVidInputs << endl
                << "                  Video Outputs: " << inInfo.numVidOutputs << endl
                #if defined (_DEBUG)
                    << "            Analog Video Inputs: " << inInfo.numAnlgVidInputs << endl
                    << "           Analog Video Outputs: " << inInfo.numAnlgVidOutputs << endl
                    << "              HDMI Video Inputs: " << inInfo.numHDMIVidInputs << endl
                    << "             HDMI Video Outputs: " << inInfo.numHDMIVidOutputs << endl
                    << "               Input Converters: " << inInfo.numInputConverters << endl
                    << "              Output Converters: " << inInfo.numOutputConverters << endl
                    << "                  Up Converters: " << inInfo.numUpConverters << endl
                    << "                Down Converters: " << inInfo.numDownConverters << endl
                    << "           Down Converter Delay: " << inInfo.downConverterDelay << endl
                    << "                       DVCProHD: " << (inInfo.dvcproHDSupport ? "Y" : "N") << endl
                    << "                           Qrez: " << (inInfo.qrezSupport ? "Y" : "N") << endl
                    << "                            HDV: " << (inInfo.hdvSupport ? "Y" : "N") << endl
                    << "                 Quarter Expand: " << (inInfo.quarterExpandSupport ? "Y" : "N") << endl
                    << "                    ISO Convert: " << (inInfo.isoConvertSupport ? "Y" : "N") << endl
                    << "                   Rate Convert: " << (inInfo.rateConvertSupport ? "Y" : "N") << endl
                    << "                        VidProc: " << (inInfo.vidProcSupport ? "Y" : "N") << endl
                    << "                      Dual-Link: " << (inInfo.dualLinkSupport ? "Y" : "N") << endl
                    << "               Color-Correction: " << (inInfo.colorCorrectionSupport ? "Y" : "N") << endl
                    << "               Programmable CSC: " << (inInfo.programmableCSCSupport ? "Y" : "N") << endl
                    << "               RGB Alpha Output: " << (inInfo.rgbAlphaOutputSupport ? "Y" : "N") << endl
                    << "                   Breakout Box: " << (inInfo.breakoutBoxSupport ? "Y" : "N") << endl
                    << "                        ProcAmp: " << (inInfo.procAmpSupport ? "Y" : "N") << endl
                    << "                             2K: " << (inInfo.has2KSupport ? "Y" : "N") << endl
                    << "                             4K: " << (inInfo.has4KSupport ? "Y" : "N") << endl
                    << "                             8K: " << (inInfo.has8KSupport ? "Y" : "N") << endl
                    << "            3G Level Conversion: " << (inInfo.has3GLevelConversion ? "Y" : "N") << endl
                    << "                         ProRes: " << (inInfo.proResSupport ? "Y" : "N") << endl
                    << "                         SDI 3G: " << (inInfo.sdi3GSupport ? "Y" : "N") << endl
                    << "                        SDI 12G: " << (inInfo.sdi12GSupport ? "Y" : "N") << endl
                    << "                             IP: " << (inInfo.ipSupport ? "Y" : "N") << endl
                    << "             SDI Bi-Directional: " << (inInfo.biDirectionalSDI ? "Y" : "N") << endl
                    << "                         LTC In: " << (inInfo.ltcInSupport ? "Y" : "N") << endl
                    << "                        LTC Out: " << (inInfo.ltcOutSupport ? "Y" : "N") << endl
                    << "             LTC In on Ref Port: " << (inInfo.ltcInOnRefPort ? "Y" : "N") << endl
                    << "                     Stereo Out: " << (inInfo.stereoOutSupport ? "Y" : "N") << endl
                    << "                      Stereo In: " << (inInfo.stereoInSupport ? "Y" : "N") << endl
                    << "             Audio Sample Rates: " << inInfo.audioSampleRateList << endl
                    << "           AudioNumChannelsList: " << inInfo.audioNumChannelsList << endl
                    << "         AudioBitsPerSampleList: " << inInfo.audioBitsPerSampleList << endl
                    << "              AudioInSourceList: " << inInfo.audioInSourceList << endl
                    << "             AudioOutSourceList: " << inInfo.audioOutSourceList << endl
                    << "                  Audio Streams: " << inInfo.numAudioStreams << endl
                    << "    Analog Audio Input Channels: " << inInfo.numAnalogAudioInputChannels << endl
                    << "   Analog Audio Output Channels: " << inInfo.numAnalogAudioOutputChannels << endl
                    << "       AES Audio Input Channels: " << inInfo.numAESAudioInputChannels << endl
                    << "      AES Audio Output Channels: " << inInfo.numAESAudioOutputChannels << endl
                    << "  Embedded Audio Input Channels: " << inInfo.numEmbeddedAudioInputChannels << endl
                    << " Embedded Audio Output Channels: " << inInfo.numEmbeddedAudioOutputChannels << endl
                    << "      HDMI Audio Input Channels: " << inInfo.numHDMIAudioInputChannels << endl
                    << "     HDMI Audio Output Channels: " << inInfo.numHDMIAudioOutputChannels << endl
                    << "                    DMA Engines: " << inInfo.numDMAEngines << endl
                    << "                   Serial Ports: " << inInfo.numSerialPorts << endl
                #endif  //  AJA_DEBUG
                << "";

    return inOutStr;

}   //  NTV2DeviceInfo ostream operator <<


ostream &   operator << (ostream & inOutStr, const NTV2AudioPhysicalFormat & inFormat)
{
    inOutStr    << "AudioPhysicalFormat:" << endl
                << "    boardNumber: " << inFormat.boardNumber << endl
                << "     sampleRate: " << inFormat.sampleRate << endl
                << "    numChannels: " << inFormat.numChannels << endl
                << "  bitsPerSample: " << inFormat.bitsPerSample << endl
    #if defined (DEBUG) || defined (AJA_DEBUG)
                << "       sourceIn: 0x" << hex << inFormat.sourceIn << dec << endl
                << "      sourceOut: 0x" << hex << inFormat.sourceOut << dec << endl
    #endif  //  DEBUG or AJA_DEBUG
                ;

    return inOutStr;

}   //  AudioPhysicalFormat ostream operator <<


std::ostream &  operator << (std::ostream & inOutStr, const NTV2AudioPhysicalFormatList & inList)
{
    for (NTV2AudioPhysicalFormatListConstIter iter (inList.begin ()); iter != inList.end (); ++iter)
        inOutStr << *iter;

    return inOutStr;

}   //  AudioPhysicalFormatList ostream operator <<


// Private methods

void CNTV2DeviceScanner::SetDeviceAttributes (NTV2DeviceInfo & devInfo, CNTV2DriverInterface & dev)
{
    const ULWordSet wgtIDs (dev.GetSupportedItems(kNTV2EnumsID_WidgetID));
    devInfo.numVidInputs            = dev.GetNumSupported(kDeviceGetNumVideoInputs);
    devInfo.numVidOutputs           = dev.GetNumSupported(kDeviceGetNumVideoOutputs);
    devInfo.numAnlgVidOutputs       = dev.GetNumSupported(kDeviceGetNumAnalogVideoOutputs);
    devInfo.numAnlgVidInputs        = dev.GetNumSupported(kDeviceGetNumAnalogVideoInputs);
    devInfo.numHDMIVidOutputs       = dev.GetNumSupported(kDeviceGetNumHDMIVideoOutputs);
    devInfo.numHDMIVidInputs        = dev.GetNumSupported(kDeviceGetNumHDMIVideoInputs);
    devInfo.numInputConverters      = dev.GetNumSupported(kDeviceGetNumInputConverters);
    devInfo.numOutputConverters     = dev.GetNumSupported(kDeviceGetNumOutputConverters);
    devInfo.numUpConverters         = dev.GetNumSupported(kDeviceGetNumUpConverters);
    devInfo.numDownConverters       = dev.GetNumSupported(kDeviceGetNumDownConverters);
    devInfo.downConverterDelay      = dev.GetNumSupported(kDeviceGetDownConverterDelay);
    devInfo.dvcproHDSupport         = dev.IsSupported(kDeviceCanDoDVCProHD);
    devInfo.qrezSupport             = dev.IsSupported(kDeviceCanDoQREZ);
    devInfo.hdvSupport              = dev.IsSupported(kDeviceCanDoHDV);
    devInfo.quarterExpandSupport    = dev.IsSupported(kDeviceCanDoQuarterExpand);
    devInfo.colorCorrectionSupport  = dev.IsSupported(kDeviceCanDoColorCorrection);
    devInfo.programmableCSCSupport  = dev.IsSupported(kDeviceCanDoProgrammableCSC);
    devInfo.rgbAlphaOutputSupport   = dev.IsSupported(kDeviceCanDoRGBPlusAlphaOut);
    devInfo.breakoutBoxSupport      = dev.IsSupported(kDeviceCanDoBreakoutBox);
    devInfo.vidProcSupport          = dev.IsSupported(kDeviceCanDoVideoProcessing);
    devInfo.dualLinkSupport         = dev.IsSupported(kDeviceCanDoDualLink);
    devInfo.numDMAEngines           = UWord(dev.GetNumSupported(kDeviceGetNumDMAEngines));
    devInfo.pingLED                 = dev.GetNumSupported(kDeviceGetPingLED);
    devInfo.has2KSupport            = dev.IsSupported(kDeviceCanDo2KVideo);
    devInfo.has4KSupport            = dev.IsSupported(kDeviceCanDo4KVideo);
    devInfo.has8KSupport            = dev.IsSupported(kDeviceCanDo8KVideo);
    devInfo.has3GLevelConversion    = dev.IsSupported(kDeviceCanDo3GLevelConversion);
    devInfo.isoConvertSupport       = dev.IsSupported(kDeviceCanDoIsoConvert);
    devInfo.rateConvertSupport      = dev.IsSupported(kDeviceCanDoRateConvert);
    devInfo.proResSupport           = dev.IsSupported(kDeviceCanDoProRes);
    devInfo.sdi3GSupport            = wgtIDs.find(NTV2_Wgt3GSDIOut1) != wgtIDs.end();
    devInfo.sdi12GSupport           = dev.IsSupported(kDeviceCanDo12GSDI);
    devInfo.ipSupport               = dev.IsSupported(kDeviceCanDoIP);
    devInfo.biDirectionalSDI        = dev.IsSupported(kDeviceHasBiDirectionalSDI);
    devInfo.ltcInSupport            = dev.GetNumSupported(kDeviceGetNumLTCInputs) > 0;
    devInfo.ltcOutSupport           = dev.GetNumSupported(kDeviceGetNumLTCOutputs) > 0;
    devInfo.ltcInOnRefPort          = dev.IsSupported(kDeviceCanDoLTCInOnRefPort);
    devInfo.stereoOutSupport        = dev.IsSupported(kDeviceCanDoStereoOut);
    devInfo.stereoInSupport         = dev.IsSupported(kDeviceCanDoStereoIn);
    devInfo.multiFormat             = dev.IsSupported(kDeviceCanDoMultiFormat);
    devInfo.numSerialPorts          = dev.GetNumSupported(kDeviceGetNumSerialPorts);
    devInfo.procAmpSupport          = false;
}

void CNTV2DeviceScanner::SetAudioAttributes (NTV2DeviceInfo & info, CNTV2DriverInterface & dev)
{
    //  Start with empty lists...
    info.audioSampleRateList.clear();
    info.audioNumChannelsList.clear();
    info.audioBitsPerSampleList.clear();
    info.audioInSourceList.clear();
    info.audioOutSourceList.clear();


    if (dev.GetNumSupported(kDeviceGetNumAudioSystems))
    {
        ULWord audioControl;
        dev.ReadRegister(kRegAud1Control, audioControl);

        //audioSampleRateList
        info.audioSampleRateList.push_back(k48KHzSampleRate);
        if (dev.IsSupported(kDeviceCanDoAudio96K))
            info.audioSampleRateList.push_back(k96KHzSampleRate);

        //audioBitsPerSampleList
        info.audioBitsPerSampleList.push_back(k32bitsPerSample);

        //audioInSourceList
        info.audioInSourceList.push_back(kSourceSDI);
        if (audioControl & BIT(21))
            info.audioInSourceList.push_back(kSourceAES);
        if (dev.IsSupported(kDeviceCanDoAnalogAudio))
            info.audioInSourceList.push_back(kSourceAnalog);

        //audioOutSourceList
        info.audioOutSourceList.push_back(kSourceAll);

        //audioNumChannelsList
        if (dev.IsSupported(kDeviceCanDoAudio2Channels))
            info.audioNumChannelsList.push_back(kNumAudioChannels2);
        if (dev.IsSupported(kDeviceCanDoAudio6Channels))
            info.audioNumChannelsList.push_back(kNumAudioChannels6);
        if (dev.IsSupported(kDeviceCanDoAudio8Channels))
            info.audioNumChannelsList.push_back(kNumAudioChannels8);

        info.numAudioStreams = dev.GetNumSupported(kDeviceGetNumAudioSystems);
    }

    info.numAnalogAudioInputChannels    = dev.GetNumSupported(kDeviceGetNumAnalogAudioInputChannels);
    info.numAESAudioInputChannels       = dev.GetNumSupported(kDeviceGetNumAESAudioInputChannels);
    info.numEmbeddedAudioInputChannels  = dev.GetNumSupported(kDeviceGetNumEmbeddedAudioInputChannels);
    info.numHDMIAudioInputChannels      = dev.GetNumSupported(kDeviceGetNumHDMIAudioInputChannels);
    info.numAnalogAudioOutputChannels   = dev.GetNumSupported(kDeviceGetNumAnalogAudioOutputChannels);
    info.numAESAudioOutputChannels      = dev.GetNumSupported(kDeviceGetNumAESAudioOutputChannels);
    info.numEmbeddedAudioOutputChannels = dev.GetNumSupported(kDeviceGetNumEmbeddedAudioOutputChannels);
    info.numHDMIAudioOutputChannels     = dev.GetNumSupported(kDeviceGetNumHDMIAudioOutputChannels);

}   //  SetAudioAttributes

//  Back door access to sDevInfoList
bool CNTV2DeviceScanner::PatchDeviceInfo (const UWord inDevIndex, CNTV2DriverInterface & dev)       //  STATIC
{
    AJAAutoLock tmpLock(&sDevInfoListLock);
    if (inDevIndex >= UWord(sDevInfoList.size()))
        return false;   //  Bad index
    if (!dev.IsOpen())
        return false;   //  No device instance

    NTV2DeviceInfo & devInfo (sDevInfoList.at(inDevIndex));
    NTV2DeviceID devID (dev.GetDeviceID());
    if (!devID)
        return false;   //  Bad device ID
    if (devID == DEVICE_ID_INVALID)
        return false;   //  Bad device ID

    if (devInfo.deviceID == devID)
        return true;    //  Matching device IDs

    //  Mismatched device IDs -- patch sDevInfoList entry...
    VDNOTE(dev.GetDescription() << ": patched sDevInfoList[" << DEC(inDevIndex) << "]: device ID changed from '"
            << ::NTV2DeviceIDToString(devInfo.deviceID) << "' to '"
            << ::NTV2DeviceIDToString(devID) << "'");
    devInfo.deviceID = devID;
    SetDeviceAttributes (devInfo, dev);
    SetAudioAttributes (devInfo, dev);
    return true;
}

bool CNTV2DeviceScanner::GetVDevList (NTV2DeviceInfoList & outVDevList)
{
#if defined(NTV2_PREVENT_PLUGIN_LOAD)
    return false;   //  Plugin loading disabled, therefore no virtual devices
#else   //  else NTV2_PREVENT_PLUGIN_LOAD
    string vdevPath (::NTV2GetVDevFolderPath());
    if (vdevPath.empty())
        return false;
    ULWord vdIndex (ULWord(outVDevList.size()));
    NTV2StringList vdevFiles;
    AJAFileIO::ReadDirectory(vdevPath, "*.vdev", vdevFiles);
    for (const auto & vdevFile : vdevFiles)
    {
        VDDBUG(vdevFile);
        json vdevJson;
        {
            std::ifstream vf(vdevFile);
            if (!vf.is_open())
                {VDFAIL("Unable to open '" << vdevFile << "'"); return false;}
            try
            {
                vdevJson = json::parse(vf);
            }
            catch (const json::parse_error& e)
            {
                VDFAIL("Invalid JSON at byte " << e.byte << " in '" << vdevFile << "': " << e.what() << ", exceptionID " << e.id);
                return false;
            }
        }

        NTV2DeviceInfo newVDev;
        newVDev.isVirtualDevice     = true;
        newVDev.deviceIndex         = vdIndex;
        newVDev.deviceID            = DEVICE_ID_SOFTWARE;
        newVDev.deviceIdentifier    = "";
        newVDev.vdevName            = "";
        bool explicitlyDisabled(false);

        //  EXPECTED JSON KEYS:
        //  "urlspec"   [required]  Specifies urlspec used to load the plugin.
        //  "name"      [optional]  Specifies a human-readable name for the device.
        //                          If not specified, the .vdev file's base name is used instead.
        //  "disabled"  [optional]  Specify boolean 'true' to explicitly disable the device;  'false' retains device.
        //                          If not specified, the device will always be considered enabled.
        if (vdevJson.size() > 32)
            {VDFAIL("File '" << vdevFile << "': more than 32 keys");  continue;}
        NTV2StringSet keys;
        for (auto it(vdevJson.cbegin());  it != vdevJson.cend();  ++it)
            if (keys.find(it.key()) == keys.end())
                keys.insert(it.key());
        NTV2StringSet legalKeys = {kVDevJSON_Name, kVDevJSON_Disabled, kVDevJSON_URLSpec};
        NTV2StringList goodKeys, badKeys;
        for (NTV2StringSetConstIter itKey(keys.begin());  itKey != keys.end();  ++itKey)
        {
            if (legalKeys.find(*itKey) == legalKeys.end())
                badKeys.push_back(*itKey);
            else
                goodKeys.push_back(*itKey);
        }
        if (!badKeys.empty())
            VDWARN("File '" << vdevFile << "': ignored " << DEC(badKeys.size()) << " unknown key(s): '" << aja::join(badKeys, "', '") << "'");
        auto nameVal (vdevJson[kVDevJSON_Name]), urlspecVal (vdevJson[kVDevJSON_URLSpec]), disabledVal (vdevJson[kVDevJSON_Disabled]);
        if (urlspecVal.is_null())
            {VDFAIL("File '" << vdevFile << "': missing required 'urlspec' parameter");  continue;}
        if (disabledVal.is_boolean())
        {
            NTV2_ASSERT(!disabledVal.is_null());
            explicitlyDisabled = disabledVal.get<bool>();
        }
        else if (!disabledVal.is_null())
            {VDFAIL("File '" << vdevFile << "': invalid 'disabled' value -- expected boolean 'true' or 'false' value");  continue;}
        if (explicitlyDisabled)
            {VDINFO("File '" << vdevFile << "': explicitly 'disabled'");  continue;}
        newVDev.vdevUrl = urlspecVal.get<std::string>();    //  done, we have the vdevUrl
        NTV2DeviceSpecParser parser (newVDev.vdevUrl);  //  Check it
        if (!nameVal.is_null())
            newVDev.vdevName = nameVal.get<std::string>();  //  Name specified in JSON file
        {   //  URLencode & append these URL params:  &vdevfname=   &vdevfpath=    &vdevname=   &vdevbasename=
            newVDev.vdevUrl += parser.HasQueryParams() ? "&" : "?";
            newVDev.vdevUrl += kQParamVDevFolderPath "=" + ::PercentEncode(vdevPath);
            string fName (vdevFile);
            fName.erase(fName.find(vdevPath), vdevPath.length()+1);     //  Remove everything up to file name
            newVDev.vdevUrl += "&" kQParamVDevFileName "=" + ::PercentEncode(fName);    //  Remember file name
            fName.erase(fName.length()-5, 5);                           //  Lop off file name extension
            if (newVDev.vdevName.empty())
                newVDev.vdevName = fName;   //  Use file base name if no name specified in JSON file
            newVDev.vdevUrl += "&" kQParamVDevName "=" + ::PercentEncode(newVDev.vdevName); //  Remember name
            ostringstream oss; oss << DEC(newVDev.deviceIndex);
            newVDev.vdevUrl += "&" kQParamVDevIndex "=" + oss.str();    //  Remember index number
        }
        if (!newVDev.vdevName.empty())
        {   ostringstream oss;  oss << newVDev.vdevName << " - " << newVDev.deviceIndex;
            newVDev.deviceIdentifier = oss.str();
        }

        outVDevList.push_back(newVDev);
        vdIndex++;  //  Now increment the device index number
    }   //  for each vdev file found
    return true;
#endif  //  else NTV2_PREVENT_PLUGIN_LOAD
}   //  GetVDevList

bool CNTV2DeviceScanner::GetCP2DevList (NTV2DeviceInfoList & outVDevList)
{
#if defined(NTV2_PREVENT_PLUGIN_LOAD)
    return false;   //  Plugin loading disabled, therefore no virtual devices
#else   //  else NTV2_PREVENT_PLUGIN_LOAD
    string vdevPath;
    {   const AJASystemInfo pathInfo(AJA_SystemInfoMemoryUnit_Megabytes, AJA_SystemInfoSection_Path);
        if (pathInfo.GetValue(AJA_SystemInfoTag_Path_PersistenceStoreUser, vdevPath) != AJA_STATUS_SUCCESS)
            return false;
    }
    vdevPath += "virtualdevices";
    ULWord vdIndex = ULWord(outVDevList.size());
    NTV2StringList vdevFiles;
    AJAFileIO::ReadDirectory(vdevPath, "*.vdev", vdevFiles);
    for (const auto & vdevFile : vdevFiles)
    {
        json vdevJson;
        {
            std::ifstream vf(vdevFile);
            if (!vf.is_open())
                {C2FAIL("Unable to open '" << vdevFile << "'"); return false;}
            try
            {
                vdevJson = json::parse(vf);
            }
            catch (const json::parse_error& e)
            {
                C2FAIL("Invalid JSON at byte " << e.byte << " in '" << vdevFile << "': " << e.what() << ", exceptionID " << e.id);
                return false;
            }
        }

        NTV2DeviceInfo newVDev;
        newVDev.isVirtualDevice     = true;
        newVDev.deviceIndex         = vdIndex++;
        newVDev.deviceID            = DEVICE_ID_SOFTWARE;
        newVDev.deviceIdentifier    = "";
        newVDev.vdevName            = "";

        //  EXPECTED JSON KEYS:
        //  "plugin"    [required]  Specifies name of plugin to be loaded.
        //  "name"      [optional]  Specifies a human-readable name for the device.
        //  "host"      [optional]  Specifies host to use in the plugin URL. Defaults to "localhost".
        string hostName;
        auto pluginVal (vdevJson["plugin"]), nameVal (vdevJson["name"]), hostVal (vdevJson["host"]), urlspecVal (vdevJson["urlspec"]);
        if (pluginVal.is_null())
            {C2FAIL("File: '" << vdevFile << "' missing required 'plugin' parameter");  continue;}
        if (!urlspecVal.is_null())
            C2WARN("File: '" << vdevFile << "' 'urlspec' parameter ignored");

        newVDev.vdevUrl = pluginVal.get<std::string>();
        if (!nameVal.is_null())
        {
            ostringstream oss;
            oss << nameVal.get<std::string>() << " - " << newVDev.deviceIndex;
            newVDev.deviceIdentifier = oss.str();
            newVDev.vdevName = nameVal.get<std::string>();
        }

        if (!hostVal.is_null())
            hostName = hostVal.get<std::string>();
        if (hostName.empty())
            hostName = "localhost";
        newVDev.vdevUrl += "://" + hostName + "/?";

        NTV2StringList params;
        for (auto it (vdevJson.begin());  it != vdevJson.end();  ++it)
            if (it.key() != "plugin"  &&  it.key() != "name"  &&  it.key() != "host")
            {
                auto paramValStr = to_string(it.value());
                aja::strip(paramValStr, "\"");
                params.push_back(it.key() + "=" + ::PercentEncode(paramValStr));
            }

        if (!newVDev.deviceIdentifier.empty())
            params.push_back("displayname=" + ::PercentEncode(newVDev.deviceIdentifier));
        const string queryStr(aja::join(params, "&"));
        if (!queryStr.empty())
            newVDev.vdevUrl += "?" + queryStr;
        outVDevList.push_back(newVDev);
    }   //  for each .vdev file found
    return true;
#endif  //  else NTV2_PREVENT_PLUGIN_LOAD
}   //  GetCP2DeviceList