1 /*
2  * Copyright 2006 The Android Open Source Project
3  *
4  * Use of this source code is governed by a BSD-style license that can be
5  * found in the LICENSE file.
6  */
7 
8 #include "SkAdvancedTypefaceMetrics.h"
9 #include "SkBitmap.h"
10 #include "SkCanvas.h"
11 #include "SkColorPriv.h"
12 #include "SkDescriptor.h"
13 #include "SkFDot6.h"
14 #include "SkFontDescriptor.h"
15 #include "SkFontHost_FreeType_common.h"
16 #include "SkGlyph.h"
17 #include "SkMakeUnique.h"
18 #include "SkMask.h"
19 #include "SkMaskGamma.h"
20 #include "SkMatrix22.h"
21 #include "SkMalloc.h"
22 #include "SkMutex.h"
23 #include "SkOTUtils.h"
24 #include "SkPath.h"
25 #include "SkScalerContext.h"
26 #include "SkStream.h"
27 #include "SkString.h"
28 #include "SkTemplates.h"
29 #include <memory>
30 
31 #include <ft2build.h>
32 #include FT_ADVANCES_H
33 #include FT_BITMAP_H
34 #include FT_FREETYPE_H
35 #include FT_LCD_FILTER_H
36 #include FT_MODULE_H
37 #include FT_MULTIPLE_MASTERS_H
38 #include FT_OUTLINE_H
39 #include FT_SIZES_H
40 #include FT_SYSTEM_H
41 #include FT_TRUETYPE_TABLES_H
42 #include FT_TYPE1_TABLES_H
43 #include FT_XFREE86_H
44 
45 // SK_FREETYPE_MINIMUM_RUNTIME_VERSION 0x<major><minor><patch><flags>
46 // Flag SK_FREETYPE_DLOPEN: also try dlopen to get newer features.
47 #define SK_FREETYPE_DLOPEN (0x1)
48 #ifndef SK_FREETYPE_MINIMUM_RUNTIME_VERSION
49 #  if defined(SK_BUILD_FOR_ANDROID_FRAMEWORK) || defined (GOOGLE3)
50 #    define SK_FREETYPE_MINIMUM_RUNTIME_VERSION (((FREETYPE_MAJOR) << 24) | ((FREETYPE_MINOR) << 16) | ((FREETYPE_PATCH) << 8))
51 #  else
52 #    define SK_FREETYPE_MINIMUM_RUNTIME_VERSION ((2 << 24) | (3 << 16) | (11 << 8) | (SK_FREETYPE_DLOPEN))
53 #  endif
54 #endif
55 #if SK_FREETYPE_MINIMUM_RUNTIME_VERSION & SK_FREETYPE_DLOPEN
56 #  include <dlfcn.h>
57 #endif
58 
59 // FT_LOAD_COLOR and the corresponding FT_Pixel_Mode::FT_PIXEL_MODE_BGRA
60 // were introduced in FreeType 2.5.0.
61 // The following may be removed once FreeType 2.5.0 is required to build.
62 #ifndef FT_LOAD_COLOR
63 #    define FT_LOAD_COLOR ( 1L << 20 )
64 #    define FT_PIXEL_MODE_BGRA 7
65 #endif
66 
67 // FT_LOAD_BITMAP_METRICS_ONLY was introduced in FreeType 2.7.1
68 // The following may be removed once FreeType 2.7.1 is required to build.
69 #ifndef FT_LOAD_BITMAP_METRICS_ONLY
70 #    define FT_LOAD_BITMAP_METRICS_ONLY ( 1L << 22 )
71 #endif
72 
73 //#define ENABLE_GLYPH_SPEW     // for tracing calls
74 //#define DUMP_STRIKE_CREATION
75 //#define SK_FONTHOST_FREETYPE_RUNTIME_VERSION
76 //#define SK_GAMMA_APPLY_TO_A8
77 
isLCD(const SkScalerContext::Rec & rec)78 static bool isLCD(const SkScalerContext::Rec& rec) {
79     return SkMask::kLCD16_Format == rec.fMaskFormat;
80 }
81 
82 //////////////////////////////////////////////////////////////////////////
83 
84 extern "C" {
sk_ft_alloc(FT_Memory,long size)85     static void* sk_ft_alloc(FT_Memory, long size) {
86         return sk_malloc_throw(size);
87     }
sk_ft_free(FT_Memory,void * block)88     static void sk_ft_free(FT_Memory, void* block) {
89         sk_free(block);
90     }
sk_ft_realloc(FT_Memory,long cur_size,long new_size,void * block)91     static void* sk_ft_realloc(FT_Memory, long cur_size, long new_size, void* block) {
92         return sk_realloc_throw(block, new_size);
93     }
94 };
95 FT_MemoryRec_ gFTMemory = { nullptr, sk_ft_alloc, sk_ft_free, sk_ft_realloc };
96 
97 class FreeTypeLibrary : SkNoncopyable {
98 public:
FreeTypeLibrary()99     FreeTypeLibrary()
100         : fGetVarDesignCoordinates(nullptr)
101         , fLibrary(nullptr)
102         , fIsLCDSupported(false)
103         , fLCDExtra(0)
104     {
105         if (FT_New_Library(&gFTMemory, &fLibrary)) {
106             return;
107         }
108         FT_Add_Default_Modules(fLibrary);
109 
110         // When using dlsym
111         // *(void**)(&procPtr) = dlsym(self, "proc");
112         // is non-standard, but safe for POSIX. Cannot write
113         // *reinterpret_cast<void**>(&procPtr) = dlsym(self, "proc");
114         // because clang has not implemented DR573. See http://clang.llvm.org/cxx_dr_status.html .
115 
116         FT_Int major, minor, patch;
117         FT_Library_Version(fLibrary, &major, &minor, &patch);
118 
119 #if SK_FREETYPE_MINIMUM_RUNTIME_VERSION >= 0x02070100
120         fGetVarDesignCoordinates = FT_Get_Var_Design_Coordinates;
121 #elif SK_FREETYPE_MINIMUM_RUNTIME_VERSION & SK_FREETYPE_DLOPEN
122         if (major > 2 || ((major == 2 && minor > 7) || (major == 2 && minor == 7 && patch >= 0))) {
123             //The FreeType library is already loaded, so symbols are available in process.
124             void* self = dlopen(nullptr, RTLD_LAZY);
125             if (self) {
126                 *(void**)(&fGetVarDesignCoordinates) = dlsym(self, "FT_Get_Var_Design_Coordinates");
127                 dlclose(self);
128             }
129         }
130 #endif
131 
132 #if SK_FREETYPE_MINIMUM_RUNTIME_VERSION >= 0x02070200
133         FT_Set_Default_Properties(fLibrary);
134 #elif SK_FREETYPE_MINIMUM_RUNTIME_VERSION & SK_FREETYPE_DLOPEN
135         if (major > 2 || ((major == 2 && minor > 7) || (major == 2 && minor == 7 && patch >= 1))) {
136             //The FreeType library is already loaded, so symbols are available in process.
137             void* self = dlopen(nullptr, RTLD_LAZY);
138             if (self) {
139                 FT_Set_Default_PropertiesProc setDefaultProperties;
140                 *(void**)(&setDefaultProperties) = dlsym(self, "FT_Set_Default_Properties");
141                 dlclose(self);
142 
143                 if (setDefaultProperties) {
144                     setDefaultProperties(fLibrary);
145                 }
146             }
147         }
148 #endif
149 
150         // Setup LCD filtering. This reduces color fringes for LCD smoothed glyphs.
151         // The default has changed over time, so this doesn't mean the same thing to all users.
152         if (FT_Library_SetLcdFilter(fLibrary, FT_LCD_FILTER_DEFAULT) == 0) {
153             fIsLCDSupported = true;
154             fLCDExtra = 2; //Using a filter adds one full pixel to each side.
155         }
156     }
~FreeTypeLibrary()157     ~FreeTypeLibrary() {
158         if (fLibrary) {
159             FT_Done_Library(fLibrary);
160         }
161     }
162 
library()163     FT_Library library() { return fLibrary; }
isLCDSupported()164     bool isLCDSupported() { return fIsLCDSupported; }
lcdExtra()165     int lcdExtra() { return fLCDExtra; }
166 
167     // FT_Get_{MM,Var}_{Blend,Design}_Coordinates were added in FreeType 2.7.1.
168     // Prior to this there was no way to get the coordinates out of the FT_Face.
169     // This wasn't too bad because you needed to specify them anyway, and the clamp was provided.
170     // However, this doesn't work when face_index specifies named variations as introduced in 2.6.1.
171     using FT_Get_Var_Blend_CoordinatesProc = FT_Error (*)(FT_Face, FT_UInt, FT_Fixed*);
172     FT_Get_Var_Blend_CoordinatesProc fGetVarDesignCoordinates;
173 
174 private:
175     FT_Library fLibrary;
176     bool fIsLCDSupported;
177     int fLCDExtra;
178 
179     // FT_Library_SetLcdFilterWeights was introduced in FreeType 2.4.0.
180     // The following platforms provide FreeType of at least 2.4.0.
181     // Ubuntu >= 11.04 (previous deprecated April 2013)
182     // Debian >= 6.0 (good)
183     // OpenSuse >= 11.4 (previous deprecated January 2012 / Nov 2013 for Evergreen 11.2)
184     // Fedora >= 14 (good)
185     // Android >= Gingerbread (good)
186     // RHEL >= 7 (6 has 2.3.11, EOL Nov 2020, Phase 3 May 2017)
187     using FT_Library_SetLcdFilterWeightsProc = FT_Error (*)(FT_Library, unsigned char*);
188 
189     // FreeType added the ability to read global properties in 2.7.0. After 2.7.1 a means for users
190     // of FT_New_Library to request these global properties to be read was added.
191     using FT_Set_Default_PropertiesProc = void (*)(FT_Library);
192 };
193 
194 struct SkFaceRec;
195 
196 SK_DECLARE_STATIC_MUTEX(gFTMutex);
197 static FreeTypeLibrary* gFTLibrary;
198 static SkFaceRec* gFaceRecHead;
199 
200 // Private to ref_ft_library and unref_ft_library
201 static int gFTCount;
202 
203 // Caller must lock gFTMutex before calling this function.
ref_ft_library()204 static bool ref_ft_library() {
205     gFTMutex.assertHeld();
206     SkASSERT(gFTCount >= 0);
207 
208     if (0 == gFTCount) {
209         SkASSERT(nullptr == gFTLibrary);
210         gFTLibrary = new FreeTypeLibrary;
211     }
212     ++gFTCount;
213     return gFTLibrary->library();
214 }
215 
216 // Caller must lock gFTMutex before calling this function.
unref_ft_library()217 static void unref_ft_library() {
218     gFTMutex.assertHeld();
219     SkASSERT(gFTCount > 0);
220 
221     --gFTCount;
222     if (0 == gFTCount) {
223         SkASSERT(nullptr == gFaceRecHead);
224         SkASSERT(nullptr != gFTLibrary);
225         delete gFTLibrary;
226         SkDEBUGCODE(gFTLibrary = nullptr;)
227     }
228 }
229 
230 ///////////////////////////////////////////////////////////////////////////
231 
232 struct SkFaceRec {
233     SkFaceRec* fNext;
234     std::unique_ptr<FT_FaceRec, SkFunctionWrapper<FT_Error, FT_FaceRec, FT_Done_Face>> fFace;
235     FT_StreamRec fFTStream;
236     std::unique_ptr<SkStreamAsset> fSkStream;
237     uint32_t fRefCnt;
238     uint32_t fFontID;
239 
240     // FreeType prior to 2.7.1 does not implement retreiving variation design metrics.
241     // Cache the variation design metrics used to create the font if the user specifies them.
242     SkAutoSTMalloc<4, SkFixed> fAxes;
243     int fAxesCount;
244 
245     // FreeType from 2.6.1 (14d6b5d7) until 2.7.0 (ee3f36f6b38) uses font_index for both font index
246     // and named variation index on input, but masks the named variation index part on output.
247     // Manually keep track of when a named variation is requested for 2.6.1 until 2.7.1.
248     bool fNamedVariationSpecified;
249 
250     SkFaceRec(std::unique_ptr<SkStreamAsset> stream, uint32_t fontID);
251 };
252 
253 extern "C" {
sk_ft_stream_io(FT_Stream ftStream,unsigned long offset,unsigned char * buffer,unsigned long count)254     static unsigned long sk_ft_stream_io(FT_Stream ftStream,
255                                          unsigned long offset,
256                                          unsigned char* buffer,
257                                          unsigned long count)
258     {
259         SkStreamAsset* stream = static_cast<SkStreamAsset*>(ftStream->descriptor.pointer);
260 
261         if (count) {
262             if (!stream->seek(offset)) {
263                 return 0;
264             }
265             count = stream->read(buffer, count);
266         }
267         return count;
268     }
269 
sk_ft_stream_close(FT_Stream)270     static void sk_ft_stream_close(FT_Stream) {}
271 }
272 
SkFaceRec(std::unique_ptr<SkStreamAsset> stream,uint32_t fontID)273 SkFaceRec::SkFaceRec(std::unique_ptr<SkStreamAsset> stream, uint32_t fontID)
274         : fNext(nullptr), fSkStream(std::move(stream)), fRefCnt(1), fFontID(fontID)
275         , fAxesCount(0), fNamedVariationSpecified(false)
276 {
277     sk_bzero(&fFTStream, sizeof(fFTStream));
278     fFTStream.size = fSkStream->getLength();
279     fFTStream.descriptor.pointer = fSkStream.get();
280     fFTStream.read  = sk_ft_stream_io;
281     fFTStream.close = sk_ft_stream_close;
282 }
283 
ft_face_setup_axes(SkFaceRec * rec,const SkFontData & data)284 static void ft_face_setup_axes(SkFaceRec* rec, const SkFontData& data) {
285     if (!(rec->fFace->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS)) {
286         return;
287     }
288 
289     // If a named variation is requested, don't overwrite the named variation's position.
290     if (data.getIndex() > 0xFFFF) {
291         rec->fNamedVariationSpecified = true;
292         return;
293     }
294 
295     SkDEBUGCODE(
296         FT_MM_Var* variations = nullptr;
297         if (FT_Get_MM_Var(rec->fFace.get(), &variations)) {
298             SkDEBUGF(("INFO: font %s claims variations, but none found.\n",
299                       rec->fFace->family_name));
300             return;
301         }
302         SkAutoFree autoFreeVariations(variations);
303 
304         if (static_cast<FT_UInt>(data.getAxisCount()) != variations->num_axis) {
305             SkDEBUGF(("INFO: font %s has %d variations, but %d were specified.\n",
306                       rec->fFace->family_name, variations->num_axis, data.getAxisCount()));
307             return;
308         }
309     )
310 
311     SkAutoSTMalloc<4, FT_Fixed> coords(data.getAxisCount());
312     for (int i = 0; i < data.getAxisCount(); ++i) {
313         coords[i] = data.getAxis()[i];
314     }
315     if (FT_Set_Var_Design_Coordinates(rec->fFace.get(), data.getAxisCount(), coords.get())) {
316         SkDEBUGF(("INFO: font %s has variations, but specified variations could not be set.\n",
317                   rec->fFace->family_name));
318         return;
319     }
320 
321     rec->fAxesCount = data.getAxisCount();
322     rec->fAxes.reset(rec->fAxesCount);
323     for (int i = 0; i < rec->fAxesCount; ++i) {
324         rec->fAxes[i] = data.getAxis()[i];
325     }
326 }
327 
328 // Will return nullptr on failure
329 // Caller must lock gFTMutex before calling this function.
ref_ft_face(const SkTypeface * typeface)330 static SkFaceRec* ref_ft_face(const SkTypeface* typeface) {
331     gFTMutex.assertHeld();
332 
333     const SkFontID fontID = typeface->uniqueID();
334     SkFaceRec* cachedRec = gFaceRecHead;
335     while (cachedRec) {
336         if (cachedRec->fFontID == fontID) {
337             SkASSERT(cachedRec->fFace);
338             cachedRec->fRefCnt += 1;
339             return cachedRec;
340         }
341         cachedRec = cachedRec->fNext;
342     }
343 
344     std::unique_ptr<SkFontData> data = typeface->makeFontData();
345     if (nullptr == data || !data->hasStream()) {
346         return nullptr;
347     }
348 
349     std::unique_ptr<SkFaceRec> rec(new SkFaceRec(data->detachStream(), fontID));
350 
351     FT_Open_Args args;
352     memset(&args, 0, sizeof(args));
353     const void* memoryBase = rec->fSkStream->getMemoryBase();
354     if (memoryBase) {
355         args.flags = FT_OPEN_MEMORY;
356         args.memory_base = (const FT_Byte*)memoryBase;
357         args.memory_size = rec->fSkStream->getLength();
358     } else {
359         args.flags = FT_OPEN_STREAM;
360         args.stream = &rec->fFTStream;
361     }
362 
363     {
364         FT_Face rawFace;
365         FT_Error err = FT_Open_Face(gFTLibrary->library(), &args, data->getIndex(), &rawFace);
366         if (err) {
367             SkDEBUGF(("ERROR: unable to open font '%x'\n", fontID));
368             return nullptr;
369         }
370         rec->fFace.reset(rawFace);
371     }
372     SkASSERT(rec->fFace);
373 
374     ft_face_setup_axes(rec.get(), *data);
375 
376     // FreeType will set the charmap to the "most unicode" cmap if it exists.
377     // If there are no unicode cmaps, the charmap is set to nullptr.
378     // However, "symbol" cmaps should also be considered "fallback unicode" cmaps
379     // because they are effectively private use area only (even if they aren't).
380     // This is the last on the fallback list at
381     // https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6cmap.html
382     if (!rec->fFace->charmap) {
383         FT_Select_Charmap(rec->fFace.get(), FT_ENCODING_MS_SYMBOL);
384     }
385 
386     rec->fNext = gFaceRecHead;
387     gFaceRecHead = rec.get();
388     return rec.release();
389 }
390 
391 // Caller must lock gFTMutex before calling this function.
392 // Marked extern because vc++ does not support internal linkage template parameters.
unref_ft_face(SkFaceRec * faceRec)393 extern /*static*/ void unref_ft_face(SkFaceRec* faceRec) {
394     gFTMutex.assertHeld();
395 
396     SkFaceRec*  rec = gFaceRecHead;
397     SkFaceRec*  prev = nullptr;
398     while (rec) {
399         SkFaceRec* next = rec->fNext;
400         if (rec->fFace == faceRec->fFace) {
401             if (--rec->fRefCnt == 0) {
402                 if (prev) {
403                     prev->fNext = next;
404                 } else {
405                     gFaceRecHead = next;
406                 }
407                 delete rec;
408             }
409             return;
410         }
411         prev = rec;
412         rec = next;
413     }
414     SkDEBUGFAIL("shouldn't get here, face not in list");
415 }
416 
417 class AutoFTAccess {
418 public:
AutoFTAccess(const SkTypeface * tf)419     AutoFTAccess(const SkTypeface* tf) : fFaceRec(nullptr) {
420         gFTMutex.acquire();
421         if (!ref_ft_library()) {
422             sk_throw();
423         }
424         fFaceRec = ref_ft_face(tf);
425     }
426 
~AutoFTAccess()427     ~AutoFTAccess() {
428         if (fFaceRec) {
429             unref_ft_face(fFaceRec);
430         }
431         unref_ft_library();
432         gFTMutex.release();
433     }
434 
face()435     FT_Face face() { return fFaceRec ? fFaceRec->fFace.get() : nullptr; }
getAxesCount()436     int getAxesCount() { return fFaceRec ? fFaceRec->fAxesCount : 0; }
getAxes()437     SkFixed* getAxes() { return fFaceRec ? fFaceRec->fAxes.get() : nullptr; }
isNamedVariationSpecified()438     bool isNamedVariationSpecified() {
439         return fFaceRec ? fFaceRec->fNamedVariationSpecified : false;
440     }
441 
442 private:
443     SkFaceRec* fFaceRec;
444 };
445 
446 ///////////////////////////////////////////////////////////////////////////
447 
448 class SkScalerContext_FreeType : public SkScalerContext_FreeType_Base {
449 public:
450     SkScalerContext_FreeType(sk_sp<SkTypeface>,
451                              const SkScalerContextEffects&,
452                              const SkDescriptor* desc);
453     ~SkScalerContext_FreeType() override;
454 
success() const455     bool success() const {
456         return fFTSize != nullptr && fFace != nullptr;
457     }
458 
459 protected:
460     unsigned generateGlyphCount() override;
461     uint16_t generateCharToGlyph(SkUnichar uni) override;
462     void generateAdvance(SkGlyph* glyph) override;
463     void generateMetrics(SkGlyph* glyph) override;
464     void generateImage(const SkGlyph& glyph) override;
465     void generatePath(SkGlyphID glyphID, SkPath* path) override;
466     void generateFontMetrics(SkPaint::FontMetrics*) override;
467     SkUnichar generateGlyphToChar(uint16_t glyph) override;
468 
469 private:
470     using UnrefFTFace = SkFunctionWrapper<void, SkFaceRec, unref_ft_face>;
471     std::unique_ptr<SkFaceRec, UnrefFTFace> fFaceRec;
472 
473     FT_Face   fFace;  // Borrowed face from gFaceRecHead.
474     FT_Size   fFTSize;  // The size on the fFace for this scaler.
475     FT_Int    fStrikeIndex;
476 
477     /** The rest of the matrix after FreeType handles the size.
478      *  With outline font rasterization this is handled by FreeType with FT_Set_Transform.
479      *  With bitmap only fonts this matrix must be applied to scale the bitmap.
480      */
481     SkMatrix  fMatrix22Scalar;
482     /** Same as fMatrix22Scalar, but in FreeType units and space. */
483     FT_Matrix fMatrix22;
484     /** The actual size requested. */
485     SkVector  fScale;
486 
487     uint32_t  fLoadGlyphFlags;
488     bool      fDoLinearMetrics;
489     bool      fLCDIsVert;
490 
491     FT_Error setupSize();
492     void getBBoxForCurrentGlyph(SkGlyph* glyph, FT_BBox* bbox,
493                                 bool snapToPixelBoundary = false);
494     bool getCBoxForLetter(char letter, FT_BBox* bbox);
495     // Caller must lock gFTMutex before calling this function.
496     void updateGlyphIfLCD(SkGlyph* glyph);
497     // Caller must lock gFTMutex before calling this function.
498     // update FreeType2 glyph slot with glyph emboldened
499     void emboldenIfNeeded(FT_Face face, FT_GlyphSlot glyph);
500     bool shouldSubpixelBitmap(const SkGlyph&, const SkMatrix&);
501 };
502 
503 ///////////////////////////////////////////////////////////////////////////
504 
canEmbed(FT_Face face)505 static bool canEmbed(FT_Face face) {
506     FT_UShort fsType = FT_Get_FSType_Flags(face);
507     return (fsType & (FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING |
508                       FT_FSTYPE_BITMAP_EMBEDDING_ONLY)) == 0;
509 }
510 
canSubset(FT_Face face)511 static bool canSubset(FT_Face face) {
512     FT_UShort fsType = FT_Get_FSType_Flags(face);
513     return (fsType & FT_FSTYPE_NO_SUBSETTING) == 0;
514 }
515 
GetLetterCBox(FT_Face face,char letter,FT_BBox * bbox)516 static bool GetLetterCBox(FT_Face face, char letter, FT_BBox* bbox) {
517     const FT_UInt glyph_id = FT_Get_Char_Index(face, letter);
518     if (!glyph_id)
519         return false;
520     if (FT_Load_Glyph(face, glyph_id, FT_LOAD_NO_SCALE) != 0)
521         return false;
522     FT_Outline_Get_CBox(&face->glyph->outline, bbox);
523     return true;
524 }
525 
populate_glyph_to_unicode(FT_Face & face,SkTDArray<SkUnichar> * glyphToUnicode)526 static void populate_glyph_to_unicode(FT_Face& face, SkTDArray<SkUnichar>* glyphToUnicode) {
527     FT_Long numGlyphs = face->num_glyphs;
528     glyphToUnicode->setCount(SkToInt(numGlyphs));
529     sk_bzero(glyphToUnicode->begin(), sizeof((*glyphToUnicode)[0]) * numGlyphs);
530 
531     FT_UInt glyphIndex;
532     SkUnichar charCode = FT_Get_First_Char(face, &glyphIndex);
533     while (glyphIndex) {
534         SkASSERT(glyphIndex < SkToUInt(numGlyphs));
535         // Use the first character that maps to this glyphID. https://crbug.com/359065
536         if (0 == (*glyphToUnicode)[glyphIndex]) {
537             (*glyphToUnicode)[glyphIndex] = charCode;
538         }
539         charCode = FT_Get_Next_Char(face, charCode, &glyphIndex);
540     }
541 }
542 
onGetAdvancedTypefaceMetrics(PerGlyphInfo perGlyphInfo,const uint32_t * glyphIDs,uint32_t glyphIDsCount) const543 SkAdvancedTypefaceMetrics* SkTypeface_FreeType::onGetAdvancedTypefaceMetrics(
544         PerGlyphInfo perGlyphInfo,
545         const uint32_t* glyphIDs,
546         uint32_t glyphIDsCount) const {
547     AutoFTAccess fta(this);
548     FT_Face face = fta.face();
549     if (!face) {
550         return nullptr;
551     }
552 
553     SkAdvancedTypefaceMetrics* info = new SkAdvancedTypefaceMetrics;
554     info->fFontName.set(FT_Get_Postscript_Name(face));
555 
556     if (FT_HAS_MULTIPLE_MASTERS(face)) {
557         info->fFlags |= SkAdvancedTypefaceMetrics::kMultiMaster_FontFlag;
558     }
559     if (!canEmbed(face)) {
560         info->fFlags |= SkAdvancedTypefaceMetrics::kNotEmbeddable_FontFlag;
561     }
562     if (!canSubset(face)) {
563         info->fFlags |= SkAdvancedTypefaceMetrics::kNotSubsettable_FontFlag;
564     }
565 
566     const char* fontType = FT_Get_X11_Font_Format(face);
567     if (strcmp(fontType, "Type 1") == 0) {
568         info->fType = SkAdvancedTypefaceMetrics::kType1_Font;
569     } else if (strcmp(fontType, "CID Type 1") == 0) {
570         info->fType = SkAdvancedTypefaceMetrics::kType1CID_Font;
571     } else if (strcmp(fontType, "CFF") == 0) {
572         info->fType = SkAdvancedTypefaceMetrics::kCFF_Font;
573     } else if (strcmp(fontType, "TrueType") == 0) {
574         info->fType = SkAdvancedTypefaceMetrics::kTrueType_Font;
575     } else {
576         info->fType = SkAdvancedTypefaceMetrics::kOther_Font;
577     }
578 
579     info->fStyle = (SkAdvancedTypefaceMetrics::StyleFlags)0;
580     if (FT_IS_FIXED_WIDTH(face)) {
581         info->fStyle |= SkAdvancedTypefaceMetrics::kFixedPitch_Style;
582     }
583     if (face->style_flags & FT_STYLE_FLAG_ITALIC) {
584         info->fStyle |= SkAdvancedTypefaceMetrics::kItalic_Style;
585     }
586 
587     PS_FontInfoRec psFontInfo;
588     TT_Postscript* postTable;
589     if (FT_Get_PS_Font_Info(face, &psFontInfo) == 0) {
590         info->fItalicAngle = psFontInfo.italic_angle;
591     } else if ((postTable = (TT_Postscript*)FT_Get_Sfnt_Table(face, ft_sfnt_post)) != nullptr) {
592         info->fItalicAngle = SkFixedToScalar(postTable->italicAngle);
593     } else {
594         info->fItalicAngle = 0;
595     }
596 
597     info->fAscent = face->ascender;
598     info->fDescent = face->descender;
599 
600     // Figure out a good guess for StemV - Min width of i, I, !, 1.
601     // This probably isn't very good with an italic font.
602     int16_t min_width = SHRT_MAX;
603     info->fStemV = 0;
604     char stem_chars[] = {'i', 'I', '!', '1'};
605     for (size_t i = 0; i < SK_ARRAY_COUNT(stem_chars); i++) {
606         FT_BBox bbox;
607         if (GetLetterCBox(face, stem_chars[i], &bbox)) {
608             int16_t width = bbox.xMax - bbox.xMin;
609             if (width > 0 && width < min_width) {
610                 min_width = width;
611                 info->fStemV = min_width;
612             }
613         }
614     }
615 
616     TT_PCLT* pcltTable;
617     TT_OS2* os2Table;
618     if ((pcltTable = (TT_PCLT*)FT_Get_Sfnt_Table(face, ft_sfnt_pclt)) != nullptr) {
619         info->fCapHeight = pcltTable->CapHeight;
620         uint8_t serif_style = pcltTable->SerifStyle & 0x3F;
621         if (2 <= serif_style && serif_style <= 6) {
622             info->fStyle |= SkAdvancedTypefaceMetrics::kSerif_Style;
623         } else if (9 <= serif_style && serif_style <= 12) {
624             info->fStyle |= SkAdvancedTypefaceMetrics::kScript_Style;
625         }
626     } else if (((os2Table = (TT_OS2*)FT_Get_Sfnt_Table(face, ft_sfnt_os2)) != nullptr) &&
627                // sCapHeight is available only when version 2 or later.
628                os2Table->version != 0xFFFF &&
629                os2Table->version >= 2)
630     {
631         info->fCapHeight = os2Table->sCapHeight;
632     } else {
633         // Figure out a good guess for CapHeight: average the height of M and X.
634         FT_BBox m_bbox, x_bbox;
635         bool got_m, got_x;
636         got_m = GetLetterCBox(face, 'M', &m_bbox);
637         got_x = GetLetterCBox(face, 'X', &x_bbox);
638         if (got_m && got_x) {
639             info->fCapHeight = ((m_bbox.yMax - m_bbox.yMin) + (x_bbox.yMax - x_bbox.yMin)) / 2;
640         } else if (got_m && !got_x) {
641             info->fCapHeight = m_bbox.yMax - m_bbox.yMin;
642         } else if (!got_m && got_x) {
643             info->fCapHeight = x_bbox.yMax - x_bbox.yMin;
644         } else {
645             // Last resort, use the ascent.
646             info->fCapHeight = info->fAscent;
647         }
648     }
649 
650     info->fBBox = SkIRect::MakeLTRB(face->bbox.xMin, face->bbox.yMax,
651                                     face->bbox.xMax, face->bbox.yMin);
652 
653     if (!FT_IS_SCALABLE(face)) {
654         perGlyphInfo = kNo_PerGlyphInfo;
655     }
656 
657     if (perGlyphInfo & kGlyphNames_PerGlyphInfo &&
658         info->fType == SkAdvancedTypefaceMetrics::kType1_Font)
659     {
660         // Postscript fonts may contain more than 255 glyphs, so we end up
661         // using multiple font descriptions with a glyph ordering.  Record
662         // the name of each glyph.
663         info->fGlyphNames.reset(face->num_glyphs);
664         for (int gID = 0; gID < face->num_glyphs; gID++) {
665             char glyphName[128];  // PS limit for names is 127 bytes.
666             FT_Get_Glyph_Name(face, gID, glyphName, 128);
667             info->fGlyphNames[gID].set(glyphName);
668         }
669     }
670 
671     if (perGlyphInfo & kToUnicode_PerGlyphInfo &&
672         info->fType != SkAdvancedTypefaceMetrics::kType1_Font &&
673         face->num_charmaps)
674     {
675         populate_glyph_to_unicode(face, &(info->fGlyphToUnicode));
676     }
677 
678     return info;
679 }
680 
681 ///////////////////////////////////////////////////////////////////////////
682 
bothZero(SkScalar a,SkScalar b)683 static bool bothZero(SkScalar a, SkScalar b) {
684     return 0 == a && 0 == b;
685 }
686 
687 // returns false if there is any non-90-rotation or skew
isAxisAligned(const SkScalerContext::Rec & rec)688 static bool isAxisAligned(const SkScalerContext::Rec& rec) {
689     return 0 == rec.fPreSkewX &&
690            (bothZero(rec.fPost2x2[0][1], rec.fPost2x2[1][0]) ||
691             bothZero(rec.fPost2x2[0][0], rec.fPost2x2[1][1]));
692 }
693 
onCreateScalerContext(const SkScalerContextEffects & effects,const SkDescriptor * desc) const694 SkScalerContext* SkTypeface_FreeType::onCreateScalerContext(const SkScalerContextEffects& effects,
695                                                             const SkDescriptor* desc) const {
696     auto c = skstd::make_unique<SkScalerContext_FreeType>(
697             sk_ref_sp(const_cast<SkTypeface_FreeType*>(this)), effects, desc);
698     if (!c->success()) {
699         return nullptr;
700     }
701     return c.release();
702 }
703 
onFilterRec(SkScalerContextRec * rec) const704 void SkTypeface_FreeType::onFilterRec(SkScalerContextRec* rec) const {
705     //BOGUS: http://code.google.com/p/chromium/issues/detail?id=121119
706     //Cap the requested size as larger sizes give bogus values.
707     //Remove when http://code.google.com/p/skia/issues/detail?id=554 is fixed.
708     //Note that this also currently only protects against large text size requests,
709     //the total matrix is not taken into account here.
710     if (rec->fTextSize > SkIntToScalar(1 << 14)) {
711         rec->fTextSize = SkIntToScalar(1 << 14);
712     }
713 
714     if (isLCD(*rec)) {
715         // TODO: re-work so that FreeType is set-up and selected by the SkFontMgr.
716         SkAutoMutexAcquire ama(gFTMutex);
717         ref_ft_library();
718         if (!gFTLibrary->isLCDSupported()) {
719             // If the runtime Freetype library doesn't support LCD, disable it here.
720             rec->fMaskFormat = SkMask::kA8_Format;
721         }
722         unref_ft_library();
723     }
724 
725     SkPaint::Hinting h = rec->getHinting();
726     if (SkPaint::kFull_Hinting == h && !isLCD(*rec)) {
727         // collapse full->normal hinting if we're not doing LCD
728         h = SkPaint::kNormal_Hinting;
729     }
730     if ((rec->fFlags & SkScalerContext::kSubpixelPositioning_Flag)) {
731         if (SkPaint::kNo_Hinting != h) {
732             h = SkPaint::kSlight_Hinting;
733         }
734     }
735 
736     // rotated text looks bad with hinting, so we disable it as needed
737     if (!isAxisAligned(*rec)) {
738         h = SkPaint::kNo_Hinting;
739     }
740     rec->setHinting(h);
741 
742 #ifndef SK_GAMMA_APPLY_TO_A8
743     if (!isLCD(*rec)) {
744         // SRGBTODO: Is this correct? Do we want contrast boost?
745         rec->ignorePreBlend();
746     }
747 #endif
748 }
749 
onGetUPEM() const750 int SkTypeface_FreeType::onGetUPEM() const {
751     AutoFTAccess fta(this);
752     FT_Face face = fta.face();
753     return face ? face->units_per_EM : 0;
754 }
755 
onGetKerningPairAdjustments(const uint16_t glyphs[],int count,int32_t adjustments[]) const756 bool SkTypeface_FreeType::onGetKerningPairAdjustments(const uint16_t glyphs[],
757                                       int count, int32_t adjustments[]) const {
758     AutoFTAccess fta(this);
759     FT_Face face = fta.face();
760     if (!face || !FT_HAS_KERNING(face)) {
761         return false;
762     }
763 
764     for (int i = 0; i < count - 1; ++i) {
765         FT_Vector delta;
766         FT_Error err = FT_Get_Kerning(face, glyphs[i], glyphs[i+1],
767                                       FT_KERNING_UNSCALED, &delta);
768         if (err) {
769             return false;
770         }
771         adjustments[i] = delta.x;
772     }
773     return true;
774 }
775 
776 /** Returns the bitmap strike equal to or just larger than the requested size. */
chooseBitmapStrike(FT_Face face,FT_F26Dot6 scaleY)777 static FT_Int chooseBitmapStrike(FT_Face face, FT_F26Dot6 scaleY) {
778     if (face == nullptr) {
779         SkDEBUGF(("chooseBitmapStrike aborted due to nullptr face.\n"));
780         return -1;
781     }
782 
783     FT_Pos requestedPPEM = scaleY;  // FT_Bitmap_Size::y_ppem is in 26.6 format.
784     FT_Int chosenStrikeIndex = -1;
785     FT_Pos chosenPPEM = 0;
786     for (FT_Int strikeIndex = 0; strikeIndex < face->num_fixed_sizes; ++strikeIndex) {
787         FT_Pos strikePPEM = face->available_sizes[strikeIndex].y_ppem;
788         if (strikePPEM == requestedPPEM) {
789             // exact match - our search stops here
790             return strikeIndex;
791         } else if (chosenPPEM < requestedPPEM) {
792             // attempt to increase chosenPPEM
793             if (chosenPPEM < strikePPEM) {
794                 chosenPPEM = strikePPEM;
795                 chosenStrikeIndex = strikeIndex;
796             }
797         } else {
798             // attempt to decrease chosenPPEM, but not below requestedPPEM
799             if (requestedPPEM < strikePPEM && strikePPEM < chosenPPEM) {
800                 chosenPPEM = strikePPEM;
801                 chosenStrikeIndex = strikeIndex;
802             }
803         }
804     }
805     return chosenStrikeIndex;
806 }
807 
SkScalerContext_FreeType(sk_sp<SkTypeface> typeface,const SkScalerContextEffects & effects,const SkDescriptor * desc)808 SkScalerContext_FreeType::SkScalerContext_FreeType(sk_sp<SkTypeface> typeface,
809                                                    const SkScalerContextEffects& effects,
810                                                    const SkDescriptor* desc)
811     : SkScalerContext_FreeType_Base(std::move(typeface), effects, desc)
812     , fFace(nullptr)
813     , fFTSize(nullptr)
814     , fStrikeIndex(-1)
815 {
816     SkAutoMutexAcquire  ac(gFTMutex);
817 
818     if (!ref_ft_library()) {
819         sk_throw();
820     }
821 
822     fFaceRec.reset(ref_ft_face(this->getTypeface()));
823 
824     // load the font file
825     if (nullptr == fFaceRec) {
826         SkDEBUGF(("Could not create FT_Face.\n"));
827         return;
828     }
829 
830     fRec.computeMatrices(SkScalerContextRec::kFull_PreMatrixScale, &fScale, &fMatrix22Scalar);
831 
832     FT_F26Dot6 scaleX = SkScalarToFDot6(fScale.fX);
833     FT_F26Dot6 scaleY = SkScalarToFDot6(fScale.fY);
834     fMatrix22.xx = SkScalarToFixed(fMatrix22Scalar.getScaleX());
835     fMatrix22.xy = SkScalarToFixed(-fMatrix22Scalar.getSkewX());
836     fMatrix22.yx = SkScalarToFixed(-fMatrix22Scalar.getSkewY());
837     fMatrix22.yy = SkScalarToFixed(fMatrix22Scalar.getScaleY());
838 
839     fLCDIsVert = SkToBool(fRec.fFlags & SkScalerContext::kLCD_Vertical_Flag);
840 
841     // compute the flags we send to Load_Glyph
842     bool linearMetrics = SkToBool(fRec.fFlags & SkScalerContext::kSubpixelPositioning_Flag);
843     {
844         FT_Int32 loadFlags = FT_LOAD_DEFAULT;
845 
846         if (SkMask::kBW_Format == fRec.fMaskFormat) {
847             // See http://code.google.com/p/chromium/issues/detail?id=43252#c24
848             loadFlags = FT_LOAD_TARGET_MONO;
849             if (fRec.getHinting() == SkPaint::kNo_Hinting) {
850                 loadFlags = FT_LOAD_NO_HINTING;
851                 linearMetrics = true;
852             }
853         } else {
854             switch (fRec.getHinting()) {
855             case SkPaint::kNo_Hinting:
856                 loadFlags = FT_LOAD_NO_HINTING;
857                 linearMetrics = true;
858                 break;
859             case SkPaint::kSlight_Hinting:
860                 loadFlags = FT_LOAD_TARGET_LIGHT;  // This implies FORCE_AUTOHINT
861                 break;
862             case SkPaint::kNormal_Hinting:
863                 if (fRec.fFlags & SkScalerContext::kForceAutohinting_Flag) {
864                     loadFlags = FT_LOAD_FORCE_AUTOHINT;
865 #ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK
866                 } else {
867                     loadFlags = FT_LOAD_NO_AUTOHINT;
868 #endif
869                 }
870                 break;
871             case SkPaint::kFull_Hinting:
872                 if (fRec.fFlags & SkScalerContext::kForceAutohinting_Flag) {
873                     loadFlags = FT_LOAD_FORCE_AUTOHINT;
874                     break;
875                 }
876                 loadFlags = FT_LOAD_TARGET_NORMAL;
877                 if (isLCD(fRec)) {
878                     if (fLCDIsVert) {
879                         loadFlags = FT_LOAD_TARGET_LCD_V;
880                     } else {
881                         loadFlags = FT_LOAD_TARGET_LCD;
882                     }
883                 }
884                 break;
885             default:
886                 SkDebugf("---------- UNKNOWN hinting %d\n", fRec.getHinting());
887                 break;
888             }
889         }
890 
891         if ((fRec.fFlags & SkScalerContext::kEmbeddedBitmapText_Flag) == 0) {
892             loadFlags |= FT_LOAD_NO_BITMAP;
893         }
894 
895         // Always using FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH to get correct
896         // advances, as fontconfig and cairo do.
897         // See http://code.google.com/p/skia/issues/detail?id=222.
898         loadFlags |= FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH;
899 
900         // Use vertical layout if requested.
901         if (fRec.fFlags & SkScalerContext::kVertical_Flag) {
902             loadFlags |= FT_LOAD_VERTICAL_LAYOUT;
903         }
904 
905         loadFlags |= FT_LOAD_COLOR;
906 
907         fLoadGlyphFlags = loadFlags;
908     }
909 
910     using DoneFTSize = SkFunctionWrapper<FT_Error, skstd::remove_pointer_t<FT_Size>, FT_Done_Size>;
911     std::unique_ptr<skstd::remove_pointer_t<FT_Size>, DoneFTSize> ftSize([this]() -> FT_Size {
912         FT_Size size;
913         FT_Error err = FT_New_Size(fFaceRec->fFace.get(), &size);
914         if (err != 0) {
915             SkDEBUGF(("FT_New_Size(%s) returned 0x%x.\n", fFaceRec->fFace->family_name, err));
916             return nullptr;
917         }
918         return size;
919     }());
920     if (nullptr == ftSize) {
921         SkDEBUGF(("Could not create FT_Size.\n"));
922         return;
923     }
924 
925     FT_Error err = FT_Activate_Size(ftSize.get());
926     if (err != 0) {
927         SkDEBUGF(("FT_Activate_Size(%s) returned 0x%x.\n", fFaceRec->fFace->family_name, err));
928         return;
929     }
930 
931     if (FT_IS_SCALABLE(fFaceRec->fFace)) {
932         err = FT_Set_Char_Size(fFaceRec->fFace.get(), scaleX, scaleY, 72, 72);
933         if (err != 0) {
934             SkDEBUGF(("FT_Set_CharSize(%s, %f, %f) returned 0x%x.\n",
935                       fFaceRec->fFace->family_name, fScale.fX, fScale.fY, err));
936             return;
937         }
938     } else if (FT_HAS_FIXED_SIZES(fFaceRec->fFace)) {
939         fStrikeIndex = chooseBitmapStrike(fFaceRec->fFace.get(), scaleY);
940         if (fStrikeIndex == -1) {
941             SkDEBUGF(("No glyphs for font \"%s\" size %f.\n",
942                       fFaceRec->fFace->family_name, fScale.fY));
943             return;
944         }
945 
946         err = FT_Select_Size(fFaceRec->fFace.get(), fStrikeIndex);
947         if (err != 0) {
948             SkDEBUGF(("FT_Select_Size(%s, %d) returned 0x%x.\n",
949                       fFaceRec->fFace->family_name, fStrikeIndex, err));
950             fStrikeIndex = -1;
951             return;
952         }
953 
954         // A non-ideal size was picked, so recompute the matrix.
955         // This adjusts for the difference between FT_Set_Char_Size and FT_Select_Size.
956         fMatrix22Scalar.preScale(fScale.x() / fFaceRec->fFace->size->metrics.x_ppem,
957                                  fScale.y() / fFaceRec->fFace->size->metrics.y_ppem);
958         fMatrix22.xx = SkScalarToFixed(fMatrix22Scalar.getScaleX());
959         fMatrix22.xy = SkScalarToFixed(-fMatrix22Scalar.getSkewX());
960         fMatrix22.yx = SkScalarToFixed(-fMatrix22Scalar.getSkewY());
961         fMatrix22.yy = SkScalarToFixed(fMatrix22Scalar.getScaleY());
962 
963         // FreeType does not provide linear metrics for bitmap fonts.
964         linearMetrics = false;
965 
966         // FreeType documentation says:
967         // FT_LOAD_NO_BITMAP -- Ignore bitmap strikes when loading.
968         // Bitmap-only fonts ignore this flag.
969         //
970         // However, in FreeType 2.5.1 color bitmap only fonts do not ignore this flag.
971         // Force this flag off for bitmap only fonts.
972         fLoadGlyphFlags &= ~FT_LOAD_NO_BITMAP;
973     } else {
974         SkDEBUGF(("Unknown kind of font \"%s\" size %f.\n", fFaceRec->fFace->family_name, fScale.fY));
975         return;
976     }
977 
978     fFTSize = ftSize.release();
979     fFace = fFaceRec->fFace.get();
980     fDoLinearMetrics = linearMetrics;
981 }
982 
~SkScalerContext_FreeType()983 SkScalerContext_FreeType::~SkScalerContext_FreeType() {
984     SkAutoMutexAcquire  ac(gFTMutex);
985 
986     if (fFTSize != nullptr) {
987         FT_Done_Size(fFTSize);
988     }
989 
990     fFaceRec = nullptr;
991 
992     unref_ft_library();
993 }
994 
995 /*  We call this before each use of the fFace, since we may be sharing
996     this face with other context (at different sizes).
997 */
setupSize()998 FT_Error SkScalerContext_FreeType::setupSize() {
999     gFTMutex.assertHeld();
1000     FT_Error err = FT_Activate_Size(fFTSize);
1001     if (err != 0) {
1002         return err;
1003     }
1004     FT_Set_Transform(fFace, &fMatrix22, nullptr);
1005     return 0;
1006 }
1007 
generateGlyphCount()1008 unsigned SkScalerContext_FreeType::generateGlyphCount() {
1009     return fFace->num_glyphs;
1010 }
1011 
generateCharToGlyph(SkUnichar uni)1012 uint16_t SkScalerContext_FreeType::generateCharToGlyph(SkUnichar uni) {
1013     SkAutoMutexAcquire  ac(gFTMutex);
1014     return SkToU16(FT_Get_Char_Index( fFace, uni ));
1015 }
1016 
generateGlyphToChar(uint16_t glyph)1017 SkUnichar SkScalerContext_FreeType::generateGlyphToChar(uint16_t glyph) {
1018     SkAutoMutexAcquire  ac(gFTMutex);
1019     // iterate through each cmap entry, looking for matching glyph indices
1020     FT_UInt glyphIndex;
1021     SkUnichar charCode = FT_Get_First_Char( fFace, &glyphIndex );
1022 
1023     while (glyphIndex != 0) {
1024         if (glyphIndex == glyph) {
1025             return charCode;
1026         }
1027         charCode = FT_Get_Next_Char( fFace, charCode, &glyphIndex );
1028     }
1029 
1030     return 0;
1031 }
1032 
SkFT_FixedToScalar(FT_Fixed x)1033 static SkScalar SkFT_FixedToScalar(FT_Fixed x) {
1034   return SkFixedToScalar(x);
1035 }
1036 
generateAdvance(SkGlyph * glyph)1037 void SkScalerContext_FreeType::generateAdvance(SkGlyph* glyph) {
1038    /* unhinted and light hinted text have linearly scaled advances
1039     * which are very cheap to compute with some font formats...
1040     */
1041     if (fDoLinearMetrics) {
1042         SkAutoMutexAcquire  ac(gFTMutex);
1043 
1044         if (this->setupSize()) {
1045             glyph->zeroMetrics();
1046             return;
1047         }
1048 
1049         FT_Error    error;
1050         FT_Fixed    advance;
1051 
1052         error = FT_Get_Advance( fFace, glyph->getGlyphID(),
1053                                 fLoadGlyphFlags | FT_ADVANCE_FLAG_FAST_ONLY,
1054                                 &advance );
1055         if (0 == error) {
1056             glyph->fRsbDelta = 0;
1057             glyph->fLsbDelta = 0;
1058             const SkScalar advanceScalar = SkFT_FixedToScalar(advance);
1059             glyph->fAdvanceX = SkScalarToFloat(fMatrix22Scalar.getScaleX() * advanceScalar);
1060             glyph->fAdvanceY = SkScalarToFloat(fMatrix22Scalar.getSkewY() * advanceScalar);
1061             return;
1062         }
1063     }
1064 
1065     /* otherwise, we need to load/hint the glyph, which is slower */
1066     this->generateMetrics(glyph);
1067     return;
1068 }
1069 
getBBoxForCurrentGlyph(SkGlyph * glyph,FT_BBox * bbox,bool snapToPixelBoundary)1070 void SkScalerContext_FreeType::getBBoxForCurrentGlyph(SkGlyph* glyph,
1071                                                       FT_BBox* bbox,
1072                                                       bool snapToPixelBoundary) {
1073 
1074     FT_Outline_Get_CBox(&fFace->glyph->outline, bbox);
1075 
1076     if (fRec.fFlags & SkScalerContext::kSubpixelPositioning_Flag) {
1077         int dx = SkFixedToFDot6(glyph->getSubXFixed());
1078         int dy = SkFixedToFDot6(glyph->getSubYFixed());
1079         // negate dy since freetype-y-goes-up and skia-y-goes-down
1080         bbox->xMin += dx;
1081         bbox->yMin -= dy;
1082         bbox->xMax += dx;
1083         bbox->yMax -= dy;
1084     }
1085 
1086     // outset the box to integral boundaries
1087     if (snapToPixelBoundary) {
1088         bbox->xMin &= ~63;
1089         bbox->yMin &= ~63;
1090         bbox->xMax  = (bbox->xMax + 63) & ~63;
1091         bbox->yMax  = (bbox->yMax + 63) & ~63;
1092     }
1093 
1094     // Must come after snapToPixelBoundary so that the width and height are
1095     // consistent. Otherwise asserts will fire later on when generating the
1096     // glyph image.
1097     if (fRec.fFlags & SkScalerContext::kVertical_Flag) {
1098         FT_Vector vector;
1099         vector.x = fFace->glyph->metrics.vertBearingX - fFace->glyph->metrics.horiBearingX;
1100         vector.y = -fFace->glyph->metrics.vertBearingY - fFace->glyph->metrics.horiBearingY;
1101         FT_Vector_Transform(&vector, &fMatrix22);
1102         bbox->xMin += vector.x;
1103         bbox->xMax += vector.x;
1104         bbox->yMin += vector.y;
1105         bbox->yMax += vector.y;
1106     }
1107 }
1108 
getCBoxForLetter(char letter,FT_BBox * bbox)1109 bool SkScalerContext_FreeType::getCBoxForLetter(char letter, FT_BBox* bbox) {
1110     const FT_UInt glyph_id = FT_Get_Char_Index(fFace, letter);
1111     if (!glyph_id) {
1112         return false;
1113     }
1114     if (FT_Load_Glyph(fFace, glyph_id, fLoadGlyphFlags) != 0) {
1115         return false;
1116     }
1117     emboldenIfNeeded(fFace, fFace->glyph);
1118     FT_Outline_Get_CBox(&fFace->glyph->outline, bbox);
1119     return true;
1120 }
1121 
updateGlyphIfLCD(SkGlyph * glyph)1122 void SkScalerContext_FreeType::updateGlyphIfLCD(SkGlyph* glyph) {
1123     if (isLCD(fRec)) {
1124         if (fLCDIsVert) {
1125             glyph->fHeight += gFTLibrary->lcdExtra();
1126             glyph->fTop -= gFTLibrary->lcdExtra() >> 1;
1127         } else {
1128             glyph->fWidth += gFTLibrary->lcdExtra();
1129             glyph->fLeft -= gFTLibrary->lcdExtra() >> 1;
1130         }
1131     }
1132 }
1133 
shouldSubpixelBitmap(const SkGlyph & glyph,const SkMatrix & matrix)1134 bool SkScalerContext_FreeType::shouldSubpixelBitmap(const SkGlyph& glyph, const SkMatrix& matrix) {
1135     // If subpixel rendering of a bitmap *can* be done.
1136     bool mechanism = fFace->glyph->format == FT_GLYPH_FORMAT_BITMAP &&
1137                      fRec.fFlags & SkScalerContext::kSubpixelPositioning_Flag &&
1138                      (glyph.getSubXFixed() || glyph.getSubYFixed());
1139 
1140     // If subpixel rendering of a bitmap *should* be done.
1141     // 1. If the face is not scalable then always allow subpixel rendering.
1142     //    Otherwise, if the font has an 8ppem strike 7 will subpixel render but 8 won't.
1143     // 2. If the matrix is already not identity the bitmap will already be resampled,
1144     //    so resampling slightly differently shouldn't make much difference.
1145     bool policy = !FT_IS_SCALABLE(fFace) || !matrix.isIdentity();
1146 
1147     return mechanism && policy;
1148 }
1149 
generateMetrics(SkGlyph * glyph)1150 void SkScalerContext_FreeType::generateMetrics(SkGlyph* glyph) {
1151     SkAutoMutexAcquire  ac(gFTMutex);
1152 
1153     glyph->fRsbDelta = 0;
1154     glyph->fLsbDelta = 0;
1155 
1156     FT_Error    err;
1157 
1158     if (this->setupSize()) {
1159         glyph->zeroMetrics();
1160         return;
1161     }
1162 
1163     err = FT_Load_Glyph( fFace, glyph->getGlyphID(),
1164                          fLoadGlyphFlags | FT_LOAD_BITMAP_METRICS_ONLY );
1165     if (err != 0) {
1166         glyph->zeroMetrics();
1167         return;
1168     }
1169     emboldenIfNeeded(fFace, fFace->glyph);
1170 
1171     switch ( fFace->glyph->format ) {
1172       case FT_GLYPH_FORMAT_OUTLINE:
1173         if (0 == fFace->glyph->outline.n_contours) {
1174             glyph->fWidth = 0;
1175             glyph->fHeight = 0;
1176             glyph->fTop = 0;
1177             glyph->fLeft = 0;
1178         } else {
1179             FT_BBox bbox;
1180             getBBoxForCurrentGlyph(glyph, &bbox, true);
1181 
1182             glyph->fWidth   = SkToU16(SkFDot6Floor(bbox.xMax - bbox.xMin));
1183             glyph->fHeight  = SkToU16(SkFDot6Floor(bbox.yMax - bbox.yMin));
1184             glyph->fTop     = -SkToS16(SkFDot6Floor(bbox.yMax));
1185             glyph->fLeft    = SkToS16(SkFDot6Floor(bbox.xMin));
1186 
1187             updateGlyphIfLCD(glyph);
1188         }
1189         break;
1190 
1191       case FT_GLYPH_FORMAT_BITMAP:
1192         if (fRec.fFlags & SkScalerContext::kVertical_Flag) {
1193             FT_Vector vector;
1194             vector.x = fFace->glyph->metrics.vertBearingX - fFace->glyph->metrics.horiBearingX;
1195             vector.y = -fFace->glyph->metrics.vertBearingY - fFace->glyph->metrics.horiBearingY;
1196             FT_Vector_Transform(&vector, &fMatrix22);
1197             fFace->glyph->bitmap_left += SkFDot6Floor(vector.x);
1198             fFace->glyph->bitmap_top  += SkFDot6Floor(vector.y);
1199         }
1200 
1201         if (fFace->glyph->bitmap.pixel_mode == FT_PIXEL_MODE_BGRA) {
1202             glyph->fMaskFormat = SkMask::kARGB32_Format;
1203         }
1204 
1205         {
1206             SkRect rect = SkRect::MakeXYWH(SkIntToScalar(fFace->glyph->bitmap_left),
1207                                           -SkIntToScalar(fFace->glyph->bitmap_top),
1208                                            SkIntToScalar(fFace->glyph->bitmap.width),
1209                                            SkIntToScalar(fFace->glyph->bitmap.rows));
1210             fMatrix22Scalar.mapRect(&rect);
1211             if (this->shouldSubpixelBitmap(*glyph, fMatrix22Scalar)) {
1212                 rect.offset(SkFixedToScalar(glyph->getSubXFixed()),
1213                             SkFixedToScalar(glyph->getSubYFixed()));
1214             }
1215             SkIRect irect = rect.roundOut();
1216             glyph->fWidth   = SkToU16(irect.width());
1217             glyph->fHeight  = SkToU16(irect.height());
1218             glyph->fTop     = SkToS16(irect.top());
1219             glyph->fLeft    = SkToS16(irect.left());
1220         }
1221         break;
1222 
1223       default:
1224         SkDEBUGFAIL("unknown glyph format");
1225         glyph->zeroMetrics();
1226         return;
1227     }
1228 
1229     if (fRec.fFlags & SkScalerContext::kVertical_Flag) {
1230         if (fDoLinearMetrics) {
1231             const SkScalar advanceScalar = SkFT_FixedToScalar(fFace->glyph->linearVertAdvance);
1232             glyph->fAdvanceX = SkScalarToFloat(fMatrix22Scalar.getSkewX() * advanceScalar);
1233             glyph->fAdvanceY = SkScalarToFloat(fMatrix22Scalar.getScaleY() * advanceScalar);
1234         } else {
1235             glyph->fAdvanceX = -SkFDot6ToFloat(fFace->glyph->advance.x);
1236             glyph->fAdvanceY = SkFDot6ToFloat(fFace->glyph->advance.y);
1237         }
1238     } else {
1239         if (fDoLinearMetrics) {
1240             const SkScalar advanceScalar = SkFT_FixedToScalar(fFace->glyph->linearHoriAdvance);
1241             glyph->fAdvanceX = SkScalarToFloat(fMatrix22Scalar.getScaleX() * advanceScalar);
1242             glyph->fAdvanceY = SkScalarToFloat(fMatrix22Scalar.getSkewY() * advanceScalar);
1243         } else {
1244             glyph->fAdvanceX = SkFDot6ToFloat(fFace->glyph->advance.x);
1245             glyph->fAdvanceY = -SkFDot6ToFloat(fFace->glyph->advance.y);
1246 
1247             if (fRec.fFlags & kDevKernText_Flag) {
1248                 glyph->fRsbDelta = SkToS8(fFace->glyph->rsb_delta);
1249                 glyph->fLsbDelta = SkToS8(fFace->glyph->lsb_delta);
1250             }
1251         }
1252     }
1253 
1254 #ifdef ENABLE_GLYPH_SPEW
1255     SkDEBUGF(("Metrics(glyph:%d flags:0x%x) w:%d\n", glyph->getGlyphID(), fLoadGlyphFlags, glyph->fWidth));
1256 #endif
1257 }
1258 
clear_glyph_image(const SkGlyph & glyph)1259 static void clear_glyph_image(const SkGlyph& glyph) {
1260     sk_bzero(glyph.fImage, glyph.rowBytes() * glyph.fHeight);
1261 }
1262 
generateImage(const SkGlyph & glyph)1263 void SkScalerContext_FreeType::generateImage(const SkGlyph& glyph) {
1264     SkAutoMutexAcquire  ac(gFTMutex);
1265 
1266     if (this->setupSize()) {
1267         clear_glyph_image(glyph);
1268         return;
1269     }
1270 
1271     FT_Error err = FT_Load_Glyph(fFace, glyph.getGlyphID(), fLoadGlyphFlags);
1272     if (err != 0) {
1273         SkDEBUGF(("SkScalerContext_FreeType::generateImage: FT_Load_Glyph(glyph:%d width:%d height:%d rb:%d flags:%d) returned 0x%x\n",
1274                   glyph.getGlyphID(), glyph.fWidth, glyph.fHeight, glyph.rowBytes(), fLoadGlyphFlags, err));
1275         clear_glyph_image(glyph);
1276         return;
1277     }
1278 
1279     emboldenIfNeeded(fFace, fFace->glyph);
1280     SkMatrix* bitmapMatrix = &fMatrix22Scalar;
1281     SkMatrix subpixelBitmapMatrix;
1282     if (this->shouldSubpixelBitmap(glyph, *bitmapMatrix)) {
1283         subpixelBitmapMatrix = fMatrix22Scalar;
1284         subpixelBitmapMatrix.postTranslate(SkFixedToScalar(glyph.getSubXFixed()),
1285                                            SkFixedToScalar(glyph.getSubYFixed()));
1286         bitmapMatrix = &subpixelBitmapMatrix;
1287     }
1288     generateGlyphImage(fFace, glyph, *bitmapMatrix);
1289 }
1290 
1291 
generatePath(SkGlyphID glyphID,SkPath * path)1292 void SkScalerContext_FreeType::generatePath(SkGlyphID glyphID, SkPath* path) {
1293     SkAutoMutexAcquire  ac(gFTMutex);
1294 
1295     SkASSERT(path);
1296 
1297     if (this->setupSize()) {
1298         path->reset();
1299         return;
1300     }
1301 
1302     uint32_t flags = fLoadGlyphFlags;
1303     flags |= FT_LOAD_NO_BITMAP; // ignore embedded bitmaps so we're sure to get the outline
1304     flags &= ~FT_LOAD_RENDER;   // don't scan convert (we just want the outline)
1305 
1306     FT_Error err = FT_Load_Glyph(fFace, glyphID, flags);
1307 
1308     if (err != 0) {
1309         SkDEBUGF(("SkScalerContext_FreeType::generatePath: FT_Load_Glyph(glyph:%d flags:%d) returned 0x%x\n",
1310                   glyphID, flags, err));
1311         path->reset();
1312         return;
1313     }
1314     emboldenIfNeeded(fFace, fFace->glyph);
1315 
1316     generateGlyphPath(fFace, path);
1317 
1318     // The path's origin from FreeType is always the horizontal layout origin.
1319     // Offset the path so that it is relative to the vertical origin if needed.
1320     if (fRec.fFlags & SkScalerContext::kVertical_Flag) {
1321         FT_Vector vector;
1322         vector.x = fFace->glyph->metrics.vertBearingX - fFace->glyph->metrics.horiBearingX;
1323         vector.y = -fFace->glyph->metrics.vertBearingY - fFace->glyph->metrics.horiBearingY;
1324         FT_Vector_Transform(&vector, &fMatrix22);
1325         path->offset(SkFDot6ToScalar(vector.x), -SkFDot6ToScalar(vector.y));
1326     }
1327 }
1328 
generateFontMetrics(SkPaint::FontMetrics * metrics)1329 void SkScalerContext_FreeType::generateFontMetrics(SkPaint::FontMetrics* metrics) {
1330     if (nullptr == metrics) {
1331         return;
1332     }
1333 
1334     SkAutoMutexAcquire ac(gFTMutex);
1335 
1336     if (this->setupSize()) {
1337         sk_bzero(metrics, sizeof(*metrics));
1338         return;
1339     }
1340 
1341     FT_Face face = fFace;
1342 
1343     // fetch units/EM from "head" table if needed (ie for bitmap fonts)
1344     SkScalar upem = SkIntToScalar(face->units_per_EM);
1345     if (!upem) {
1346         TT_Header* ttHeader = (TT_Header*)FT_Get_Sfnt_Table(face, ft_sfnt_head);
1347         if (ttHeader) {
1348             upem = SkIntToScalar(ttHeader->Units_Per_EM);
1349         }
1350     }
1351 
1352     // use the os/2 table as a source of reasonable defaults.
1353     SkScalar x_height = 0.0f;
1354     SkScalar avgCharWidth = 0.0f;
1355     SkScalar cap_height = 0.0f;
1356     TT_OS2* os2 = (TT_OS2*) FT_Get_Sfnt_Table(face, ft_sfnt_os2);
1357     if (os2) {
1358         x_height = SkIntToScalar(os2->sxHeight) / upem * fScale.y();
1359         avgCharWidth = SkIntToScalar(os2->xAvgCharWidth) / upem;
1360         if (os2->version != 0xFFFF && os2->version >= 2) {
1361             cap_height = SkIntToScalar(os2->sCapHeight) / upem * fScale.y();
1362         }
1363     }
1364 
1365     // pull from format-specific metrics as needed
1366     SkScalar ascent, descent, leading, xmin, xmax, ymin, ymax;
1367     SkScalar underlineThickness, underlinePosition;
1368     if (face->face_flags & FT_FACE_FLAG_SCALABLE) { // scalable outline font
1369         // FreeType will always use HHEA metrics if they're not zero.
1370         // It completely ignores the OS/2 fsSelection::UseTypoMetrics bit.
1371         // It also ignores the VDMX tables, which are also of interest here
1372         // (and override everything else when they apply).
1373         static const int kUseTypoMetricsMask = (1 << 7);
1374         if (os2 && os2->version != 0xFFFF && (os2->fsSelection & kUseTypoMetricsMask)) {
1375             ascent = -SkIntToScalar(os2->sTypoAscender) / upem;
1376             descent = -SkIntToScalar(os2->sTypoDescender) / upem;
1377             leading = SkIntToScalar(os2->sTypoLineGap) / upem;
1378         } else {
1379             ascent = -SkIntToScalar(face->ascender) / upem;
1380             descent = -SkIntToScalar(face->descender) / upem;
1381             leading = SkIntToScalar(face->height + (face->descender - face->ascender)) / upem;
1382         }
1383         xmin = SkIntToScalar(face->bbox.xMin) / upem;
1384         xmax = SkIntToScalar(face->bbox.xMax) / upem;
1385         ymin = -SkIntToScalar(face->bbox.yMin) / upem;
1386         ymax = -SkIntToScalar(face->bbox.yMax) / upem;
1387         underlineThickness = SkIntToScalar(face->underline_thickness) / upem;
1388         underlinePosition = -SkIntToScalar(face->underline_position +
1389                                            face->underline_thickness / 2) / upem;
1390 
1391         metrics->fFlags |= SkPaint::FontMetrics::kUnderlineThicknessIsValid_Flag;
1392         metrics->fFlags |= SkPaint::FontMetrics::kUnderlinePositionIsValid_Flag;
1393 
1394         // we may be able to synthesize x_height and cap_height from outline
1395         if (!x_height) {
1396             FT_BBox bbox;
1397             if (getCBoxForLetter('x', &bbox)) {
1398                 x_height = SkIntToScalar(bbox.yMax) / 64.0f;
1399             }
1400         }
1401         if (!cap_height) {
1402             FT_BBox bbox;
1403             if (getCBoxForLetter('H', &bbox)) {
1404                 cap_height = SkIntToScalar(bbox.yMax) / 64.0f;
1405             }
1406         }
1407     } else if (fStrikeIndex != -1) { // bitmap strike metrics
1408         SkScalar xppem = SkIntToScalar(face->size->metrics.x_ppem);
1409         SkScalar yppem = SkIntToScalar(face->size->metrics.y_ppem);
1410         ascent = -SkIntToScalar(face->size->metrics.ascender) / (yppem * 64.0f);
1411         descent = -SkIntToScalar(face->size->metrics.descender) / (yppem * 64.0f);
1412         leading = (SkIntToScalar(face->size->metrics.height) / (yppem * 64.0f)) + ascent - descent;
1413         xmin = 0.0f;
1414         xmax = SkIntToScalar(face->available_sizes[fStrikeIndex].width) / xppem;
1415         ymin = descent + leading;
1416         ymax = ascent - descent;
1417         underlineThickness = 0;
1418         underlinePosition = 0;
1419 
1420         metrics->fFlags &= ~SkPaint::FontMetrics::kUnderlineThicknessIsValid_Flag;
1421         metrics->fFlags &= ~SkPaint::FontMetrics::kUnderlinePositionIsValid_Flag;
1422     } else {
1423         sk_bzero(metrics, sizeof(*metrics));
1424         return;
1425     }
1426 
1427     // synthesize elements that were not provided by the os/2 table or format-specific metrics
1428     if (!x_height) {
1429         x_height = -ascent * fScale.y();
1430     }
1431     if (!avgCharWidth) {
1432         avgCharWidth = xmax - xmin;
1433     }
1434     if (!cap_height) {
1435       cap_height = -ascent * fScale.y();
1436     }
1437 
1438     // disallow negative linespacing
1439     if (leading < 0.0f) {
1440         leading = 0.0f;
1441     }
1442 
1443     metrics->fTop = ymax * fScale.y();
1444     metrics->fAscent = ascent * fScale.y();
1445     metrics->fDescent = descent * fScale.y();
1446     metrics->fBottom = ymin * fScale.y();
1447     metrics->fLeading = leading * fScale.y();
1448     metrics->fAvgCharWidth = avgCharWidth * fScale.y();
1449     metrics->fXMin = xmin * fScale.y();
1450     metrics->fXMax = xmax * fScale.y();
1451     metrics->fXHeight = x_height;
1452     metrics->fCapHeight = cap_height;
1453     metrics->fUnderlineThickness = underlineThickness * fScale.y();
1454     metrics->fUnderlinePosition = underlinePosition * fScale.y();
1455 }
1456 
1457 ///////////////////////////////////////////////////////////////////////////////
1458 
1459 // hand-tuned value to reduce outline embolden strength
1460 #ifndef SK_OUTLINE_EMBOLDEN_DIVISOR
1461     #ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK
1462         #define SK_OUTLINE_EMBOLDEN_DIVISOR   34
1463     #else
1464         #define SK_OUTLINE_EMBOLDEN_DIVISOR   24
1465     #endif
1466 #endif
1467 
1468 ///////////////////////////////////////////////////////////////////////////////
1469 
emboldenIfNeeded(FT_Face face,FT_GlyphSlot glyph)1470 void SkScalerContext_FreeType::emboldenIfNeeded(FT_Face face, FT_GlyphSlot glyph)
1471 {
1472     // check to see if the embolden bit is set
1473     if (0 == (fRec.fFlags & SkScalerContext::kEmbolden_Flag)) {
1474         return;
1475     }
1476 
1477     switch (glyph->format) {
1478         case FT_GLYPH_FORMAT_OUTLINE:
1479             FT_Pos strength;
1480             strength = FT_MulFix(face->units_per_EM, face->size->metrics.y_scale)
1481                        / SK_OUTLINE_EMBOLDEN_DIVISOR;
1482             FT_Outline_Embolden(&glyph->outline, strength);
1483             break;
1484         case FT_GLYPH_FORMAT_BITMAP:
1485             FT_GlyphSlot_Own_Bitmap(glyph);
1486             FT_Bitmap_Embolden(glyph->library, &glyph->bitmap, kBitmapEmboldenStrength, 0);
1487             break;
1488         default:
1489             SkDEBUGFAIL("unknown glyph format");
1490     }
1491 }
1492 
1493 ///////////////////////////////////////////////////////////////////////////////
1494 
1495 #include "SkUtils.h"
1496 
next_utf8(const void ** chars)1497 static SkUnichar next_utf8(const void** chars) {
1498     return SkUTF8_NextUnichar((const char**)chars);
1499 }
1500 
next_utf16(const void ** chars)1501 static SkUnichar next_utf16(const void** chars) {
1502     return SkUTF16_NextUnichar((const uint16_t**)chars);
1503 }
1504 
next_utf32(const void ** chars)1505 static SkUnichar next_utf32(const void** chars) {
1506     const SkUnichar** uniChars = (const SkUnichar**)chars;
1507     SkUnichar uni = **uniChars;
1508     *uniChars += 1;
1509     return uni;
1510 }
1511 
1512 typedef SkUnichar (*EncodingProc)(const void**);
1513 
find_encoding_proc(SkTypeface::Encoding enc)1514 static EncodingProc find_encoding_proc(SkTypeface::Encoding enc) {
1515     static const EncodingProc gProcs[] = {
1516         next_utf8, next_utf16, next_utf32
1517     };
1518     SkASSERT((size_t)enc < SK_ARRAY_COUNT(gProcs));
1519     return gProcs[enc];
1520 }
1521 
onCharsToGlyphs(const void * chars,Encoding encoding,uint16_t glyphs[],int glyphCount) const1522 int SkTypeface_FreeType::onCharsToGlyphs(const void* chars, Encoding encoding,
1523                                          uint16_t glyphs[], int glyphCount) const
1524 {
1525     AutoFTAccess fta(this);
1526     FT_Face face = fta.face();
1527     if (!face) {
1528         if (glyphs) {
1529             sk_bzero(glyphs, glyphCount * sizeof(glyphs[0]));
1530         }
1531         return 0;
1532     }
1533 
1534     EncodingProc next_uni_proc = find_encoding_proc(encoding);
1535 
1536     if (nullptr == glyphs) {
1537         for (int i = 0; i < glyphCount; ++i) {
1538             if (0 == FT_Get_Char_Index(face, next_uni_proc(&chars))) {
1539                 return i;
1540             }
1541         }
1542         return glyphCount;
1543     } else {
1544         int first = glyphCount;
1545         for (int i = 0; i < glyphCount; ++i) {
1546             unsigned id = FT_Get_Char_Index(face, next_uni_proc(&chars));
1547             glyphs[i] = SkToU16(id);
1548             if (0 == id && i < first) {
1549                 first = i;
1550             }
1551         }
1552         return first;
1553     }
1554 }
1555 
onCountGlyphs() const1556 int SkTypeface_FreeType::onCountGlyphs() const {
1557     AutoFTAccess fta(this);
1558     FT_Face face = fta.face();
1559     return face ? face->num_glyphs : 0;
1560 }
1561 
onCreateFamilyNameIterator() const1562 SkTypeface::LocalizedStrings* SkTypeface_FreeType::onCreateFamilyNameIterator() const {
1563     SkTypeface::LocalizedStrings* nameIter =
1564         SkOTUtils::LocalizedStrings_NameTable::CreateForFamilyNames(*this);
1565     if (nullptr == nameIter) {
1566         SkString familyName;
1567         this->getFamilyName(&familyName);
1568         SkString language("und"); //undetermined
1569         nameIter = new SkOTUtils::LocalizedStrings_SingleName(familyName, language);
1570     }
1571     return nameIter;
1572 }
1573 
onGetVariationDesignPosition(SkFontArguments::VariationPosition::Coordinate coordinates[],int coordinateCount) const1574 int SkTypeface_FreeType::onGetVariationDesignPosition(
1575         SkFontArguments::VariationPosition::Coordinate coordinates[], int coordinateCount) const
1576 {
1577     AutoFTAccess fta(this);
1578     FT_Face face = fta.face();
1579 
1580     if (!face || !(face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS)) {
1581         return 0;
1582     }
1583 
1584     FT_MM_Var* variations = nullptr;
1585     if (FT_Get_MM_Var(face, &variations)) {
1586         return 0;
1587     }
1588     SkAutoFree autoFreeVariations(variations);
1589 
1590     if (!coordinates || coordinateCount < SkToInt(variations->num_axis)) {
1591         return variations->num_axis;
1592     }
1593 
1594     SkAutoSTMalloc<4, FT_Fixed> coords(variations->num_axis);
1595     // FT_Get_{MM,Var}_{Blend,Design}_Coordinates were added in FreeType 2.7.1.
1596     if (gFTLibrary->fGetVarDesignCoordinates &&
1597         !gFTLibrary->fGetVarDesignCoordinates(face, variations->num_axis, coords.get()))
1598     {
1599         for (FT_UInt i = 0; i < variations->num_axis; ++i) {
1600             coordinates[i].axis = variations->axis[i].tag;
1601             coordinates[i].value = SkFixedToScalar(coords[i]);
1602         }
1603     } else if (static_cast<FT_UInt>(fta.getAxesCount()) == variations->num_axis) {
1604         for (FT_UInt i = 0; i < variations->num_axis; ++i) {
1605             coordinates[i].axis = variations->axis[i].tag;
1606             coordinates[i].value = SkFixedToScalar(fta.getAxes()[i]);
1607         }
1608     } else if (fta.isNamedVariationSpecified()) {
1609         // The font has axes, they cannot be retrieved, and some named axis was specified.
1610         return -1;
1611     } else {
1612         // The font has axes, they cannot be retrieved, but no named instance was specified.
1613         return 0;
1614     }
1615 
1616     return variations->num_axis;
1617 }
1618 
onGetTableTags(SkFontTableTag tags[]) const1619 int SkTypeface_FreeType::onGetTableTags(SkFontTableTag tags[]) const {
1620     AutoFTAccess fta(this);
1621     FT_Face face = fta.face();
1622 
1623     FT_ULong tableCount = 0;
1624     FT_Error error;
1625 
1626     // When 'tag' is nullptr, returns number of tables in 'length'.
1627     error = FT_Sfnt_Table_Info(face, 0, nullptr, &tableCount);
1628     if (error) {
1629         return 0;
1630     }
1631 
1632     if (tags) {
1633         for (FT_ULong tableIndex = 0; tableIndex < tableCount; ++tableIndex) {
1634             FT_ULong tableTag;
1635             FT_ULong tablelength;
1636             error = FT_Sfnt_Table_Info(face, tableIndex, &tableTag, &tablelength);
1637             if (error) {
1638                 return 0;
1639             }
1640             tags[tableIndex] = static_cast<SkFontTableTag>(tableTag);
1641         }
1642     }
1643     return tableCount;
1644 }
1645 
onGetTableData(SkFontTableTag tag,size_t offset,size_t length,void * data) const1646 size_t SkTypeface_FreeType::onGetTableData(SkFontTableTag tag, size_t offset,
1647                                            size_t length, void* data) const
1648 {
1649     AutoFTAccess fta(this);
1650     FT_Face face = fta.face();
1651 
1652     FT_ULong tableLength = 0;
1653     FT_Error error;
1654 
1655     // When 'length' is 0 it is overwritten with the full table length; 'offset' is ignored.
1656     error = FT_Load_Sfnt_Table(face, tag, 0, nullptr, &tableLength);
1657     if (error) {
1658         return 0;
1659     }
1660 
1661     if (offset > tableLength) {
1662         return 0;
1663     }
1664     FT_ULong size = SkTMin((FT_ULong)length, tableLength - (FT_ULong)offset);
1665     if (data) {
1666         error = FT_Load_Sfnt_Table(face, tag, offset, reinterpret_cast<FT_Byte*>(data), &size);
1667         if (error) {
1668             return 0;
1669         }
1670     }
1671 
1672     return size;
1673 }
1674 
1675 ///////////////////////////////////////////////////////////////////////////////
1676 ///////////////////////////////////////////////////////////////////////////////
1677 
Scanner()1678 SkTypeface_FreeType::Scanner::Scanner() : fLibrary(nullptr) {
1679     if (FT_New_Library(&gFTMemory, &fLibrary)) {
1680         return;
1681     }
1682     FT_Add_Default_Modules(fLibrary);
1683 }
~Scanner()1684 SkTypeface_FreeType::Scanner::~Scanner() {
1685     if (fLibrary) {
1686         FT_Done_Library(fLibrary);
1687     }
1688 }
1689 
openFace(SkStreamAsset * stream,int ttcIndex,FT_Stream ftStream) const1690 FT_Face SkTypeface_FreeType::Scanner::openFace(SkStreamAsset* stream, int ttcIndex,
1691                                                FT_Stream ftStream) const
1692 {
1693     if (fLibrary == nullptr) {
1694         return nullptr;
1695     }
1696 
1697     FT_Open_Args args;
1698     memset(&args, 0, sizeof(args));
1699 
1700     const void* memoryBase = stream->getMemoryBase();
1701 
1702     if (memoryBase) {
1703         args.flags = FT_OPEN_MEMORY;
1704         args.memory_base = (const FT_Byte*)memoryBase;
1705         args.memory_size = stream->getLength();
1706     } else {
1707         memset(ftStream, 0, sizeof(*ftStream));
1708         ftStream->size = stream->getLength();
1709         ftStream->descriptor.pointer = stream;
1710         ftStream->read  = sk_ft_stream_io;
1711         ftStream->close = sk_ft_stream_close;
1712 
1713         args.flags = FT_OPEN_STREAM;
1714         args.stream = ftStream;
1715     }
1716 
1717     FT_Face face;
1718     if (FT_Open_Face(fLibrary, &args, ttcIndex, &face)) {
1719         return nullptr;
1720     }
1721     return face;
1722 }
1723 
recognizedFont(SkStreamAsset * stream,int * numFaces) const1724 bool SkTypeface_FreeType::Scanner::recognizedFont(SkStreamAsset* stream, int* numFaces) const {
1725     SkAutoMutexAcquire libraryLock(fLibraryMutex);
1726 
1727     FT_StreamRec streamRec;
1728     FT_Face face = this->openFace(stream, -1, &streamRec);
1729     if (nullptr == face) {
1730         return false;
1731     }
1732 
1733     *numFaces = face->num_faces;
1734 
1735     FT_Done_Face(face);
1736     return true;
1737 }
1738 
1739 #include "SkTSearch.h"
scanFont(SkStreamAsset * stream,int ttcIndex,SkString * name,SkFontStyle * style,bool * isFixedPitch,AxisDefinitions * axes) const1740 bool SkTypeface_FreeType::Scanner::scanFont(
1741     SkStreamAsset* stream, int ttcIndex,
1742     SkString* name, SkFontStyle* style, bool* isFixedPitch, AxisDefinitions* axes) const
1743 {
1744     SkAutoMutexAcquire libraryLock(fLibraryMutex);
1745 
1746     FT_StreamRec streamRec;
1747     FT_Face face = this->openFace(stream, ttcIndex, &streamRec);
1748     if (nullptr == face) {
1749         return false;
1750     }
1751 
1752     int weight = SkFontStyle::kNormal_Weight;
1753     int width = SkFontStyle::kNormal_Width;
1754     SkFontStyle::Slant slant = SkFontStyle::kUpright_Slant;
1755     if (face->style_flags & FT_STYLE_FLAG_BOLD) {
1756         weight = SkFontStyle::kBold_Weight;
1757     }
1758     if (face->style_flags & FT_STYLE_FLAG_ITALIC) {
1759         slant = SkFontStyle::kItalic_Slant;
1760     }
1761 
1762     PS_FontInfoRec psFontInfo;
1763     TT_OS2* os2 = static_cast<TT_OS2*>(FT_Get_Sfnt_Table(face, ft_sfnt_os2));
1764     if (os2 && os2->version != 0xffff) {
1765         weight = os2->usWeightClass;
1766         width = os2->usWidthClass;
1767 
1768         // OS/2::fsSelection bit 9 indicates oblique.
1769         if (SkToBool(os2->fsSelection & (1u << 9))) {
1770             slant = SkFontStyle::kOblique_Slant;
1771         }
1772     } else if (0 == FT_Get_PS_Font_Info(face, &psFontInfo) && psFontInfo.weight) {
1773         static const struct {
1774             char const * const name;
1775             int const weight;
1776         } commonWeights [] = {
1777             // There are probably more common names, but these are known to exist.
1778             { "all", SkFontStyle::kNormal_Weight }, // Multiple Masters usually default to normal.
1779             { "black", SkFontStyle::kBlack_Weight },
1780             { "bold", SkFontStyle::kBold_Weight },
1781             { "book", (SkFontStyle::kNormal_Weight + SkFontStyle::kLight_Weight)/2 },
1782             { "demi", SkFontStyle::kSemiBold_Weight },
1783             { "demibold", SkFontStyle::kSemiBold_Weight },
1784             { "extra", SkFontStyle::kExtraBold_Weight },
1785             { "extrabold", SkFontStyle::kExtraBold_Weight },
1786             { "extralight", SkFontStyle::kExtraLight_Weight },
1787             { "hairline", SkFontStyle::kThin_Weight },
1788             { "heavy", SkFontStyle::kBlack_Weight },
1789             { "light", SkFontStyle::kLight_Weight },
1790             { "medium", SkFontStyle::kMedium_Weight },
1791             { "normal", SkFontStyle::kNormal_Weight },
1792             { "plain", SkFontStyle::kNormal_Weight },
1793             { "regular", SkFontStyle::kNormal_Weight },
1794             { "roman", SkFontStyle::kNormal_Weight },
1795             { "semibold", SkFontStyle::kSemiBold_Weight },
1796             { "standard", SkFontStyle::kNormal_Weight },
1797             { "thin", SkFontStyle::kThin_Weight },
1798             { "ultra", SkFontStyle::kExtraBold_Weight },
1799             { "ultrablack", SkFontStyle::kExtraBlack_Weight },
1800             { "ultrabold", SkFontStyle::kExtraBold_Weight },
1801             { "ultraheavy", SkFontStyle::kExtraBlack_Weight },
1802             { "ultralight", SkFontStyle::kExtraLight_Weight },
1803         };
1804         int const index = SkStrLCSearch(&commonWeights[0].name, SK_ARRAY_COUNT(commonWeights),
1805                                         psFontInfo.weight, sizeof(commonWeights[0]));
1806         if (index >= 0) {
1807             weight = commonWeights[index].weight;
1808         } else {
1809             SkDEBUGF(("Do not know weight for: %s (%s) \n", face->family_name, psFontInfo.weight));
1810         }
1811     }
1812 
1813     if (name) {
1814         name->set(face->family_name);
1815     }
1816     if (style) {
1817         *style = SkFontStyle(weight, width, slant);
1818     }
1819     if (isFixedPitch) {
1820         *isFixedPitch = FT_IS_FIXED_WIDTH(face);
1821     }
1822 
1823     if (axes && face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS) {
1824         FT_MM_Var* variations = nullptr;
1825         FT_Error err = FT_Get_MM_Var(face, &variations);
1826         if (err) {
1827             SkDEBUGF(("INFO: font %s claims to have variations, but none found.\n",
1828                       face->family_name));
1829             return false;
1830         }
1831         SkAutoFree autoFreeVariations(variations);
1832 
1833         axes->reset(variations->num_axis);
1834         for (FT_UInt i = 0; i < variations->num_axis; ++i) {
1835             const FT_Var_Axis& ftAxis = variations->axis[i];
1836             (*axes)[i].fTag = ftAxis.tag;
1837             (*axes)[i].fMinimum = ftAxis.minimum;
1838             (*axes)[i].fDefault = ftAxis.def;
1839             (*axes)[i].fMaximum = ftAxis.maximum;
1840         }
1841     }
1842 
1843     FT_Done_Face(face);
1844     return true;
1845 }
1846 
computeAxisValues(AxisDefinitions axisDefinitions,const SkFontArguments::VariationPosition position,SkFixed * axisValues,const SkString & name)1847 /*static*/ void SkTypeface_FreeType::Scanner::computeAxisValues(
1848     AxisDefinitions axisDefinitions,
1849     const SkFontArguments::VariationPosition position,
1850     SkFixed* axisValues,
1851     const SkString& name)
1852 {
1853     for (int i = 0; i < axisDefinitions.count(); ++i) {
1854         const Scanner::AxisDefinition& axisDefinition = axisDefinitions[i];
1855         const SkScalar axisMin = SkFixedToScalar(axisDefinition.fMinimum);
1856         const SkScalar axisMax = SkFixedToScalar(axisDefinition.fMaximum);
1857         axisValues[i] = axisDefinition.fDefault;
1858         for (int j = 0; j < position.coordinateCount; ++j) {
1859             const auto& coordinate = position.coordinates[j];
1860             if (axisDefinition.fTag == coordinate.axis) {
1861                 const SkScalar axisValue = SkTPin(coordinate.value, axisMin, axisMax);
1862                 if (coordinate.value != axisValue) {
1863                     SkDEBUGF(("Requested font axis value out of range: "
1864                               "%s '%c%c%c%c' %f; pinned to %f.\n",
1865                               name.c_str(),
1866                               (axisDefinition.fTag >> 24) & 0xFF,
1867                               (axisDefinition.fTag >> 16) & 0xFF,
1868                               (axisDefinition.fTag >>  8) & 0xFF,
1869                               (axisDefinition.fTag      ) & 0xFF,
1870                               SkScalarToDouble(coordinate.value),
1871                               SkScalarToDouble(axisValue)));
1872                 }
1873                 axisValues[i] = SkScalarToFixed(axisValue);
1874                 break;
1875             }
1876         }
1877         // TODO: warn on defaulted axis?
1878     }
1879 
1880     SkDEBUGCODE(
1881         // Check for axis specified, but not matched in font.
1882         for (int i = 0; i < position.coordinateCount; ++i) {
1883             SkFourByteTag skTag = position.coordinates[i].axis;
1884             bool found = false;
1885             for (int j = 0; j < axisDefinitions.count(); ++j) {
1886                 if (skTag == axisDefinitions[j].fTag) {
1887                     found = true;
1888                     break;
1889                 }
1890             }
1891             if (!found) {
1892                 SkDEBUGF(("Requested font axis not found: %s '%c%c%c%c'\n",
1893                           name.c_str(),
1894                           (skTag >> 24) & 0xFF,
1895                           (skTag >> 16) & 0xFF,
1896                           (skTag >>  8) & 0xFF,
1897                           (skTag)       & 0xFF));
1898             }
1899         }
1900     )
1901 }
1902