ntv2testpatterngen.h

Go to the documentation of this file.

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

#include "ajaexport.h"
#include "ntv2enums.h"
#include "ntv2utils.h"
#include <vector>
#include <set>
#include <string>

#if !defined(NTV2_DEPRECATE_16_0)
    typedef std::vector <uint8_t>   NTV2TestPatternBuffer, NTV2TestPatBuffer;   
#endif  //  !defined(NTV2_DEPRECATE_16_0)
typedef NTV2StringList  NTV2TestPatternNames;   

enum NTV2TestPatternSelect
{
    NTV2_TestPatt_ColorBars100,
    NTV2_TestPatt_FIRST         = NTV2_TestPatt_ColorBars100,
    NTV2_TestPatt_ColorBars75,
    NTV2_TestPatt_Ramp,
    NTV2_TestPatt_MultiBurst,
    NTV2_TestPatt_LineSweep,
    NTV2_TestPatt_CheckField,
    NTV2_TestPatt_FlatField,
    NTV2_TestPatt_MultiPattern,
    NTV2_TestPatt_Black,
    NTV2_TestPatt_White,
    NTV2_TestPatt_Border,
    NTV2_TestPatt_LinearRamp,
    NTV2_TestPatt_SlantRamp,
    NTV2_TestPatt_ZonePlate,
    NTV2_TestPatt_ColorQuadrant,
    NTV2_TestPatt_ColorQuadrantBorder,
    NTV2_TestPatt_ColorQuadrantTsi,
    NTV2_TestPatt_TsiAlignment,
    NTV2_TestPatt_NoiseUniform,
    NTV2_TestPatt_NoiseGaussian,
    NTV2_TestPatt_ZonePlate_12b_RGB,
    NTV2_TestPatt_LinearRamp_12b_RGB,
    NTV2_TestPatt_HLG_Narrow_12b_RGB,
    NTV2_TestPatt_PQ_Narrow_12b_RGB,
    NTV2_TestPatt_PQ_Wide_12b_RGB,
    NTV2_TestPatt_All,
    NTV2_TestPatt_INVALID   = NTV2_TestPatt_All,
    NTV2_TestPatt_LAST      = NTV2_TestPatt_All
};
typedef NTV2TestPatternSelect   NTV2TestPatternID;

#define NTV2_IS_VALID_PATTERN(__S__) ((__S__) >= NTV2_TestPatt_ColorBars100  &&  (__S__) < NTV2_TestPatt_All)
#define NTV2_IS_12B_PATTERN(__S__)   ((__S__) >= NTV2_TestPatt_ZonePlate_12b_RGB  &&  (__S__) < NTV2_TestPatt_All)

typedef std::set<NTV2TestPatternSelect>     NTV2TestPatternSet;
typedef NTV2TestPatternSet::const_iterator  NTV2TestPatternSetConstIter;


class AJAExport NTV2TestPatternGen
{
    //  CLASS METHODS
    public:

        static bool                     canDrawTestPattern (const NTV2TestPatternSelect inPattern,
                                                            const NTV2FormatDescriptor & inDesc);

        static NTV2TestPatternNames     getTestPatternNames (void);

        static std::string              findTestPatternName (const NTV2TestPatternSelect inPattern);

        static NTV2StringList           getColorNames (void);   //  New in SDK 16.0

        static NTV2TestPatternSelect    findTestPatternByName (const std::string & inName); //  New in SDK 16.0

        static ULWord                   findRGBColorByName (const std::string & inName);    //  New in SDK 16.0

    //  INSTANCE METHODS
    public:
                                NTV2TestPatternGen ();
        virtual inline          ~NTV2TestPatternGen ()  {}


        virtual bool            DrawTestPattern (const std::string & inTPName,
                                                const NTV2FormatDescriptor & inFormatDesc,
                                                NTV2Buffer & inBuffer); //  New in SDK 16.0
        virtual bool            DrawTestPattern (const NTV2TestPatternSelect inPattern,
                                                const NTV2FormatDescriptor & inFormatDesc,
                                                NTV2Buffer & inBuffer); //  New in SDK 16.0

#if !defined(NTV2_DEPRECATE_16_0)

        virtual NTV2_DEPRECATED_16_0(bool DrawTestPattern (const NTV2TestPatternID tp, const NTV2FormatDesc & fd, NTV2TestPatBuffer & buf));
        virtual NTV2_DEPRECATED_16_0(bool DrawTestPattern (const NTV2TestPatternID tp, const uint32_t w, const uint32_t h, const NTV2PixelFormat pf, NTV2TestPatBuffer & buf));
#endif  //  !defined(NTV2_DEPRECATE_16_0)

        inline bool             getUseRGBSmpteRange (void) const        {return mSetRGBSmpteRange;}
        inline NTV2SignalMask   getSignalMask (void) const              {return mSignalMask;}
        inline const double &   getSliderValue (void) const             {return mSliderValue;}
        inline bool             getAlphaFromLuma (void) const           {return mSetAlphaFromLuma;}
        inline bool             setVANCToLegalBlack (void) const        {return mSetDstVancBlack;}  

        inline NTV2TestPatternGen & setUseRGBSmpteRange (const bool useRGBSmpteRange)   {mSetRGBSmpteRange = useRGBSmpteRange; return *this;}
        inline NTV2TestPatternGen & setSignalMask (const NTV2SignalMask signalMask)     {mSignalMask = signalMask; return *this;}
        inline NTV2TestPatternGen & setSliderValue (const double & sliderValue)         {mSliderValue = sliderValue; return *this;}
        inline NTV2TestPatternGen & setAlphaFromLuma (const bool alphaFromLuma)         {mSetAlphaFromLuma = alphaFromLuma; return *this;}
        inline NTV2TestPatternGen & setVANCToLegalBlack (const bool inClearVANC)        {mSetDstVancBlack = inClearVANC; return *this;}

    //  INTERNAL METHODS
    protected:
        virtual bool    DrawSegmentedTestPattern ();
        virtual bool    DrawYCbCrFrame (uint16_t Y, uint16_t Cb, uint16_t Cr);  
        virtual bool    DrawBorderFrame ();
        virtual bool    DrawLinearRampFrame ();
        virtual bool    DrawSlantRampFrame ();
        virtual bool    DrawZonePlateFrame ();
        virtual bool    DrawNoiseUniformFrame();
        virtual bool    DrawNoiseGaussianFrame();
        virtual bool    DrawQuadrantBorderFrame ();
        virtual bool    DrawColorQuadrantFrame ();
        virtual bool    DrawColorQuadrantFrameTsi ();
        virtual bool    DrawColorQuadrantFrameTsi2 ();

        //  12-bit patterns:
        virtual bool    DrawTestPatternNarrowHLG();
        virtual bool    DrawTestPatternNarrowPQ();
        virtual bool    DrawTestPatternWidePQ();
        virtual bool    Draw12BitRamp();
        virtual bool    Draw12BitZonePlate();
        virtual void    PrepareForOutput();

        bool            IsSDStandard(void) const;
        bool            GetStandard (int & outStandard, bool & outIs4K, bool & outIs8K) const;
        virtual bool    drawIt (void);

    //  INSTANCE DATA
    protected:
        NTV2TestPatternID   mPatternID;         
//      NTV2FormatDesc      mDstFormat;         ///< @brief Dest format
        NTV2PixelFormat     mDstPixelFormat;    
        uint32_t            mDstFrameWidth;     
        uint32_t            mDstFrameHeight;    
        uint32_t            mDstLinePitch;      
        uint32_t            mSrcLinePitch;      
        uint32_t            mDstBufferSize;     
        uint8_t *           mpDstBuffer;        
        uint32_t *          mpPackedLineBuffer;
        uint16_t *          mpUnpackedLineBuffer;
        bool                mSetRGBSmpteRange;
        bool                mSetAlphaFromLuma;
        bool                mSetDstVancBlack;   
        double              mSliderValue;       
        NTV2SignalMask      mSignalMask;        

        uint32_t            mNumPixels;
        uint32_t            mNumLines;
        uint32_t            mBitsPerComponent;
        uint32_t            mSamplesPerPixel;
        uint16_t            mCompressionType;
        uint32_t            mDataOffset;
        uint32_t            mDataSize;
        std::vector<char>       mData;
        std::vector<uint16_t>   mUnPackedRAWBuffer;
        std::vector<uint16_t>   mRGBBuffer;

};  //  NTV2TestPatternGen

#endif  //  NTV2_TESTPATTERN_GEN_