/* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*- * ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Mozilla Foundation code. * * The Initial Developer of the Original Code is Mozilla Foundation. * Portions created by the Initial Developer are Copyright (C) 2010 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Bas Schouten * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "gfxDWriteFonts.h" #include "gfxDWriteShaper.h" #include "gfxHarfBuzzShaper.h" #include "gfxDWriteFontList.h" #include "gfxContext.h" #include #include "gfxDWriteTextAnalysis.h" #include "harfbuzz/hb-blob.h" // Chosen this as to resemble DWrite's own oblique face style. #define OBLIQUE_SKEW_FACTOR 0.3 // This is also in gfxGDIFont.cpp. Would be nice to put it somewhere common, // but we can't declare it in the gfxFont.h or gfxFontUtils.h headers // because those are exported, and the cairo headers aren't. static inline cairo_antialias_t GetCairoAntialiasOption(gfxFont::AntialiasOption anAntialiasOption) { switch (anAntialiasOption) { default: case gfxFont::kAntialiasDefault: return CAIRO_ANTIALIAS_DEFAULT; case gfxFont::kAntialiasNone: return CAIRO_ANTIALIAS_NONE; case gfxFont::kAntialiasGrayscale: return CAIRO_ANTIALIAS_GRAY; case gfxFont::kAntialiasSubpixel: return CAIRO_ANTIALIAS_SUBPIXEL; } } // Code to determine whether Windows is set to use ClearType font smoothing; // based on private functions in cairo-win32-font.c #ifndef SPI_GETFONTSMOOTHINGTYPE #define SPI_GETFONTSMOOTHINGTYPE 0x200a #endif #ifndef FE_FONTSMOOTHINGCLEARTYPE #define FE_FONTSMOOTHINGCLEARTYPE 2 #endif static bool HasClearType() { OSVERSIONINFO versionInfo; versionInfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO); return (GetVersionEx(&versionInfo) && (versionInfo.dwMajorVersion > 5 || (versionInfo.dwMajorVersion == 5 && versionInfo.dwMinorVersion >= 1))); // XP or newer } static bool UsingClearType() { BOOL fontSmoothing; if (!SystemParametersInfo(SPI_GETFONTSMOOTHING, 0, &fontSmoothing, 0) || !fontSmoothing) { return false; } if (!HasClearType()) { return false; } UINT type; if (SystemParametersInfo(SPI_GETFONTSMOOTHINGTYPE, 0, &type, 0) && type == FE_FONTSMOOTHINGCLEARTYPE) { return true; } return false; } //////////////////////////////////////////////////////////////////////////////// // gfxDWriteFont gfxDWriteFont::gfxDWriteFont(gfxFontEntry *aFontEntry, const gfxFontStyle *aFontStyle, PRBool aNeedsBold, AntialiasOption anAAOption) : gfxFont(aFontEntry, aFontStyle, anAAOption) , mCairoFontFace(nsnull) , mCairoScaledFont(nsnull) , mInitialized(PR_FALSE) , mMetrics(nsnull) , mNeedsOblique(PR_FALSE) , mNeedsBold(aNeedsBold) , mUseSubpixelPositions(PR_FALSE) { if ((anAAOption == gfxFont::kAntialiasDefault && UsingClearType()) || anAAOption == gfxFont::kAntialiasSubpixel) { mUseSubpixelPositions = PR_TRUE; // note that this may be reset to FALSE if we determine that a bitmap // strike is going to be used } if (FontCanSupportHarfBuzz()) { mHarfBuzzShaper = new gfxHarfBuzzShaper(this); } } gfxDWriteFont::~gfxDWriteFont() { if (mCairoFontFace) { cairo_font_face_destroy(mCairoFontFace); } if (mCairoScaledFont) { cairo_scaled_font_destroy(mCairoScaledFont); } delete mMetrics; } gfxFont* gfxDWriteFont::CopyWithAntialiasOption(AntialiasOption anAAOption) { return new gfxDWriteFont(static_cast(mFontEntry.get()), &mStyle, mNeedsBold, anAAOption); } void gfxDWriteFont::Initialize() { NS_ASSERTION(!mInitialized, "initializing gfxDWriteFont a second time"); mInitialized = PR_TRUE; gfxDWriteFontEntry *fe = static_cast((gfxFontEntry*)mFontEntry); nsresult rv; DWRITE_FONT_SIMULATIONS sims = DWRITE_FONT_SIMULATIONS_NONE; if ((GetStyle()->style & (FONT_STYLE_ITALIC | FONT_STYLE_OBLIQUE)) && !fe->IsItalic()) { // For this we always use the font_matrix for uniformity. Not the // DWrite simulation. mNeedsOblique = PR_TRUE; } if (mNeedsBold) { sims |= DWRITE_FONT_SIMULATIONS_BOLD; } rv = fe->CreateFontFace(getter_AddRefs(mFontFace), sims); if (NS_FAILED(rv)) { mIsValid = PR_FALSE; return; } ComputeMetrics(); } void gfxDWriteFont::CreatePlatformShaper() { mPlatformShaper = new gfxDWriteShaper(this); } nsString gfxDWriteFont::GetUniqueName() { return mFontEntry->Name(); } const gfxFont::Metrics& gfxDWriteFont::GetMetrics() { if (!mInitialized) { Initialize(); } return *mMetrics; } void gfxDWriteFont::ComputeMetrics() { DWRITE_FONT_METRICS fontMetrics; mFontFace->GetMetrics(&fontMetrics); if (mStyle.sizeAdjust != 0.0) { gfxFloat aspect = (gfxFloat)fontMetrics.xHeight / fontMetrics.designUnitsPerEm; mAdjustedSize = mStyle.GetAdjustedSize(aspect); } else { mAdjustedSize = mStyle.size; } if (HasBitmapStrikeForSize(NS_lround(mAdjustedSize))) { mAdjustedSize = NS_lround(mAdjustedSize); mUseSubpixelPositions = PR_FALSE; } mMetrics = new gfxFont::Metrics; ::memset(mMetrics, 0, sizeof(*mMetrics)); mMetrics->xHeight = ((gfxFloat)fontMetrics.xHeight / fontMetrics.designUnitsPerEm) * mAdjustedSize; mMetrics->maxAscent = ceil(((gfxFloat)fontMetrics.ascent / fontMetrics.designUnitsPerEm) * mAdjustedSize); mMetrics->maxDescent = ceil(((gfxFloat)fontMetrics.descent / fontMetrics.designUnitsPerEm) * mAdjustedSize); mMetrics->maxHeight = mMetrics->maxAscent + mMetrics->maxDescent; mMetrics->emHeight = mAdjustedSize; mMetrics->emAscent = mMetrics->emHeight * mMetrics->maxAscent / mMetrics->maxHeight; mMetrics->emDescent = mMetrics->emHeight - mMetrics->emAscent; mMetrics->maxAdvance = mAdjustedSize; // try to get the true maxAdvance value from 'hhea' PRUint8 *tableData; PRUint32 len; void *tableContext = NULL; BOOL exists; HRESULT hr = mFontFace->TryGetFontTable(DWRITE_MAKE_OPENTYPE_TAG('h', 'h', 'e', 'a'), (const void**)&tableData, &len, &tableContext, &exists); if (SUCCEEDED(hr)) { if (exists && len >= sizeof(mozilla::HheaTable)) { const mozilla::HheaTable* hhea = reinterpret_cast(tableData); mMetrics->maxAdvance = ((gfxFloat)PRUint16(hhea->advanceWidthMax) / fontMetrics.designUnitsPerEm) * mAdjustedSize; } mFontFace->ReleaseFontTable(tableContext); } mMetrics->internalLeading = NS_MAX(mMetrics->maxHeight - mMetrics->emHeight, 0.0); mMetrics->externalLeading = ceil(((gfxFloat)fontMetrics.lineGap / fontMetrics.designUnitsPerEm) * mAdjustedSize); UINT16 glyph = (PRUint16)GetSpaceGlyph(); DWRITE_GLYPH_METRICS metrics; mFontFace->GetDesignGlyphMetrics(&glyph, 1, &metrics); mMetrics->spaceWidth = ((gfxFloat)metrics.advanceWidth / fontMetrics.designUnitsPerEm) * mAdjustedSize; // try to get aveCharWidth from the OS/2 table, fall back to measuring 'x' // if the table is not available mMetrics->aveCharWidth = 0; hr = mFontFace->TryGetFontTable(DWRITE_MAKE_OPENTYPE_TAG('O', 'S', '/', '2'), (const void**)&tableData, &len, &tableContext, &exists); if (SUCCEEDED(hr)) { if (exists && len >= 4) { // Not checking against sizeof(mozilla::OS2Table) here because older // versions of the table have different sizes; we only need the first // two 16-bit fields here. const mozilla::OS2Table* os2 = reinterpret_cast(tableData); mMetrics->aveCharWidth = ((gfxFloat)PRInt16(os2->xAvgCharWidth) / fontMetrics.designUnitsPerEm) * mAdjustedSize; } mFontFace->ReleaseFontTable(tableContext); } UINT32 ucs; if (mMetrics->aveCharWidth < 1) { ucs = L'x'; if (SUCCEEDED(mFontFace->GetGlyphIndicesA(&ucs, 1, &glyph)) && SUCCEEDED(mFontFace->GetDesignGlyphMetrics(&glyph, 1, &metrics))) { mMetrics->aveCharWidth = ((gfxFloat)metrics.advanceWidth / fontMetrics.designUnitsPerEm) * mAdjustedSize; } else { // Let's just assume the X is square. mMetrics->aveCharWidth = ((gfxFloat)fontMetrics.xHeight / fontMetrics.designUnitsPerEm) * mAdjustedSize; } } ucs = L'0'; if (SUCCEEDED(mFontFace->GetGlyphIndicesA(&ucs, 1, &glyph)) && SUCCEEDED(mFontFace->GetDesignGlyphMetrics(&glyph, 1, &metrics))) { mMetrics->zeroOrAveCharWidth = ((gfxFloat)metrics.advanceWidth / fontMetrics.designUnitsPerEm) * mAdjustedSize; } else { mMetrics->zeroOrAveCharWidth = mMetrics->aveCharWidth; } mMetrics->underlineOffset = ((gfxFloat)fontMetrics.underlinePosition / fontMetrics.designUnitsPerEm) * mAdjustedSize; mMetrics->underlineSize = ((gfxFloat)fontMetrics.underlineThickness / fontMetrics.designUnitsPerEm) * mAdjustedSize; mMetrics->strikeoutOffset = ((gfxFloat)fontMetrics.strikethroughPosition / fontMetrics.designUnitsPerEm) * mAdjustedSize; mMetrics->strikeoutSize = ((gfxFloat)fontMetrics.strikethroughThickness / fontMetrics.designUnitsPerEm) * mAdjustedSize; mMetrics->superscriptOffset = 0; mMetrics->subscriptOffset = 0; mFUnitsConvFactor = float(mAdjustedSize / fontMetrics.designUnitsPerEm); SanitizeMetrics(mMetrics, GetFontEntry()->mIsBadUnderlineFont); #if 0 printf("Font: %p (%s) size: %f\n", this, NS_ConvertUTF16toUTF8(GetName()).get(), mStyle.size); printf(" emHeight: %f emAscent: %f emDescent: %f\n", mMetrics->emHeight, mMetrics->emAscent, mMetrics->emDescent); printf(" maxAscent: %f maxDescent: %f maxAdvance: %f\n", mMetrics->maxAscent, mMetrics->maxDescent, mMetrics->maxAdvance); printf(" internalLeading: %f externalLeading: %f\n", mMetrics->internalLeading, mMetrics->externalLeading); printf(" spaceWidth: %f aveCharWidth: %f zeroOrAve: %f xHeight: %f\n", mMetrics->spaceWidth, mMetrics->aveCharWidth, mMetrics->zeroOrAveCharWidth, mMetrics->xHeight); printf(" uOff: %f uSize: %f stOff: %f stSize: %f supOff: %f subOff: %f\n", mMetrics->underlineOffset, mMetrics->underlineSize, mMetrics->strikeoutOffset, mMetrics->strikeoutSize, mMetrics->superscriptOffset, mMetrics->subscriptOffset); #endif } using namespace mozilla; // for AutoSwap_* types struct EBLCHeader { AutoSwap_PRUint32 version; AutoSwap_PRUint32 numSizes; }; struct SbitLineMetrics { PRInt8 ascender; PRInt8 descender; PRUint8 widthMax; PRInt8 caretSlopeNumerator; PRInt8 caretSlopeDenominator; PRInt8 caretOffset; PRInt8 minOriginSB; PRInt8 minAdvanceSB; PRInt8 maxBeforeBL; PRInt8 minAfterBL; PRInt8 pad1; PRInt8 pad2; }; struct BitmapSizeTable { AutoSwap_PRUint32 indexSubTableArrayOffset; AutoSwap_PRUint32 indexTablesSize; AutoSwap_PRUint32 numberOfIndexSubTables; AutoSwap_PRUint32 colorRef; SbitLineMetrics hori; SbitLineMetrics vert; AutoSwap_PRUint16 startGlyphIndex; AutoSwap_PRUint16 endGlyphIndex; PRUint8 ppemX; PRUint8 ppemY; PRUint8 bitDepth; PRUint8 flags; }; typedef EBLCHeader EBSCHeader; struct BitmapScaleTable { SbitLineMetrics hori; SbitLineMetrics vert; PRUint8 ppemX; PRUint8 ppemY; PRUint8 substitutePpemX; PRUint8 substitutePpemY; }; PRBool gfxDWriteFont::HasBitmapStrikeForSize(PRUint32 aSize) { PRUint8 *tableData; PRUint32 len; void *tableContext; BOOL exists; HRESULT hr = mFontFace->TryGetFontTable(DWRITE_MAKE_OPENTYPE_TAG('E', 'B', 'L', 'C'), (const void**)&tableData, &len, &tableContext, &exists); if (FAILED(hr)) { return PR_FALSE; } PRBool hasStrike = PR_FALSE; // not really a loop, but this lets us use 'break' to skip out of the block // as soon as we know the answer, and skips it altogether if the table is // not present while (exists) { if (len < sizeof(EBLCHeader)) { break; } const EBLCHeader *hdr = reinterpret_cast(tableData); if (hdr->version != 0x00020000) { break; } PRUint32 numSizes = hdr->numSizes; if (numSizes > 0xffff) { // sanity-check, prevent overflow below break; } if (len < sizeof(EBLCHeader) + numSizes * sizeof(BitmapSizeTable)) { break; } const BitmapSizeTable *sizeTable = reinterpret_cast(hdr + 1); for (PRUint32 i = 0; i < numSizes; ++i, ++sizeTable) { if (sizeTable->ppemX == aSize && sizeTable->ppemY == aSize) { // we ignore a strike that contains fewer than 4 glyphs, // as that probably indicates a font such as Courier New // that provides bitmaps ONLY for the "shading" characters // U+2591..2593 hasStrike = (PRUint16(sizeTable->endGlyphIndex) >= PRUint16(sizeTable->startGlyphIndex) + 3); break; } } // if we reach here, we didn't find a strike; unconditionally break // out of the while-loop block break; } mFontFace->ReleaseFontTable(tableContext); if (hasStrike) { return PR_TRUE; } // if we didn't find a real strike, check if the font calls for scaling // another bitmap to this size hr = mFontFace->TryGetFontTable(DWRITE_MAKE_OPENTYPE_TAG('E', 'B', 'S', 'C'), (const void**)&tableData, &len, &tableContext, &exists); if (FAILED(hr)) { return PR_FALSE; } while (exists) { if (len < sizeof(EBSCHeader)) { break; } const EBSCHeader *hdr = reinterpret_cast(tableData); if (hdr->version != 0x00020000) { break; } PRUint32 numSizes = hdr->numSizes; if (numSizes > 0xffff) { break; } if (len < sizeof(EBSCHeader) + numSizes * sizeof(BitmapScaleTable)) { break; } const BitmapScaleTable *scaleTable = reinterpret_cast(hdr + 1); for (PRUint32 i = 0; i < numSizes; ++i, ++scaleTable) { if (scaleTable->ppemX == aSize && scaleTable->ppemY == aSize) { hasStrike = PR_TRUE; break; } } break; } mFontFace->ReleaseFontTable(tableContext); return hasStrike; } PRUint32 gfxDWriteFont::GetSpaceGlyph() { if (!mInitialized) { Initialize(); } UINT32 ucs = L' '; UINT16 glyph; HRESULT hr; hr = mFontFace->GetGlyphIndicesA(&ucs, 1, &glyph); if (FAILED(hr)) { return 0; } return glyph; } PRBool gfxDWriteFont::SetupCairoFont(gfxContext *aContext) { if (!mInitialized) { Initialize(); } cairo_scaled_font_t *scaledFont = CairoScaledFont(); if (cairo_scaled_font_status(scaledFont) != CAIRO_STATUS_SUCCESS) { // Don't cairo_set_scaled_font as that would propagate the error to // the cairo_t, precluding any further drawing. return PR_FALSE; } cairo_set_scaled_font(aContext->GetCairo(), scaledFont); return PR_TRUE; } PRBool gfxDWriteFont::IsValid() { if (!mInitialized) { Initialize(); } return mFontFace != NULL; } IDWriteFontFace* gfxDWriteFont::GetFontFace() { if (!mInitialized) { Initialize(); } return mFontFace.get(); } cairo_font_face_t * gfxDWriteFont::CairoFontFace() { if (!mCairoFontFace) { #ifdef CAIRO_HAS_DWRITE_FONT mCairoFontFace = cairo_dwrite_font_face_create_for_dwrite_fontface( ((gfxDWriteFontEntry*)mFontEntry.get())->mFont, mFontFace); #endif } return mCairoFontFace; } cairo_scaled_font_t * gfxDWriteFont::CairoScaledFont() { if (!mCairoScaledFont) { cairo_matrix_t sizeMatrix; cairo_matrix_t identityMatrix; cairo_matrix_init_scale(&sizeMatrix, mAdjustedSize, mAdjustedSize); cairo_matrix_init_identity(&identityMatrix); cairo_font_options_t *fontOptions = cairo_font_options_create(); if (mNeedsOblique) { double skewfactor = OBLIQUE_SKEW_FACTOR; cairo_matrix_t style; cairo_matrix_init(&style, 1, //xx 0, //yx -1 * skewfactor, //xy 1, //yy 0, //x0 0); //y0 cairo_matrix_multiply(&sizeMatrix, &sizeMatrix, &style); } if (mAntialiasOption != kAntialiasDefault) { cairo_font_options_set_antialias(fontOptions, GetCairoAntialiasOption(mAntialiasOption)); } mCairoScaledFont = cairo_scaled_font_create(CairoFontFace(), &sizeMatrix, &identityMatrix, fontOptions); cairo_font_options_destroy(fontOptions); } NS_ASSERTION(mAdjustedSize == 0.0 || cairo_scaled_font_status(mCairoScaledFont) == CAIRO_STATUS_SUCCESS, "Failed to make scaled font"); return mCairoScaledFont; } // Access to font tables packaged in hb_blob_t form // object attached to the Harfbuzz blob, used to release // the table when the blob is destroyed class FontTableRec { public: FontTableRec(IDWriteFontFace *aFontFace, void *aContext) : mFontFace(aFontFace), mContext(aContext) { } ~FontTableRec() { mFontFace->ReleaseFontTable(mContext); } private: IDWriteFontFace *mFontFace; void *mContext; }; /*static*/ void gfxDWriteFont::DestroyBlobFunc(void* aUserData) { FontTableRec *ftr = static_cast(aUserData); delete ftr; } hb_blob_t * gfxDWriteFont::GetFontTable(PRUint32 aTag) { const void *data; UINT32 size; void *context; BOOL exists; HRESULT hr = mFontFace->TryGetFontTable(NS_SWAP32(aTag), &data, &size, &context, &exists); if (SUCCEEDED(hr) && exists) { FontTableRec *ftr = new FontTableRec(mFontFace, context); return hb_blob_create(static_cast(data), size, HB_MEMORY_MODE_READONLY, DestroyBlobFunc, ftr); } if (mFontEntry->IsUserFont() && !mFontEntry->IsLocalUserFont()) { // for downloaded fonts, there may be layout tables cached in the entry // even though they're absent from the sanitized platform font hb_blob_t *blob; if (mFontEntry->GetExistingFontTable(aTag, &blob)) { return blob; } } return nsnull; } PRInt32 gfxDWriteFont::GetGlyphWidth(gfxContext *aCtx, PRUint16 aGID) { if (!mGlyphWidths.IsInitialized()) { mGlyphWidths.Init(200); } PRInt32 width = -1; if (mGlyphWidths.Get(aGID, &width)) { return width; } DWRITE_GLYPH_METRICS glyphMetrics; HRESULT hr; if (mUseSubpixelPositions) { hr = mFontFace->GetDesignGlyphMetrics( &aGID, 1, &glyphMetrics, FALSE); if (SUCCEEDED(hr)) { width = NS_lround(glyphMetrics.advanceWidth * mFUnitsConvFactor * 65536.0); } } else { hr = mFontFace->GetGdiCompatibleGlyphMetrics( FLOAT(mAdjustedSize), 1.0f, nsnull, FALSE, &aGID, 1, &glyphMetrics, FALSE); if (SUCCEEDED(hr)) { width = NS_lround(glyphMetrics.advanceWidth * mFUnitsConvFactor) << 16; } } mGlyphWidths.Put(aGID, width); return width; }