ntv2formatdescriptor.h

Go to the documentation of this file.

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

#include "ajaexport.h"
#include "ajatypes.h"
#include "ntv2enums.h"
#include "ntv2publicinterface.h"
#include <string>
#include <iostream>
#include <vector>
#if defined (AJALinux)
    #include <stdint.h>
#endif


typedef std::vector <ULWord>                    NTV2RasterLineOffsets;              
typedef NTV2RasterLineOffsets::const_iterator   NTV2RasterLineOffsetsConstIter;     
typedef NTV2RasterLineOffsets::iterator         NTV2RasterLineOffsetsIter;          

AJAExport std::ostream & NTV2PrintRasterLineOffsets (const NTV2RasterLineOffsets & inObj, std::ostream & inOutStream = std::cout);

class AJAExport NTV2FormatDescriptor
{
public:

    explicit        NTV2FormatDescriptor ();    

    explicit        NTV2FormatDescriptor (  const ULWord inNumLines,
                                            const ULWord inNumPixels,
                                            const ULWord inLinePitch,
                                            const ULWord in1stActiveLine = 0,
                                            const UByte inNumLumaBits = 0,
                                            const UByte inNumChromaBits = 0,
                                            const UByte inNumAlphaBits = 0);

    explicit        NTV2FormatDescriptor (  const NTV2Standard          inStandard,
                                            const NTV2FrameBufferFormat inFrameBufferFormat,
                                            const NTV2VANCMode          inVancMode      = NTV2_VANCMODE_OFF);

    explicit        NTV2FormatDescriptor (  const NTV2VideoFormat       inVideoFormat,
                                            const NTV2FrameBufferFormat inFrameBufferFormat,
                                            const NTV2VANCMode          inVancMode  = NTV2_VANCMODE_OFF);

    explicit        NTV2FormatDescriptor (  const NTV2FrameSize &   inRasterSize,
                                            const NTV2PixelFormat   inPixelFormat,
                                            const NTV2VANCMode      inVancMode  = NTV2_VANCMODE_OFF);
    

    inline bool     IsValid (void) const        {return numLines && numPixels && mNumPlanes && mLinePitch[0]
                                                    && (mNumBitsLuma || mNumBitsChroma);}
    inline bool     IsVANC (void) const         {return GetFirstActiveLine() > 0;}  
    inline bool     IsPlanar (void) const       {return GetNumPlanes() > 1 || NTV2_IS_FBF_PLANAR (mPixelFormat);}   

    ULWord          GetVerticalSampleRatio (const UWord inPlaneIndex0 = 0) const;   //  New in SDK 16.0

    inline ULWord   GetTotalRasterBytes (const UWord inPlaneIndex0 = 0) const
                    {   const ULWord vSamp(GetVerticalSampleRatio(inPlaneIndex0));
                        return vSamp ? (GetFullRasterHeight() * GetBytesPerRow(inPlaneIndex0) / vSamp) : 0;
                    }

    ULWord          GetTotalBytes (void) const; //  New in SDK 16.0

    ULWord          GetVideoWriteSize (ULWord inPageSize = 4096UL) const;   //  New in SDK 16.2

    inline ULWord   GetVisibleRasterBytes (const UWord inPlaneIndex0 = 0) const {return GetVisibleRasterHeight() * GetBytesPerRow(inPlaneIndex0);}

    inline ULWord   GetBytesPerRow (const UWord inPlaneIndex0 = 0) const    {return inPlaneIndex0 < mNumPlanes ? mLinePitch[inPlaneIndex0] : 0;}

    inline ULWord   GetRasterWidth (void) const         {return numPixels;}     
    inline UWord    GetNumPlanes (void) const           {return mNumPlanes;}    
    std::string     PlaneToString (const UWord inPlaneIndex0) const;            

    UWord           ByteOffsetToPlane (const ULWord inByteOffset) const;

    UWord           ByteOffsetToRasterLine (const ULWord inByteOffset) const;

    bool            IsAtLineStart (ULWord inByteOffset) const;

    inline ULWord   GetRasterHeight (const bool inVisibleOnly = false) const        {return inVisibleOnly ? GetVisibleRasterHeight() : GetFullRasterHeight();}

    inline ULWord   GetFullRasterHeight (void) const                                {return numLines;}

    inline ULWord   GetFirstActiveLine (void) const                                 {return firstActiveLine;}

    inline ULWord   GetVisibleRasterHeight (void) const                             {return GetFullRasterHeight() - GetFirstActiveLine();}

    bool            GetRowBuffer (const NTV2Buffer & inFrameBuffer, NTV2Buffer & inOutRowBuffer,  const ULWord inRowIndex0,  const UWord inPlaneIndex0 = 0) const;  //  New in SDK 16.0

    const void *    GetRowAddress (const void * pInStartAddress,  const ULWord inRowIndex0,  const UWord inPlaneIndex0 = 0) const;

    void *          GetWriteableRowAddress (void * pInStartAddress,  const ULWord inRowIndex0,  const UWord inPlaneIndex0 = 0) const;

    ULWord          RasterLineToByteOffset (const ULWord inRowIndex0,  const UWord inPlaneIndex0 = 0) const;

    inline UByte *  GetTopVisibleRowAddress (UByte * pInStartAddress) const             {return (UByte *) GetRowAddress (pInStartAddress, firstActiveLine);}

    bool            GetFirstChangedRow (const void * pInStartAddress1, const void * pInStartAddress2, ULWord & outFirstChangedRowNum) const;

    bool            GetChangedLines (NTV2RasterLineOffsets & outDiffs, const void * pInBuffer1, const void * pInBuffer2, const ULWord inMaxLines = 0) const;

    bool            FlipVertically (NTV2Buffer & inFB) const;   //  New in SDK 18.1

    NTV2FrameSize                   GetFullRasterDimensions (void) const;

    NTV2FrameSize                   GetVisibleRasterDimensions (void) const;

    bool                            GetSMPTELineNumber (const ULWord inLineOffset, ULWord & outSMPTELine, bool & outIsField2) const;

    bool                            GetLineOffsetFromSMPTELine (const ULWord inSMPTELine, ULWord & outLineOffset) const;

    NTV2SegmentedXferInfo &         GetSegmentedXferInfo (NTV2SegmentedXferInfo & inSegmentInfo, const bool inIsSource = true) const;

    bool                            operator == (const NTV2FormatDescriptor & inRHS) const;

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

    std::ostream &                  PrintSMPTELineNumber (std::ostream & inOutStream, const ULWord inLineOffset, const bool inForTextMode = false) const;

    inline NTV2Standard             GetVideoStandard (void) const   {return mStandard;}                         
    inline NTV2VideoFormat          GetVideoFormat (void) const     {return mVideoFormat;}                      
    inline NTV2FrameBufferFormat    GetPixelFormat (void) const     {return mPixelFormat;}                      
    inline NTV2VANCMode             GetVANCMode (void) const        {return mVancMode;}                         
    inline bool                     IsSD (void) const {return NTV2_IS_SD_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_SD_STANDARD(GetVideoStandard());}        
    inline bool                     IsHD (void) const {return NTV2_IS_HD_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_HD_STANDARD(GetVideoStandard());}        
    inline bool                     IsUHD (void) const {return NTV2_IS_UHD_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_UHD_STANDARD(GetVideoStandard());}     
    inline bool                     Is4K (void) const {return NTV2_IS_4K_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_4K_STANDARD(GetVideoStandard());}        
    inline bool                     IsUHD2 (void) const {return NTV2_IS_UHD2_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_UHD2_STANDARD(GetVideoStandard());}  
    inline bool                     Is8K (void) const {return NTV2_IS_8K_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_8K_STANDARD(GetVideoStandard());}        
    inline bool                     IsQuadRaster (void) const       {return NTV2_IS_QUAD_STANDARD(mStandard) || NTV2_IS_4K_VIDEO_FORMAT(mVideoFormat);} 
    inline bool                     IsTallVanc (void) const         {return mVancMode == NTV2_VANCMODE_TALL;}   
    inline bool                     IsTallerVanc (void) const       {return mVancMode == NTV2_VANCMODE_TALLER;} 
    inline NTV2FrameGeometry        GetFrameGeometry (void) const   {return mFrameGeometry;}                    
    inline UByte                    GetNumBitsLuma (void) const     {return mNumBitsLuma;}                      
    inline UByte                    GetNumBitsChroma (void) const   {return mNumBitsChroma;}                    
    inline UByte                    GetNumBitsAlpha (void) const    {return mNumBitsAlpha;}                     
    inline bool                     HasAlpha (void) const           {return IsValid() && GetNumBitsAlpha();}    
    inline bool                     IsRGB (void) const              {return GetNumBitsLuma() ? false : true;}   
    bool                            Is2KFormat (void) const;        
#if !defined(NTV2_DEPRECATE_16_3)
    inline NTV2_DEPRECATED_16_3(bool IsSDFormat(void) const) {return NTV2_IS_SD_VIDEO_FORMAT(GetVideoFormat()) || NTV2_IS_SD_STANDARD(GetVideoStandard());} 
#endif
    void                            MakeInvalid (void);             

    private:
        friend class CNTV2CaptionRenderer;  //  The caption renderer needs to call SetPixelFormat
        inline void                 SetPixelFormat (const NTV2PixelFormat inPixFmt)     {mPixelFormat = inPixFmt;}          
        inline void                 SetBitsPerComponent (const UByte inLuma, const UByte inChroma, const UByte inAlpha) {mNumBitsLuma = inLuma; mNumBitsChroma = inChroma; mNumBitsAlpha = inAlpha;}
        void                        FinalizePlanar (void);          

    //  Member Data
    public:
        ULWord              numLines;           
        ULWord              numPixels;          
        ULWord              linePitch;          
        ULWord              firstActiveLine;    
    private:
        NTV2Standard        mStandard;          
        NTV2VideoFormat     mVideoFormat;       
        NTV2PixelFormat     mPixelFormat;       
        NTV2VANCMode        mVancMode;          
        ULWord              mLinePitch[4];      
        UWord               mNumPlanes;         
        NTV2FrameGeometry   mFrameGeometry;     
        UByte               mNumBitsLuma;       
        UByte               mNumBitsChroma;     
        UByte               mNumBitsAlpha;      

};  //  NTV2FormatDescriptor

typedef NTV2FormatDescriptor    NTV2FormatDesc; 
typedef NTV2FormatDesc          NTV2RasterInfo; 

AJAExport inline std::ostream & operator << (std::ostream & inOutStream, const NTV2FormatDescriptor & inFormatDesc) {return inFormatDesc.Print (inOutStream);}


AJAExport bool      UnpackLine_10BitYUVtoUWordSequence (const void * pIn10BitYUVLine, const NTV2FormatDescriptor & inFormatDesc, UWordSequence & out16BitYUVLine);

AJAExport bool      UnpackLine_10BitARGBtoUWordSequence (const void * pIn10BitARGBLine, const NTV2FormatDescriptor & inFormatDesc, UWordSequence & out16BitARGBLine);

#endif  //  NTV2FORMATDESC_H