blob: 595767a25a5610a4f3cffe4e29cb94a871aadd88 [file] [log] [blame]
/*
* Copyright 2014 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "src/utils/win/SkDWriteNTDDI_VERSION.h"
#include "include/core/SkTypes.h"
#if defined(SK_BUILD_FOR_WIN)
// SkTypes will include Windows.h, which will pull in all of the GDI defines.
// GDI #defines GetGlyphIndices to GetGlyphIndicesA or GetGlyphIndicesW, but
// IDWriteFontFace has a method called GetGlyphIndices. Since this file does
// not use GDI, undefing GetGlyphIndices makes things less confusing.
#undef GetGlyphIndices
#include "include/core/SkData.h"
#include "include/private/SkTo.h"
#include "src/core/SkFontDescriptor.h"
#include "src/core/SkFontStream.h"
#include "src/core/SkScalerContext.h"
#include "src/core/SkUtils.h"
#include "src/ports/SkScalerContext_win_dw.h"
#include "src/ports/SkTypeface_win_dw.h"
#include "src/sfnt/SkOTTable_OS_2.h"
#include "src/sfnt/SkOTTable_fvar.h"
#include "src/sfnt/SkOTTable_head.h"
#include "src/sfnt/SkOTTable_hhea.h"
#include "src/sfnt/SkOTTable_post.h"
#include "src/sfnt/SkOTUtils.h"
#include "src/utils/win/SkDWrite.h"
#include "src/utils/win/SkDWriteFontFileStream.h"
DWriteFontTypeface::Loaders::~Loaders() {
// Don't return if any fail, just keep going to free up as much as possible.
HRESULT hr;
hr = fFactory->UnregisterFontCollectionLoader(fDWriteFontCollectionLoader.get());
if (FAILED(hr)) {
SK_TRACEHR(hr, "FontCollectionLoader");
}
hr = fFactory->UnregisterFontFileLoader(fDWriteFontFileLoader.get());
if (FAILED(hr)) {
SK_TRACEHR(hr, "FontFileLoader");
}
}
void DWriteFontTypeface::onGetFamilyName(SkString* familyName) const {
SkTScopedComPtr<IDWriteLocalizedStrings> familyNames;
HRV(fDWriteFontFamily->GetFamilyNames(&familyNames));
sk_get_locale_string(familyNames.get(), nullptr/*fMgr->fLocaleName.get()*/, familyName);
}
bool DWriteFontTypeface::onGetPostScriptName(SkString* skPostScriptName) const {
SkString localSkPostScriptName;
SkTScopedComPtr<IDWriteLocalizedStrings> postScriptNames;
BOOL exists = FALSE;
if (FAILED(fDWriteFont->GetInformationalStrings(
DWRITE_INFORMATIONAL_STRING_POSTSCRIPT_NAME,
&postScriptNames,
&exists)) ||
!exists ||
FAILED(sk_get_locale_string(postScriptNames.get(), nullptr, &localSkPostScriptName)))
{
return false;
}
if (skPostScriptName) {
*skPostScriptName = localSkPostScriptName;
}
return true;
}
void DWriteFontTypeface::onGetFontDescriptor(SkFontDescriptor* desc,
bool* isLocalStream) const {
// Get the family name.
SkTScopedComPtr<IDWriteLocalizedStrings> familyNames;
HRV(fDWriteFontFamily->GetFamilyNames(&familyNames));
SkString utf8FamilyName;
sk_get_locale_string(familyNames.get(), nullptr/*fMgr->fLocaleName.get()*/, &utf8FamilyName);
desc->setFamilyName(utf8FamilyName.c_str());
desc->setStyle(this->fontStyle());
*isLocalStream = SkToBool(fLoaders);
}
void DWriteFontTypeface::onCharsToGlyphs(const SkUnichar* uni, int count,
SkGlyphID glyphs[]) const {
fDWriteFontFace->GetGlyphIndices((const UINT32*)uni, count, glyphs);
}
int DWriteFontTypeface::onCountGlyphs() const {
return fDWriteFontFace->GetGlyphCount();
}
void DWriteFontTypeface::getPostScriptGlyphNames(SkString*) const {}
int DWriteFontTypeface::onGetUPEM() const {
DWRITE_FONT_METRICS metrics;
fDWriteFontFace->GetMetrics(&metrics);
return metrics.designUnitsPerEm;
}
class LocalizedStrings_IDWriteLocalizedStrings : public SkTypeface::LocalizedStrings {
public:
/** Takes ownership of the IDWriteLocalizedStrings. */
explicit LocalizedStrings_IDWriteLocalizedStrings(IDWriteLocalizedStrings* strings)
: fIndex(0), fStrings(strings)
{ }
bool next(SkTypeface::LocalizedString* localizedString) override {
if (fIndex >= fStrings->GetCount()) {
return false;
}
// String
UINT32 stringLen;
HRBM(fStrings->GetStringLength(fIndex, &stringLen), "Could not get string length.");
SkSMallocWCHAR wString(stringLen+1);
HRBM(fStrings->GetString(fIndex, wString.get(), stringLen+1), "Could not get string.");
HRB(sk_wchar_to_skstring(wString.get(), stringLen, &localizedString->fString));
// Locale
UINT32 localeLen;
HRBM(fStrings->GetLocaleNameLength(fIndex, &localeLen), "Could not get locale length.");
SkSMallocWCHAR wLocale(localeLen+1);
HRBM(fStrings->GetLocaleName(fIndex, wLocale.get(), localeLen+1), "Could not get locale.");
HRB(sk_wchar_to_skstring(wLocale.get(), localeLen, &localizedString->fLanguage));
++fIndex;
return true;
}
private:
UINT32 fIndex;
SkTScopedComPtr<IDWriteLocalizedStrings> fStrings;
};
SkTypeface::LocalizedStrings* DWriteFontTypeface::onCreateFamilyNameIterator() const {
sk_sp<SkTypeface::LocalizedStrings> nameIter =
SkOTUtils::LocalizedStrings_NameTable::MakeForFamilyNames(*this);
if (!nameIter) {
SkTScopedComPtr<IDWriteLocalizedStrings> familyNames;
HRNM(fDWriteFontFamily->GetFamilyNames(&familyNames), "Could not obtain family names.");
nameIter = sk_make_sp<LocalizedStrings_IDWriteLocalizedStrings>(familyNames.release());
}
return nameIter.release();
}
int DWriteFontTypeface::onGetVariationDesignPosition(
SkFontArguments::VariationPosition::Coordinate coordinates[], int coordinateCount) const
{
#if defined(NTDDI_WIN10_RS3) && NTDDI_VERSION >= NTDDI_WIN10_RS3
SkTScopedComPtr<IDWriteFontFace5> fontFace5;
if (FAILED(fDWriteFontFace->QueryInterface(&fontFace5))) {
return -1;
}
// Return 0 if the font is not variable font.
if (!fontFace5->HasVariations()) {
return 0;
}
UINT32 fontAxisCount = fontFace5->GetFontAxisValueCount();
SkTScopedComPtr<IDWriteFontResource> fontResource;
HR_GENERAL(fontFace5->GetFontResource(&fontResource), nullptr, -1);
UINT32 variableAxisCount = 0;
for (UINT32 i = 0; i < fontAxisCount; ++i) {
if (fontResource->GetFontAxisAttributes(i) & DWRITE_FONT_AXIS_ATTRIBUTES_VARIABLE) {
++variableAxisCount;
}
}
if (!coordinates || coordinateCount < 0 || (unsigned)coordinateCount < variableAxisCount) {
return SkTo<int>(variableAxisCount);
}
SkAutoSTMalloc<8, DWRITE_FONT_AXIS_VALUE> fontAxisValue(fontAxisCount);
HR_GENERAL(fontFace5->GetFontAxisValues(fontAxisValue.get(), fontAxisCount), nullptr, -1);
UINT32 coordIndex = 0;
for (UINT32 axisIndex = 0; axisIndex < fontAxisCount; ++axisIndex) {
if (fontResource->GetFontAxisAttributes(axisIndex) & DWRITE_FONT_AXIS_ATTRIBUTES_VARIABLE) {
coordinates[coordIndex].axis = SkEndian_SwapBE32(fontAxisValue[axisIndex].axisTag);
coordinates[coordIndex].value = fontAxisValue[axisIndex].value;
++coordIndex;
}
}
SkASSERT(coordIndex == variableAxisCount);
return SkTo<int>(variableAxisCount);
#endif
return -1;
}
int DWriteFontTypeface::onGetVariationDesignParameters(
SkFontParameters::Variation::Axis parameters[], int parameterCount) const
{
#if defined(NTDDI_WIN10_RS3) && NTDDI_VERSION >= NTDDI_WIN10_RS3
SkTScopedComPtr<IDWriteFontFace5> fontFace5;
if (FAILED(fDWriteFontFace->QueryInterface(&fontFace5))) {
return -1;
}
// Return 0 if the font is not variable font.
if (!fontFace5->HasVariations()) {
return 0;
}
UINT32 fontAxisCount = fontFace5->GetFontAxisValueCount();
SkTScopedComPtr<IDWriteFontResource> fontResource;
HR_GENERAL(fontFace5->GetFontResource(&fontResource), nullptr, -1);
int variableAxisCount = 0;
for (UINT32 i = 0; i < fontAxisCount; ++i) {
if (fontResource->GetFontAxisAttributes(i) & DWRITE_FONT_AXIS_ATTRIBUTES_VARIABLE) {
variableAxisCount++;
}
}
if (!parameters || parameterCount < variableAxisCount) {
return variableAxisCount;
}
SkAutoSTMalloc<8, DWRITE_FONT_AXIS_RANGE> fontAxisRange(fontAxisCount);
HR_GENERAL(fontResource->GetFontAxisRanges(fontAxisRange.get(), fontAxisCount), nullptr, -1);
SkAutoSTMalloc<8, DWRITE_FONT_AXIS_VALUE> fontAxisDefaultValue(fontAxisCount);
HR_GENERAL(fontResource->GetDefaultFontAxisValues(fontAxisDefaultValue.get(), fontAxisCount),
nullptr, -1);
UINT32 coordIndex = 0;
for (UINT32 axisIndex = 0; axisIndex < fontAxisCount; ++axisIndex) {
if (fontResource->GetFontAxisAttributes(axisIndex) & DWRITE_FONT_AXIS_ATTRIBUTES_VARIABLE) {
parameters[coordIndex].tag = SkEndian_SwapBE32(fontAxisDefaultValue[axisIndex].axisTag);
parameters[coordIndex].min = fontAxisRange[axisIndex].minValue;
parameters[coordIndex].def = fontAxisDefaultValue[axisIndex].value;
parameters[coordIndex].max = fontAxisRange[axisIndex].maxValue;
parameters[coordIndex].setHidden(fontResource->GetFontAxisAttributes(axisIndex) &
DWRITE_FONT_AXIS_ATTRIBUTES_HIDDEN);
++coordIndex;
}
}
return variableAxisCount;
#endif
return -1;
}
int DWriteFontTypeface::onGetTableTags(SkFontTableTag tags[]) const {
DWRITE_FONT_FACE_TYPE type = fDWriteFontFace->GetType();
if (type != DWRITE_FONT_FACE_TYPE_CFF &&
type != DWRITE_FONT_FACE_TYPE_TRUETYPE &&
type != DWRITE_FONT_FACE_TYPE_TRUETYPE_COLLECTION)
{
return 0;
}
int ttcIndex;
std::unique_ptr<SkStreamAsset> stream = this->openStream(&ttcIndex);
return stream.get() ? SkFontStream::GetTableTags(stream.get(), ttcIndex, tags) : 0;
}
size_t DWriteFontTypeface::onGetTableData(SkFontTableTag tag, size_t offset,
size_t length, void* data) const
{
AutoDWriteTable table(fDWriteFontFace.get(), SkEndian_SwapBE32(tag));
if (!table.fExists) {
return 0;
}
if (offset > table.fSize) {
return 0;
}
size_t size = std::min(length, table.fSize - offset);
if (data) {
memcpy(data, table.fData + offset, size);
}
return size;
}
sk_sp<SkData> DWriteFontTypeface::onCopyTableData(SkFontTableTag tag) const {
const uint8_t* data;
UINT32 size;
void* lock;
BOOL exists;
fDWriteFontFace->TryGetFontTable(SkEndian_SwapBE32(tag),
reinterpret_cast<const void **>(&data), &size, &lock, &exists);
if (!exists) {
return nullptr;
}
struct Context {
Context(void* lock, IDWriteFontFace* face) : fLock(lock), fFontFace(SkRefComPtr(face)) {}
~Context() { fFontFace->ReleaseFontTable(fLock); }
void* fLock;
SkTScopedComPtr<IDWriteFontFace> fFontFace;
};
return SkData::MakeWithProc(data, size,
[](const void*, void* ctx) { delete (Context*)ctx; },
new Context(lock, fDWriteFontFace.get()));
}
sk_sp<SkTypeface> DWriteFontTypeface::onMakeClone(const SkFontArguments& args) const {
// Skip if the current face index does not match the ttcIndex
if (fDWriteFontFace->GetIndex() != SkTo<UINT32>(args.getCollectionIndex())) {
return sk_ref_sp(this);
}
#if defined(NTDDI_WIN10_RS3) && NTDDI_VERSION >= NTDDI_WIN10_RS3
SkTScopedComPtr<IDWriteFontFace5> fontFace5;
if (SUCCEEDED(fDWriteFontFace->QueryInterface(&fontFace5)) && fontFace5->HasVariations()) {
UINT32 fontAxisCount = fontFace5->GetFontAxisValueCount();
UINT32 argsCoordCount = args.getVariationDesignPosition().coordinateCount;
SkAutoSTMalloc<8, DWRITE_FONT_AXIS_VALUE> fontAxisValue(fontAxisCount);
HRN(fontFace5->GetFontAxisValues(fontAxisValue.get(), fontAxisCount));
for (UINT32 fontIndex = 0; fontIndex < fontAxisCount; ++fontIndex) {
for (UINT32 argsIndex = 0; argsIndex < argsCoordCount; ++argsIndex) {
if (SkEndian_SwapBE32(fontAxisValue[fontIndex].axisTag) ==
args.getVariationDesignPosition().coordinates[argsIndex].axis) {
fontAxisValue[fontIndex].value =
args.getVariationDesignPosition().coordinates[argsIndex].value;
}
}
}
SkTScopedComPtr<IDWriteFontResource> fontResource;
HRN(fontFace5->GetFontResource(&fontResource));
SkTScopedComPtr<IDWriteFontFace5> newFontFace5;
HRN(fontResource->CreateFontFace(fDWriteFont->GetSimulations(),
fontAxisValue.get(),
fontAxisCount,
&newFontFace5));
SkTScopedComPtr<IDWriteFontFace> newFontFace;
HRN(newFontFace5->QueryInterface(&newFontFace));
return DWriteFontTypeface::Make(fFactory.get(),
newFontFace.get(),
fDWriteFont.get(),
fDWriteFontFamily.get(),
fLoaders);
}
#endif
return sk_ref_sp(this);
}
std::unique_ptr<SkStreamAsset> DWriteFontTypeface::onOpenStream(int* ttcIndex) const {
*ttcIndex = fDWriteFontFace->GetIndex();
UINT32 numFiles;
HRNM(fDWriteFontFace->GetFiles(&numFiles, nullptr),
"Could not get number of font files.");
if (numFiles != 1) {
return nullptr;
}
SkTScopedComPtr<IDWriteFontFile> fontFile;
HRNM(fDWriteFontFace->GetFiles(&numFiles, &fontFile), "Could not get font files.");
const void* fontFileKey;
UINT32 fontFileKeySize;
HRNM(fontFile->GetReferenceKey(&fontFileKey, &fontFileKeySize),
"Could not get font file reference key.");
SkTScopedComPtr<IDWriteFontFileLoader> fontFileLoader;
HRNM(fontFile->GetLoader(&fontFileLoader), "Could not get font file loader.");
SkTScopedComPtr<IDWriteFontFileStream> fontFileStream;
HRNM(fontFileLoader->CreateStreamFromKey(fontFileKey, fontFileKeySize,
&fontFileStream),
"Could not create font file stream.");
return std::unique_ptr<SkStreamAsset>(new SkDWriteFontFileStream(fontFileStream.get()));
}
std::unique_ptr<SkScalerContext> DWriteFontTypeface::onCreateScalerContext(
const SkScalerContextEffects& effects, const SkDescriptor* desc) const
{
return std::make_unique<SkScalerContext_DW>(
sk_ref_sp(const_cast<DWriteFontTypeface*>(this)), effects, desc);
}
void DWriteFontTypeface::onFilterRec(SkScalerContextRec* rec) const {
if (rec->fFlags & SkScalerContext::kLCD_Vertical_Flag) {
rec->fMaskFormat = SkMask::kA8_Format;
rec->fFlags |= SkScalerContext::kGenA8FromLCD_Flag;
}
unsigned flagsWeDontSupport = SkScalerContext::kForceAutohinting_Flag |
SkScalerContext::kEmbolden_Flag |
SkScalerContext::kLCD_Vertical_Flag;
rec->fFlags &= ~flagsWeDontSupport;
SkFontHinting h = rec->getHinting();
// DirectWrite2 allows for hinting to be turned off. Force everything else to normal.
if (h != SkFontHinting::kNone || !fFactory2 || !fDWriteFontFace2) {
h = SkFontHinting::kNormal;
}
rec->setHinting(h);
#if defined(SK_FONT_HOST_USE_SYSTEM_SETTINGS)
IDWriteFactory* factory = sk_get_dwrite_factory();
if (factory != nullptr) {
SkTScopedComPtr<IDWriteRenderingParams> defaultRenderingParams;
if (SUCCEEDED(factory->CreateRenderingParams(&defaultRenderingParams))) {
float gamma = defaultRenderingParams->GetGamma();
rec->setDeviceGamma(gamma);
rec->setPaintGamma(gamma);
rec->setContrast(defaultRenderingParams->GetEnhancedContrast());
}
}
#endif
}
///////////////////////////////////////////////////////////////////////////////
//PDF Support
void DWriteFontTypeface::getGlyphToUnicodeMap(SkUnichar* glyphToUnicode) const {
unsigned glyphCount = fDWriteFontFace->GetGlyphCount();
sk_bzero(glyphToUnicode, sizeof(SkUnichar) * glyphCount);
IDWriteFontFace* fontFace = fDWriteFontFace.get();
int maxGlyph = -1;
unsigned remainingGlyphCount = glyphCount;
for (UINT32 c = 0; c < 0x10FFFF && remainingGlyphCount != 0; ++c) {
UINT16 glyph = 0;
HRVM(fontFace->GetGlyphIndices(&c, 1, &glyph), "Failed to get glyph index.");
// Intermittent DW bug on Windows 10. See crbug.com/470146.
if (glyph >= glyphCount) {
return;
}
if (0 < glyph && glyphToUnicode[glyph] == 0) {
maxGlyph = std::max(static_cast<int>(glyph), maxGlyph);
glyphToUnicode[glyph] = c; // Always use lowest-index unichar.
--remainingGlyphCount;
}
}
}
std::unique_ptr<SkAdvancedTypefaceMetrics> DWriteFontTypeface::onGetAdvancedMetrics() const {
std::unique_ptr<SkAdvancedTypefaceMetrics> info(nullptr);
DWRITE_FONT_METRICS dwfm;
fDWriteFontFace->GetMetrics(&dwfm);
info.reset(new SkAdvancedTypefaceMetrics);
info->fAscent = SkToS16(dwfm.ascent);
info->fDescent = SkToS16(dwfm.descent);
info->fCapHeight = SkToS16(dwfm.capHeight);
{
SkTScopedComPtr<IDWriteLocalizedStrings> postScriptNames;
BOOL exists = FALSE;
if (FAILED(fDWriteFont->GetInformationalStrings(
DWRITE_INFORMATIONAL_STRING_POSTSCRIPT_NAME,
&postScriptNames,
&exists)) ||
!exists ||
FAILED(sk_get_locale_string(postScriptNames.get(), nullptr, &info->fPostScriptName)))
{
SkDEBUGF("Unable to get postscript name for typeface %p\n", this);
}
}
// SkAdvancedTypefaceMetrics::fFontName must actually be a family name.
SkTScopedComPtr<IDWriteLocalizedStrings> familyNames;
if (FAILED(fDWriteFontFamily->GetFamilyNames(&familyNames)) ||
FAILED(sk_get_locale_string(familyNames.get(), nullptr, &info->fFontName)))
{
SkDEBUGF("Unable to get family name for typeface 0x%p\n", this);
}
if (info->fPostScriptName.isEmpty()) {
info->fPostScriptName = info->fFontName;
}
DWRITE_FONT_FACE_TYPE fontType = fDWriteFontFace->GetType();
if (fontType != DWRITE_FONT_FACE_TYPE_TRUETYPE &&
fontType != DWRITE_FONT_FACE_TYPE_TRUETYPE_COLLECTION)
{
return info;
}
// Simulated fonts aren't really TrueType fonts.
if (fDWriteFontFace->GetSimulations() == DWRITE_FONT_SIMULATIONS_NONE) {
info->fType = SkAdvancedTypefaceMetrics::kTrueType_Font;
}
AutoTDWriteTable<SkOTTableHead> headTable(fDWriteFontFace.get());
AutoTDWriteTable<SkOTTablePostScript> postTable(fDWriteFontFace.get());
AutoTDWriteTable<SkOTTableHorizontalHeader> hheaTable(fDWriteFontFace.get());
AutoTDWriteTable<SkOTTableOS2> os2Table(fDWriteFontFace.get());
if (!headTable.fExists || !postTable.fExists || !hheaTable.fExists || !os2Table.fExists) {
return info;
}
SkOTUtils::SetAdvancedTypefaceFlags(os2Table->version.v4.fsType, info.get());
// There are versions of DirectWrite which support named instances for system variation fonts,
// but no means to indicate that such a typeface is a variation.
AutoTDWriteTable<SkOTTableFontVariations> fvarTable(fDWriteFontFace.get());
if (fvarTable.fExists) {
info->fFlags |= SkAdvancedTypefaceMetrics::kVariable_FontFlag;
}
//There exist CJK fonts which set the IsFixedPitch and Monospace bits,
//but have full width, latin half-width, and half-width kana.
bool fixedWidth = (postTable->isFixedPitch &&
(1 == SkEndian_SwapBE16(hheaTable->numberOfHMetrics)));
//Monospace
if (fixedWidth) {
info->fStyle |= SkAdvancedTypefaceMetrics::kFixedPitch_Style;
}
//Italic
if (os2Table->version.v0.fsSelection.field.Italic) {
info->fStyle |= SkAdvancedTypefaceMetrics::kItalic_Style;
}
//Serif
using SerifStyle = SkPanose::Data::TextAndDisplay::SerifStyle;
SerifStyle serifStyle = os2Table->version.v0.panose.data.textAndDisplay.bSerifStyle;
if (SkPanose::FamilyType::TextAndDisplay == os2Table->version.v0.panose.bFamilyType) {
if (SerifStyle::Cove == serifStyle ||
SerifStyle::ObtuseCove == serifStyle ||
SerifStyle::SquareCove == serifStyle ||
SerifStyle::ObtuseSquareCove == serifStyle ||
SerifStyle::Square == serifStyle ||
SerifStyle::Thin == serifStyle ||
SerifStyle::Bone == serifStyle ||
SerifStyle::Exaggerated == serifStyle ||
SerifStyle::Triangle == serifStyle)
{
info->fStyle |= SkAdvancedTypefaceMetrics::kSerif_Style;
}
//Script
} else if (SkPanose::FamilyType::Script == os2Table->version.v0.panose.bFamilyType) {
info->fStyle |= SkAdvancedTypefaceMetrics::kScript_Style;
}
info->fItalicAngle = SkEndian_SwapBE32(postTable->italicAngle) >> 16;
info->fBBox = SkIRect::MakeLTRB((int32_t)SkEndian_SwapBE16((uint16_t)headTable->xMin),
(int32_t)SkEndian_SwapBE16((uint16_t)headTable->yMax),
(int32_t)SkEndian_SwapBE16((uint16_t)headTable->xMax),
(int32_t)SkEndian_SwapBE16((uint16_t)headTable->yMin));
return info;
}
#endif//defined(SK_BUILD_FOR_WIN)