2 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/devel-api/text-abstraction/font-client.h>
22 #include <dali/devel-api/adaptor-framework/environment-variable.h>
23 #include <dali/internal/text/text-abstraction/font-client-impl.h>
27 namespace TextAbstraction
29 // FontClient static const value definition.
31 const PointSize26Dot6 FontClient::DEFAULT_POINT_SIZE = 768u; // 12*64
32 const float FontClient::DEFAULT_ITALIC_ANGLE = 12.f * Dali::Math::PI_OVER_180; // FreeType documentation states the software italic is done by doing a horizontal shear of 12 degrees (file ftsynth.h).
35 const bool FontClient::DEFAULT_ATLAS_LIMITATION_ENABLED = true;
36 const uint32_t FontClient::DEFAULT_TEXT_ATLAS_WIDTH = 512u;
37 const uint32_t FontClient::DEFAULT_TEXT_ATLAS_HEIGHT = 512u;
38 const Size FontClient::DEFAULT_TEXT_ATLAS_SIZE(DEFAULT_TEXT_ATLAS_WIDTH, DEFAULT_TEXT_ATLAS_HEIGHT);
41 const uint32_t FontClient::MAX_TEXT_ATLAS_WIDTH = 1024u;
42 const uint32_t FontClient::MAX_TEXT_ATLAS_HEIGHT = 1024u;
43 const Size FontClient::MAX_TEXT_ATLAS_SIZE(MAX_TEXT_ATLAS_WIDTH, MAX_TEXT_ATLAS_HEIGHT);
45 //MAX_WIDTH_FIT_IN_ATLAS: blockWidth + 2 * DOUBLE_PIXEL_PADDING + 1u <= atlasWidth
46 //MAX_HEIGHT_FIT_IN_ATLAS: blockHeight + 2 * DOUBLE_PIXEL_PADDING + 1u <= atlasHeight
47 const uint16_t FontClient::PADDING_TEXT_ATLAS_BLOCK = 5u; // 2 * DOUBLE_PIXEL_PADDING + 1u
49 //Maximum block size to fit into atlas block
50 const Size FontClient::MAX_SIZE_FIT_IN_ATLAS(MAX_TEXT_ATLAS_WIDTH - PADDING_TEXT_ATLAS_BLOCK, MAX_TEXT_ATLAS_HEIGHT - PADDING_TEXT_ATLAS_BLOCK);
52 const uint32_t FontClient::NUMBER_OF_POINTS_PER_ONE_UNIT_OF_POINT_SIZE = 64u; //Found this value from toolkit
55 static bool TEXT_PERFORMANCE_LOG_SET = false;
56 static uint32_t TEXT_PERFORMANCE_LOG_THRESHOLD_TIME = 0u;
57 constexpr auto TEXT_PERFORMANCE_LOG_THRESHOLD_TIME_ENV = "DALI_TEXT_PERFORMANCE_LOG_THRESHOLD_TIME";
59 uint32_t FontClient::GetPerformanceLogThresholdTime()
61 uint32_t time = TEXT_PERFORMANCE_LOG_THRESHOLD_TIME;
62 if(!TEXT_PERFORMANCE_LOG_SET)
64 // Threshold time in miliseconds.
65 auto timeString = Dali::EnvironmentVariable::GetEnvironmentVariable(TEXT_PERFORMANCE_LOG_THRESHOLD_TIME_ENV);
66 time = timeString ? static_cast<uint32_t>(std::atoi(timeString)) : 0u;
67 TEXT_PERFORMANCE_LOG_THRESHOLD_TIME = time;
68 TEXT_PERFORMANCE_LOG_SET = true;
73 bool FontClient::IsPerformanceLogEnabled()
75 return GetPerformanceLogThresholdTime() > 0 ? true : false;
80 FontClient FontClient::Get()
82 return Internal::FontClient::Get();
85 FontClient FontClient::New(uint32_t horizontalDpi, uint32_t verticalDpi)
87 auto fontClientImpl = new Internal::FontClient();
89 fontClientImpl->SetDpi(horizontalDpi, verticalDpi);
91 return FontClient(fontClientImpl);
94 FontClient::FontClient()
98 FontClient::~FontClient()
102 FontClient::FontClient(const FontClient& handle) = default;
104 FontClient& FontClient::operator=(const FontClient& handle) = default;
106 FontClient::FontClient(FontClient&& handle) = default;
108 FontClient& FontClient::operator=(FontClient&& handle) = default;
110 void FontClient::ClearCache()
112 GetImplementation(*this).ClearCache();
115 void FontClient::SetDpi(unsigned int horizontalDpi, unsigned int verticalDpi)
117 GetImplementation(*this).SetDpi(horizontalDpi, verticalDpi);
120 void FontClient::GetDpi(unsigned int& horizontalDpi, unsigned int& verticalDpi)
122 GetImplementation(*this).GetDpi(horizontalDpi, verticalDpi);
125 int FontClient::GetDefaultFontSize()
127 return GetImplementation(*this).GetDefaultFontSize();
130 void FontClient::ResetSystemDefaults()
132 GetImplementation(*this).ResetSystemDefaults();
135 void FontClient::GetDefaultFonts(FontList& defaultFonts)
137 GetImplementation(*this).GetDefaultFonts(defaultFonts);
140 void FontClient::InitDefaultFontDescription()
142 GetImplementation(*this).InitDefaultFontDescription();
145 void FontClient::GetDefaultPlatformFontDescription(FontDescription& fontDescription)
147 GetImplementation(*this).GetDefaultPlatformFontDescription(fontDescription);
150 void FontClient::GetSystemFonts(FontList& systemFonts)
152 GetImplementation(*this).GetSystemFonts(systemFonts);
155 void FontClient::GetDescription(FontId fontId, FontDescription& fontDescription)
157 GetImplementation(*this).GetDescription(fontId, fontDescription);
160 PointSize26Dot6 FontClient::GetPointSize(FontId fontId)
162 return GetImplementation(*this).GetPointSize(fontId);
165 bool FontClient::IsCharacterSupportedByFont(FontId fontId, Character character)
167 return GetImplementation(*this).IsCharacterSupportedByFont(fontId, character);
170 FontId FontClient::FindDefaultFont(Character charcode,
171 PointSize26Dot6 requestedPointSize,
174 return GetImplementation(*this).FindDefaultFont(charcode,
179 FontId FontClient::FindFallbackFont(Character charcode,
180 const FontDescription& preferredFontDescription,
181 PointSize26Dot6 requestedPointSize,
184 return GetImplementation(*this).FindFallbackFont(charcode, preferredFontDescription, requestedPointSize, preferColor);
187 FontId FontClient::GetFontId(const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex)
189 return GetImplementation(*this).GetFontId(path, requestedPointSize, faceIndex);
192 FontId FontClient::GetFontId(const FontDescription& fontDescription,
193 PointSize26Dot6 requestedPointSize,
196 return GetImplementation(*this).GetFontId(fontDescription,
201 FontId FontClient::GetFontId(const BitmapFont& bitmapFont)
203 return GetImplementation(*this).GetFontId(bitmapFont);
206 bool FontClient::IsScalable(const FontPath& path)
208 return GetImplementation(*this).IsScalable(path);
211 bool FontClient::IsScalable(const FontDescription& fontDescription)
213 return GetImplementation(*this).IsScalable(fontDescription);
216 void FontClient::GetFixedSizes(const FontPath& path, Dali::Vector<PointSize26Dot6>& sizes)
218 GetImplementation(*this).GetFixedSizes(path, sizes);
221 void FontClient::GetFixedSizes(const FontDescription& fontDescription,
222 Dali::Vector<PointSize26Dot6>& sizes)
224 GetImplementation(*this).GetFixedSizes(fontDescription, sizes);
227 bool FontClient::HasItalicStyle(FontId fontId) const
229 return GetImplementation(*this).HasItalicStyle(fontId);
232 void FontClient::GetFontMetrics(FontId fontId, FontMetrics& metrics)
234 GetImplementation(*this).GetFontMetrics(fontId, metrics);
237 GlyphIndex FontClient::GetGlyphIndex(FontId fontId, Character charcode)
239 return GetImplementation(*this).GetGlyphIndex(fontId, charcode);
242 GlyphIndex FontClient::GetGlyphIndex(FontId fontId, Character charcode, Character variantSelector)
244 return GetImplementation(*this).GetGlyphIndex(fontId, charcode, variantSelector);
247 bool FontClient::GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal)
249 return GetImplementation(*this).GetGlyphMetrics(array, size, type, horizontal);
252 void FontClient::CreateBitmap(FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, GlyphBufferData& data, int outlineWidth)
254 GetImplementation(*this).CreateBitmap(fontId, glyphIndex, isItalicRequired, isBoldRequired, data, outlineWidth);
257 PixelData FontClient::CreateBitmap(FontId fontId, GlyphIndex glyphIndex, int outlineWidth)
259 return GetImplementation(*this).CreateBitmap(fontId, glyphIndex, outlineWidth);
262 void FontClient::CreateVectorBlob(FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight)
264 GetImplementation(*this).CreateVectorBlob(fontId, glyphIndex, blob, blobLength, nominalWidth, nominalHeight);
267 const GlyphInfo& FontClient::GetEllipsisGlyph(PointSize26Dot6 requestedPointSize)
269 return GetImplementation(*this).GetEllipsisGlyph(requestedPointSize);
272 bool FontClient::IsColorGlyph(FontId fontId, GlyphIndex glyphIndex)
274 return GetImplementation(*this).IsColorGlyph(fontId, glyphIndex);
277 bool FontClient::AddCustomFontDirectory(const FontPath& path)
279 return GetImplementation(*this).AddCustomFontDirectory(path);
282 GlyphIndex FontClient::CreateEmbeddedItem(const EmbeddedItemDescription& description, Pixel::Format& pixelFormat)
284 return GetImplementation(*this).CreateEmbeddedItem(description, pixelFormat);
287 void FontClient::EnableAtlasLimitation(bool enabled)
289 return GetImplementation(*this).EnableAtlasLimitation(enabled);
292 bool FontClient::IsAtlasLimitationEnabled() const
294 return GetImplementation(*this).IsAtlasLimitationEnabled();
297 Size FontClient::GetMaximumTextAtlasSize() const
299 return GetImplementation(*this).GetMaximumTextAtlasSize();
302 Size FontClient::GetDefaultTextAtlasSize() const
304 return GetImplementation(*this).GetDefaultTextAtlasSize();
307 Size FontClient::GetCurrentMaximumBlockSizeFitInAtlas() const
309 return GetImplementation(*this).GetCurrentMaximumBlockSizeFitInAtlas();
312 bool FontClient::SetCurrentMaximumBlockSizeFitInAtlas(const Size& currentMaximumBlockSizeFitInAtlas)
314 return GetImplementation(*this).SetCurrentMaximumBlockSizeFitInAtlas(currentMaximumBlockSizeFitInAtlas);
317 uint32_t FontClient::GetNumberOfPointsPerOneUnitOfPointSize() const
319 return GetImplementation(*this).GetNumberOfPointsPerOneUnitOfPointSize();
322 FontClient::FontClient(Internal::FontClient* internal)
323 : BaseHandle(internal)
327 FontClient FontClientPreInitialize()
329 return Internal::FontClient::PreInitialize();
332 void FontClientPreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily, bool useThread, bool syncCreation)
334 Internal::FontClient::PreCache(fallbackFamilyList, extraFamilyList, localeFamily, useThread, syncCreation);
337 void FontClientFontPreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool useThread, bool syncCreation)
339 Internal::FontClient::PreLoad(fontPathList, memoryFontPathList, useThread, syncCreation);
342 void FontClientJoinFontThreads()
344 Internal::FontClient::JoinFontThreads();
347 } // namespace TextAbstraction