ntv2signalrouter.h

Go to the documentation of this file.

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

#include "ajaexport.h"
#include "ntv2publicinterface.h"
#include <stddef.h>
#include <set>
#include <map>

typedef std::set <NTV2OutputXptID>          NTV2OutputCrosspointIDSet,          NTV2OutputXptIDSet;             
typedef NTV2OutputXptIDSet::const_iterator  NTV2OutputCrosspointIDSetConstIter, NTV2OutputXptIDSetConstIter;    
typedef NTV2OutputXptIDSet::iterator        NTV2OutputCrosspointIDSetIter,      NTV2OutputXptIDSetIter;         

AJAExport std::ostream & operator << (std::ostream & inOutStream, const NTV2OutputXptIDSet & inObj);

typedef NTV2OutputCrosspointIDSet                   NTV2CrosspointIDSet;        

typedef std::set <NTV2InputXptID>                   NTV2InputCrosspointIDSet,           NTV2InputXptIDSet;          
typedef NTV2InputXptIDSet::const_iterator           NTV2InputCrosspointIDSetConstIter,  NTV2InputXptIDSetConstIter; 
typedef NTV2InputXptIDSet::iterator                 NTV2InputCrosspointIDSetIter,       NTV2InputXptIDSetIter;      

AJAExport std::ostream & operator << (std::ostream & inOutStream, const NTV2InputXptIDSet & inObj);

typedef std::set <NTV2WidgetID>                     NTV2WidgetIDSet;            
typedef NTV2WidgetIDSet::const_iterator             NTV2WidgetIDSetConstIter;   

AJAExport std::ostream & operator << (std::ostream & inOutStream, const NTV2WidgetIDSet & inObj);


typedef std::pair <NTV2InputXptID, NTV2OutputXptID>     NTV2SignalConnection, NTV2XptConnection, NTV2Connection;    
typedef std::map <NTV2InputXptID, NTV2OutputXptID>      NTV2XptConnections, NTV2ActualConnections;  
typedef NTV2XptConnections::const_iterator              NTV2XptConnectionsConstIter, NTV2ActualConnectionsConstIter;
typedef std::multimap <NTV2InputXptID, NTV2OutputXptID> NTV2PossibleConnections;    
typedef NTV2PossibleConnections::const_iterator         NTV2PossibleConnectionsConstIter;

AJAExport std::ostream & operator << (std::ostream & inOutStream, const NTV2XptConnection & inObj);
AJAExport std::ostream & operator << (std::ostream & inOutStream, const NTV2XptConnections & inObj);
AJAExport std::ostream & operator << (std::ostream & inOutStream, const NTV2PossibleConnections & inObj);   //  New in SDK 18.1

class AJAExport CNTV2SignalRouter
{
    //  Instance Methods
    public:
        inline                                      CNTV2SignalRouter ()            {Reset ();}     
        virtual inline                              ~CNTV2SignalRouter ()           {}              

        virtual bool                                AddConnection (const NTV2InputXptID inSignalInput, const NTV2OutputXptID inSignalOutput = NTV2_XptBlack);

        virtual bool                                RemoveConnection (const NTV2InputXptID inSignalInput, const NTV2OutputXptID inSignalOutput);

        virtual bool                                HasConnection (const NTV2InputXptID inSignalInput, const NTV2OutputXptID inSignalOutput) const;

        virtual bool                                HasInput (const NTV2InputXptID inSignalInput) const;

        virtual NTV2OutputXptID                     GetConnectedOutput (const NTV2InputXptID inSignalInput) const;

        virtual inline void                         Reset (void)                                        {mConnections.clear ();}

        virtual bool                                ResetFromRegisters (const NTV2InputXptIDSet & inInputXpts, const NTV2RegisterReads & inRegReads);

        virtual bool                                ResetFrom (const NTV2XptConnections & inConnections)    {mConnections = inConnections; return true;}    //  New in SDK 16.0

        virtual inline ULWord                       GetNumberOfConnections (void) const                 {return ULWord (mConnections.size ());}

        virtual inline bool                         IsEmpty (void) const                                {return mConnections.empty();}

        virtual inline NTV2XptConnections           GetConnections (void) const                         {return mConnections;}

        virtual bool                                GetRegisterWrites (NTV2RegisterWrites & outRegWrites) const;

        virtual bool                                Compare (const CNTV2SignalRouter & inRHS,
                                                            NTV2XptConnections & outNew,
                                                            NTV2XptConnections & outChanged,
                                                            NTV2XptConnections & outMissing) const;

        virtual inline bool         operator == (const CNTV2SignalRouter & inRHS) const     {NTV2XptConnections tmp; return Compare(inRHS, tmp,tmp,tmp);}

        virtual inline bool         operator != (const CNTV2SignalRouter & inRHS) const     {return !(inRHS == *this);}

        virtual std::ostream &      Print (std::ostream & inOutStream, const bool inForRetailDisplay = false) const;

        struct AJAExport PrintCodeConfig
        {
            bool        mShowComments       = true;     
            bool        mShowDeclarations   = true;     
            bool        mUseRouter          = false;    
            std::string mPreCommentText     = "// ";    
            std::string mPostCommentText    = "";       
            std::string mPreClassText       = "";       
            std::string mPostClassText      = "";       
            std::string mPreVariableText    = "";       
            std::string mPostVariableText   = "";       
            std::string mPreXptText         = "";       
            std::string mPostXptText        = "";       
            std::string mPreFunctionText    = "";       
            std::string mPostFunctionText   = "";       
            std::string mDeviceVarName      = "device"; 
            std::string mRouterVarName      = "router"; 
            std::string mLineBreakText      = "\n";     
            std::string mFieldBreakText     = "\t";     
            NTV2XptConnections mNew         = {};       
            NTV2XptConnections mChanged     = {};       
            NTV2XptConnections mMissing     = {};       

            PrintCodeConfig ()  {}
        };

        virtual bool                                PrintCode (std::string & outCode, const PrintCodeConfig & inConfig = PrintCodeConfig()) const;

    //  Instance Data
    private:
        typedef NTV2XptConnections::iterator        NTV2XptConnectionsIter;

        NTV2XptConnections                          mConnections;       


    public: //  CLASS METHODS
        static bool                 GetRouteROMInfoFromReg (const ULWord inROMRegNum, const ULWord inROMRegValue,
                                                            NTV2InputXptID & outInputXpt, NTV2OutputXptIDSet & outOutputXpts,
                                                            const bool inAppendOutputXpts = false); //  New in SDK 16.0;  moved into CNTV2SignalRouter in SDK 16.1

        static bool                 GetPossibleConnections (const NTV2RegReads & inROMRegisters,
                                                            NTV2PossibleConnections & outConnections);  //  New in SDK 16.0;  moved into CNTV2SignalRouter in SDK 16.1

        static bool                 MakeRouteROMRegisters (NTV2RegReads & outROMRegisters); //  New in SDK 16.0;  moved into CNTV2SignalRouter in SDK 16.1

        static std::string          NTV2InputCrosspointIDToString (const NTV2InputXptID inInputXpt);

        static std::string          NTV2OutputCrosspointIDToString (const NTV2OutputXptID inOutputXpt);

        static NTV2InputXptID       StringToNTV2InputCrosspointID (const std::string & inStr);

        static NTV2OutputXptID      StringToNTV2OutputCrosspointID (const std::string & inStr);

        static bool                 GetWidgetIDs (const NTV2DeviceID inDeviceID, NTV2WidgetIDSet & outWidgets);

        static bool                 GetWidgetsForOutput (const NTV2OutputXptID inOutputXpt, NTV2WidgetIDSet & outWidgetIDs);

        static bool                 GetWidgetForOutput (const NTV2OutputXptID inOutputXpt, NTV2WidgetID & outWidgetID, const NTV2DeviceID inDeviceID = DEVICE_ID_NOTFOUND);

        static bool                 GetWidgetsForInput (const NTV2InputXptID inInputXpt, NTV2WidgetIDSet & outWidgetIDs);

        static bool                 GetWidgetForInput (const NTV2InputXptID inInputXpt, NTV2WidgetID & outWidgetID, const NTV2DeviceID inDeviceID = DEVICE_ID_NOTFOUND);

        static bool                 GetWidgetInputs (const NTV2WidgetID inWidgetID, NTV2InputXptIDSet & outInputs);

        static bool                 GetAllWidgetInputs (const NTV2DeviceID inDeviceID, NTV2InputXptIDSet & outInputs);

        static bool                 GetAllRoutingRegInfos (const NTV2InputXptIDSet & inInputs, NTV2RegisterWrites & outRegInfos);

        static bool                 GetWidgetOutputs (const NTV2WidgetID inWidgetID, NTV2OutputXptIDSet & outOutputs);

        static bool                 GetAllWidgetOutputs (const NTV2DeviceID inDeviceID, NTV2OutputXptIDSet & outOutputs);   //  New in SDK 17.5

        static bool                 GetConnectionsFromRegs (const NTV2InputXptIDSet & inInputXptIDs, const NTV2RegisterReads & inRegValues, NTV2XptConnections & outConnections);   //  New in SDK 16.0

        static bool                 IsRGBOnlyInputXpt (const NTV2InputXptID inInputXpt);    //  New in SDK 16.0

        static bool                 IsYUVOnlyInputXpt (const NTV2InputXptID inInputXpt);    //  New in SDK 16.0

        static bool                 IsKeyInputXpt (const NTV2InputXptID inInputXpt);    //  New in SDK 16.0

        static NTV2Channel          WidgetIDToChannel (const NTV2WidgetID inWidgetID); // New in SDK 16.1

        static NTV2WidgetID         WidgetIDFromTypeAndChannel(const NTV2WidgetType inWidgetType, const NTV2Channel inChannel); // New in SDK 16.1
        
        static NTV2WidgetType       WidgetIDToType (const NTV2WidgetID inWidgetID); // New in SDK 16.1

        static bool                 IsSDIWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 IsSDIInputWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 IsSDIOutputWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 Is3GSDIWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 Is12GSDIWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 IsDualLinkWidgetType (const NTV2WidgetType inWidgetType);   // New in SDK 16.1

        static bool                 IsDualLinkInWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 IsDualLinkOutWidgetType (const NTV2WidgetType inWidgetType);    // New in SDK 16.1

        static bool                 IsHDMIWidgetType (const NTV2WidgetType inWidgetType);   // New in SDK 16.1

        static bool                 IsHDMIInWidgetType (const NTV2WidgetType inWidgetType); // New in SDK 16.1

        static bool                 IsHDMIOutWidgetType (const NTV2WidgetType inWidgetType);    // New in SDK 16.1

        static bool                 CompareConnections (const NTV2XptConnections & inLHS,
                                                        const NTV2XptConnections & inRHS,
                                                        NTV2XptConnections & outNew,
                                                        NTV2XptConnections & outRemoved);   //  New in SDK 16.0

        static bool                 CreateFromString (const std::string & inString, NTV2XptConnections & outConnections);   //  New in SDK 16.0

        static bool                 CreateFromString (const std::string & inString, NTV2PossibleConnections & outConns);    //  New in SDK 18.1

        static bool                 CreateFromString (const std::string & inString, CNTV2SignalRouter & outRouter);

        static bool                 ToCodeString (std::string & outCode, const NTV2XptConnections & inConnections,
                                                    const PrintCodeConfig & inConfig = PrintCodeConfig());  //  New in SDK 16.0

        static bool                 IsInitialized(void);    

        static bool                 Initialize(void);

        static bool                 Deinitialize(void);

};  //  CNTV2SignalRouter


AJAExport NTV2InputXptID        GetFrameStoreInputXptFromChannel (const NTV2Channel inFrameStore, const bool inIsBInput = false);   //  Renamed in SDK 17.5

AJAExport NTV2InputXptID        GetCSCInputXptFromChannel (const NTV2Channel inCSC, const bool inIsKeyInput = false);

AJAExport NTV2InputXptID        GetLUTInputXptFromChannel (const NTV2Channel inLUT);    //  New in SDK 16.0

AJAExport NTV2InputXptID        GetDLInInputXptFromChannel (const NTV2Channel inChannel, const bool inLinkB = false);

AJAExport NTV2InputXptID        GetDLOutInputXptFromChannel (const NTV2Channel inDLOutWidget);

AJAExport NTV2OutputXptID       GetCSCOutputXptFromChannel (const NTV2Channel inCSC, const bool inIsKey = false, const bool inIsRGB = false);

AJAExport NTV2OutputXptID       GetLUTOutputXptFromChannel (const NTV2Channel inLUT);   //  New in SDK 16.0

AJAExport NTV2OutputXptID       GetFrameStoreOutputXptFromChannel (const NTV2Channel inFrameStore, const bool inIsRGB = false, const bool inIs425 = false); //  Renamed in SDK 17.5

AJAExport NTV2OutputXptID       GetInputSourceOutputXpt (const NTV2InputSource inInputSource,  const bool inIsSDI_DS2 = false,
                                                        const bool inIsHDMI_RGB = false,  const UWord inHDMI_Quadrant = 0);

AJAExport NTV2OutputXptID       GetSDIInputOutputXptFromChannel (const NTV2Channel inSDIInput,  const bool inIsDS2 = false);

AJAExport NTV2OutputXptID       GetDLOutOutputXptFromChannel(const NTV2Channel inDLOutput, const bool inIsLinkB = false);

AJAExport NTV2OutputXptID       GetDLInOutputXptFromChannel(const NTV2Channel inDLInput);

AJAExport NTV2InputXptID        GetOutputDestInputXpt (const NTV2OutputDestination inOutputDest,  const bool inIsSDI_DS2 = false,  const UWord inHDMI_Quadrant = 99);

AJAExport NTV2InputXptID        GetSDIOutputInputXpt (const NTV2Channel inSDIOutput,  const bool inIsDS2 = false);

AJAExport NTV2OutputXptID       GetMixerOutputXptFromChannel (const NTV2Channel inChannel, const bool inIsKey = false);

AJAExport NTV2InputXptID        GetMixerFGInputXpt (const NTV2Channel inChannel,  const bool inIsKey = false);

AJAExport NTV2InputXptID        GetMixerBGInputXpt (const NTV2Channel inChannel,  const bool inIsKey = false);

AJAExport NTV2InputXptID         GetTSIMuxInputXptFromChannel(const NTV2Channel inTSIMuxer, const bool inLinkB = false);

AJAExport NTV2OutputXptID       GetTSIMuxOutputXptFromChannel (const NTV2Channel inTSIMuxer, const bool inLinkB = false, const bool inIsRGB = false);


//  Stream operators
AJAExport std::ostream & operator << (std::ostream & inOutStream, const CNTV2SignalRouter & inObj);

#if !defined(NTV2_DEPRECATE_17_5)
    #define GetFrameBufferOutputXptFromChannel  GetFrameStoreOutputXptFromChannel
    #define GetFrameBufferInputXptFromChannel   GetFrameStoreInputXptFromChannel
#endif  //  !defined(NTV2_DEPRECATE_17_5)

#endif  //  NTV2SIGNALROUTER_H