1 #ifndef DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H
2 #define DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
23 #include <dali/devel-api/text-abstraction/bitmap-font.h>
24 #include <dali/devel-api/text-abstraction/font-metrics.h>
25 #include <dali/devel-api/text-abstraction/glyph-info.h>
26 #include <dali/internal/text/text-abstraction/font-client-impl.h>
28 #ifdef ENABLE_VECTOR_BASED_TEXT_RENDERING
29 #include <third-party/glyphy/vector-font-cache.h>
31 class VectorFontCache;
36 #include FT_FREETYPE_H
40 #include FT_SYNTHESIS_H
42 // forward declarations of font config types.
49 namespace TextAbstraction
54 * @brief Type used for indices addressing the vector with front descriptions of validated fonts.
56 typedef uint32_t FontDescriptionId;
59 * @brief Type used for indices addressing the vector with pixel buffers.
61 typedef uint32_t PixelBufferId;
64 * @brief Vector of character sets.
66 typedef Vector<_FcCharSet*> CharacterSetList;
69 * @brief FontClient implementation.
71 struct FontClient::Plugin
73 struct FontIdCacheItem
75 FontDescription::Type type; ///< The type of font.
76 FontId id; ///< Index to the cache of fonts for the specified type.
80 * @brief Caches an list of fallback fonts for a given font-description
82 struct FallbackCacheItem
84 FallbackCacheItem(FontDescription&& fontDescription, FontList* fallbackFonts, CharacterSetList* characterSets);
86 FontDescription fontDescription; ///< The font description.
87 FontList* fallbackFonts; ///< The list of fallback fonts for the given font-description.
88 CharacterSetList* characterSets; ///< The list of character sets for the given font-description.
92 * @brief Caches an index to the vector of font descriptions for a given font.
94 struct FontDescriptionCacheItem
96 FontDescriptionCacheItem(const FontDescription& fontDescription,
97 FontDescriptionId index);
98 FontDescriptionCacheItem(FontDescription&& fontDescription,
99 FontDescriptionId index);
101 FontDescription fontDescription; ///< The font description.
102 FontDescriptionId index; ///< Index to the vector of font descriptions.
106 * @brief Caches the font id of the pair font point size and the index to the vector of font descriptions of validated fonts.
108 struct FontDescriptionSizeCacheItem
110 FontDescriptionSizeCacheItem(FontDescriptionId validatedFontId,
111 PointSize26Dot6 requestedPointSize,
114 FontDescriptionId validatedFontId; ///< Index to the vector with font descriptions.
115 PointSize26Dot6 requestedPointSize; ///< The font point size.
116 FontId fontId; ///< The font identifier.
120 * @brief Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
122 struct FontFaceCacheItem
124 FontFaceCacheItem(FT_Face ftFace,
125 const FontPath& path,
126 PointSize26Dot6 requestedPointSize,
128 const FontMetrics& metrics);
130 FontFaceCacheItem(FT_Face ftFace,
131 const FontPath& path,
132 PointSize26Dot6 requestedPointSize,
134 const FontMetrics& metrics,
138 bool hasColorTables);
140 FT_Face mFreeTypeFace; ///< The FreeType face.
141 FontPath mPath; ///< The path to the font file name.
142 PointSize26Dot6 mRequestedPointSize; ///< The font point size.
143 FaceIndex mFaceIndex; ///< The face index.
144 FontMetrics mMetrics; ///< The font metrics.
145 _FcCharSet* mCharacterSet; ///< Pointer with the range of characters.
146 int mFixedSizeIndex; ///< Index to the fixed size table for the requested size.
147 float mFixedWidthPixels; ///< The height in pixels (fixed size bitmaps only)
148 float mFixedHeightPixels; ///< The height in pixels (fixed size bitmaps only)
149 unsigned int mVectorFontId; ///< The ID of the equivalent vector-based font
150 FontId mFontId; ///< Index to the vector with the cache of font's ids.
151 bool mIsFixedSizeBitmap : 1; ///< Whether the font has fixed size bitmaps.
152 bool mHasColorTables : 1; ///< Whether the font has color tables.
157 PointSize26Dot6 requestedPointSize;
162 * @brief Caches pixel buffers.
164 struct PixelBufferCacheItem
166 Devel::PixelBuffer pixelBuffer; ///< The pixel buffer loaded from the url.
167 std::string url; ///< The url.
171 * @brief Caches embedded items.
175 PixelBufferId pixelBufferId; ///< Index to the vector of pixel buffers
176 unsigned int width; ///< The desired width.
177 unsigned int height; ///< The desired height.
181 * @brief Stores a bitmap font and its pixel buffers per glyph.
183 struct BitmapFontCacheItem
185 BitmapFont font; ///< The bitmap font.
186 std::vector<Devel::PixelBuffer> pixelBuffers; ///< The pixel buffers of the glyphs.
187 FontId id; ///< Index to the vector with the cache of font's ids.
193 * Initializes the FreeType library.
194 * Initializes the dpi values.
196 * @param[in] horizontalDpi The horizontal dpi.
197 * @param[in] verticalDpi The vertical dpi.
199 Plugin(unsigned int horizontalDpi, unsigned int verticalDpi);
202 * Default destructor.
204 * Frees any allocated resource.
209 * @copydoc Dali::TextAbstraction::FontClient::ClearCache()
214 * @copydoc Dali::TextAbstraction::FontClient::SetDpi()
216 void SetDpi(unsigned int horizontalDpi, unsigned int verticalDpi);
219 * @copydoc Dali::TextAbstraction::FontClient::ResetSystemDefaults()
221 void ResetSystemDefaults();
224 * @copydoc Dali::TextAbstraction::FontClient::SetDefaultFont()
226 void SetDefaultFont(const FontDescription& preferredFontDescription);
229 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
231 void GetDefaultPlatformFontDescription(FontDescription& fontDescription);
234 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFonts()
236 void GetDefaultFonts(FontList& defaultFonts);
239 * @copydoc Dali::TextAbstraction::FontClient::GetSystemFonts()
241 void GetSystemFonts(FontList& systemFonts);
244 * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
246 void GetDescription(FontId id, FontDescription& fontDescription) const;
249 * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
251 PointSize26Dot6 GetPointSize(FontId id);
254 * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
256 bool IsCharacterSupportedByFont(FontId fontId, Character character);
259 * @brief Finds within the @p fontList a font which support the @p carcode.
261 * @param[in] fontList A list of font paths, family, width, weight and slant.
262 * @param[in] characterSetList A list that contains a character set for each description of the font list.
263 * @param[in] charcode The character for which a font is needed.
264 * @param[in] requestedPointSize The point size in 26.6 fractional points.
265 * @param[in] preferColor @e true if a color font is preferred.
267 * @return A valid font identifier, or zero if no font is found.
269 FontId FindFontForCharacter(const FontList& fontList,
270 const CharacterSetList& characterSetList,
272 PointSize26Dot6 requestedPointSize,
276 * @copydoc Dali::TextAbstraction::FontClient::FindDefaultFont()
278 FontId FindDefaultFont(Character charcode,
279 PointSize26Dot6 requestedPointSize,
283 * @copydoc Dali::TextAbstraction::FontClient::FindFallbackFont()
285 FontId FindFallbackFont(Character charcode,
286 const FontDescription& preferredFontDescription,
287 PointSize26Dot6 requestedPointSize,
291 * @see Dali::TextAbstraction::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
293 * @param[in] cacheDescription Whether to cache the font description.
295 FontId GetFontId(const FontPath& path,
296 PointSize26Dot6 requestedPointSize,
298 bool cacheDescription);
301 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontDescription& preferredFontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
303 FontId GetFontId(const FontDescription& fontDescription,
304 PointSize26Dot6 requestedPointSize,
305 FaceIndex faceIndex);
308 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const BitmapFont& bitmapFont )
310 FontId GetFontId(const BitmapFont& bitmapFont);
313 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontPath& path )
315 bool IsScalable(const FontPath& path);
318 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontDescription& fontDescription )
320 bool IsScalable(const FontDescription& fontDescription);
323 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
325 void GetFixedSizes(const FontPath& path, Dali::Vector<PointSize26Dot6>& sizes);
328 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
330 void GetFixedSizes(const FontDescription& fontDescription,
331 Dali::Vector<PointSize26Dot6>& sizes);
334 * @copydoc Dali::TextAbstraction::FontClient::HasItalicStyle()
336 bool HasItalicStyle(FontId fontId) const;
339 * @copydoc Dali::TextAbstraction::FontClient::GetFontMetrics()
341 void GetFontMetrics(FontId fontId, FontMetrics& metrics);
344 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
346 GlyphIndex GetGlyphIndex(FontId fontId, Character charcode);
349 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
351 bool GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal);
354 * Helper for GetGlyphMetrics when using bitmaps
356 bool GetBitmapMetrics(GlyphInfo* array, uint32_t size, bool horizontal);
359 * Helper for GetGlyphMetrics when using vectors
361 bool GetVectorMetrics(GlyphInfo* array, uint32_t size, bool horizontal);
364 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth )
366 void CreateBitmap(FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth);
369 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth )
371 PixelData CreateBitmap(FontId fontId, GlyphIndex glyphIndex, int outlineWidth);
374 * @copydoc Dali::TextAbstraction::FontClient::CreateVectorBlob()
376 void CreateVectorBlob(FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight);
379 * @copydoc Dali::TextAbstraction::FontClient::GetEllipsisGlyph()
381 const GlyphInfo& GetEllipsisGlyph(PointSize26Dot6 requestedPointSize);
384 * @copydoc Dali::TextAbstraction::FontClient::IsColorGlyph()
386 bool IsColorGlyph(FontId fontId, GlyphIndex glyphIndex);
389 * @copydoc Dali::TextAbstraction::FontClient::CreateEmbeddedItem()
391 GlyphIndex CreateEmbeddedItem(const TextAbstraction::FontClient::EmbeddedItemDescription& description, Pixel::Format& pixelFormat);
394 * @copydoc Dali::TextAbstraction::Internal::FontClient::GetFreetypeFace()
396 FT_FaceRec_* GetFreetypeFace(FontId fontId);
399 * @copydoc Dali::TextAbstraction::Internal::FontClient::GetFontType()
401 FontDescription::Type GetFontType(FontId fontId);
404 * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
406 bool AddCustomFontDirectory(const FontPath& path);
410 * @brief Caches the fonts present in the platform.
412 * Calls GetFcFontSet() to retrieve the fonts.
414 void InitSystemFonts();
417 * @brief Gets the FontDescription which matches the given pattern.
419 * @note The reference counter of the @p characterSet has been increased. Call FcCharSetDestroy to decrease it.
421 * @param[in] pattern pattern to match against.
422 * @param[out] fontDescription the resultant fontDescription that matched.
423 * @param[out] characterSet The character set for that pattern.
424 * @return true if match found.
426 bool MatchFontDescriptionToPattern(_FcPattern* pattern, Dali::TextAbstraction::FontDescription& fontDescription, _FcCharSet** characterSet);
429 * @brief Creates a font family pattern used to match fonts.
431 * @note Need to call FcPatternDestroy to free the resources.
433 * @param[in] fontDescription The font to cache.
435 * @return The pattern.
437 _FcPattern* CreateFontFamilyPattern(const FontDescription& fontDescription) const;
440 * @brief Retrieves the fonts present in the platform.
442 * @note Need to call FcFontSetDestroy to free the allocated resources.
444 * @return A font fonfig data structure with the platform's fonts.
446 _FcFontSet* GetFcFontSet() const;
449 * @brief Retrieves a font config object's value from a pattern.
451 * @param[in] pattern The font config pattern.
452 * @param[in] n The object.
453 * @param[out] string The object's value.
455 * @return @e true if the operation is successful.
457 bool GetFcString(const _FcPattern* const pattern, const char* const n, std::string& string);
460 * @brief Retrieves a font config object's value from a pattern.
462 * @param[in] pattern The font config pattern.
463 * @param[in] n The object.
464 * @param[out] intVal The object's value.
466 * @return @e true if the operation is successful.
468 bool GetFcInt(const _FcPattern* const pattern, const char* const n, int& intVal);
471 * @brief Creates a font.
473 * @param[in] path The path to the font file name.
474 * @param[in] requestedPointSize The requested point size.
475 * @param[in] faceIndex A face index.
476 * @param[in] cacheDescription Whether to cache the font description.
478 * @return The font identifier.
480 FontId CreateFont(const FontPath& path,
481 PointSize26Dot6 requestedPointSize,
483 bool cacheDescription);
486 * @brief Copy the color bitmap given in @p srcBuffer to @p data.
488 * @param[out] data The bitmap data.
489 * @param[in] srcWidth The width of the bitmap.
490 * @param[in] srcHeight The height of the bitmap.
491 * @param[in] srcBuffer The buffer of the bitmap.
493 void ConvertBitmap(TextAbstraction::FontClient::GlyphBufferData& data, unsigned int srcWidth, unsigned int srcHeight, const unsigned char* const srcBuffer);
496 * @brief Copy the FreeType bitmap to the given buffer.
498 * @param[out] data The bitmap data.
499 * @param[in] srcBitmap The FreeType bitmap.
500 * @param[in] isShearRequired Whether the bitmap needs a shear transform (for software italics).
502 void ConvertBitmap(TextAbstraction::FontClient::GlyphBufferData& data, FT_Bitmap srcBitmap, bool isShearRequired);
505 * @brief Finds in the cache if there is a triplet with the path to the font file name, the font point size and the face index.
506 * If there is one , if writes the font identifier in the param @p fontId.
508 * @param[in] path Path to the font file name.
509 * @param[in] requestedPointSize The font point size.
510 * @param[in] faceIndex The face index.
511 * @param[out] fontId The font identifier.
513 * @return @e true if there triplet is found.
515 bool FindFont(const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex, FontId& fontId) const;
518 * @brief Finds in the cache a cluster 'font family, font width, font weight, font slant'
519 * If there is one, it writes the index to the vector with font descriptions in the param @p validatedFontId.
521 * @param[in] fontDescription The font to validate.
522 * @param[out] validatedFontId The index to the vector with font descriptions.
524 * @return @e true if the pair is found.
526 bool FindValidatedFont(const FontDescription& fontDescription,
527 FontDescriptionId& validatedFontId);
530 * @brief Finds a fallback font list from the cache for a given font-description
532 * @param[in] fontDescription The font to validate.
533 * @param[out] A valid pointer to a font list, or @e nullptr if not found.
534 * @param[out] characterSetList A valid pointer to a character set list, or @e nullptr if not found.
536 bool FindFallbackFontList(const FontDescription& fontDescription,
538 CharacterSetList*& characterSetList);
541 * @brief Finds in the cache a pair 'validated font identifier and font point size'.
542 * If there is one it writes the font identifier in the param @p fontId.
544 * @param[in] validatedFontId Index to the vector with font descriptions.
545 * @param[in] requestedPointSize The font point size.
546 * @param[out] fontId The font identifier.
548 * @return @e true if the pair is found.
550 bool FindFont(FontDescriptionId validatedFontId,
551 PointSize26Dot6 requestedPointSize,
555 * @brief Finds in the cache a bitmap font with the @p bitmapFont family name.
557 * @param[in] bitmapFont The font's family name.
558 * @param[out] fontId The id of the font.
560 * @return Whether the font has been found.
562 bool FindBitmapFont(const FontFamily& bitmapFont, FontId& fontId) const;
565 * @brief Validate a font description.
567 * @param[in] fontDescription The font to validate.
568 * @param[out] validatedFontId Result of validation
570 void ValidateFont(const FontDescription& fontDescription,
571 FontDescriptionId& validatedFontId);
574 * @brief Helper for GetDefaultFonts etc.
576 * @note CharacterSetList is a vector of FcCharSet that are reference counted. It's needed to call FcCharSetDestroy to decrease the reference counter.
578 * @param[in] fontDescription A font description.
579 * @param[out] fontList A list of the fonts which are a close match for fontDescription.
580 * @param[out] characterSetList A list of character sets which are a close match for fontDescription.
582 void SetFontList(const FontDescription& fontDescription, FontList& fontList, CharacterSetList& characterSetList);
585 * Caches a font path.
587 * @param[in] ftFace The FreeType face.
588 * @param[in] id The font identifier.
589 * @param[in] requestedPointSize The font point size.
590 * @param[in] path Path to the font file name.
592 void CacheFontPath(FT_Face ftFace, FontId id, PointSize26Dot6 requestedPointSize, const FontPath& path);
595 * @brief Creates a character set from a given font's @p description.
597 * @note Need to call FcCharSetDestroy to free the resources.
599 * @param[in] description The font's description.
601 * @return A character set.
603 _FcCharSet* CreateCharacterSetFromDescription(const FontDescription& description);
606 * @brief Free the resources allocated in the fallback cache.
608 * @param[in] fallbackCache The fallback cache.
610 void ClearFallbackCache(std::vector<FallbackCacheItem>& fallbackCache);
613 * @brief Free the resources allocated by the FcCharSet objects.
615 void ClearCharacterSetFromFontFaceCache();
618 // Declared private and left undefined to avoid copies.
619 Plugin(const Plugin&);
620 // Declared private and left undefined to avoid copies.
621 Plugin& operator=(const Plugin&);
624 FT_Library mFreeTypeLibrary; ///< A handle to a FreeType library instance.
626 unsigned int mDpiHorizontal; ///< Horizontal dpi.
627 unsigned int mDpiVertical; ///< Vertical dpi.
629 FontDescription mDefaultFontDescription; ///< The cached default font from the system
631 FontList mSystemFonts; ///< Cached system fonts.
632 FontList mDefaultFonts; ///< Cached default fonts.
633 CharacterSetList mDefaultFontCharacterSets;
635 std::vector<FallbackCacheItem> mFallbackCache; ///< Cached fallback font lists.
637 Vector<FontIdCacheItem> mFontIdCache;
638 std::vector<FontFaceCacheItem> mFontFaceCache; ///< Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
639 std::vector<FontDescriptionCacheItem> mValidatedFontCache; ///< Caches indices to the vector of font descriptions for a given font.
640 FontList mFontDescriptionCache; ///< Caches font descriptions for the validated font.
641 CharacterSetList mCharacterSetCache; ///< Caches character set lists for the validated font.
642 std::vector<FontDescriptionSizeCacheItem> mFontDescriptionSizeCache; ///< Caches font identifiers for the pairs of font point size and the index to the vector with font descriptions of the validated fonts.
644 VectorFontCache* mVectorFontCache; ///< Separate cache for vector data blobs etc.
646 Vector<EllipsisItem> mEllipsisCache; ///< Caches ellipsis glyphs for a particular point size.
647 std::vector<PixelBufferCacheItem> mPixelBufferCache; ///< Caches the pixel buffer of a url.
648 Vector<EmbeddedItem> mEmbeddedItemCache; ///< Cache embedded items.
649 std::vector<BitmapFontCacheItem> mBitmapFontCache; ///< Stores bitmap fonts.
651 bool mDefaultFontDescriptionCached : 1; ///< Whether the default font is cached or not
654 } // namespace Internal
656 } // namespace TextAbstraction
660 #endif // DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H