ancillarylist.h

Go to the documentation of this file.

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

#include "ancillarydata.h"
#include "ntv2formatdescriptor.h"
#include <map>
#include <set>

//  Starting with SDK 16.3, AJAAncillaryList is implemented using std::vector,
//  which is faster than std::list, which is what was used in SDK 16.2.x and earlier.
#define AJAANCLISTIMPL_VECTOR   //  Comment out this line to revert to pre-16.3 behavior
#if defined(AJAANCLISTIMPL_VECTOR)
    #include <vector>
#else
    #include <list>
#endif


// used for "match any" searches and counts
const uint8_t AJAAncillaryDataWildcard_DID = 0xFF;
const uint8_t AJAAncillaryDataWildcard_SID = 0xFF;

typedef std::map <uint16_t, AJAAncDataType> AJAAncillaryAnalogTypeMap;

typedef std::vector<ULWordSequence> AJAU32Pkts;                     
typedef AJAU32Pkts::const_iterator  AJAU32PktsConstIter;            
typedef AJAU32Pkts::iterator        AJAU32PktsIter;                 

typedef UByteSequence               AJAAncPktCounts;                
typedef AJAAncPktCounts::const_iterator AJAAncPktCountsConstIter;   
class CNTV2Card;

typedef std::set<AJAAncPktDIDSID>           AJAAncPktDIDSIDSet;             
typedef AJAAncPktDIDSIDSet::const_iterator  AJAAncPktDIDSIDSetConstIter;    
typedef AJAAncPktDIDSIDSet::iterator        AJAAncPktDIDSIDSetIter;         


class AJAExport AJAAncillaryList
{
public: //  CLASS METHODS


    static AJAStatus                        SetFromVANCData (const NTV2Buffer & inFrameBuffer,
                                                            const NTV2FormatDescriptor & inFormatDesc,
                                                            AJAAncillaryList & outPackets,
                                                            const uint32_t inFrameNum = 0);

    static AJAStatus                        SetFromDeviceAncBuffers (const NTV2Buffer & inF1AncBuffer,
                                                                    const NTV2Buffer & inF2AncBuffer,
                                                                    AJAAncillaryList & outPackets,
                                                                    const uint32_t inFrameNum = 0);

    static AJAStatus                        SetFromDeviceAuxBuffers (const NTV2Buffer & inF1AuxBuffer,
                                                                    const NTV2Buffer & inF2AuxBuffer,
                                                                    AJAAncillaryList & outPackets,
                                                                    const uint32_t inFrameNum = 0);


    static AJAStatus                        ClearAnalogAncillaryDataTypeMap (void);
    

    static AJAStatus                        SetAnalogAncillaryDataTypeMap (const AJAAncillaryAnalogTypeMap & inMap);
    

    static AJAStatus                        GetAnalogAncillaryDataTypeMap (AJAAncillaryAnalogTypeMap & outMap);


    static  AJAStatus                       SetAnalogAncillaryDataTypeForLine (const uint16_t inLineNum, const AJAAncDataType inType);


    static AJAAncDataType                   GetAnalogAncillaryDataTypeForLine (const uint16_t inLineNum);


    static void                             SetIncludeZeroLengthPackets (const bool inExclude);
    static uint32_t                         GetExcludedZeroLengthPacketCount (void);    
    static void                             ResetExcludedZeroLengthPacketCount (void);  
    static bool                             IsIncludingZeroLengthPackets (void);        


public: //  INSTANCE METHODS
                                            AJAAncillaryList ();            
    inline                                  AJAAncillaryList (const AJAAncillaryList & inRHS)   {*this = inRHS;}    
    virtual                                 ~AJAAncillaryList ();           

    virtual AJAAncillaryList &              operator = (const AJAAncillaryList & inRHS);

#if defined(AJA_USE_CPLUSPLUS11)

                                            AJAAncillaryList (AJAAncillaryList && inRHS) noexcept;  //  (New in SDK 17.5)
    virtual AJAAncillaryList &              operator = (AJAAncillaryList && inRHS); //  (New in SDK 17.5)
#endif  //  AJA_USE_CPLUSPLUS11



    virtual inline uint32_t                 CountAncillaryData (void) const             {return uint32_t(m_ancList.size());}

    virtual inline bool                     IsEmpty (void) const                        {return !CountAncillaryData();}

    virtual AJAAncillaryData *              GetAncillaryDataAtIndex (const uint32_t inIndex) const;

    virtual uint32_t                        CountAncillaryDataWithType (const AJAAncDataType inMatchType) const;

    virtual AJAAncillaryData *              GetAncillaryDataWithType (const AJAAncDataType inMatchType, const uint32_t inIndex = 0) const;

    virtual uint32_t                        CountAncillaryDataWithID (const uint8_t inDID, const uint8_t inSID) const;

    virtual AJAAncillaryData *              GetAncillaryDataWithID (const uint8_t inDID, const uint8_t inSID, const uint32_t inIndex = 0) const;

    virtual AJAAncPktDIDSIDSet              GetAncillaryPacketIDs (void) const; 



    virtual AJAStatus                       Clear (void);

    virtual AJAStatus                       AddAncillaryData (const AJAAncillaryList & inPackets);

    virtual AJAStatus                       AddAncillaryData (const AJAAncillaryData * pInAncData);

    virtual inline AJAStatus                AddAncillaryData (const AJAAncillaryData & inAncData)   {return AddAncillaryData(&inAncData);}

    virtual AJAStatus                       RemoveAncillaryData (AJAAncillaryData * pInAncData);

    virtual AJAStatus                       DeleteAncillaryData (AJAAncillaryData * pInAncData);



    virtual AJAStatus                       SortListByDID (void);

    virtual AJAStatus                       SortListBySID (void);

    virtual AJAStatus                       SortListByLocation (void);

    virtual AJAStatus                       Compare (const AJAAncillaryList & inCompareList, const bool inIgnoreLocation = true,  const bool inIgnoreChecksum = true) const;

    virtual std::string                     CompareWithInfo (const AJAAncillaryList & inCompareList, const bool inIgnoreLocation = true,  const bool inIgnoreChecksum = true) const;

    virtual bool                            CompareWithInfo (std::vector<std::string> & outDiffs, const AJAAncillaryList & inCompareList, const bool inIgnoreLocation = true,  const bool inIgnoreChecksum = true) const;   //  New in SDK 16.3



    virtual AJAStatus                       GetAncillaryDataTransmitSize (const bool inIsProgressive, const uint32_t inF2StartLine,
                                                                            uint32_t & outF1ByteCount, uint32_t & outF2ByteCount);


    virtual AJAStatus                       GetAncillaryDataTransmitData (const bool inIsProgressive, const uint32_t inF2StartLine,
                                                                            uint8_t * pOutF1AncData, const uint32_t inF1ByteCountMax,
                                                                            uint8_t * pOutF2AncData, const uint32_t inF2ByteCountMax);

    virtual AJAStatus                       GetTransmitData (NTV2Buffer & F1Buffer, NTV2Buffer & F2Buffer,
                                                            const bool inIsProgressive = true, const uint32_t inF2StartLine = 0);

    virtual inline AJAStatus                GetSDITransmitData (NTV2Buffer & F1Buffer, NTV2Buffer & F2Buffer,
                                                                const bool inIsProgressive = true, const uint32_t inF2StartLine = 0)
                                                                            {return GetTransmitData(F1Buffer, F2Buffer, inIsProgressive, inF2StartLine);}   

    virtual AJAStatus                       GetVANCTransmitData (NTV2Buffer & inFrameBuffer,  const NTV2FormatDescriptor & inFormatDesc);

    virtual AJAStatus                       GetIPTransmitData (NTV2Buffer & F1Buffer, NTV2Buffer & F2Buffer,
                                                                const bool inIsProgressive = true, const uint32_t inF2StartLine = 0);

    virtual inline AJAStatus                GetHDMITransmitData (NTV2Buffer & F1Buffer, NTV2Buffer & F2Buffer,
                                                                const bool inIsProgressive = true, const uint32_t inF2StartLine = 0)
                                                                            {return AJA_STATUS_UNSUPPORTED;}

    virtual AJAStatus                       GetIPTransmitDataLength (uint32_t & outF1ByteCount, uint32_t & outF2ByteCount,
                                                                    const bool inIsProgressive = true, const uint32_t inF2StartLine = 0);

    virtual inline bool                     AllowMultiRTPTransmit (void) const                  {return m_xmitMultiRTP;}

    virtual inline void                     SetAllowMultiRTPTransmit (const bool inAllow)       {m_xmitMultiRTP = inAllow;}



    virtual AJAStatus           AddReceivedAncillaryData (const NTV2Buffer & inReceivedData, const uint32_t inFrameNum = 0);    //  New in SDK 17.1

    virtual AJAStatus           AddReceivedAuxiliaryData (const NTV2Buffer & inReceivedData, const uint32_t inFrameNum = 0);    //  New in SDK 17.1

    virtual AJAStatus           AddReceivedAncillaryData (const ULWordSequence & inReceivedData);


    virtual AJAStatus           AddVANCData (const UWordSequence & inPacketWords,
                                            const AJAAncillaryDataLocation & inLocation,
                                            const uint32_t inFrameNum = 0);

    virtual inline bool         AllowMultiRTPReceive (void) const                   {return m_rcvMultiRTP;}

    virtual inline void         SetAllowMultiRTPReceive (const bool inAllow)        {m_rcvMultiRTP = inAllow;}

    virtual inline bool         IgnoreChecksumErrors (void) const   {return m_ignoreCS;}

    virtual inline void         SetIgnoreChecksumErrors (const bool inIgnore)       {m_ignoreCS = inIgnore;}

    virtual AJAStatus           ParseAllAncillaryData (void);

    virtual inline AJAStatus    AddReceivedAncillaryData (  const uint8_t * rcvData,                        \
                                                            const uint32_t rcvCnt,                          \
                                                            const uint32_t frmNum = 0)                      \
                                {   return AddReceivedAncillaryData (NTV2Buffer (rcvData, rcvCnt), frmNum); \
                                }   



    virtual std::ostream &      Print (std::ostream & oss, const bool inDetailed = true) const;

    static bool                 StripNativeInserterGUMPPackets (const NTV2Buffer & inSrc, NTV2Buffer & outDst);

protected:
    friend class CNTV2Card; //  CNTV2Card's member functions can call AJAAncillaryList's private & protected member functions

#if defined(AJAANCLISTIMPL_VECTOR)
    typedef std::vector <AJAAncillaryData*>         AJAAncillaryDataList;
#else
    typedef std::list <AJAAncillaryData*>           AJAAncillaryDataList;
#endif
    typedef AJAAncillaryDataList::const_iterator    AJAAncDataListConstIter;    
    typedef AJAAncillaryDataList::iterator          AJAAncDataListIter;         

    virtual inline AJAAncDataType                   GetAnalogAncillaryDataType (const AJAAncillaryData & inAncData) {return GetAnalogAncillaryDataTypeForLine(inAncData.GetLocationLineNumber());}

    static inline bool                      BufferHasGUMPData (const NTV2Buffer & inBuffer) {return inBuffer ? inBuffer.U8(0) == 0xFF : false;}

    static AJAStatus                        AddFromDeviceAncBuffer (const NTV2Buffer & inAncBuffer,
                                                                    AJAAncillaryList & outPacketList,
                                                                    const uint32_t inFrameNum = 0);

    static AJAStatus                        AddFromDeviceAuxBuffer (const NTV2Buffer & inAuxBuffer,
                                                                    AJAAncillaryList & outPacketList,
                                                                    const uint32_t inFrameNum = 0);

    virtual AJAStatus                       GetRTPPackets (AJAU32Pkts & outF1U32Pkts,
                                                            AJAU32Pkts & outF2U32Pkts,
                                                            AJAAncPktCounts & outF1AncCounts,
                                                            AJAAncPktCounts & outF2AncCounts,
                                                            const bool inIsProgressive,
                                                            const uint32_t inF2StartLine);
    static AJAStatus                        WriteRTPPackets (NTV2Buffer & theBuffer,
                                                            uint32_t & outBytesWritten,
                                                            const AJAU32Pkts & inRTPPkts,
                                                            const AJAAncPktCounts & inAncCounts,
                                                            const bool inIsF2,
                                                            const bool inIsProgressive);

private:
    AJAAncillaryDataList    m_ancList;      
    bool                    m_rcvMultiRTP;  
    bool                    m_xmitMultiRTP; 
    bool                    m_ignoreCS;     

};  //  AJAAncillaryList

typedef AJAAncillaryList    AJAAuxiliaryList, AJAAncList, AJAAuxList;


inline std::ostream & operator << (std::ostream & inOutStream, const AJAAncillaryList & inList)     {return inList.Print(inOutStream);}

AJAExport std::ostream & operator << (std::ostream & inOutStream, const AJAU32Pkts & inPkts);

AJAExport std::ostream & operator << (std::ostream & inOutStream, const AJAAncPktDIDSIDSet & inSet);    //  New in SDK 16.0

#endif  // AJA_ANCILLARYLIST_H