ntv2captionrenderer.h

Go to the documentation of this file.

#ifndef __NTV2_CAPTIONRENDERER__
#define __NTV2_CAPTIONRENDERER__

#include "ajatypes.h"
#include "ntv2enums.h"
#include "ntv2caption608types.h"
#include "ntv2formatdescriptor.h"
#include "ccfont.h"
#include "ajabase/common/ajarefptr.h"
#ifdef MSWindows
    #include "windows.h"
    #include "stdio.h"
#else
    #include <stdint.h>
#endif


class CNTV2CaptionRenderer;
typedef AJARefPtr <CNTV2CaptionRenderer>    CNTV2CaptionRendererPtr;

class AJAExport CNTV2CaptionRenderer
{
    //  CLASS METHODS
    public:
        static CNTV2CaptionRendererPtr      GetRenderer (const NTV2FormatDesc & inFBDescriptor,
                                                         const bool inAutoOpen = true);     //  New in SDK 16.0

        static bool                         FlushGlyphCaches (void);

        static bool                         BurnChar (  const UByte             inCharCode,
                                                        const NTV2Line21Attrs & inAttribs,
                                                        NTV2Buffer &            inFB,
                                                        const NTV2FormatDesc &  inFD,
                                                        const UWord             inXPos,
                                                        const UWord             inYPos);    //  New in SDK 16.0

        static bool                         BurnString (const std::string &     inString,
                                                        const NTV2Line21Attrs & inAttribs,
                                                        NTV2Buffer &            inFB,
                                                        const NTV2FormatDesc &  inFBDescriptor,
                                                        const UWord             inRowNum    = 15,
                                                        const UWord             inColumnNum = 1);   //  New in SDK 16.0

        static bool                         BurnStringAtXY (const std::string &     inString,
                                                            const NTV2Line21Attrs & inAttribs,
                                                            NTV2Buffer &            inFB,
                                                            const NTV2FormatDesc &  inFBDescriptor,
                                                            const UWord             inXPos,
                                                            const UWord             inYPos);
    //  INSTANCE METHODS
    public:
        virtual bool                    Open (void);

        virtual bool                    Close (void);

        virtual inline bool             IsOpen (void) const                         {return mGlyphHeightInLines && mGlyphWidthInBytes && mGlyphWidthInPixels;}

        virtual inline NTV2PixelFormat  GetPixelFormat (void) const                 {return mPixelFormat;}

        virtual inline UWord            GetGlyphWidthInBytes (void) const           {return mGlyphWidthInBytes;}

        virtual inline UWord            GetGlyphWidthInPixels (void) const          {return mGlyphWidthInPixels;}

        virtual inline UWord            GetGlyphHeightInLines (void) const          {return mGlyphHeightInLines;}

        virtual inline UWord            GlyphDotHeightToRasterLines (const UWord inVHeightInGlyphDots) const    {return inVHeightInGlyphDots * mVRasterLinesPerGlyphDot;}

        virtual inline UWord            GlyphDotWidthToRasterPixels (const UWord inHWidthInGlyphDots) const     {return inHWidthInGlyphDots * mHRasterPixelsPerGlyphDot;}

        virtual bool                    GetCharacterRasterOrigin (const UWord in608CaptionRow, const UWord in608CaptionCol,
                                                                    UWord & outVertLineOffset, UWord & outHorzPixelOffset) const;

        virtual const UByte *           GetPreloadedGlyphsRasterAddress (const NTV2Line21Attrs & inAttrs) const;

        virtual bool                    GetGlyphsRaster (NTV2Buffer & outBuffer, const NTV2Line21Attrs & inAttrs) const;    //  New in SDK 16.0

        virtual NTV2FormatDescriptor    GetFormatDescriptor (void) const;   //  New in SDK 16.0

        virtual inline ULWord           GetPreloadedGlyphsRasterRowBytes (void) const           {return ULWord(mGlyphWidthInBytes) * ULWord(mCCFont.GetGlyphCount());}

        virtual inline UWord            GetPreloadedGlyphsRasterHeightInLines (void) const      {return GetGlyphHeightInLines();}

        virtual inline UWord            GetPreloadedGlyphsRasterWidthInPixels (void) const      {return GetGlyphWidthInPixels() * mCCFont.GetGlyphCount();}

        virtual inline ULWord           GetTotalBytes (void) const                              {return mBytesPerAttribute * GetNumActivePreloadedGlyphsRasters();}

        virtual inline ULWord           GetNumActivePreloadedGlyphsRasters (void) const         {return ULWord(mpRasters.size());}

        virtual ULWordSequence          GetActivePreloadedGlyphsRastersAttributes (void) const;

        virtual std::ostream &          Print (std::ostream & inOutStream, const bool inIncludeActives = false) const;

        virtual                         ~CNTV2CaptionRenderer ();


    //  PRIVATE METHODS
    private:
        //  Hidden constructors & assignment operators
        explicit                        CNTV2CaptionRenderer (  const NTV2PixelFormat   inPixelFormat,
                                                                const NTV2CCFont &      inCCFont,
                                                                const NTV2FrameSize &   inFrameDimensions);

        explicit inline                 CNTV2CaptionRenderer (const CNTV2CaptionRenderer & inRendererToCopy);

        virtual CNTV2CaptionRenderer &  operator = (const CNTV2CaptionRenderer & inRendererToCopy);

        //  Per-Attribute Preloaded Glyphs Rasters
        virtual bool                    CreatePreloadedGlyphsRasterForAttribute (const NTV2Line21Attributes & inAttribs) const;
        virtual bool                    HasPreloadedGlyphsRasterForAttribute (const NTV2Line21Attributes & inAttribs) const;
        virtual const UByte *           GetPreloadedGlyphsRasterForAttribute (const NTV2Line21Attributes & inAttribs) const;


#if !defined(NTV2_DEPRECATE_16_0)   //  Old APIs
    static NTV2_DEPRECATED_16_0(CNTV2CaptionRendererPtr GetRenderer (const NTV2PixelFormat pf, const NTV2FrameDimensions fd, const bool autoOpen = true));  
    static NTV2_DEPRECATED_16_0(bool BurnChar (const UByte charCode, const NTV2Line21Attrs & att, UByte* fb, const NTV2FrameDimensions fd, const NTV2PixelFormat pf, const UWord x, const UWord y, const UWord bpr));   
    static NTV2_DEPRECATED_16_0(bool BurnString (const std::string & st, const NTV2Line21Attrs& att, UByte* fb, const NTV2FrameDimensions fd, const NTV2PixelFormat pf, const UWord bpr, const UWord r = 15, const UWord c = 1));   
    static NTV2_DEPRECATED_16_0(bool BurnStringAtXY (const std::string & st, const NTV2Line21Attrs & att, UByte* fb, const NTV2FrameDimensions fd, const NTV2PixelFormat pf, const UWord bpr, const UWord x, const UWord y));   
#endif  //  !defined(NTV2_DEPRECATE_16_0)

    //  PRIVATE CLASS METHODS
    private:
        static bool                     Create (CNTV2CaptionRendererPtr &   outCache,
                                                const NTV2PixelFormat       inPixelFormat,
                                                const NTV2CCFont &          inCCFont,
                                                const NTV2FrameSize &       inFrameDimensions);

    //  INSTANCE DATA
    private:
        typedef std::map <ULWord, UByte *>          AttribToBufferMap;
        typedef AttribToBufferMap::iterator         AttribToBufferMapIter;
        typedef AttribToBufferMap::const_iterator   AttribToBufferMapConstIter;

        const NTV2CCFont            mCCFont;                    
        NTV2PixelFormat             mPixelFormat;               
        mutable AttribToBufferMap   mpRasters;                  
        UWord                       mHRasterPixelsPerGlyphDot;  
        UWord                       mVRasterLinesPerGlyphDot;   
        UWord                       mVCaptionRasterOrigin;      
        UWord                       mHCaptionRasterOrigin;      
        UWord                       mGlyphWidthInPixels;        
        UWord                       mGlyphWidthInBytes;         
        UWord                       mGlyphHeightInLines;        
        ULWord                      mBytesPerAttribute;         
        ULWord                      mTotalBytes;                
        NTV2FrameSize               mFrameDimensions;           

};  //  CNTV2CaptionRenderer

AJAExport std::ostream & operator << (std::ostream & inOutStream, const CNTV2CaptionRendererPtr & inObjPtr);
AJAExport std::ostream & operator << (std::ostream & inOutStream, const CNTV2CaptionRenderer & inObj);

#endif  // __NTV2_CAPTIONRENDERER__