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) 2022 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>
27 #include <dali/internal/text/text-abstraction/plugin/bitmap-font-cache-item.h>
28 #include <dali/internal/text/text-abstraction/plugin/embedded-item.h>
29 #include <dali/internal/text/text-abstraction/plugin/font-face-cache-item.h>
30 #include <dali/internal/text/text-abstraction/plugin/pixel-buffer-cache-item.h>
32 #ifdef ENABLE_VECTOR_BASED_TEXT_RENDERING
33 #include <third-party/glyphy/vector-font-cache.h>
35 class VectorFontCache;
39 #include <unordered_map>
42 #include FT_FREETYPE_H
45 #include FT_SYNTHESIS_H
47 // forward declarations of font config types.
54 namespace TextAbstraction
59 * @brief Type used for indices addressing the vector with front descriptions of validated fonts.
61 typedef uint32_t FontDescriptionId;
64 * @brief Vector of character sets.
66 typedef Vector<_FcCharSet*> CharacterSetList;
69 * @brief FontClient implementation.
71 struct FontClient::Plugin
73 public: // Dali::TextAbstraction::FontClient
77 * Initializes the FreeType library.
78 * Initializes the dpi values.
80 * @param[in] horizontalDpi The horizontal dpi.
81 * @param[in] verticalDpi The vertical dpi.
83 Plugin(unsigned int horizontalDpi, unsigned int verticalDpi);
88 * Frees any allocated resource.
93 * @copydoc Dali::TextAbstraction::FontClient::ClearCache()
95 void ClearCache() const;
98 * @copydoc Dali::TextAbstraction::FontClient::SetDpi()
100 void SetDpi(unsigned int horizontalDpi, unsigned int verticalDpi);
103 * @copydoc Dali::TextAbstraction::FontClient::ResetSystemDefaults()
105 void ResetSystemDefaults() const;
108 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
110 void GetDefaultPlatformFontDescription(FontDescription& fontDescription) const;
113 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFonts()
115 void GetDefaultFonts(FontList& defaultFonts) const;
118 * @copydoc Dali::TextAbstraction::FontClient::GetSystemFonts()
120 void GetSystemFonts(FontList& systemFonts) const;
123 * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
125 void GetDescription(FontId fontId, FontDescription& fontDescription) const;
128 * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
130 PointSize26Dot6 GetPointSize(FontId fontId) const;
133 * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
135 bool IsCharacterSupportedByFont(FontId fontId, Character character) const;
138 * @copydoc Dali::TextAbstraction::FontClient::FindDefaultFont()
140 FontId FindDefaultFont(Character charcode,
141 PointSize26Dot6 requestedPointSize,
142 bool preferColor) const;
145 * @copydoc Dali::TextAbstraction::FontClient::FindFallbackFont()
147 FontId FindFallbackFont(Character charcode,
148 const FontDescription& preferredFontDescription,
149 PointSize26Dot6 requestedPointSize,
150 bool preferColor) const;
153 * @see Dali::TextAbstraction::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
155 * @param[in] cacheDescription Whether to cache the font description.
157 FontId GetFontIdByPath(const FontPath& path,
158 PointSize26Dot6 requestedPointSize,
160 bool cacheDescription) const;
163 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontDescription& preferredFontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
165 FontId GetFontId(const FontDescription& fontDescription,
166 PointSize26Dot6 requestedPointSize,
167 FaceIndex faceIndex) const;
170 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const BitmapFont& bitmapFont )
172 FontId GetFontId(const BitmapFont& bitmapFont) const;
175 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontPath& path )
177 bool IsScalable(const FontPath& path) const;
180 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontDescription& fontDescription )
182 bool IsScalable(const FontDescription& fontDescription) const;
185 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
187 void GetFixedSizes(const FontPath& path, Dali::Vector<PointSize26Dot6>& sizes) const;
190 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
192 void GetFixedSizes(const FontDescription& fontDescription,
193 Dali::Vector<PointSize26Dot6>& sizes) const;
196 * @copydoc Dali::TextAbstraction::FontClient::HasItalicStyle()
198 bool HasItalicStyle(FontId fontId) const;
201 * @copydoc Dali::TextAbstraction::FontClient::GetFontMetrics()
203 void GetFontMetrics(FontId fontId, FontMetrics& metrics) const;
206 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
208 GlyphIndex GetGlyphIndex(FontId fontId, Character charcode) const;
211 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
213 GlyphIndex GetGlyphIndex(FontId fontId, Character charcode, Character variantSelector) const;
216 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
218 bool GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal) const;
221 * Helper for GetGlyphMetrics when using bitmaps
223 bool GetBitmapMetrics(GlyphInfo* array, uint32_t size, bool horizontal) const;
226 * Helper for GetGlyphMetrics when using vectors
228 bool GetVectorMetrics(GlyphInfo* array, uint32_t size, bool horizontal) const;
231 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth )
233 void CreateBitmap(FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth) const;
236 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth )
238 PixelData CreateBitmap(FontId fontId, GlyphIndex glyphIndex, int outlineWidth) const;
241 * @copydoc Dali::TextAbstraction::FontClient::CreateVectorBlob()
243 void CreateVectorBlob(FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight) const;
246 * @copydoc Dali::TextAbstraction::FontClient::GetEllipsisGlyph()
248 const GlyphInfo& GetEllipsisGlyph(PointSize26Dot6 requestedPointSize) const;
251 * @copydoc Dali::TextAbstraction::FontClient::IsColorGlyph()
253 bool IsColorGlyph(FontId fontId, GlyphIndex glyphIndex) const;
256 * @copydoc Dali::TextAbstraction::FontClient::CreateEmbeddedItem()
258 GlyphIndex CreateEmbeddedItem(const TextAbstraction::FontClient::EmbeddedItemDescription& description, Pixel::Format& pixelFormat) const;
261 * @copydoc Dali::TextAbstraction::FontClient::EnableAtlasLimitation(bool enabled)
263 void EnableAtlasLimitation(bool enabled);
266 * @copydoc Dali::TextAbstraction::FontClient::IsAtlasLimitationEnabled()
268 bool IsAtlasLimitationEnabled() const;
271 * @copydoc Dali::TextAbstraction::FontClient::GetMaximumTextAtlasSize()
273 Size GetMaximumTextAtlasSize() const;
276 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultTextAtlasSize()
278 Size GetDefaultTextAtlasSize() const;
281 * @copydoc Dali::TextAbstraction::FontClient::GetCurrentMaximumBlockSizeFitInAtlas()
283 Size GetCurrentMaximumBlockSizeFitInAtlas() const;
286 * @copydoc Dali::TextAbstraction::FontClient::SetCurrentMaximumBlockSizeFitInAtlas(const Size& currentMaximumBlockSizeFitInAtlas)
288 bool SetCurrentMaximumBlockSizeFitInAtlas(const Size& currentMaximumBlockSizeFitInAtlas);
291 * @copydoc Dali::TextAbstraction::FontClient::GetNumberOfPointsPerOneUnitOfPointSize()
293 uint32_t GetNumberOfPointsPerOneUnitOfPointSize() const;
296 * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
298 bool AddCustomFontDirectory(const FontPath& path);
300 public: // Dali::TextAbstraction::Internal::FontClient
302 * @copydoc Dali::TextAbstraction::Internal::FontClient::GetFreetypeFace()
304 FT_FaceRec_* GetFreetypeFace(FontId fontId) const;
307 * @copydoc Dali::TextAbstraction::Internal::FontClient::GetFontType()
309 FontDescription::Type GetFontType(FontId fontId) const;
312 * @copydoc Dali::TextAbstraction::Internal::FontClient::GetHarfBuzzFont()
314 HarfBuzzFontHandle GetHarfBuzzFont(FontId fontId) const;
317 * @copydoc Dali::TextAbstraction::Internal::FontClient::FontPreCache()
319 void FontPreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily) const;
323 * Get the cached font item for the given font
324 * @param[in] fontId The font id to search for
325 * @return the matching cached font item
327 const FontCacheItemInterface* GetCachedFontItem(FontId fontId) const;
330 * @brief Finds within the @p fontList a font which support the @p carcode.
332 * @param[in] fontList A list of font paths, family, width, weight and slant.
333 * @param[in] characterSetList A list that contains a character set for each description of the font list.
334 * @param[in] charcode The character for which a font is needed.
335 * @param[in] requestedPointSize The point size in 26.6 fractional points.
336 * @param[in] preferColor @e true if a color font is preferred.
338 * @return A valid font identifier, or zero if no font is found.
340 FontId FindFontForCharacter(const FontList& fontList,
341 const CharacterSetList& characterSetList,
343 PointSize26Dot6 requestedPointSize,
344 bool preferColor) const;
347 * @brief Creates a font.
349 * @param[in] path The path to the font file name.
350 * @param[in] requestedPointSize The requested point size.
351 * @param[in] faceIndex A face index.
352 * @param[in] cacheDescription Whether to cache the font description.
354 * @return The font identifier.
356 FontId CreateFont(const FontPath& path,
357 PointSize26Dot6 requestedPointSize,
359 bool cacheDescription) const;
362 Plugin(const Plugin&) = delete;
363 Plugin& operator=(const Plugin&) = delete;
366 FT_Library mFreeTypeLibrary; ///< A handle to a FreeType library instance.
368 unsigned int mDpiHorizontal; ///< Horizontal dpi.
369 unsigned int mDpiVertical; ///< Vertical dpi.
371 bool mIsAtlasLimitationEnabled : 1; ///< Whether the validation on maximum atlas block size, then reduce block size to fit into it is enabled or not.
372 Vector2 mCurrentMaximumBlockSizeFitInAtlas; ///< The current maximum size (width, height) of text-atlas-block.
375 VectorFontCache* mVectorFontCache; ///< Separate cache for vector data blobs etc.
378 CacheHandler* mCacheHandler; ///< Seperate cache for font data.
381 } // namespace Internal
383 } // namespace TextAbstraction
387 #endif // DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H