Add support for FontClientFontPreLoad API
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / text-abstraction / font-client.h
1 #ifndef DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H
2 #define DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H
3
4 /*
5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/devel-api/text-abstraction/font-list.h>
23 #include <dali/devel-api/text-abstraction/glyph-buffer-data.h>
24 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
25 #include <dali/public-api/common/dali-vector.h>
26 #include <dali/public-api/dali-adaptor-common.h>
27 #include <dali/public-api/images/pixel-data.h>
28 #include <dali/public-api/object/base-handle.h>
29
30 namespace Dali
31 {
32 namespace TextAbstraction
33 {
34 struct FontMetrics;
35 struct GlyphInfo;
36 struct BitmapFont;
37
38 namespace Internal DALI_INTERNAL
39 {
40 class FontClient;
41 }
42
43 /**
44  * @brief FontClient provides access to font information and resources.
45  *
46  * <h3>Querying the System Fonts</h3>
47  *
48  * A "system font" is described by a "path" to a font file on the native filesystem, along with a "family" and "style".
49  * For example on the Ubuntu system a "Regular" style font from the "Ubuntu Mono" family can be accessed from "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf".
50  *
51  * <h3>Accessing Fonts</h3>
52  *
53  * A "font" is created from the system for a specific point size in 26.6 fractional points. A "FontId" is used to identify each font.
54  * For example two different fonts with point sizes 10 & 12 can be created from the "Ubuntu Mono" family:
55  * @code
56  * FontClient fontClient   = FontClient::Get();
57  * FontId ubuntuMonoTen    = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 10*64 );
58  * FontId ubuntuMonoTwelve = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 12*64 );
59  * @endcode
60  * Glyph metrics and bitmap resources can then be retrieved using the FontId.
61  */
62 class DALI_ADAPTOR_API FontClient : public BaseHandle
63 {
64 public:
65   static const PointSize26Dot6 DEFAULT_POINT_SIZE;   ///< The default point size.
66   static const float           DEFAULT_ITALIC_ANGLE; ///< The default software italic angle in radians.
67
68   static const bool     DEFAULT_ATLAS_LIMITATION_ENABLED; ///< The default behavior of whether atlas limitation is enabled in dali.
69   static const uint32_t DEFAULT_TEXT_ATLAS_WIDTH;         ///< The default width of text-atlas-block.
70   static const uint32_t DEFAULT_TEXT_ATLAS_HEIGHT;        ///< The default height of text-atlas-block.
71   static const Size     DEFAULT_TEXT_ATLAS_SIZE;          ///< The default size(width, height) of text-atlas-block.
72
73   static const uint32_t MAX_TEXT_ATLAS_WIDTH;  ///< The maximum width of text-atlas-block.
74   static const uint32_t MAX_TEXT_ATLAS_HEIGHT; ///< The maximum height of text-atlas-block.
75   static const Size     MAX_TEXT_ATLAS_SIZE;   ///< The maximum height of text-atlas-block.
76
77   static const uint16_t PADDING_TEXT_ATLAS_BLOCK; ///< Padding per edge. How much the block size (width, height) less than the text-atlas-block size (width, height).
78   static const Size     MAX_SIZE_FIT_IN_ATLAS;    ///< The maximum block's size fit into text-atlas-block.
79
80   static const uint32_t NUMBER_OF_POINTS_PER_ONE_UNIT_OF_POINT_SIZE; ///< Factor multiply point-size in toolkit.
81
82   /**
83    * @brief Used to load an embedded item into the font client.
84    */
85   struct EmbeddedItemDescription
86   {
87     std::string       url;               ///< The url path of the image.
88     unsigned int      width;             ///< The width of the item.
89     unsigned int      height;            ///< The height of the item.
90     ColorBlendingMode colorblendingMode; ///< Whether the color of the image is multiplied by the color of the text.
91   };
92
93 public:
94   /**
95    * @brief Retrieve a handle to the FontClient instance.
96    *
97    * @return A handle to the FontClient
98    */
99   static FontClient Get();
100
101   /**
102    * @brief Create a handle to the new FontClient instance.
103    *
104    * @param[in] horizontalDpi The horizontal resolution in DPI.
105    * @param[in] verticalDpi The vertical resolution in DPI.
106    * @return A handle to the FontClient
107    */
108   static FontClient New(uint32_t horizontalDpi, uint32_t verticalDpi);
109
110   /**
111    * @brief Create an uninitialized TextAbstraction handle.
112    */
113   FontClient();
114
115   /**
116    * @brief Destructor
117    *
118    * This is non-virtual since derived Handle types must not contain data or virtual methods.
119    */
120   ~FontClient();
121
122   /**
123    * @brief This copy constructor is required for (smart) pointer semantics.
124    *
125    * @param[in] handle A reference to the copied handle.
126    */
127   FontClient(const FontClient& handle);
128
129   /**
130    * @brief This assignment operator is required for (smart) pointer semantics.
131    *
132    * @param [in] handle  A reference to the copied handle.
133    * @return A reference to this.
134    */
135   FontClient& operator=(const FontClient& handle);
136
137   /**
138    * @brief This move constructor is required for (smart) pointer semantics.
139    *
140    * @param[in] handle A reference to the moved handle.
141    */
142   FontClient(FontClient&& handle);
143
144   /**
145    * @brief This move assignment operator is required for (smart) pointer semantics.
146    *
147    * @param [in] handle  A reference to the moved handle.
148    * @return A reference to this.
149    */
150   FontClient& operator=(FontClient&& handle);
151
152   ////////////////////////////////////////
153   // Font management and validation.
154   ////////////////////////////////////////
155
156   /**
157    * @brief Clear all caches in FontClient
158    *
159    */
160   void ClearCache();
161
162   /**
163    * @brief Set the DPI of the target window.
164    *
165    * @note Multiple windows are not currently supported.
166    * @param[in] horizontalDpi The horizontal resolution in DPI.
167    * @param[in] verticalDpi The vertical resolution in DPI.
168    */
169   void SetDpi(unsigned int horizontalDpi, unsigned int verticalDpi);
170
171   /**
172    * @brief Retrieves the DPI previously set to the target window.
173    *
174    * @note Multiple windows are not currently supported.
175    * @param[out] horizontalDpi The horizontal resolution in DPI.
176    * @param[out] verticalDpi The vertical resolution in DPI.
177    */
178   void GetDpi(unsigned int& horizontalDpi, unsigned int& verticalDpi);
179
180   /**
181    * @brief Called by Dali to retrieve the default font size for the platform.
182    *
183    * This is an accessibility size, which is mapped to a UI Control specific point-size in stylesheets.
184    * For example if zero the smallest size, this could potentially map to TextLabel point-size 8.
185    * @return The default font size.
186    */
187   int GetDefaultFontSize();
188
189   /**
190    * @brief Called when the user changes the system defaults.
191    *
192    * @post Previously cached system defaults are removed.
193    */
194   void ResetSystemDefaults();
195
196   /**
197    * @brief Retrieve the list of default fonts supported by the system.
198    *
199    * @param[out] defaultFonts A list of default font paths, family, width, weight and slant.
200    */
201   void GetDefaultFonts(FontList& defaultFonts);
202
203   /**
204    * @brief Initializes and caches default font from the system.
205    */
206   void InitDefaultFontDescription();
207
208   /**
209    * @brief Retrieve the active default font from the system.
210    *
211    * @param[out] fontDescription font structure describing the default font.
212    */
213   void GetDefaultPlatformFontDescription(FontDescription& fontDescription);
214
215   /**
216    * @brief Retrieve the list of fonts supported by the system.
217    *
218    * @param[out] systemFonts A list of font paths, family, width, weight and slant.
219    */
220   void GetSystemFonts(FontList& systemFonts);
221
222   /**
223    * @brief Retrieves the font description of a given font @p fontId.
224    *
225    * @param[in] fontId The font identifier.
226    * @param[out] fontDescription The path, family & style (width, weight and slant) describing the font.
227    */
228   void GetDescription(FontId fontId, FontDescription& fontDescription);
229
230   /**
231    * @brief Retrieves the font point size of a given font @p fontId.
232    *
233    * @param[in] fontId The font identifier.
234    *
235    * @return The point size in 26.6 fractional points.
236    */
237   PointSize26Dot6 GetPointSize(FontId fontId);
238
239   /**
240    * @brief Whether the given @p character is supported by the font.
241    *
242    * @param[in] fontId The id of the font.
243    * @param[in] character The character.
244    *
245    * @return @e true if the character is supported by the font.
246    */
247   bool IsCharacterSupportedByFont(FontId fontId, Character character);
248
249   /**
250    * @brief Find the default font for displaying a UTF-32 character.
251    *
252    * This is useful when localised strings are provided for multiple languages
253    * i.e. when a single default font does not work for all languages.
254    *
255    * @param[in] charcode The character for which a font is needed.
256    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
257    * @param[in] preferColor @e true if a color font is preferred.
258    *
259    * @return A valid font identifier, or zero if the font does not exist.
260    */
261   FontId FindDefaultFont(Character       charcode,
262                          PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
263                          bool            preferColor        = false);
264
265   /**
266    * @brief Find a fallback-font for displaying a UTF-32 character.
267    *
268    * This is useful when localised strings are provided for multiple languages
269    * i.e. when a single default font does not work for all languages.
270    *
271    * @param[in] charcode The character for which a font is needed.
272    * @param[in] preferredFontDescription Description of the preferred font which may not provide a glyph for @p charcode.
273    *                                     The fallback-font will be the closest match to @p preferredFontDescription, which does support the required glyph.
274    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
275    * @param[in] preferColor @e true if a color font is preferred.
276    *
277    * @return A valid font identifier, or zero if the font does not exist.
278    */
279   FontId FindFallbackFont(Character              charcode,
280                           const FontDescription& preferredFontDescription,
281                           PointSize26Dot6        requestedPointSize = DEFAULT_POINT_SIZE,
282                           bool                   preferColor        = false);
283
284   /**
285    * @brief Retrieve the unique identifier for a font.
286    *
287    * @param[in] path The path to a font file.
288    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
289    * @param[in] faceIndex The index of the font face (optional).
290    *
291    * @return A valid font identifier, or zero if the font does not exist.
292    */
293   FontId GetFontId(const FontPath& path,
294                    PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
295                    FaceIndex       faceIndex          = 0);
296
297   /**
298    * @brief Retrieves a unique font identifier for a given description.
299    *
300    * @param[in] preferredFontDescription Description of the preferred font.
301    *                                     The font will be the closest match to @p preferredFontDescription.
302    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
303    * @param[in] faceIndex The index of the font face (optional).
304    *
305    * @return A valid font identifier, or zero if no font is found.
306    */
307   FontId GetFontId(const FontDescription& preferredFontDescription,
308                    PointSize26Dot6        requestedPointSize = DEFAULT_POINT_SIZE,
309                    FaceIndex              faceIndex          = 0);
310
311   /**
312    * @brief Retrieves a unique font identifier for a given bitmap font.
313    * If the font is not present, it will cache the given font, and give it a new font id.
314    *
315    * @param[in] bitmapFont A bitmap font.
316    *
317    * @return A valid font identifier.
318    */
319   FontId GetFontId(const BitmapFont& bitmapFont);
320
321   /**
322    * @brief Check to see if a font is scalable.
323    *
324    * @param[in] path The path to a font file.
325    * @return true if scalable.
326    */
327   bool IsScalable(const FontPath& path);
328
329   /**
330    * @brief Check to see if a font is scalable.
331    *
332    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
333    *
334    * @param[in] fontDescription A font description.
335    *
336    * @return true if scalable
337    */
338   bool IsScalable(const FontDescription& fontDescription);
339
340   /**
341    * @brief Get a list of sizes available for a fixed size font.
342    *
343    * @param[in] path The path to a font file.
344    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
345    */
346   void GetFixedSizes(const FontPath& path, Dali::Vector<PointSize26Dot6>& sizes);
347
348   /**
349    * @brief Get a list of sizes available for a fixed size font.
350    *
351    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
352    *
353    * @param[in] fontDescription A font description.
354    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
355    */
356   void GetFixedSizes(const FontDescription&         fontDescription,
357                      Dali::Vector<PointSize26Dot6>& sizes);
358
359   /**
360    * @brief Whether the font has Italic style.
361    *
362    * @param[in] fontId The font identifier.
363    *
364    * @return true if the font has italic style.
365    */
366   bool HasItalicStyle(FontId fontId) const;
367
368   ////////////////////////////////////////
369   // Font metrics, glyphs and bitmaps.
370   ////////////////////////////////////////
371
372   /**
373    * @brief Query the metrics for a font.
374    *
375    * @param[in] fontId The identifier of the font for the required glyph.
376    * @param[out] metrics The font metrics.
377    */
378   void GetFontMetrics(FontId fontId, FontMetrics& metrics);
379
380   /**
381    * @brief Retrieve the glyph index for a UTF-32 character code.
382    *
383    * @param[in] fontId The identifier of the font for the required glyph.
384    * @param[in] charcode The UTF-32 character code.
385    *
386    * @return The glyph index, or zero if the character code is undefined.
387    */
388   GlyphIndex GetGlyphIndex(FontId fontId, Character charcode);
389
390   /**
391    * @brief Return the glyph index of a given character code as modified by the variation selector.
392    *
393    * @param[in] fontId The identifier of the font for the required glyph.
394    * @param[in] charcode The UTF-32 character code.
395    * @param[in] variantSelector The UTF-32 character code point of the variation selector.
396    *
397    * @return The glyph index, or zero if the character code is undefined.
398    */
399   GlyphIndex GetGlyphIndex(FontId fontId, Character charcode, Character variantSelector);
400
401   /**
402    * @brief Retrieve the metrics for a series of glyphs.
403    *
404    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
405    *                      It may contain the advance and an offset set into the bearing from the shaping tool.
406    *                      On return, the glyph's size value will be initialized. The bearing value will be updated by adding the font's glyph bearing to the one set by the shaping tool.
407    * @param[in] size The size of the array.
408    * @param[in] type The type of glyphs used for rendering; either bitmaps or vectors.
409    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
410    *
411    * @return @e true if all of the requested metrics were found.
412    */
413   bool GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true);
414
415   /**
416    * @brief Create a bitmap representation of a glyph.
417    *
418    * @note The caller is responsible for deallocating the bitmap data @p data.buffer using delete[].
419    *
420    * @param[in]  fontId           The identifier of the font.
421    * @param[in]  glyphIndex       The index of a glyph within the specified font.
422    * @param[in]  isItalicRequired Whether the glyph requires italic style.
423    * @param[in]  isBoldRequired   Whether the glyph requires bold style.
424    * @param[out] data             The bitmap data.
425    * @param[in]  outlineWidth     The width of the glyph outline in pixels.
426    */
427   void CreateBitmap(FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, GlyphBufferData& data, int outlineWidth);
428
429   /**
430    * @brief Create a bitmap representation of a glyph.
431    *
432    * @param[in] fontId The identifier of the font.
433    * @param[in] glyphIndex The index of a glyph within the specified font.
434    * @param[in] outlineWidth The width of the glyph outline in pixels.
435    *
436    * @return A valid PixelData, or an empty handle if the glyph could not be rendered.
437    */
438   PixelData CreateBitmap(FontId fontId, GlyphIndex glyphIndex, int outlineWidth);
439
440   /**
441    * @brief Create a vector representation of a glyph.
442    *
443    * @note This feature requires highp shader support and is not available on all platforms
444    * @param[in] fontId The identifier of the font.
445    * @param[in] glyphIndex The index of a glyph within the specified font.
446    * @param[out] blob A blob of data; this is owned by FontClient and should be copied by the caller of CreateVectorData().
447    * @param[out] blobLength The length of the blob data, or zero if the blob creation failed.
448    * @param[out] nominalWidth The width of the blob.
449    * @param[out] nominalHeight The height of the blob.
450    */
451   void CreateVectorBlob(FontId        fontId,
452                         GlyphIndex    glyphIndex,
453                         VectorBlob*&  blob,
454                         unsigned int& blobLength,
455                         unsigned int& nominalWidth,
456                         unsigned int& nominalHeight);
457
458   /**
459    * @brief Retrieves the ellipsis glyph for a requested point size.
460    *
461    * @param[in] requestedPointSize The requested point size.
462    *
463    * @return The ellipsis glyph.
464    */
465   const GlyphInfo& GetEllipsisGlyph(PointSize26Dot6 requestedPointSize);
466
467   /**
468    * @brief Whether the given glyph @p glyphIndex is a color glyph.
469    *
470    * @param[in] fontId The font id.
471    * @param[in] glyphIndex The glyph index.
472    *
473    * @return @e true if the glyph is a color one.
474    */
475   bool IsColorGlyph(FontId fontId, GlyphIndex glyphIndex);
476
477   /**
478    * @brief  Add custom fonts directory
479    *
480    * @param[in] path to the fonts directory
481    *
482    * @return true if the fonts can be added.
483    */
484   bool AddCustomFontDirectory(const FontPath& path);
485
486   /**
487    * @brief Creates and stores an embedded item and it's metrics.
488    *
489    * If in the @p description there is a non empty url, it calls Dali::LoadImageFromFile() internally.
490    * If in the @p description there is a url and @e width or @e height are zero it stores the default size. Otherwise the image is resized.
491    * If the url in the @p description is empty it stores the size.
492    *
493    * @param[in] description The description of the embedded item.
494    * @param[out] pixelFormat The pixel format of the image.
495    *
496    * return The index within the vector of embedded items.
497    */
498   GlyphIndex CreateEmbeddedItem(const EmbeddedItemDescription& description, Pixel::Format& pixelFormat);
499
500   /**
501    * @brief true to enable Atlas-Limitation.
502    *
503    * @note Used default configuration.
504    * @param[in] enabled The on/off value to enable/disable Atlas-Limitation.
505    */
506   void EnableAtlasLimitation(bool enabled);
507
508   /**
509    * @brief Check Atlas-Limitation is enabled or disabled.
510    *
511    * @note Used default configuration.
512    * return true if Atlas-Limitation is enabled, otherwise false.
513    */
514   bool IsAtlasLimitationEnabled() const;
515
516   /**
517    * @brief retrieve the maximum allowed width and height for text-atlas-block.
518    *
519    * @note Used default configuration.
520    * return the maximum width and height of text-atlas-block.
521    */
522   Size GetMaximumTextAtlasSize() const;
523
524   /**
525    * @brief retrieve the default width and height for text-atlas-block.
526    *
527    * @note Used default configuration.
528    * return the default width and height of text-atlas-block.
529    */
530   Size GetDefaultTextAtlasSize() const;
531
532   /**
533    * @brief retrieve the current maximum width and height for text-atlas-block.
534    *
535    * @note Used default configuration.
536    * return the current maximum width and height of text-atlas-block.
537    */
538   Size GetCurrentMaximumBlockSizeFitInAtlas() const;
539
540   /**
541    * @brief set the achieved size (width and height) for text-atlas-block.
542    * If @p currentMaximumBlockSizeFitInAtlas larger than the current maximum text atlas then store, otherwise ignore.
543    *
544    * @note Used default configuration.
545    * return true if the current maximum text atlas size is changed, otherwise false.
546    */
547   bool SetCurrentMaximumBlockSizeFitInAtlas(const Size& currentMaximumBlockSizeFitInAtlas);
548
549   /**
550    * @brief retrieve the number of points to scale-up one unit of point-size.
551    *
552    * @note Used default configuration.
553    * return the number of points per one unit of point-size
554    */
555   uint32_t GetNumberOfPointsPerOneUnitOfPointSize() const;
556
557 public: // Not intended for application developers
558   /**
559    * @brief This constructor is used by FontClient::Get().
560    *
561    * @param[in] fontClient  A pointer to the internal fontClient object.
562    */
563   explicit DALI_INTERNAL FontClient(Internal::FontClient* fontClient);
564 };
565
566 /**
567  * @brief This is used to improve application launch performance
568  *
569  * @return A pre-initialized FontClient
570  */
571 DALI_ADAPTOR_API FontClient FontClientPreInitialize();
572
573 /**
574  * @brief This is used to pre-cache FontConfig in order to improve the runtime performance of the application.
575  *
576  * @param[in] fallbackFamilyList A list of fallback font families to be pre-cached.
577  * @param[in] extraFamilyList A list of additional font families to be pre-cached.
578  * @param[in] localeFamily A locale font family to be pre-cached.
579  * @param[in] useThread True if the font client should create thread and perform pre-caching, false otherwise.
580  */
581 DALI_ADAPTOR_API void FontClientPreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily, bool useThread);
582
583 /**
584  * @brief This is used to pre-load FreeType font face in order to improve the runtime performance of the application.
585  *
586  * @param[in] fontPathList A list of font paths to be pre-loaded.
587  * @param[in] memoryFontPathList A list of memory font paths to be pre-loaded.
588  * @param[in] useThread True if the font client should create thread and perform font pre-loading, false otherwise.
589  *
590  * @note
591  * The fonts in the fontPathList perform FT_New_Face during pre-loading,
592  * which can provide some performace benefits.
593  *
594  * The fonts in the memoryFontPathList read the font file and cache the buffer in memory during pre-load.
595  * This enables the use of FT_New_Memory_Face during runtime and provides a performance boost.
596  * It requires memory equivalent to the size of each font file.
597  */
598 DALI_ADAPTOR_API void FontClientFontPreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool useThread);
599
600 } // namespace TextAbstraction
601
602 } // namespace Dali
603
604 #endif // DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H