ntv2smpteancdata.h

Go to the documentation of this file.

#ifndef __NTV2_SMPTEANCDATA_
#define __NTV2_SMPTEANCDATA_

#include "ntv2utils.h"
#include "ntv2formatdescriptor.h"
#include <vector>
#include <iostream>
#ifdef MSWindows
    #include "windows.h"
#endif


// Some popular ancillary packet DID/SDID's (sans parity)
const UByte NTV2_SMPTEAncRP334DID   = 0x61;     // SMPTE 334 (Closed Captioning)
const UByte NTV2_SMPTEAncRP334SDID  = 0x01;
const UWord NTV2_WildCardDID        = 0x2FF;    // Wild Card - Match any Data ID
const UWord NTV2_WildCardSDID       = 0x2FF;    // Wild Card - Match any Secondary Data ID


// SMPTE 291 Ancillary Packet data structures
typedef struct NTV2_SMPTEAncHeader
{
    UWord   ancDataFlag0;   // 0x000
    UWord   ancDataFlag1;   // 0x3FF
    UWord   ancDataFlag2;   // 0x3FF
    UWord   ancDataID;      // DID
    UWord   ancSecDID;      // SDID (or Data Block Number)
    UWord   ancDataCount;   // DC

    inline NTV2_SMPTEAncHeader (const UWord inDID = 0, const UWord inSDID = 0, const UWord inDataCount = 0)
        :   ancDataFlag0    (0x000),
            ancDataFlag1    (0x3FF),
            ancDataFlag2    (0x3FF),
            ancDataID       (inDID),
            ancSecDID       (inSDID),
            ancDataCount    (inDataCount)
    {
    }

} NTV2_SMPTEAncHeader, *NTV2_SMPTEAncHeaderPtr;


const UWord kAncHeaderSize  = sizeof (NTV2_SMPTEAncHeader) / sizeof (UWord);


typedef struct NTV2_SMPTEAncFooter
{
    UWord   ancChecksum;    // anc packet checksum

} NTV2_SMPTEAncFooter, * NTV2_SMPTEAncFooterPtr;


const UWord     kAncFooterSize      = sizeof (NTV2_SMPTEAncFooter) / sizeof (UWord);
const ULWord    kMaxAncPacketSize   = kAncHeaderSize + 255 + kAncFooterSize;        // max TOTAL anc packet size (header + payload + footer)


//  Use this enum to specify which channel (luma or chroma) to look for ANC in...
typedef enum NTV2_SMPTEAncChannelSelect
{
    kNTV2SMPTEAncChannel_Y,     
    kNTV2SMPTEAncChannel_C,     
    kNTV2SMPTEAncChannel_Both   

} NTV2_SMPTEAncChannelSelect;


std::string NTV2SMPTEAncChannelSelectToString (const NTV2_SMPTEAncChannelSelect inChanSelect, const bool inCompactForm = true);


typedef const UByte *   UByteConstPtr;

typedef UWordSequence                       UWordVANCPacket;

typedef std::vector <UWordVANCPacket>       UWordVANCPacketList;
typedef UWordVANCPacketList::const_iterator UWordVANCPacketListConstIter;
typedef UWordVANCPacketList::iterator       UWordVANCPacketListIter;

AJAExport std::ostream & operator << (std::ostream & inOutStream, const UWordVANCPacketList & inData);


class AJAExport CNTV2SMPTEAncData
{
    //  Class Methods
    public:
        static  UWord   AddEvenParity (UByte dataByte);

        static bool     UnpackLine_8BitYUVtoUWordSequence (const void * pInYUV8Line, UWordSequence & out16BitYUVLine, const ULWord inNumPixels);

        static  bool    FindAnc (const UWord                        inAncDID,
                                const UWord                         inAncSDID,
                                const NTV2Buffer &                  inFrameBuffer,
                                const NTV2FormatDescriptor &        inFormatDesc,
                                const NTV2_SMPTEAncChannelSelect    inAncChannel,
                                UWordSequence &                     outWords,
                                bool &                              outHasParityErrors,
                                const UWord                         inLineIncrement,
                                UWord &                             inOutLineStart,
                                UWord &                             inOutPixelStart);

        static  bool    FindAnc (const UWord                        inAncDID,
                                const UWord                         inAncSDID,
                                const ULWord *                      pInFrameBuffer,
                                const NTV2_SMPTEAncChannelSelect    inAncChannel,
                                const NTV2VideoFormat               inVideoFormat,
                                const NTV2FrameBufferFormat         inFBFormat,
                                UWord *                             pOutBuff,
                                ULWord &                            outWordCount,
                                const ULWord                        inWordCountMax,
                                bool &                              outHasParityErrors,
                                const UWord                         inLineIncrement,
                                UWord &                             inOutLineStart,
                                UWord &                             inOutPixelStart);

        static  bool    FindAnc (const UWord                        inAncDID,
                                const UWord                         inAncSDID,
                                const ULWord *                      pInFrameBuffer,
                                const NTV2_SMPTEAncChannelSelect    inAncChannel,
                                const NTV2VideoFormat               inVideoFormat,
                                const NTV2FrameBufferFormat         inFBFormat,
                                UWord *                             pOutBuff,
                                ULWord &                            outWordCount,
                                const ULWord                        inWordCountMax,
                                bool &                              outHasParityErrors);

        static  bool    FindAnc (const UWord                        inAncDID,
                                const UWord                         inAncSDID,
                                const ULWord *                      pInFrameBuffer,
                                const NTV2_SMPTEAncChannelSelect    inAncChannel,
                                const NTV2VideoFormat               inVideoFormat,
                                const NTV2FrameBufferFormat         inFBFormat,
                                UWord *                             pOutBuff,
                                ULWord &                            outWordCount,
                                const ULWord                        inWordCountMax);

        static  bool    MakeAncHeader (NTV2_SMPTEAncHeaderPtr pHdr, UByte ancDID, UByte ancSDID, UByte ancDC);
        static  bool    SetAncHeaderDataCount (NTV2_SMPTEAncHeaderPtr pHdr, UByte ancDC);

        static  bool    SetAncFooterChecksum (NTV2_SMPTEAncFooterPtr pFtr, UWord checksum);
        static  bool    CalculateAncChecksum (NTV2_SMPTEAncHeaderPtr pHdr, UByte dataCount = 0);

        static  bool    ExtractCompressedAnc (const void *              pFrameBuffer,
                                                void *                  pAncBuff,
                                                ULWord                  ancBufMax,
                                                ULWord &                inOutFoundSize,
                                                NTV2VideoFormat         videoFormat,
                                                NTV2FrameBufferFormat   fbFormat);

        static  bool    EmbedCompressedAnc (const void *                pAncBuff,
                                            void *                      pFrameBuffer,
                                            const ULWord                ancBufSize,
                                            const NTV2VideoFormat       videoFormat,
                                            const NTV2FrameBufferFormat fbFormat);

        static  bool    InsertAnc (const UWord *                pInAncBuff,
                                    const size_t                inAncWordCount,
                                    const ULWord                inLineOffset,
                                    const ULWord                inWordOffset,
                                    ULWord *                    pFrameBuffer,
                                    const NTV2VideoFormat       inVideoFormat,
                                    const NTV2FrameBufferFormat inFBFormat);

        static  bool    InsertAncAtSmpteLine (const UWord *                 pInAncBuff,
                                                const ULWord                inAncWordCount,
                                                const ULWord                inSMPTELineNum,
                                                const ULWord                inWordOffset,
                                                ULWord *                    pFrameBuffer,
                                                const NTV2VideoFormat       inVideoFormat,
                                                const NTV2FrameBufferFormat inFBFormat);

        static  bool    FirstVancLineAndChannel (const NTV2FormatDescriptor &   inFD,
                                                const NTV2SmpteLineNumber &     inLN,
                                                NTV2_SMPTEAncChannelSelect &    inOutChannel,
                                                ULWord &                        inOutSMPTELine,
                                                ULWord &                        outLineOffset);

        static  bool    NextVancLineAndChannel (const NTV2FormatDescriptor &    inFD,
                                                const NTV2SmpteLineNumber &     inLN,
                                                NTV2_SMPTEAncChannelSelect &    inOutChannel,
                                                ULWord &                        inOutSMPTELine,
                                                ULWord &                        outLineOffset);

        static  ULWord  GetVancLineOffset (const NTV2FormatDescriptor & inFormatDesc,
                                            const NTV2SmpteLineNumber & inSmpteLineNumbers,
                                            const ULWord                inSmpteLine);

        static  bool    CompressAncPacket (const UWord *        packetBuffer,
                                            UByte *     targetBuffer,
                                            ULWord      maxTargetSize,
                                            ULWord &    outCompPacketSize,
                                            NTV2_SMPTEAncChannelSelect  chan,
                                            UWord       smpteLine);

        static  void    DecompressAncPacket (const UByte *                  pInCompBuffer,
                                            UWord *                         pOutUnpackedBuffer,
                                            ULWord &                        outCompPacketSize,
                                            bool &                          outIsValidLoc,
                                            NTV2_SMPTEAncChannelSelect &    outChan,
                                            ULWord &                        outSmpteLine);

        static  bool    FindCompressedAnc (UByte            ancDID,
                                            UByte           ancSDID,
                                            const UByte *   pSrcAncBuf,
                                            const ULWord    srcAncSize,
                                            UByteConstPtr & outBuffPtr,
                                            ULWord &        outBufSize);

        static bool     GetAncPacketsFromVANCLine (const UWordSequence &                inYUV16Line,
                                                    const NTV2_SMPTEAncChannelSelect    inChanSelect,
                                                    UWordVANCPacketList &               outRawPackets,
                                                    UWordSequence &                     outWordOffsets);
        static ULWord   GetCaptionAncLineNumber (const NTV2VideoFormat inVideoFormat, const bool inIsField1 = true);
};  //  CNTV2SMPTEAncData

#endif  // __NTV2_SMPTEANCDATA_