ccfont.h

Go to the documentation of this file.

#ifndef CCFONT_H
    #define CCFONT_H

    #include "ajatypes.h"
    #include "ntv2caption608types.h"
    #include "ntv2enums.h"


    typedef uint16_t    NTV2GlyphIndex;


    class NTV2CCFont
    {
        //  CLASS METHODS
        public:
            static const NTV2CCFont &       GetInstance (void);

            static UByte                    GlyphIndexToCharacterCode (const NTV2GlyphIndex inGlyphIndex);

            static NTV2GlyphIndex           CharacterCodeToGlyphIndex (const UByte inCharacterCode);

            static UByte                    UnicodeCodePointToCharacterCode (const ULWord inCodePoint);

            static std::string              Utf8ToCCFontByteArray (const std::string & inUtf8Str);


        //  INSTANCE METHODS
        public:
            virtual bool                    HasGlyphFor608CodePoint (const NTV2_CC608_CodePoint in608CodePoint) const;

            virtual UWord *                 GetGlyphFor608CodePoint (const NTV2_CC608_CodePoint in608CodePoint) const;

            virtual UWord                   GetGlyphRowDots (const NTV2GlyphIndex inGlyphIndex, const unsigned inRow) const;

            virtual UByte                   GetCCFontCharCode (const NTV2_CC608_CodePoint in608CodePoint) const;

            virtual NTV2CodePointSet        GetCodePointsForCCFontCharCode (const UByte inCharCode) const;

            virtual inline bool             IsValidGlyphIndex (const NTV2GlyphIndex inGlyphIndex) const     {return inGlyphIndex < GetGlyphCount ();}

            virtual inline UWord            GetGlyphCount (void) const                                  {return mGlyphCount;}

            virtual inline std::string      GetName (void) const                                        {return mFontName;}

            virtual inline NTV2GlyphIndex   GetUnderlineGlyphIndex (void) const                         {return mUnderlineGlyphIndex;}

            virtual inline NTV2GlyphIndex   GetNoUnderlineSpaceGlyphIndex (void) const                  {return mNoUnderlineSpaceGlyphIndex;}

            virtual inline UByte            GetUnderlineCharacterCode (void) const                      {return GlyphIndexToCharacterCode (mUnderlineGlyphIndex);}

            virtual inline UByte            GetNoUnderlineSpaceCharacterCode (void) const               {return GlyphIndexToCharacterCode (mNoUnderlineSpaceGlyphIndex);}

            virtual inline UWord            GetUnderlineStartingDotRow (void) const                     {return GetTopMarginDotCount () + GetDotMapHeight () + 2;}

            virtual inline UWord            GetDotMapWidth (void) const                                 {return mDotMapWidth;}

            virtual inline UWord            GetLeftMarginDotCount (void) const                          {return mLeftMarginDotCount;}

            virtual inline UWord            GetRightMarginDotCount (void) const                         {return mRightMarginDotCount;}

            virtual inline UWord            GetTotalWidthInDots (void) const                            {return GetDotMapWidth () + GetLeftMarginDotCount () + GetRightMarginDotCount ();}

            virtual inline UWord            GetDotMapRowCount (void) const                              {return GetDotMapHeight ();}

            virtual inline UWord            GetDotMapHeight (void) const                                {return mDotMapHeight;}

            virtual inline UWord            GetTopMarginDotCount (void) const                           {return mTopMarginDotCount;}

            virtual inline UWord            GetBottomMarginDotCount (void) const                        {return mBottomMarginDotCount;}

            virtual inline UWord            GetTotalHeightInDots (void) const                           {return GetDotMapHeight () + GetTopMarginDotCount () + GetBottomMarginDotCount ();}


            virtual std::string             GetGlyphRowDotsAsString (const NTV2GlyphIndex inGlyphIndex, const unsigned inRow) const;


            virtual std::ostream &          PrintGlyphs (std::ostream & inOutStream, const NTV2GlyphIndex inFirstGlyph, const NTV2GlyphIndex inLastGlyph) const;


            virtual bool                    RenderGlyph8BitYCbCr (UByte *                   pDestBuffer,
                                                                    const ULWord            inBytesPerRow,
                                                                    const NTV2GlyphIndex    inGlyphIndex,
                                                                    const NTV2Line21Attrs & inAttribs,
                                                                    const ULWord            inScaledDotWidth = 1,
                                                                    const ULWord            inScaledDotHeight = 1) const;


            virtual bool                    RenderGlyph8BitRGB (const NTV2PixelFormat   inPixelFormat,
                                                                UByte *                 pDestBuffer,
                                                                const ULWord            inBytesPerRow,
                                                                const NTV2GlyphIndex    inGlyphIndex,
                                                                const NTV2Line21Attrs & inAttribs,
                                                                const ULWord            inScaledDotWidth,
                                                                const ULWord            inScaledDotHeight,
                                                                const bool              inIsHD = false) const;

            explicit                        NTV2CCFont ();
            virtual                         ~NTV2CCFont ();

        private:
            //  Hidden assignment operator to quiet MSVC warning C4512
            virtual inline NTV2CCFont &     operator = (const NTV2CCFont & inRHS)           {(void) inRHS;  return *this;}

        //  INSTANCE DATA
        private:
            const UWord             mGlyphCount;                    
            const NTV2GlyphIndex    mUnderlineGlyphIndex;           
            const NTV2GlyphIndex    mNoUnderlineSpaceGlyphIndex;    
            const UWord             mDotMapWidth;                   
            const UWord             mLeftMarginDotCount;            
            const UWord             mRightMarginDotCount;           
            const UWord             mDotMapHeight;                  
            const UWord             mTopMarginDotCount;             
            const UWord             mBottomMarginDotCount;          
            const std::string       mFontName;                      

    };  //  NTV2CCFont


    void DumpCCFont (const NTV2CCFont & inCCFont = NTV2CCFont::GetInstance ());

#endif  //  CCFONT_H