llfont.cpp

Go to the documentation of this file.

#include "linden_common.h"

#include "llfont.h"

// Freetype stuff
#if !defined(LL_LINUX) || defined(LL_STANDALONE)
# include <ft2build.h>
#else
// I had to do some work to avoid the system-installed FreeType headers... --ryan.
# include "llfreetype2/freetype/ft2build.h"
#endif

// For some reason, this won't work if it's not wrapped in the ifdef
#ifdef FT_FREETYPE_H
#include FT_FREETYPE_H
#endif

#include "llerror.h"
#include "llimage.h"
//#include "llimagej2c.h"
#include "llmath.h"     // Linden math
#include "llstring.h"
//#include "imdebug.h"

FT_Render_Mode gFontRenderMode = FT_RENDER_MODE_NORMAL;

LLFontManager *gFontManagerp = NULL;

FT_Library gFTLibrary = NULL;

//static
void LLFontManager::initClass()
{
        gFontManagerp = new LLFontManager;
}

//static
void LLFontManager::cleanupClass()
{
        delete gFontManagerp;
        gFontManagerp = NULL;
}

LLFontManager::LLFontManager()
{
        int error;
        error = FT_Init_FreeType(&gFTLibrary);
        if (error)
        {
                // Clean up freetype libs.
                llerrs << "Freetype initialization failure!" << llendl;
                FT_Done_FreeType(gFTLibrary);
        }
}


LLFontManager::~LLFontManager()
{
        FT_Done_FreeType(gFTLibrary);
}


LLFontGlyphInfo::LLFontGlyphInfo(U32 index)
{
        mGlyphIndex = index;
        mXBitmapOffset = 0; // Offset to the origin in the bitmap
        mYBitmapOffset = 0; // Offset to the origin in the bitmap
        mXBearing = 0;          // Distance from baseline to left in pixels
        mYBearing = 0;          // Distance from baseline to top in pixels
        mWidth = 0;                     // In pixels
        mHeight = 0;            // In pixels
        mXAdvance = 0.f;        // In pixels
        mYAdvance = 0.f;        // In pixels
        mIsRendered = FALSE;
}

LLFontList::LLFontList()
{
}

LLFontList::~LLFontList()
{
        LLFontList::iterator iter;
        for(iter = this->begin(); iter != this->end(); iter++)
        {
                delete *iter;
                // The (now dangling) pointers in the vector will be cleaned up when the vector is deleted by the superclass destructor.
        }
}
void LLFontList::addAtEnd(LLFont *font)
{
        // Purely a convenience function
        this->push_back(font);
}

LLFont::LLFont(LLImageRaw *imagep)
        : mRawImagep(imagep)
{
        mValid = FALSE;
        mAscender = 0.f;
        mDescender = 0.f;
        mLineHeight = 0.f;
        mBitmapWidth = 0;
        mBitmapHeight = 0;
        mCurrentOffsetX = 1;
        mCurrentOffsetY = 1;
        mMaxCharWidth = 0;
        mMaxCharHeight = 0;
        mNumComponents = 0;
        mFallbackFontp = NULL;
        mIsFallback = FALSE;
        mFTFace = NULL;
}


LLFont::~LLFont()
{
        mRawImagep = NULL; // dereferences or deletes image

        // Clean up freetype libs.
        if (mFTFace)
                FT_Done_Face(mFTFace);
        mFTFace = NULL;

        // Delete glyph info
        std::for_each(mCharGlyphInfoMap.begin(), mCharGlyphInfoMap.end(), DeletePairedPointer());
}

void LLFont::setRawImage(LLImageRaw *imagep)
{
        mRawImagep = imagep; // will delete old raw image if we have one and created it
}

// virtual
F32 LLFont::getLineHeight() const
{
        return mLineHeight;
}

// virtual
F32 LLFont::getAscenderHeight() const
{
        return mAscender;
}

// virtual
F32 LLFont::getDescenderHeight() const
{
        return mDescender;
}

BOOL LLFont::loadFace(const std::string& filename, const F32 point_size, const F32 vert_dpi, const F32 horz_dpi, const S32 components, BOOL is_fallback)
{
        // Don't leak face objects.  This is also needed to deal with
        // changed font file names.
        if (mFTFace)
        {
                FT_Done_Face(mFTFace);
                mFTFace = NULL;
        }

        int error;

        error = FT_New_Face( gFTLibrary,
                                                 filename.c_str(),
                                                 0,
                                                 &mFTFace );

    if (error)
        {
                return FALSE;
        }

        mIsFallback = is_fallback;
        mNumComponents = components;
        F32 pixels_per_em = (point_size / 72.f)*vert_dpi; // Size in inches * dpi

        error = FT_Set_Char_Size(mFTFace,    /* handle to face object           */
                                                        0,       /* char_width in 1/64th of points  */
                                                        (S32)(point_size*64),   /* char_height in 1/64th of points */
                                                        (U32)horz_dpi,     /* horizontal device resolution    */
                                                        (U32)vert_dpi);   /* vertical device resolution      */

        if (error)
        {
                // Clean up freetype libs.
                FT_Done_Face(mFTFace);
                mFTFace = NULL;
                return FALSE;
        }

        F32 y_max, y_min, x_max, x_min;
        F32 ems_per_unit = 1.f/ mFTFace->units_per_EM;
        F32 pixels_per_unit = pixels_per_em * ems_per_unit;

        // Get size of bbox in pixels
        y_max = mFTFace->bbox.yMax * pixels_per_unit;
        y_min = mFTFace->bbox.yMin * pixels_per_unit;
        x_max = mFTFace->bbox.xMax * pixels_per_unit;
        x_min = mFTFace->bbox.xMin * pixels_per_unit;
        mAscender = mFTFace->ascender * pixels_per_unit;
        mDescender = -mFTFace->descender * pixels_per_unit;
        mLineHeight = mFTFace->height * pixels_per_unit;

        mMaxCharWidth = llround(0.5f + (x_max - x_min));
        mMaxCharHeight = llround(0.5f + (y_max - y_min));

        if (!mFTFace->charmap)
        {
                //llinfos << " no unicode encoding, set whatever encoding there is..." << llendl;
                FT_Set_Charmap(mFTFace, mFTFace->charmaps[0]);
        }

        if (mRawImagep.isNull() && !mIsFallback)
        {
                mRawImagep = new LLImageRaw();
        }

        if (!mIsFallback)
        {
                // Place text into bitmap, and generate all necessary positions/
                // offsets for the individual characters.

                // calc width and height for mRawImagep (holds all characters)
                // Guess for approximately 20*20 characters
                S32 image_width = mMaxCharWidth * 20;
                S32 pow_iw = 2;
                while (pow_iw < image_width)
                {
                        pow_iw *= 2;
                }
                image_width = pow_iw;
                image_width = llmin(512, image_width); // Don't make bigger than 512x512, ever.
                S32 image_height = image_width;

                //llinfos << "Guessing texture size of " << image_width << " pixels square" << llendl;

                mRawImagep->resize(image_width, image_height, components);

                mBitmapWidth = image_width;
                mBitmapHeight = image_height;

                switch (components)
                {
                case 1:
                        mRawImagep->clear();
                        break;
                case 2:
                        mRawImagep->clear(255, 0);
                        break;
                }

                mCurrentOffsetX = 1;
                mCurrentOffsetY = 1;

                // Add the default glyph
                addGlyph(0, 0);
        }

        mName = filename;

        return TRUE;
}


void LLFont::resetBitmap()
{
        llinfos << "Rebuilding bitmap for glyph" << llendl;

        // Iterate through glyphs and clear the mIsRendered flag
        for (char_glyph_info_map_t::iterator iter = mCharGlyphInfoMap.begin();
                 iter != mCharGlyphInfoMap.end(); ++iter)
        {
                iter->second->mIsRendered = FALSE;
        }
        mRawImagep->clear(255, 0);
        mCurrentOffsetX = 1;
        mCurrentOffsetY = 1;

        // Add the empty glyph`5
        addGlyph(0, 0);
}

LLFontGlyphInfo* LLFont::getGlyphInfo(const llwchar wch) const
{
        char_glyph_info_map_t::iterator iter = mCharGlyphInfoMap.find(wch);
        if (iter != mCharGlyphInfoMap.end())
        {
                return iter->second;
        }
        return NULL;
}


BOOL LLFont::hasGlyph(const llwchar wch) const
{
        llassert(!mIsFallback);
        const LLFontGlyphInfo* gi = getGlyphInfo(wch);
        if (gi && gi->mIsRendered)
        {
                return TRUE;
        }
        else
        {
                return FALSE;
        }
}

BOOL LLFont::addChar(const llwchar wch)
{
        if (mFTFace == NULL)
                return FALSE;

        llassert(!mIsFallback);
        //lldebugs << "Adding new glyph for " << wch << " to font" << llendl;

        FT_UInt glyph_index;

        // Initialize char to glyph map
        glyph_index = FT_Get_Char_Index(mFTFace, wch);
        if (glyph_index == 0)
        {
                // Try looking it up in the backup Unicode font
                if (mFallbackFontp)
                {
                        //llinfos << "Trying to add glyph from fallback font!" << llendl
                        LLFontList::iterator iter;
                        for(iter = mFallbackFontp->begin(); iter != mFallbackFontp->end(); iter++)
                        {
                                glyph_index = FT_Get_Char_Index((*iter)->mFTFace, wch);
                                if (glyph_index)
                                {
                                        addGlyphFromFont(*iter, wch, glyph_index);
                                        return TRUE;
                                }
                        }
                }
        }
        
        char_glyph_info_map_t::iterator iter = mCharGlyphInfoMap.find(wch);
        if (iter == mCharGlyphInfoMap.end() || !(iter->second->mIsRendered))
        {
                BOOL result = addGlyph(wch, glyph_index);
                //imdebug("luma b=8 w=%d h=%d t=%s %p", mRawImagep->getWidth(), mRawImagep->getHeight(), mName.c_str(), mRawImagep->getData());
                return result;
        }
        return FALSE;
}

void LLFont::insertGlyphInfo(llwchar wch, LLFontGlyphInfo* gi) const
{
        char_glyph_info_map_t::iterator iter = mCharGlyphInfoMap.find(wch);
        if (iter != mCharGlyphInfoMap.end())
        {
                delete iter->second;
                iter->second = gi;
        }
        else
        {
                mCharGlyphInfoMap[wch] = gi;
        }
}

BOOL LLFont::addGlyphFromFont(LLFont *fontp, const llwchar wch, const U32 glyph_index)
{
        if (mFTFace == NULL)
                return FALSE;

        llassert(!mIsFallback);
        fontp->renderGlyph(glyph_index);
        S32 width = fontp->mFTFace->glyph->bitmap.width;
        S32 height = fontp->mFTFace->glyph->bitmap.rows;

        if ((mCurrentOffsetX + width + 1) > mRawImagep->getWidth())
        {
                if ((mCurrentOffsetY + 2*mMaxCharHeight + 2) > mBitmapHeight)
                {
                        // We're out of space in this texture - clear it an all of the glyphs
                        // and start over again.  Easier than LRU and should work just as well
                        // (just slightly slower on the rebuild).  As long as the texture has
                        // enough room to hold all glyphs needed for a particular frame this
                        // shouldn't be too slow.

                        resetBitmap();

                        // Need to rerender the glyph, as it's been overwritten by the default glyph.
                        fontp->renderGlyph(glyph_index);
                        width = fontp->mFTFace->glyph->bitmap.width;
                        height = fontp->mFTFace->glyph->bitmap.rows;

                        // We should have a reasonable offset for x and y, no need to check that it's in range
                }
                else
                {
                        mCurrentOffsetX = 1;
                        mCurrentOffsetY += mMaxCharHeight + 1;
                }
        }

        LLFontGlyphInfo* gi = new LLFontGlyphInfo(glyph_index);
        gi->mXBitmapOffset = mCurrentOffsetX;
        gi->mYBitmapOffset = mCurrentOffsetY;
        gi->mWidth = width;
        gi->mHeight = height;
        gi->mXBearing = fontp->mFTFace->glyph->bitmap_left;
        gi->mYBearing = fontp->mFTFace->glyph->bitmap_top;
        // Convert these from 26.6 units to float pixels.
        gi->mXAdvance = fontp->mFTFace->glyph->advance.x / 64.f;
        gi->mYAdvance = fontp->mFTFace->glyph->advance.y / 64.f;
        gi->mIsRendered = TRUE;

        insertGlyphInfo(wch, gi);

        llassert(fontp->mFTFace->glyph->bitmap.pixel_mode == FT_PIXEL_MODE_MONO
            || fontp->mFTFace->glyph->bitmap.pixel_mode == FT_PIXEL_MODE_GRAY);

        if (fontp->mFTFace->glyph->bitmap.pixel_mode == FT_PIXEL_MODE_MONO
            || fontp->mFTFace->glyph->bitmap.pixel_mode == FT_PIXEL_MODE_GRAY)
        {
                U8 *buffer_data = fontp->mFTFace->glyph->bitmap.buffer;
                S32 buffer_row_stride = fontp->mFTFace->glyph->bitmap.pitch;
                U8 *tmp_graydata = NULL;

                if (fontp->mFTFace->glyph->bitmap.pixel_mode
                    == FT_PIXEL_MODE_MONO)
                {
                        // need to expand 1-bit bitmap to 8-bit graymap.
                        tmp_graydata = new U8[width * height];
                        S32 xpos, ypos;
                        for (ypos = 0; ypos < height; ++ypos)
                        {
                                S32 bm_row_offset = buffer_row_stride * ypos;
                                for (xpos = 0; xpos < width; ++xpos)
                                {
                                        U32 bm_col_offsetbyte = xpos / 8;
                                        U32 bm_col_offsetbit = 7 - (xpos % 8);
                                        U32 bit =
                                        !!(buffer_data[bm_row_offset
                                                       + bm_col_offsetbyte
                                           ] & (1 << bm_col_offsetbit) );
                                        tmp_graydata[width*ypos + xpos] =
                                                255 * bit;
                                }
                        }
                        // use newly-built graymap.
                        buffer_data = tmp_graydata;
                        buffer_row_stride = width;
                }

                switch (mNumComponents)
                {
                case 1:
                        mRawImagep->setSubImage(mCurrentOffsetX,
                                                mCurrentOffsetY,
                                                width,
                                                height,
                                                buffer_data,
                                                buffer_row_stride,
                                                TRUE);
                        break;
                case 2:
                        setSubImageLuminanceAlpha(mCurrentOffsetX,
                                                  mCurrentOffsetY,
                                                  width,
                                                  height,
                                                  buffer_data,
                                                  buffer_row_stride);
                        break;
                default:
                        break;
                }

                if (tmp_graydata)
                        delete[] tmp_graydata;
        } else {
                // we don't know how to handle this pixel format from FreeType;
                // omit it from the font-image.
        }
        
        mCurrentOffsetX += width + 1;
        return TRUE;
}

BOOL LLFont::addGlyph(const llwchar wch, const U32 glyph_index)
{
        return addGlyphFromFont(this, wch, glyph_index);
}


F32 LLFont::getXAdvance(const llwchar wch) const
{
        if (mFTFace == NULL)
                return 0.0;

        llassert(!mIsFallback);
        U32 glyph_index;

        // Return existing info only if it is current
        LLFontGlyphInfo* gi = getGlyphInfo(wch);
        if (gi && gi->mIsRendered)
        {
                return gi->mXAdvance;
        }

        const LLFont* fontp = this;
        
        // Initialize char to glyph map
        glyph_index = FT_Get_Char_Index(mFTFace, wch);
        if (glyph_index == 0 && mFallbackFontp)
        {
                LLFontList::iterator iter;
                for(iter = mFallbackFontp->begin(); (iter != mFallbackFontp->end()) && (glyph_index == 0); iter++)
                {
                        glyph_index = FT_Get_Char_Index((*iter)->mFTFace, wch);
                        if(glyph_index)
                        {
                                fontp = *iter;
                        }
                }
        }
        
        if (glyph_index)
        {
                // This font has this glyph
                (const_cast<LLFont *>(fontp))->renderGlyph(glyph_index);

                // Create the entry if it's not there
                char_glyph_info_map_t::iterator iter2 = mCharGlyphInfoMap.find(wch);
                if (iter2 == mCharGlyphInfoMap.end())
                {
                        gi = new LLFontGlyphInfo(glyph_index);
                        insertGlyphInfo(wch, gi);
                }
                else
                {
                        gi = iter2->second;
                }
                
                gi->mWidth = fontp->mFTFace->glyph->bitmap.width;
                gi->mHeight = fontp->mFTFace->glyph->bitmap.rows;

                // Convert these from 26.6 units to float pixels.
                gi->mXAdvance = fontp->mFTFace->glyph->advance.x / 64.f;
                gi->mYAdvance = fontp->mFTFace->glyph->advance.y / 64.f;
                return gi->mXAdvance;
        }
        else
        {
                gi = get_if_there(mCharGlyphInfoMap, (llwchar)0, (LLFontGlyphInfo*)NULL);
                if (gi)
                {
                        return gi->mXAdvance;
                }
        }

        // Last ditch fallback - no glyphs defined at all.
        return (F32)mMaxCharWidth;
}


void LLFont::renderGlyph(const U32 glyph_index)
{
        if (mFTFace == NULL)
                return;

        int error = FT_Load_Glyph(mFTFace, glyph_index, FT_LOAD_DEFAULT );
        llassert(!error);

        error = FT_Render_Glyph(mFTFace->glyph, gFontRenderMode);
        llassert(!error);
}


F32 LLFont::getXKerning(const llwchar char_left, const llwchar char_right) const
{
        if (mFTFace == NULL)
                return 0.0;

        llassert(!mIsFallback);
        LLFontGlyphInfo* left_glyph_info = get_if_there(mCharGlyphInfoMap, char_left, (LLFontGlyphInfo*)NULL);
        U32 left_glyph = left_glyph_info ? left_glyph_info->mGlyphIndex : 0;
        // Kern this puppy.
        LLFontGlyphInfo* right_glyph_info = get_if_there(mCharGlyphInfoMap, char_right, (LLFontGlyphInfo*)NULL);
        U32 right_glyph = right_glyph_info ? right_glyph_info->mGlyphIndex : 0;

        FT_Vector  delta;

        llverify(!FT_Get_Kerning(mFTFace, left_glyph, right_glyph, ft_kerning_unfitted, &delta));

        return delta.x*(1.f/64.f);
}

void LLFont::setSubImageLuminanceAlpha(const U32 x,
                                       const U32 y,
                                       const U32 width,
                                       const U32 height,
                                       const U8 *data,
                                       S32 stride)
{
        llassert(!mIsFallback);
        llassert(mRawImagep->getComponents() == 2);

        U8 *target = mRawImagep->getData();

        if (!data)
        {
                return;
        }

        if (0 == stride)
                stride = width;

        U32 i, j;
        U32 to_offset;
        U32 from_offset;
        U32 target_width = mRawImagep->getWidth();
        for (i = 0; i < height; i++)
        {
                to_offset = (y + i)*target_width + x;
                from_offset = (height - 1 - i)*stride;
                for (j = 0; j < width; j++)
                {
                        *(target + to_offset*2 + 1) = *(data + from_offset);
                        to_offset++;
                        from_offset++;
                }
        }
}

---