[FreeType] Add initial implementation of variation fonts
[WebKit-https.git] / Source / WebCore / platform / graphics / freetype / FontPlatformDataFreeType.cpp
1 /*
2  * Copyright (C) 2006 Apple Inc.
3  * Copyright (C) 2006 Michael Emmel mike.emmel@gmail.com
4  * Copyright (C) 2007, 2008 Alp Toker <alp@atoker.com>
5  * Copyright (C) 2007 Holger Hans Peter Freyther
6  * Copyright (C) 2009, 2010 Igalia S.L.
7  * All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #include "config.h"
26 #include "FontPlatformData.h"
27
28 #include "CairoUniquePtr.h"
29 #include "CairoUtilities.h"
30 #include "FontCache.h"
31 #include "SharedBuffer.h"
32 #include <cairo-ft.h>
33 #include <fontconfig/fcfreetype.h>
34 #include <ft2build.h>
35 #include FT_TRUETYPE_TABLES_H
36 #include <wtf/MathExtras.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 static cairo_subpixel_order_t convertFontConfigSubpixelOrder(int fontConfigOrder)
42 {
43     switch (fontConfigOrder) {
44     case FC_RGBA_RGB:
45         return CAIRO_SUBPIXEL_ORDER_RGB;
46     case FC_RGBA_BGR:
47         return CAIRO_SUBPIXEL_ORDER_BGR;
48     case FC_RGBA_VRGB:
49         return CAIRO_SUBPIXEL_ORDER_VRGB;
50     case FC_RGBA_VBGR:
51         return CAIRO_SUBPIXEL_ORDER_VBGR;
52     case FC_RGBA_NONE:
53     case FC_RGBA_UNKNOWN:
54         return CAIRO_SUBPIXEL_ORDER_DEFAULT;
55     }
56     return CAIRO_SUBPIXEL_ORDER_DEFAULT;
57 }
58
59 static cairo_hint_style_t convertFontConfigHintStyle(int fontConfigStyle)
60 {
61     switch (fontConfigStyle) {
62     case FC_HINT_NONE:
63         return CAIRO_HINT_STYLE_NONE;
64     case FC_HINT_SLIGHT:
65         return CAIRO_HINT_STYLE_SLIGHT;
66     case FC_HINT_MEDIUM:
67         return CAIRO_HINT_STYLE_MEDIUM;
68     case FC_HINT_FULL:
69         return CAIRO_HINT_STYLE_FULL;
70     }
71     return CAIRO_HINT_STYLE_NONE;
72 }
73
74 static void setCairoFontOptionsFromFontConfigPattern(cairo_font_options_t* options, FcPattern* pattern)
75 {
76     FcBool booleanResult;
77     int integerResult;
78
79     if (FcPatternGetInteger(pattern, FC_RGBA, 0, &integerResult) == FcResultMatch) {
80         cairo_font_options_set_subpixel_order(options, convertFontConfigSubpixelOrder(integerResult));
81
82         // Based on the logic in cairo-ft-font.c in the cairo source, a font with
83         // a subpixel order implies that is uses subpixel antialiasing.
84         if (integerResult != FC_RGBA_NONE)
85             cairo_font_options_set_antialias(options, CAIRO_ANTIALIAS_SUBPIXEL);
86     }
87
88     if (FcPatternGetBool(pattern, FC_ANTIALIAS, 0, &booleanResult) == FcResultMatch) {
89         // Only override the anti-aliasing setting if was previously turned off. Otherwise
90         // we'll override the preference which decides between gray anti-aliasing and
91         // subpixel anti-aliasing.
92         if (!booleanResult)
93             cairo_font_options_set_antialias(options, CAIRO_ANTIALIAS_NONE);
94         else if (cairo_font_options_get_antialias(options) == CAIRO_ANTIALIAS_NONE)
95             cairo_font_options_set_antialias(options, CAIRO_ANTIALIAS_GRAY);
96     }
97
98     if (FcPatternGetInteger(pattern, FC_HINT_STYLE, 0, &integerResult) == FcResultMatch)
99         cairo_font_options_set_hint_style(options, convertFontConfigHintStyle(integerResult));
100     if (FcPatternGetBool(pattern, FC_HINTING, 0, &booleanResult) == FcResultMatch && !booleanResult)
101         cairo_font_options_set_hint_style(options, CAIRO_HINT_STYLE_NONE);
102
103 #if ENABLE(VARIATION_FONTS)
104     FcChar8* variations;
105     if (FcPatternGetString(pattern, FC_FONT_VARIATIONS, 0, &variations) == FcResultMatch) {
106         cairo_font_options_set_variations(options, reinterpret_cast<char*>(variations));
107     }
108 #endif
109 }
110
111 FontPlatformData::FontPlatformData(cairo_font_face_t* fontFace, FcPattern* pattern, float size, bool fixedWidth, bool syntheticBold, bool syntheticOblique, FontOrientation orientation)
112     : FontPlatformData(size, syntheticBold, syntheticOblique, orientation)
113 {
114     m_pattern = pattern;
115     m_fixedWidth = fixedWidth;
116
117     buildScaledFont(fontFace);
118 }
119
120 FontPlatformData::FontPlatformData(const FontPlatformData& other)
121 {
122     *this = other;
123 }
124
125 FontPlatformData& FontPlatformData::operator=(const FontPlatformData& other)
126 {
127     // Check for self-assignment.
128     if (this == &other)
129         return *this;
130
131     m_size = other.m_size;
132     m_orientation = other.m_orientation;
133     m_widthVariant = other.m_widthVariant;
134     m_textRenderingMode = other.m_textRenderingMode;
135
136     m_syntheticBold = other.m_syntheticBold;
137     m_syntheticOblique = other.m_syntheticOblique;
138     m_isColorBitmapFont = other.m_isColorBitmapFont;
139     m_isHashTableDeletedValue = other.m_isHashTableDeletedValue;
140     m_isSystemFont = other.m_isSystemFont;
141
142     m_fixedWidth = other.m_fixedWidth;
143     m_pattern = other.m_pattern;
144
145     m_scaledFont = other.m_scaledFont;
146
147     // This will be re-created on demand.
148     m_harfBuzzFace = nullptr;
149
150     return *this;
151 }
152
153 FontPlatformData::~FontPlatformData() = default;
154
155 FontPlatformData FontPlatformData::cloneWithOrientation(const FontPlatformData& source, FontOrientation orientation)
156 {
157     FontPlatformData copy(source);
158     if (copy.m_scaledFont && copy.m_orientation != orientation) {
159         copy.m_orientation = orientation;
160         copy.buildScaledFont(cairo_scaled_font_get_font_face(copy.m_scaledFont.get()));
161     }
162     return copy;
163 }
164
165 FontPlatformData FontPlatformData::cloneWithSyntheticOblique(const FontPlatformData& source, bool syntheticOblique)
166 {
167     FontPlatformData copy(source);
168     if (copy.m_syntheticOblique != syntheticOblique) {
169         copy.m_syntheticOblique = syntheticOblique;
170         ASSERT(copy.m_scaledFont.get());
171         copy.buildScaledFont(cairo_scaled_font_get_font_face(copy.m_scaledFont.get()));
172     }
173     return copy;
174 }
175
176 FontPlatformData FontPlatformData::cloneWithSize(const FontPlatformData& source, float size)
177 {
178     FontPlatformData copy(source);
179     copy.m_size = size;
180     // We need to reinitialize the instance, because the difference in size
181     // necessitates a new scaled font instance.
182     ASSERT(copy.m_scaledFont.get());
183     copy.buildScaledFont(cairo_scaled_font_get_font_face(copy.m_scaledFont.get()));
184     return copy;
185 }
186
187 HarfBuzzFace& FontPlatformData::harfBuzzFace() const
188 {
189     if (!m_harfBuzzFace)
190         m_harfBuzzFace = std::make_unique<HarfBuzzFace>(const_cast<FontPlatformData&>(*this), hash());
191     return *m_harfBuzzFace;
192 }
193
194 FcPattern* FontPlatformData::fcPattern() const
195 {
196     return m_pattern.get();
197 }
198
199 bool FontPlatformData::isFixedPitch() const
200 {
201     return m_fixedWidth;
202 }
203
204 unsigned FontPlatformData::hash() const
205 {
206     return PtrHash<cairo_scaled_font_t*>::hash(m_scaledFont.get());
207 }
208
209 bool FontPlatformData::platformIsEqual(const FontPlatformData& other) const
210 {
211     // FcPatternEqual does not support null pointers as arguments.
212     if ((m_pattern && !other.m_pattern)
213         || (!m_pattern && other.m_pattern)
214         || (m_pattern != other.m_pattern && !FcPatternEqual(m_pattern.get(), other.m_pattern.get())))
215         return false;
216
217     return m_scaledFont == other.m_scaledFont;
218 }
219
220 #if !LOG_DISABLED
221 String FontPlatformData::description() const
222 {
223     return String();
224 }
225 #endif
226
227 void FontPlatformData::buildScaledFont(cairo_font_face_t* fontFace)
228 {
229     ASSERT(m_pattern);
230     CairoUniquePtr<cairo_font_options_t> options(cairo_font_options_copy(getDefaultCairoFontOptions()));
231     setCairoFontOptionsFromFontConfigPattern(options.get(), m_pattern.get());
232
233     cairo_matrix_t ctm;
234     cairo_matrix_init_identity(&ctm);
235
236     // FontConfig may return a list of transformation matrices with the pattern, for instance,
237     // for fonts that are oblique. We use that to initialize the cairo font matrix.
238     cairo_matrix_t fontMatrix;
239     FcMatrix fontConfigMatrix, *tempFontConfigMatrix;
240     FcMatrixInit(&fontConfigMatrix);
241
242     // These matrices may be stacked in the pattern, so it's our job to get them all and multiply them.
243     for (int i = 0; FcPatternGetMatrix(m_pattern.get(), FC_MATRIX, i, &tempFontConfigMatrix) == FcResultMatch; i++)
244         FcMatrixMultiply(&fontConfigMatrix, &fontConfigMatrix, tempFontConfigMatrix);
245
246     cairo_matrix_init(&fontMatrix, 1, -fontConfigMatrix.yx, -fontConfigMatrix.xy, 1, 0, 0);
247
248     // The matrix from FontConfig does not include the scale. Scaling a font with width zero size leads
249     // to a failed cairo_scaled_font_t instantiations. Instead we scale the font to a very tiny
250     // size and just abort rendering later on.
251     float realSize = m_size ? m_size : 1;
252     cairo_matrix_scale(&fontMatrix, realSize, realSize);
253
254     if (syntheticOblique()) {
255         static const float syntheticObliqueSkew = -tanf(14 * acosf(0) / 90);
256         static const cairo_matrix_t skew = {1, 0, syntheticObliqueSkew, 1, 0, 0};
257         static const cairo_matrix_t verticalSkew = {1, -syntheticObliqueSkew, 0, 1, 0, 0};
258         cairo_matrix_multiply(&fontMatrix, m_orientation == FontOrientation::Vertical ? &verticalSkew : &skew, &fontMatrix);
259     }
260
261     if (m_orientation == FontOrientation::Vertical) {
262         // The resulting transformation matrix for vertical glyphs (V) is a
263         // combination of rotation (R) and translation (T) applied on the
264         // horizontal matrix (H). V = H . R . T, where R rotates by -90 degrees
265         // and T translates by font size towards y axis.
266         cairo_matrix_rotate(&fontMatrix, -piOverTwoDouble);
267         cairo_matrix_translate(&fontMatrix, 0.0, 1.0);
268     }
269
270     m_scaledFont = adoptRef(cairo_scaled_font_create(fontFace, &fontMatrix, &ctm, options.get()));
271 }
272
273 bool FontPlatformData::hasCompatibleCharmap() const
274 {
275     ASSERT(m_scaledFont.get());
276     CairoFtFaceLocker cairoFtFaceLocker(m_scaledFont.get());
277     FT_Face freeTypeFace = cairoFtFaceLocker.ftFace();
278     if (!freeTypeFace)
279         return false;
280     return !(FT_Select_Charmap(freeTypeFace, ft_encoding_unicode)
281         && FT_Select_Charmap(freeTypeFace, ft_encoding_symbol)
282         && FT_Select_Charmap(freeTypeFace, ft_encoding_apple_roman));
283 }
284
285 RefPtr<SharedBuffer> FontPlatformData::openTypeTable(uint32_t table) const
286 {
287     CairoFtFaceLocker cairoFtFaceLocker(m_scaledFont.get());
288     FT_Face freeTypeFace = cairoFtFaceLocker.ftFace();
289     if (!freeTypeFace)
290         return nullptr;
291
292     FT_ULong tableSize = 0;
293     // Tag bytes need to be reversed because OT_MAKE_TAG uses big-endian order.
294     uint32_t tag = FT_MAKE_TAG((table & 0xff), (table & 0xff00) >> 8, (table & 0xff0000) >> 16, table >> 24);
295     if (FT_Load_Sfnt_Table(freeTypeFace, tag, 0, 0, &tableSize))
296         return nullptr;
297
298     Vector<char> data(tableSize);
299     FT_ULong expectedTableSize = tableSize;
300     FT_Error error = FT_Load_Sfnt_Table(freeTypeFace, tag, 0, reinterpret_cast<FT_Byte*>(data.data()), &tableSize);
301     if (error || tableSize != expectedTableSize)
302         return nullptr;
303
304     return SharedBuffer::create(WTFMove(data));
305 }
306
307 } // namespace WebCore