ntv2captionlogging.h

Go to the documentation of this file.

#ifndef __NTV2_CAPTIONLOGGING_
#define __NTV2_CAPTIONLOGGING_

#include "ajatypes.h"
#include "ntv2publicinterface.h"
#ifdef MSWindows
    #include "windows.h"
    #include "stdio.h"
#else
    #include <stdint.h>
#endif
#include <string>
#include <iostream>
#include <set>

#if !defined(NULL)
    #define NULL 0
#endif


//  The 'ajacc' library can use whatever 'assert' facility is desired.
#define AJACC_ASSERT    NTV2_ASSERT

//  For debugging...
#define UHEX2(_c_)      HEX0N(uint16_t(_c_),2)
#define HEX4(_uword_)   HEX0N((_uword_),4)


typedef uint64_t    NTV2CaptionLogMask;

const uint64_t  kCaptionLog_All                 (0xFFFFFFFFFFFFFFFF);   
const uint64_t  kCaptionLog_Off                 (0x0000000000000000);   
const uint64_t  kCaptionLog_Decode608           (0x0000000000000001);   
const uint64_t  kCaptionLog_DecodeXDS           (0x0000000000000002);   
const uint64_t  kCaptionLog_Line21DetectSuccess (0x0000000000000100);   
const uint64_t  kCaptionLog_Line21DetectFail    (0x0000000000000200);   
const uint64_t  kCaptionLog_Line21DecodeSuccess (0x0000000000000400);   
const uint64_t  kCaptionLog_Line21DecodeFail    (0x0000000000000800);   
const uint64_t  kCaptionLog_608ShowScreen       (0x0000000000008000);   
const uint64_t  kCaptionLog_608ShowAllScreens   (0x0000000000010000);   
const uint64_t  kCaptionLog_608ShowScreenAttrs  (0x0000000000020000);   
const uint64_t  kCaptionLog_DecodeVANC          (0x0000000000100000);   
const uint64_t  kCaptionLog_DecodeCDP           (0x0000000000200000);   

//  For debugging rows/columns-of-interest:
typedef std::set <int>                      Line21RowSet;               
typedef Line21RowSet                        Line21ColumnSet;            
typedef Line21RowSet::const_iterator        Line21RowSetConstIter;      
typedef Line21RowSetConstIter               Line21ColumnSetConstIter;   

AJAExport std::string Line21RowSetToString (const Line21RowSet & inRowSet); //  std::ostream & operator << (std::ostream & inOutStream, const Line21RowSet & inData);
#define Line21ColumnSetToString             Line21RowSetToString

AJAExport void SetDefaultCaptionLogMask (const NTV2CaptionLogMask inMask);

AJAExport NTV2CaptionLogMask GetDefaultCaptionLogMask (void);


class AJAExport CNTV2CaptionLogConfig
{
    //  CLASS METHODS
    public:
        static std::ostream & DumpMemory (const void *  pInStartAddress,
                                        const size_t    inByteCount,
                                        std::ostream &  inOutputStream  = std::cout,
                                        const size_t    inRadix         = 16,
                                        const size_t    inBytesPerGroup = 4,
                                        const size_t    inGroupsPerLine = 8,
                                        const size_t    inAddressRadix  = 16,
                                        const bool      inShowAscii     = true,
                                        const size_t    inAddrOffset    = 0);

        static std::string  HexDump32Bytes (const void * pInStartAddress, const size_t inByteCount, const size_t inLimitBytes = 32);

        static std::ostream & DumpYBytes_2vuy (const UByte *    pInVideoLine,
                                                std::ostream &  inOutputStream,
                                                const unsigned  inFromPixel         = 0,
                                                const unsigned  inToPixel           = 719,
                                                const bool      inShowRuler         = true,
                                                const unsigned  inHiliteRangeFrom   = 9999,
                                                const unsigned  inHiliteRangeTo     = 9999);

        static std::ostream & DumpYBytes_2vuy (const std::vector<uint8_t> & inVideoLine,
                                                std::ostream &  inOutputStream,
                                                const size_t    inFromPixel         = 0,
                                                const size_t    inToPixel           = 719,
                                                const bool      inShowRuler         = true,
                                                const size_t    inHiliteRangeFrom   = 9999,
                                                const size_t    inHiliteRangeTo     = 9999);

        static std::string  GetSeverityLabel(const unsigned inSeverity);


    //  INSTANCE METHODS
    public:
                                            CNTV2CaptionLogConfig (const std::string inLogLabel = std::string ());

        virtual                             ~CNTV2CaptionLogConfig ();

        //  Debug Output Control
        virtual inline NTV2CaptionLogMask   SetLogMask (const NTV2CaptionLogMask inLogMask)             {const NTV2CaptionLogMask tmp (mLogMask);  mLogMask = inLogMask;  return tmp;}

        virtual inline NTV2CaptionLogMask   GetLogMask (void) const                                     {return mLogMask;}

        virtual inline bool                 TestLogMask (const NTV2CaptionLogMask inLogMask, const bool inExact = false) const      {if (inExact) return (GetLogMask() & inLogMask) == inLogMask; else return (GetLogMask() & inLogMask) ? true : false;}

        virtual void                        SetLogLabel (const std::string & inNewLabel);

        virtual void                        AppendToLogLabel (const std::string & inString);

        virtual const std::string &         GetLogLabel (void) const;


        //  OBSOLETE FUNCTIONS
        virtual void                        SetLogStream (std::ostream & inOutputStream);       
        virtual std::ostream &              LogIf (const NTV2CaptionLogMask inLogMask) const;   
        virtual std::ostream &              Log (void) const;                                   


    //  INSTANCE DATA
    protected:      
        NTV2CaptionLogMask      mLogMask;       
        std::string             mLogLabel;      
        mutable void *          mpLabelLock;    

};  //  CNTV2CaptionLogConfig


//  OBSOLETE
AJAExport void SetDefaultCaptionLogOutputStream (std::ostream & inOutputStream);    
AJAExport std::ostream & GetDefaultCaptionLogOutputStream (void);                   

#endif  // __NTV2_CAPTIONLOGGING_