2 * Copyright (c) 2021 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-toolkit/devel-api/text/text-utils-devel.h>
22 #include <dali/devel-api/scripting/enum-helper.h>
23 #include <dali/devel-api/text-abstraction/font-client.h>
24 #include <dali/devel-api/text-abstraction/text-renderer-layout-helper.h>
25 #include <dali/devel-api/text-abstraction/text-renderer.h>
26 #include <dali/integration-api/debug.h>
31 #include <dali-toolkit/internal/text/bidirectional-support.h>
32 #include <dali-toolkit/internal/text/character-set-conversion.h>
33 #include <dali-toolkit/internal/text/color-segmentation.h>
34 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
35 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
36 #include <dali-toolkit/internal/text/markup-processor.h>
37 #include <dali-toolkit/internal/text/multi-language-support.h>
38 #include <dali-toolkit/internal/text/segmentation.h>
39 #include <dali-toolkit/internal/text/shaper.h>
40 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
41 #include <dali-toolkit/internal/text/text-font-style.h>
42 #include <dali-toolkit/internal/text/text-model.h>
46 using namespace TextAbstraction;
57 * @brief The text's layout.
61 SINGLELINE, ///< The text is laid out on a single line.
62 MULTILINE, ///< The text is laid out in multiple lines.
63 CIRCULAR, ///< The text is laid out on a single line following a circular path.
68 namespace CircularAlignment
71 * @brief The enumerations for the circular alignment.
75 BEGIN, ///< The text is aligned to the @p begin angle of the arc (or to the @p begin+increment if it's a RTL text).
76 CENTER, ///< The text is centered within the arc.
77 END, ///< The text is aligned to the @p begin+increment angle of the arc (or to the @p begin if it's a RTL text).
80 } // namespace CircularAlignment
82 const float TO_POINT_26_DOT_6 = 64.f;
83 const float TO_FLOAT = 1.f / 255.f;
84 const float TO_UCHAR = 255.f;
85 const bool RTL = true;
86 const float TWO_PI = 2.f * Dali::Math::PI; ///< 360 degrees in radians
87 const float RAD_135 = Math::PI_2 + Math::PI_4; ///< 135 degrees in radians;
88 const float RAD_225 = RAD_135 + Math::PI_2; ///< 225 degrees in radians;
89 const float RAD_270 = 3.f * Math::PI_2; ///< 270 degrees in radians;
90 const float RAD_315 = RAD_225 + Math::PI_2; ///< 315 degrees in radians;
91 const float MAX_INT = std::numeric_limits<int>::max();
93 DALI_ENUM_TO_STRING_TABLE_BEGIN(LAYOUT_TYPE)
94 DALI_ENUM_TO_STRING_WITH_SCOPE(DevelText::Layout, SINGLELINE)
95 DALI_ENUM_TO_STRING_WITH_SCOPE(DevelText::Layout, MULTILINE)
96 DALI_ENUM_TO_STRING_WITH_SCOPE(DevelText::Layout, CIRCULAR)
97 DALI_ENUM_TO_STRING_TABLE_END(LAYOUT_TYPE)
99 DALI_ENUM_TO_STRING_TABLE_BEGIN(CIRCULAR_ALIGNMENT_TYPE)
100 DALI_ENUM_TO_STRING_WITH_SCOPE(DevelText::CircularAlignment, BEGIN)
101 DALI_ENUM_TO_STRING_WITH_SCOPE(DevelText::CircularAlignment, CENTER)
102 DALI_ENUM_TO_STRING_WITH_SCOPE(DevelText::CircularAlignment, END)
103 DALI_ENUM_TO_STRING_TABLE_END(CIRCULAR_ALIGNMENT_TYPE)
105 struct InternalDataModel
107 InternalDataModel(FontClient& fontClient,
109 Text::ModelPtr textModel)
110 : fontClient(fontClient),
112 textModel(textModel),
113 numberOfCharacters{0u},
114 isTextMirrored{false},
117 layoutEngine.SetMetrics(metrics);
120 FontClient& fontClient;
122 Text::Layout::Engine layoutEngine; ///< The layout engine.
123 Text::ModelPtr textModel; ///< Pointer to the text's model.
124 Vector<ColorBlendingMode> blendingMode; ///< How embedded items and bitmap font glyphs are blended with color text.
125 Vector<bool> isEmoji; ///< Whether the glyph is an emoji.
127 Vector<Character> mirroredUtf32Characters; // The utf32Characters Characters but mirrored if there are RTL text.
129 Length numberOfCharacters; // The number of characters (not glyphs!).
130 bool isTextMirrored; // Whether the text has been mirrored.
132 Length numberOfGlyphs;
136 bool GetLayoutEnumeration(const Property::Value& propertyValue, DevelText::Layout::Type& layout)
138 return Scripting::GetEnumerationProperty(propertyValue, LAYOUT_TYPE_TABLE, LAYOUT_TYPE_TABLE_COUNT, layout);
141 bool GetCircularAlignmentEnumeration(const Property::Value& propertyValue, DevelText::CircularAlignment::Type& circularAlignment)
143 return Scripting::GetEnumerationProperty(propertyValue, CIRCULAR_ALIGNMENT_TYPE_TABLE, CIRCULAR_ALIGNMENT_TYPE_TABLE_COUNT, circularAlignment);
146 void ShapeTextPreprocess(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, InternalDataModel& internalDataModel)
148 MultilanguageSupport multilanguageSupport = MultilanguageSupport::Get();
149 const uint8_t* utf8 = NULL; // pointer to the first character of the text (encoded in utf8)
150 Length textSize = 0u; // The length of the utf8 string.
152 Length& numberOfCharacters = internalDataModel.numberOfCharacters;
153 Vector<Character>& mirroredUtf32Characters = internalDataModel.mirroredUtf32Characters;
154 Text::ModelPtr& textModel = internalDataModel.textModel;
156 Vector<Character>& utf32Characters = textModel->mLogicalModel->mText; // Characters encoded in utf32.
157 Vector<LineBreakInfo>& lineBreakInfo = textModel->mLogicalModel->mLineBreakInfo; // The line break info.
158 Vector<ScriptRun>& scripts = textModel->mLogicalModel->mScriptRuns; // Charactes's script.
159 Vector<FontDescriptionRun>& fontDescriptionRuns = textModel->mLogicalModel->mFontDescriptionRuns; // Desired font descriptions.
160 Vector<FontRun>& validFonts = textModel->mLogicalModel->mFontRuns; // Validated fonts.
161 Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = textModel->mLogicalModel->mBidirectionalParagraphInfo; // The bidirectional info per paragraph.
162 Vector<CharacterDirection>& directions = textModel->mLogicalModel->mCharacterDirections; // Character's directions.
163 Vector<ColorRun>& colorRuns = textModel->mLogicalModel->mColorRuns; // colors of the text.
165 // the default font's description.
166 FontDescription defaultFontDescription;
167 PointSize26Dot6 defaultPointSize = FontClient::DEFAULT_POINT_SIZE;
169 ////////////////////////////////////////////////////////////////////////////////
170 // Process the markup string if the mark-up processor is enabled.
171 ////////////////////////////////////////////////////////////////////////////////
173 MarkupProcessData markupProcessData(colorRuns,
175 textModel->mLogicalModel->mEmbeddedItems,
176 textModel->mLogicalModel->mAnchors,
177 textModel->mLogicalModel->mUnderlinedCharacterRuns,
178 textModel->mLogicalModel->mBackgroundColorRuns);
180 if(textParameters.markupEnabled)
182 ProcessMarkupString(textParameters.text, markupProcessData);
183 textSize = markupProcessData.markupProcessedText.size();
185 // This is a bit horrible but std::string returns a (signed) char*
186 utf8 = reinterpret_cast<const uint8_t*>(markupProcessData.markupProcessedText.c_str());
190 textSize = textParameters.text.size();
192 // This is a bit horrible but std::string returns a (signed) char*
193 utf8 = reinterpret_cast<const uint8_t*>(textParameters.text.c_str());
196 ////////////////////////////////////////////////////////////////////////////////
197 // Convert from utf8 to utf32
198 ////////////////////////////////////////////////////////////////////////////////
200 utf32Characters.Resize(textSize);
202 // Transform a text array encoded in utf8 into an array encoded in utf32.
203 // It returns the actual number of characters.
204 numberOfCharacters = Utf8ToUtf32(utf8, textSize, utf32Characters.Begin());
205 utf32Characters.Resize(numberOfCharacters);
207 ////////////////////////////////////////////////////////////////////////////////
208 // Retrieve the Line and Word Break Info.
209 ////////////////////////////////////////////////////////////////////////////////
211 lineBreakInfo.Resize(numberOfCharacters, LINE_NO_BREAK);
213 SetLineBreakInfo(utf32Characters,
218 ////////////////////////////////////////////////////////////////////////////////
219 // Retrieve the script runs.
220 ////////////////////////////////////////////////////////////////////////////////
222 multilanguageSupport.SetScripts(utf32Characters,
227 // Check if there are emojis.
228 // If there are an RGBA8888 pixel format is needed.
229 for(const auto& run : scripts)
231 if(run.script == TextAbstraction::Script::EMOJI)
233 rendererParameters.pixelFormat = TextAbstraction::TextRenderer::Parameters::RGBA8888;
238 ////////////////////////////////////////////////////////////////////////////////
239 // Retrieve the font runs.
240 ////////////////////////////////////////////////////////////////////////////////
242 // Set the description font run with the given text parameters.
243 FontDescriptionRun fontDescriptionRun;
244 fontDescriptionRun.characterRun.characterIndex = 0u;
245 fontDescriptionRun.characterRun.numberOfCharacters = numberOfCharacters;
247 fontDescriptionRun.familyLength = 0u;
248 fontDescriptionRun.familyName = nullptr;
249 fontDescriptionRun.familyDefined = !textParameters.fontFamily.empty();
250 if(fontDescriptionRun.familyDefined)
252 // The allocated memory will be freed when the logical model is destroyed.
253 fontDescriptionRun.familyLength = textParameters.fontFamily.size();
254 fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
255 memcpy(fontDescriptionRun.familyName, textParameters.fontFamily.c_str(), fontDescriptionRun.familyLength);
258 fontDescriptionRun.weightDefined = !textParameters.fontWeight.empty();
259 if(fontDescriptionRun.weightDefined)
261 fontDescriptionRun.weight = StringToWeight(textParameters.fontWeight.c_str());
264 fontDescriptionRun.widthDefined = !textParameters.fontWidth.empty();
265 if(fontDescriptionRun.widthDefined)
267 fontDescriptionRun.width = StringToWidth(textParameters.fontWidth.c_str());
270 fontDescriptionRun.slantDefined = !textParameters.fontSlant.empty();
271 if(fontDescriptionRun.slantDefined)
273 fontDescriptionRun.slant = StringToSlant(textParameters.fontSlant.c_str());
276 fontDescriptionRun.sizeDefined = !EqualsZero(textParameters.fontSize);
277 if(fontDescriptionRun.sizeDefined)
279 fontDescriptionRun.size = static_cast<unsigned int>(textParameters.fontSize * TO_POINT_26_DOT_6);
282 fontDescriptionRuns.PushBack(fontDescriptionRun);
284 // Validates the fonts. If there is a character with no assigned font it sets a default one.
285 // After this call, fonts are validated.
286 multilanguageSupport.ValidateFonts(utf32Characters,
289 defaultFontDescription,
295 ////////////////////////////////////////////////////////////////////////////////
296 // Retrieve the Bidirectional info.
297 ////////////////////////////////////////////////////////////////////////////////
299 bidirectionalInfo.Reserve(1u);
301 SetBidirectionalInfo(utf32Characters,
308 const bool hasBidirectionalText = 0u != bidirectionalInfo.Count();
309 if(hasBidirectionalText)
311 // Only set the character directions if there is right to left characters.
312 GetCharactersDirection(bidirectionalInfo,
318 // This paragraph has right to left text. Some characters may need to be mirrored.
319 // TODO: consider if the mirrored string can be stored as well.
321 internalDataModel.isTextMirrored = GetMirroredText(utf32Characters,
326 mirroredUtf32Characters);
330 void ShapeText(TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel)
332 Vector<GlyphIndex> newParagraphGlyphs; // Glyphs for the new paragraph characters.
333 const Length numberOfCharacters = internalDataModel.numberOfCharacters;
334 const bool isTextMirrored = internalDataModel.isTextMirrored;
335 Text::ModelPtr& textModel = internalDataModel.textModel;
336 const Vector<Character>& mirroredUtf32Characters = internalDataModel.mirroredUtf32Characters;
337 FontClient& fontClient = internalDataModel.fontClient;
338 const Vector<Character>& utf32Characters = textModel->mLogicalModel->mText; // Characters encoded in utf32.
339 const Vector<LineBreakInfo>& lineBreakInfo = textModel->mLogicalModel->mLineBreakInfo; // The line break info.
340 const Vector<ScriptRun>& scripts = textModel->mLogicalModel->mScriptRuns; // Charactes's script.
341 const Vector<FontRun>& validFonts = textModel->mLogicalModel->mFontRuns; // Validated fonts.
343 Vector<CharacterIndex>& glyphsToCharacters = textModel->mVisualModel->mGlyphsToCharacters; // Glyphs to character map.
344 Vector<Length>& charactersPerGlyph = textModel->mVisualModel->mCharactersPerGlyph; // Number of characters per glyph.
346 ////////////////////////////////////////////////////////////////////////////////
347 // Retrieve the glyphs. Text shaping
348 ////////////////////////////////////////////////////////////////////////////////
350 const Vector<Character>& textToShape = isTextMirrored ? mirroredUtf32Characters : utf32Characters;
352 newParagraphGlyphs.Reserve(1u);
355 ShapeText(textToShape,
362 rendererParameters.glyphs,
367 // Create the 'number of glyphs' per character and the glyph to character conversion tables.
368 textModel->mVisualModel->CreateGlyphsPerCharacterTable(0u, 0u, numberOfCharacters);
369 textModel->mVisualModel->CreateCharacterToGlyphTable(0u, 0u, numberOfCharacters);
371 internalDataModel.numberOfGlyphs = rendererParameters.glyphs.Count();
373 // Once the text has been shaped and the glyphs created it's possible to replace the font id of those glyphs
374 // that represent an image or an item and create the embedded item layout info.
375 // Note: the position of the embedded item can't be set until the text is laid-out.
376 embeddedItemLayout.Reserve(textModel->mLogicalModel->mEmbeddedItems.Count());
377 for(const auto& item : textModel->mLogicalModel->mEmbeddedItems)
379 // Get the glyph that matches with the character index.
380 const GlyphIndex glyphIndex = textModel->mVisualModel->mCharactersToGlyph[item.characterIndex];
381 GlyphInfo& glyph = rendererParameters.glyphs[glyphIndex];
384 Pixel::Format pixelFormat = Pixel::A8;
385 TextAbstraction::FontClient::EmbeddedItemDescription description = {std::string(item.url, item.urlLength), item.width, item.height, item.colorBlendingMode};
386 glyph.index = fontClient.CreateEmbeddedItem(description, pixelFormat); // Set here an index to an item.
388 if((Pixel::RGBA8888 == pixelFormat) || (Pixel::BGRA8888 == pixelFormat))
390 rendererParameters.pixelFormat = TextAbstraction::TextRenderer::Parameters::RGBA8888;
393 // If the url is empty the item is going to be added after the text is rendered. It's needed to store the layout here.
394 if(description.url.empty())
396 EmbeddedItemInfo embeddedInfo =
401 Size(static_cast<float>(item.width), static_cast<float>(item.height)),
402 Size(static_cast<float>(item.width), static_cast<float>(item.height)),
404 item.colorBlendingMode};
406 embeddedItemLayout.PushBack(embeddedInfo);
411 void SetColorSegmentation(const RendererParameters& textParameters, InternalDataModel& internalDataModel)
413 Text::ModelPtr& textModel = internalDataModel.textModel;
414 Vector<ColorBlendingMode>& blendingMode = internalDataModel.blendingMode;
416 Vector<ColorRun>& colorRuns = textModel->mLogicalModel->mColorRuns; // colors of the text.
418 Vector<GlyphIndex>& charactersToGlyph = textModel->mVisualModel->mCharactersToGlyph; // Characters to glyphs map.
419 Vector<Length>& glyphsPerCharacter = textModel->mVisualModel->mGlyphsPerCharacter; // The number of glyphs that are shaped.
421 ////////////////////////////////////////////////////////////////////////////////
422 // Set the color runs in glyphs.
423 ////////////////////////////////////////////////////////////////////////////////
425 SetColorSegmentationInfo(colorRuns,
430 internalDataModel.numberOfCharacters,
431 textModel->mVisualModel->mColors,
432 textModel->mVisualModel->mColorIndices);
434 // Insert the default color at the beginning of the vector.
435 textModel->mVisualModel->mColors.Insert(textModel->mVisualModel->mColors.Begin(), textParameters.textColor);
437 // Set how the embedded items are blended with text color.
438 blendingMode.Resize(internalDataModel.numberOfGlyphs, textParameters.isTextColorSet ? ColorBlendingMode::MULTIPLY : ColorBlendingMode::NONE);
440 if(!textParameters.isTextColorSet)
442 // Traverse the color runs.
443 for(const auto& run : colorRuns)
445 const GlyphIndex firstGlyph = textModel->mVisualModel->mCharactersToGlyph[run.characterRun.characterIndex];
446 const CharacterIndex lastCharacter = run.characterRun.characterIndex + run.characterRun.numberOfCharacters - 1u;
447 const GlyphIndex lastGlyphPlusOne = textModel->mVisualModel->mCharactersToGlyph[lastCharacter] + textModel->mVisualModel->mGlyphsPerCharacter[lastCharacter];
449 for(GlyphIndex index = firstGlyph; index < lastGlyphPlusOne; ++index)
451 blendingMode[index] = ColorBlendingMode::MULTIPLY;
456 // Traverse the embedded items and update the blending mode vector.
457 for(const auto& item : textModel->mLogicalModel->mEmbeddedItems)
459 const GlyphIndex glyphIndex = textModel->mVisualModel->mCharactersToGlyph[item.characterIndex];
460 blendingMode[glyphIndex] = item.colorBlendingMode;
464 void SetEmojiVector(InternalDataModel& internalDataModel)
466 Vector<bool>& isEmoji = internalDataModel.isEmoji;
467 Text::ModelPtr& textModel = internalDataModel.textModel;
468 const Length numberOfGlyphs = internalDataModel.numberOfGlyphs;
470 const Vector<ScriptRun>& scripts = textModel->mLogicalModel->mScriptRuns; // Charactes's script.
471 ////////////////////////////////////////////////////////////////////////////////
472 // Set the isEmoji Vector
473 ////////////////////////////////////////////////////////////////////////////////
475 isEmoji.Resize(numberOfGlyphs, false);
477 for(const auto& run : scripts)
479 if(run.script == TextAbstraction::Script::EMOJI)
481 const GlyphIndex firstGlyph = textModel->mVisualModel->mCharactersToGlyph[run.characterRun.characterIndex];
482 const CharacterIndex lastCharacter = run.characterRun.characterIndex + run.characterRun.numberOfCharacters - 1u;
483 const GlyphIndex lastGlyphPlusOne = textModel->mVisualModel->mCharactersToGlyph[lastCharacter] + textModel->mVisualModel->mGlyphsPerCharacter[lastCharacter];
485 for(GlyphIndex index = firstGlyph; index < lastGlyphPlusOne; ++index)
487 isEmoji[index] = true;
493 void Align(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel, const Size& newLayoutSize)
495 Text::Layout::Engine& layoutEngine = internalDataModel.layoutEngine;
496 Text::ModelPtr& textModel = internalDataModel.textModel;
497 const Length numberOfCharacters = internalDataModel.numberOfCharacters;
498 Size& textLayoutArea = internalDataModel.textLayoutArea;
500 Vector<LineRun>& lines = textModel->mVisualModel->mLines; // The laid out lines.
502 ////////////////////////////////////////////////////////////////////////////////
504 ////////////////////////////////////////////////////////////////////////////////
506 HorizontalAlignment::Type horizontalAlignment = Toolkit::HorizontalAlignment::CENTER;
507 HorizontalAlignment::Type horizontalCircularAlignment = Toolkit::HorizontalAlignment::CENTER;
508 VerticalAlignment::Type verticalAlignment = VerticalAlignment::CENTER;
509 CircularAlignment::Type circularAlignment = CircularAlignment::BEGIN;
511 Layout::Type layout = Layout::SINGLELINE;
513 // Sets the alignment
514 Property::Value horizontalAlignmentStr(textParameters.horizontalAlignment);
515 GetHorizontalAlignmentEnumeration(horizontalAlignmentStr, horizontalAlignment);
516 horizontalCircularAlignment = horizontalAlignment;
518 Property::Value verticalAlignmentStr(textParameters.verticalAlignment);
519 GetVerticalAlignmentEnumeration(verticalAlignmentStr, verticalAlignment);
521 Property::Value circularAlignmentStr(textParameters.circularAlignment);
522 GetCircularAlignmentEnumeration(circularAlignmentStr, circularAlignment);
524 Property::Value layoutStr(textParameters.layout);
525 GetLayoutEnumeration(layoutStr, layout);
527 // Whether the layout is circular.
528 const bool isCircularTextLayout = (Layout::CIRCULAR == layout);
529 const bool isClockwise = isCircularTextLayout && (0.f < textParameters.incrementAngle);
531 // Convert CircularAlignment to HorizontalAlignment.
532 if(isCircularTextLayout)
534 switch(circularAlignment)
536 case CircularAlignment::BEGIN:
538 horizontalCircularAlignment = Toolkit::HorizontalAlignment::BEGIN;
541 case CircularAlignment::CENTER:
543 horizontalCircularAlignment = Toolkit::HorizontalAlignment::CENTER;
546 case CircularAlignment::END:
548 horizontalCircularAlignment = Toolkit::HorizontalAlignment::END;
553 textModel->mHorizontalAlignment = isCircularTextLayout ? horizontalCircularAlignment : horizontalAlignment;
555 // Retrieve the line of text to know the direction and the width. @todo multi-line
556 const LineRun& line = lines[0u];
558 if(isCircularTextLayout)
560 // Set the circular alignment.
561 rendererParameters.circularLayout = isClockwise ? TextRenderer::Parameters::CLOCKWISE : TextRenderer::Parameters::COUNTER_CLOCKWISE;
563 // Update the text's height to be used by the ellipsis code.
564 textLayoutArea.height = newLayoutSize.height;
566 // Set the size of the text laid out on a straight horizontal line.
567 rendererParameters.circularWidth = static_cast<unsigned int>(newLayoutSize.width);
568 rendererParameters.circularHeight = static_cast<unsigned int>(newLayoutSize.height);
570 // Calculate the center of the circular text according the horizontal and vertical alingments and the radius.
571 switch(horizontalAlignment)
573 case HorizontalAlignment::BEGIN:
575 rendererParameters.centerX = static_cast<int>(textParameters.radius);
578 case HorizontalAlignment::CENTER:
580 rendererParameters.centerX = static_cast<int>(textParameters.textWidth / 2u);
583 case HorizontalAlignment::END:
585 rendererParameters.centerX = static_cast<int>(textParameters.textWidth) - static_cast<int>(textParameters.radius);
590 switch(verticalAlignment)
592 case VerticalAlignment::TOP:
594 rendererParameters.centerY = static_cast<int>(textParameters.radius);
597 case VerticalAlignment::CENTER:
599 rendererParameters.centerY = static_cast<int>(textParameters.textHeight / 2u);
602 case VerticalAlignment::BOTTOM:
604 rendererParameters.centerY = static_cast<int>(textParameters.textHeight) - static_cast<int>(textParameters.radius);
609 // Calculate the beginning angle according with the given horizontal alignment.
610 const bool isRTL = RTL == line.direction;
612 CircularAlignment::Type alignment = circularAlignment;
615 // Swap the alignment type if the line is right to left.
618 case CircularAlignment::BEGIN:
620 alignment = CircularAlignment::END;
623 case CircularAlignment::CENTER:
628 case CircularAlignment::END:
630 alignment = CircularAlignment::BEGIN;
636 float angleOffset = 0.f;
640 case CircularAlignment::BEGIN:
645 case CircularAlignment::CENTER:
647 const bool isNeg = textParameters.incrementAngle < 0.f;
648 const float textWidth = static_cast<float>(rendererParameters.circularWidth);
649 angleOffset = (isNeg ? -0.5f : 0.5f) * (textLayoutArea.width - textWidth) / static_cast<float>(rendererParameters.radius);
652 case CircularAlignment::END:
654 const bool isNeg = textParameters.incrementAngle < 0.f;
655 const float textWidth = static_cast<float>(rendererParameters.circularWidth);
656 angleOffset = (isNeg ? -1.f : 1.f) * (textLayoutArea.width - textWidth) / static_cast<float>(rendererParameters.radius);
661 // Update the beginning angle with the calculated offset.
662 rendererParameters.beginAngle = Radian(Degree(textParameters.beginAngle)) + angleOffset;
664 // Set the vertical position of the glyphs.
665 for(auto& position : rendererParameters.positions)
672 // Calculate the vertical offset according with the given alignment.
675 switch(verticalAlignment)
677 case VerticalAlignment::TOP:
679 penY = line.ascender;
682 case VerticalAlignment::CENTER:
684 penY = line.ascender + 0.5f * (textLayoutArea.height - (line.ascender - line.descender));
687 case VerticalAlignment::BOTTOM:
689 penY = textLayoutArea.height;
694 // Calculate the horizontal offset according with the given alignment.
695 float alignmentOffset = 0.f;
696 layoutEngine.Align(textLayoutArea,
702 Dali::LayoutDirection::LEFT_TO_RIGHT,
705 // Update the position of the glyphs with the calculated offsets.
706 for(auto& position : rendererParameters.positions)
708 position.x += line.alignmentOffset;
713 // Cairo adds the bearing to the position of the glyph
714 // that has already been added by the DALi's layout engine,
715 // so it's needed to be removed here.
716 for(unsigned int index = 0u; index < rendererParameters.glyphs.Count(); ++index)
718 const GlyphInfo& glyph = rendererParameters.glyphs[index];
719 Vector2& position = rendererParameters.positions[index];
721 position.x -= glyph.xBearing;
724 // Set the position of the embedded items (if there is any).
725 EmbeddedItemInfo* embeddedItemLayoutBuffer = embeddedItemLayout.Begin();
727 for(Length index = 0u, endIndex = embeddedItemLayout.Count(); index < endIndex; ++index)
729 EmbeddedItemInfo& embeddedItem = *(embeddedItemLayoutBuffer + index);
731 embeddedItem.position = rendererParameters.positions[embeddedItem.glyphIndex];
733 if(isCircularTextLayout)
735 // Calculate the new position of the embedded item in the circular path.
737 // Center of the bitmap.
738 const float halfWidth = 0.5f * embeddedItem.size.width;
739 const float halfHeight = 0.5f * embeddedItem.size.height;
740 double centerX = static_cast<double>(embeddedItem.position.x + halfWidth);
741 double centerY = static_cast<double>(embeddedItem.position.y - halfHeight);
743 Dali::TextAbstraction::CircularTextParameters circularTextParameters;
745 circularTextParameters.radius = static_cast<double>(rendererParameters.radius);
746 circularTextParameters.invRadius = 1.0 / circularTextParameters.radius;
747 circularTextParameters.beginAngle = static_cast<double>(-rendererParameters.beginAngle + Dali::Math::PI_2);
748 circularTextParameters.centerX = 0.5f * static_cast<double>(textParameters.textWidth);
749 circularTextParameters.centerY = 0.5f * static_cast<double>(textParameters.textHeight);
751 // Calculate the rotation angle.
752 float radians = rendererParameters.beginAngle;
755 radians += static_cast<float>(circularTextParameters.invRadius * centerX);
760 radians -= static_cast<float>(circularTextParameters.invRadius * centerX);
761 radians = -radians + Dali::Math::PI;
763 embeddedItem.angle = Degree(Radian(radians));
765 Dali::TextAbstraction::TransformToArc(circularTextParameters, centerX, centerY);
767 // Recalculate the size of the embedded item after the rotation to position it correctly.
768 float width = embeddedItem.size.width;
769 float height = embeddedItem.size.height;
771 // Transform the input angle into the range [0..2PI]
772 radians = fmod(radians, TWO_PI);
773 radians += (radians < 0.f) ? TWO_PI : 0.f;
775 // Does the same operations than rotate by shear.
776 if((radians > Math::PI_4) && (radians <= RAD_135))
778 std::swap(width, height);
779 radians -= Math::PI_2;
781 else if((radians > RAD_135) && (radians <= RAD_225))
785 else if((radians > RAD_225) && (radians <= RAD_315))
787 std::swap(width, height);
791 if(fabs(radians) > Dali::Math::MACHINE_EPSILON_10)
793 const float angleSinus = fabs(sin(radians));
794 const float angleCosinus = cos(radians);
796 // Calculate the rotated image dimensions.
797 embeddedItem.rotatedSize.height = width * angleSinus + height * angleCosinus;
798 embeddedItem.rotatedSize.width = height * angleSinus + width * angleCosinus + 1.f;
801 embeddedItem.position.x = floor(static_cast<float>(centerX) - 0.5f * embeddedItem.rotatedSize.width);
802 embeddedItem.position.y = floor(static_cast<float>(centerY) - 0.5f * embeddedItem.rotatedSize.height);
806 embeddedItem.position.y -= embeddedItem.size.height;
811 void Ellipsis(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel)
813 Text::ModelPtr& textModel = internalDataModel.textModel;
814 FontClient& fontClient = internalDataModel.fontClient;
816 Vector<LineRun>& lines = textModel->mVisualModel->mLines; // The laid out lines.
817 Vector<bool>& isEmoji = internalDataModel.isEmoji;
818 const Size textLayoutArea = internalDataModel.textLayoutArea;
819 ////////////////////////////////////////////////////////////////////////////////
820 // Ellipsis the text.
821 ////////////////////////////////////////////////////////////////////////////////
823 if(textParameters.ellipsisEnabled)
825 const LineRun& line = lines[0u]; // TODO: multi-line
829 Length finalNumberOfGlyphs = 0u;
831 if((GetLineHeight(line)) > textLayoutArea.height)
833 // The height of the line is bigger than the height of the text area.
834 // Show the ellipsis glyph even if it doesn't fit in the text area.
835 // If no text is rendered then issues are rised and it may be a while
836 // until is find out that the text area is too small.
838 // Get the first glyph which is going to be replaced and the ellipsis glyph.
839 GlyphInfo& glyphInfo = rendererParameters.glyphs[0u];
840 const GlyphInfo& ellipsisGlyph = fontClient.GetEllipsisGlyph(fontClient.GetPointSize(glyphInfo.fontId));
842 // Change the 'x' and 'y' position of the ellipsis glyph.
843 Vector2& position = rendererParameters.positions[0u];
844 position.x = ellipsisGlyph.xBearing;
845 position.y = textLayoutArea.height - ellipsisGlyph.yBearing;
847 // Replace the glyph by the ellipsis glyph.
848 glyphInfo = ellipsisGlyph;
850 // Set the final number of glyphs
851 finalNumberOfGlyphs = 1u;
855 // firstPenX, penY and firstPenSet are used to position the ellipsis glyph if needed.
856 float firstPenX = 0.f; // Used if rtl text is elided.
857 bool firstPenSet = false;
859 // Add the ellipsis glyph.
860 bool inserted = false;
861 float removedGlypsWidth = 0.f;
862 Length numberOfRemovedGlyphs = 0u;
863 if(line.glyphRun.numberOfGlyphs > 0u)
865 GlyphIndex index = line.glyphRun.numberOfGlyphs - 1u;
867 GlyphInfo* glyphs = rendererParameters.glyphs.Begin();
868 Vector2* glyphPositions = rendererParameters.positions.Begin();
872 // The ellipsis glyph has to fit in the place where the last glyph(s) is(are) removed.
875 const GlyphInfo& glyphToRemove = *(glyphs + index);
877 if(0u != glyphToRemove.fontId)
879 // i.e. The font id of the glyph shaped from the '\n' character is zero.
881 // Need to reshape the glyph as the font may be different in size.
882 const GlyphInfo& ellipsisGlyph = fontClient.GetEllipsisGlyph(fontClient.GetPointSize(glyphToRemove.fontId));
886 const Vector2& position = *(glyphPositions + index);
888 // Calculates the penY of the current line. It will be used to position the ellipsis glyph.
891 // Calculates the first penX which will be used if rtl text is elided.
892 firstPenX = position.x - glyphToRemove.xBearing;
893 if(firstPenX < -ellipsisGlyph.xBearing)
895 // Avoids to exceed the bounding box when rtl text is elided.
896 firstPenX = -ellipsisGlyph.xBearing;
899 removedGlypsWidth = -ellipsisGlyph.xBearing;
904 removedGlypsWidth += std::min(glyphToRemove.advance, (glyphToRemove.xBearing + glyphToRemove.width));
906 // Calculate the width of the ellipsis glyph and check if it fits.
907 const float ellipsisGlyphWidth = ellipsisGlyph.width + ellipsisGlyph.xBearing;
908 if(ellipsisGlyphWidth < removedGlypsWidth)
910 GlyphInfo& glyphInfo = *(glyphs + index);
911 Vector2& position = *(glyphPositions + index);
912 position.x -= (0.f > glyphInfo.xBearing) ? glyphInfo.xBearing : 0.f;
914 // Replace the glyph by the ellipsis glyph.
915 glyphInfo = ellipsisGlyph;
917 // Update the isEmoji vector
918 isEmoji[index] = false;
920 // Change the 'x' and 'y' position of the ellipsis glyph.
922 if(position.x > firstPenX)
924 position.x = firstPenX + removedGlypsWidth - ellipsisGlyphWidth;
927 position.x += ellipsisGlyph.xBearing;
942 // No space for the ellipsis.
945 ++numberOfRemovedGlyphs;
948 // Set the final number of glyphs
949 finalNumberOfGlyphs = line.glyphRun.numberOfGlyphs - numberOfRemovedGlyphs;
953 // Resize the number of glyphs/positions
954 rendererParameters.glyphs.Resize(finalNumberOfGlyphs);
955 rendererParameters.positions.Resize(finalNumberOfGlyphs);
957 // Remove from the embedded items those exceding the last laid out glyph.
958 embeddedItemLayout.Erase(std::remove_if(embeddedItemLayout.Begin(),
959 embeddedItemLayout.End(),
960 [finalNumberOfGlyphs](const EmbeddedItemInfo& item) {
961 return item.glyphIndex >= finalNumberOfGlyphs;
963 embeddedItemLayout.End());
969 Size LayoutText(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel)
971 ////////////////////////////////////////////////////////////////////////////////
973 ////////////////////////////////////////////////////////////////////////////////
974 Text::ModelPtr& textModel = internalDataModel.textModel;
975 Text::Layout::Engine& layoutEngine = internalDataModel.layoutEngine;
976 FontClient& fontClient = internalDataModel.fontClient;
977 const Length numberOfGlyphs = internalDataModel.numberOfGlyphs;
978 const bool isTextMirrored = internalDataModel.isTextMirrored;
979 const Vector<Character>& mirroredUtf32Characters = internalDataModel.mirroredUtf32Characters;
980 const Length numberOfCharacters = internalDataModel.numberOfCharacters;
981 const auto ellipsisPosition = textModel->mEllipsisPosition;
983 Layout::Type layout = Layout::SINGLELINE;
985 Property::Value layoutStr(textParameters.layout);
986 GetLayoutEnumeration(layoutStr, layout);
988 // Whether the layout is multi-line.
989 const Text::Layout::Engine::Type horizontalLayout = (Layout::MULTILINE == layout) ? Text::Layout::Engine::MULTI_LINE_BOX : Text::Layout::Engine::SINGLE_LINE_BOX;
990 layoutEngine.SetLayout(horizontalLayout); // TODO: multi-line.
992 // Set minimun line size
993 layoutEngine.SetDefaultLineSize(textParameters.minLineSize);
995 // Whether the layout is circular.
996 const bool isCircularTextLayout = (Layout::CIRCULAR == layout);
997 const bool isClockwise = isCircularTextLayout && (0.f < textParameters.incrementAngle);
999 // Calculates the max ascender or the max descender.
1000 // Is used to calculate the radius of the base line of the text.
1001 float maxAscenderDescender = 0.f;
1002 if(isCircularTextLayout)
1004 FontId currentFontId = 0u;
1005 for(const auto& glyph : rendererParameters.glyphs)
1007 if(currentFontId != glyph.fontId)
1009 currentFontId = glyph.fontId;
1010 FontMetrics metrics;
1011 fontClient.GetFontMetrics(currentFontId, metrics);
1012 maxAscenderDescender = std::max(maxAscenderDescender, isClockwise ? metrics.ascender : metrics.descender);
1016 const unsigned int radius = textParameters.radius - static_cast<unsigned int>(maxAscenderDescender);
1018 // Set the layout parameters.
1019 Size textLayoutArea = Size(static_cast<float>(textParameters.textWidth),
1020 static_cast<float>(textParameters.textHeight));
1023 Extents padding = textParameters.padding;
1024 internalDataModel.textLayoutArea = Size(textLayoutArea.x - (padding.start + padding.end), textLayoutArea.y - (padding.top + padding.bottom));
1026 if(isCircularTextLayout)
1028 // In a circular layout, the length of the text area depends on the radius.
1029 rendererParameters.radius = radius;
1030 internalDataModel.textLayoutArea.width = fabs(Radian(Degree(textParameters.incrementAngle)) * static_cast<float>(rendererParameters.radius));
1032 // Resize the vector of positions to have the same size than the vector of glyphs.
1033 rendererParameters.positions.Resize(numberOfGlyphs);
1035 textModel->mLineWrapMode = Text::LineWrap::WORD;
1036 textModel->mIgnoreSpacesAfterText = false;
1037 Text::Layout::Parameters layoutParameters(internalDataModel.textLayoutArea,
1040 // Whether the last character is a new paragraph character.
1041 const Vector<Character>& textToShape = isTextMirrored ? mirroredUtf32Characters : textModel->mLogicalModel->mText;
1042 layoutParameters.isLastNewParagraph = TextAbstraction::IsNewParagraph(textToShape[numberOfCharacters - 1u]);
1044 // The initial glyph and the number of glyphs to layout.
1045 layoutParameters.startGlyphIndex = 0u;
1046 layoutParameters.numberOfGlyphs = numberOfGlyphs;
1047 layoutParameters.startLineIndex = 0u;
1048 layoutParameters.estimatedNumberOfLines = 1u;
1049 layoutParameters.interGlyphExtraAdvance = 0.f;
1051 // Update the visual model.
1053 bool isAutoScrollEnabled = false;
1054 layoutEngine.LayoutText(layoutParameters,
1056 textParameters.ellipsisEnabled,
1057 isAutoScrollEnabled,
1060 return newLayoutSize;
1063 Devel::PixelBuffer RenderText(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters)
1065 ////////////////////////////////////////////////////////////////////////////////
1067 ////////////////////////////////////////////////////////////////////////////////
1069 rendererParameters.width = textParameters.textWidth;
1070 rendererParameters.height = textParameters.textHeight;
1072 TextAbstraction::TextRenderer renderer = TextAbstraction::TextRenderer::Get();
1073 return renderer.Render(rendererParameters);
1076 Devel::PixelBuffer Render(const RendererParameters& textParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout)
1078 if(textParameters.text.empty())
1080 Dali::Devel::PixelBuffer pixelBuffer = Dali::Devel::PixelBuffer::New(textParameters.textWidth,
1081 textParameters.textHeight,
1082 Dali::Pixel::RGBA8888);
1084 const unsigned int bufferSize = textParameters.textWidth * textParameters.textHeight * Dali::Pixel::GetBytesPerPixel(Dali::Pixel::RGBA8888);
1085 unsigned char* buffer = pixelBuffer.GetBuffer();
1086 memset(buffer, 0, bufferSize);
1091 FontClient fontClient = FontClient::Get();
1093 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
1094 metrics = Metrics::New(fontClient);
1096 Text::ModelPtr textModel = Text::Model::New();
1097 InternalDataModel internalData(fontClient, metrics, textModel);
1099 TextAbstraction::TextRenderer::Parameters rendererParameters(internalData.textModel->mVisualModel->mGlyphs,
1100 internalData.textModel->mVisualModel->mGlyphPositions,
1101 internalData.textModel->mVisualModel->mColors,
1102 internalData.textModel->mVisualModel->mColorIndices,
1103 internalData.blendingMode,
1104 internalData.isEmoji);
1106 rendererParameters.width = textParameters.textWidth;
1107 rendererParameters.height = textParameters.textHeight;
1108 rendererParameters.pixelFormat = TextAbstraction::TextRenderer::Parameters::RGBA8888; // @note: At the moment all textures are generated RGBA8888
1110 ////////////////////////////////////////////////////////////////////////////////
1111 // Process the markup string if the mark-up processor is enabled.
1112 ////////////////////////////////////////////////////////////////////////////////
1113 ShapeTextPreprocess(textParameters, rendererParameters, internalData);
1115 ////////////////////////////////////////////////////////////////////////////////
1116 // Retrieve the glyphs. Text shaping
1117 ////////////////////////////////////////////////////////////////////////////////
1118 ShapeText(rendererParameters, embeddedItemLayout, internalData);
1120 ////////////////////////////////////////////////////////////////////////////////
1121 // Retrieve the glyph's metrics.
1122 ////////////////////////////////////////////////////////////////////////////////
1124 metrics->GetGlyphMetrics(rendererParameters.glyphs.Begin(), internalData.numberOfGlyphs);
1126 ////////////////////////////////////////////////////////////////////////////////
1127 // Set the color runs in glyphs.
1128 ////////////////////////////////////////////////////////////////////////////////
1129 SetColorSegmentation(textParameters, internalData);
1131 ////////////////////////////////////////////////////////////////////////////////
1132 // Set the isEmoji Vector
1133 ////////////////////////////////////////////////////////////////////////////////
1134 SetEmojiVector(internalData);
1136 ////////////////////////////////////////////////////////////////////////////////
1138 ////////////////////////////////////////////////////////////////////////////////
1139 Size newLayoutSize = LayoutText(textParameters, rendererParameters, embeddedItemLayout, internalData);
1141 ////////////////////////////////////////////////////////////////////////////////
1143 ////////////////////////////////////////////////////////////////////////////////
1144 Align(textParameters, rendererParameters, embeddedItemLayout, internalData, newLayoutSize);
1146 ////////////////////////////////////////////////////////////////////////////////
1147 // Ellipsis the text.
1148 ////////////////////////////////////////////////////////////////////////////////
1149 Ellipsis(textParameters, rendererParameters, embeddedItemLayout, internalData);
1151 ////////////////////////////////////////////////////////////////////////////////
1153 ////////////////////////////////////////////////////////////////////////////////
1154 return RenderText(textParameters, rendererParameters);
1157 Devel::PixelBuffer CreateShadow(const ShadowParameters& shadowParameters)
1159 // The size of the pixel data.
1160 const int width = static_cast<int>(shadowParameters.input.GetWidth());
1161 const int height = static_cast<int>(shadowParameters.input.GetHeight());
1163 // The shadow's offset.
1164 const int xOffset = static_cast<int>(shadowParameters.offset.x);
1165 const int yOffset = static_cast<int>(shadowParameters.offset.y);
1167 // The size in bytes of the pixel of the input's buffer.
1168 const Pixel::Format inputFormat = shadowParameters.input.GetPixelFormat();
1169 const unsigned int inputPixelSize = Pixel::GetBytesPerPixel(inputFormat);
1170 const bool isA8 = Pixel::A8 == inputFormat;
1172 // Creates the output pixel buffer.
1173 Devel::PixelBuffer outputPixelBuffer = Devel::PixelBuffer::New(width, height, Pixel::RGBA8888);
1175 // Clear the output buffer
1176 unsigned char* outputPixelBufferPtr = outputPixelBuffer.GetBuffer();
1177 memset(outputPixelBufferPtr, 0, width * height * Pixel::GetBytesPerPixel(Pixel::RGBA8888));
1179 // Gets the buffer of the input pixel buffer.
1180 const unsigned char* const inputPixelBuffer = shadowParameters.input.GetBuffer();
1182 float textColor[4u];
1185 memcpy(textColor, shadowParameters.textColor.AsFloat(), 4u * sizeof(float));
1187 const float* const shadowColor = shadowParameters.color.AsFloat();
1189 // Traverse the input pixel buffer and write the text on the foreground and the shadow on the background.
1190 for(int rowIndex = 0; rowIndex < height; ++rowIndex)
1192 // Calculates the rowIndex to the input pixel buffer for the shadow and whether it's within the boundaries.
1193 const int yOffsetIndex = rowIndex - yOffset;
1194 const bool isValidRowIndex = ((yOffsetIndex >= 0) && (yOffsetIndex < height));
1196 const int rows = rowIndex * width;
1197 const int offsetRows = yOffsetIndex * width;
1198 for(int columnIndex = 0; columnIndex < width; ++columnIndex)
1200 // Index to the input buffer to retrieve the alpha value of the foreground text.
1201 const unsigned int index = inputPixelSize * static_cast<unsigned int>(rows + columnIndex);
1203 // Build the index to the input buffer to retrieve the alpha value of the background shadow.
1204 unsigned int shadowIndex = 0u;
1205 bool isValidShadowIndex = false;
1208 const int xOffsetIndex = columnIndex - xOffset;
1209 isValidShadowIndex = ((xOffsetIndex >= 0) && (xOffsetIndex < width));
1211 if(isValidShadowIndex)
1213 shadowIndex = inputPixelSize * static_cast<unsigned int>(offsetRows + xOffsetIndex);
1217 // If the input buffer is an alpha mask, retrieve the values for the foreground text and the background shadow.
1218 // If not retrieve the color.
1219 float inputShadowOffsetAlphaValue = 1.f;
1220 float inputAlphaValue = 1.f;
1223 // Retrieve the alpha value for the shadow.
1224 inputShadowOffsetAlphaValue = isValidShadowIndex ? (static_cast<float>(*(inputPixelBuffer + shadowIndex)) / 255.f) : 0.f;
1226 // Retrieve the alpha value for the text.
1227 inputAlphaValue = static_cast<float>(*(inputPixelBuffer + index)) / 255.f;
1231 // The input buffer is not an alpha mask. Retrieve the color.
1232 textColor[0u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 0u));
1233 textColor[1u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 1u));
1234 textColor[2u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 2u));
1235 textColor[3u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 3u));
1236 inputAlphaValue = textColor[3u];
1237 inputShadowOffsetAlphaValue = isValidShadowIndex ? TO_FLOAT * static_cast<float>(*(inputPixelBuffer + shadowIndex + 3u)) : 0.f;
1240 // Build the output color.
1241 float outputColor[4u];
1243 if(shadowParameters.blendShadow)
1245 // Blend the shadow's color with the text's color on top
1246 const float textAlpha = textColor[3u] * inputAlphaValue;
1247 const float shadowAlpha = shadowColor[3u] * inputShadowOffsetAlphaValue;
1249 // Blends the alpha.
1250 outputColor[3u] = 1.f - ((1.f - textAlpha) * (1.f - shadowAlpha));
1251 const bool isOutputAlphaZero = outputColor[3u] < Dali::Math::MACHINE_EPSILON_1000;
1252 if(isOutputAlphaZero)
1254 std::fill(outputColor, outputColor + 4u, 0.f);
1258 // Blends the RGB components.
1259 float shadowComponent = 0.f;
1260 float textComponent = 0.f;
1262 shadowComponent = shadowColor[0u] * inputShadowOffsetAlphaValue;
1263 textComponent = textColor[0u] * inputAlphaValue;
1264 outputColor[0u] = (textComponent * textAlpha / outputColor[3u]) + (shadowComponent * shadowAlpha * (1.f - textAlpha) / outputColor[3u]);
1266 shadowComponent = shadowColor[1u] * inputShadowOffsetAlphaValue;
1267 textComponent = textColor[1u] * inputAlphaValue;
1268 outputColor[1u] = (textComponent * textAlpha / outputColor[3u]) + (shadowComponent * shadowAlpha * (1.f - textAlpha) / outputColor[3u]);
1270 shadowComponent = shadowColor[2u] * inputShadowOffsetAlphaValue;
1271 textComponent = textColor[2u] * inputAlphaValue;
1272 outputColor[2u] = (textComponent * textAlpha / outputColor[3u]) + (shadowComponent * shadowAlpha * (1.f - textAlpha) / outputColor[3u]);
1278 std::fill(outputColor, outputColor + 4u, 0.f);
1280 const float textAlpha = textColor[3u];
1281 const float shadowAlpha = shadowColor[3u] * inputShadowOffsetAlphaValue;
1283 // Write shadow first.
1284 if(shadowAlpha > Dali::Math::MACHINE_EPSILON_1000)
1286 outputColor[0u] = shadowColor[0u] * inputShadowOffsetAlphaValue;
1287 outputColor[1u] = shadowColor[1u] * inputShadowOffsetAlphaValue;
1288 outputColor[2u] = shadowColor[2u] * inputShadowOffsetAlphaValue;
1289 outputColor[3u] = shadowAlpha;
1292 // Write character on top.
1293 if(textAlpha > Dali::Math::MACHINE_EPSILON_1000)
1295 outputColor[0u] = textColor[0u];
1296 outputColor[1u] = textColor[1u];
1297 outputColor[2u] = textColor[2u];
1298 outputColor[3u] = textAlpha;
1302 // Write the color into the output pixel buffer.
1303 const unsigned int outputIndex = 4u * (rows + columnIndex);
1304 *(outputPixelBufferPtr + outputIndex + 0u) = static_cast<unsigned char>(TO_UCHAR * outputColor[0u]);
1305 *(outputPixelBufferPtr + outputIndex + 1u) = static_cast<unsigned char>(TO_UCHAR * outputColor[1u]);
1306 *(outputPixelBufferPtr + outputIndex + 2u) = static_cast<unsigned char>(TO_UCHAR * outputColor[2u]);
1307 *(outputPixelBufferPtr + outputIndex + 3u) = static_cast<unsigned char>(TO_UCHAR * outputColor[3u]);
1311 // Returns the pixel buffer.
1312 return outputPixelBuffer;
1315 Devel::PixelBuffer ConvertToRgba8888(Devel::PixelBuffer pixelBuffer, const Vector4& color, bool multiplyByAlpha)
1317 if(Dali::Pixel::A8 != pixelBuffer.GetPixelFormat())
1323 const unsigned int width = pixelBuffer.GetWidth();
1324 const unsigned int height = pixelBuffer.GetHeight();
1325 Devel::PixelBuffer newPixelBuffer = Devel::PixelBuffer::New(width, height, Dali::Pixel::RGBA8888);
1327 unsigned char* dstBuffer = newPixelBuffer.GetBuffer();
1328 const unsigned char* const srcBuffer = pixelBuffer.GetBuffer();
1330 const unsigned char r = static_cast<unsigned char>(TO_UCHAR * color.r);
1331 const unsigned char g = static_cast<unsigned char>(TO_UCHAR * color.g);
1332 const unsigned char b = static_cast<unsigned char>(TO_UCHAR * color.b);
1334 unsigned char dstColor[4];
1335 for(unsigned int j = 0u; j < height; ++j)
1337 const unsigned int lineIndex = j * width;
1338 for(unsigned int i = 0u; i < width; ++i)
1340 const unsigned int srcIndex = lineIndex + i;
1342 const float srcAlpha = static_cast<float>(*(srcBuffer + srcIndex));
1346 dstColor[0u] = static_cast<unsigned char>(srcAlpha * color.r);
1347 dstColor[1u] = static_cast<unsigned char>(srcAlpha * color.g);
1348 dstColor[2u] = static_cast<unsigned char>(srcAlpha * color.b);
1349 dstColor[3u] = static_cast<unsigned char>(srcAlpha * color.a);
1356 dstColor[3u] = static_cast<unsigned char>(srcAlpha);
1359 const unsigned int dstIndex = srcIndex * 4u;
1360 memcpy(dstBuffer + dstIndex, dstColor, 4u);
1364 return newPixelBuffer;
1367 void UpdateBuffer(Devel::PixelBuffer src, Devel::PixelBuffer dst, unsigned int x, unsigned int y, bool blend)
1369 const Dali::Pixel::Format pixelFormat = dst.GetPixelFormat();
1370 if(src.GetPixelFormat() != pixelFormat)
1372 DALI_LOG_ERROR("PixelBuffer::SetBuffer. The pixel format of the new data must be the same of the current pixel buffer.");
1376 const unsigned int srcWidth = src.GetWidth();
1377 const unsigned int srcHeight = src.GetHeight();
1378 const unsigned int dstWidth = dst.GetWidth();
1379 const unsigned int dstHeight = dst.GetHeight();
1381 if((x > dstWidth) ||
1383 (x + srcWidth > dstWidth) ||
1384 (y + srcHeight > dstHeight))
1386 DALI_LOG_ERROR("PixelBuffer::SetBuffer. The source pixel buffer is out of the boundaries of the destination pixel buffer.");
1390 const unsigned int bytesPerPixel = Dali::Pixel::GetBytesPerPixel(pixelFormat);
1391 if(bytesPerPixel == 0u || bytesPerPixel == 12u || bytesPerPixel == 24u)
1395 const unsigned int alphaIndex = bytesPerPixel - 1u;
1397 const unsigned char* const srcBuffer = src.GetBuffer();
1398 unsigned char* dstBuffer = dst.GetBuffer();
1402 const unsigned int currentLineSize = dstWidth * bytesPerPixel;
1403 const unsigned int newLineSize = srcWidth * bytesPerPixel;
1404 unsigned char* currentBuffer = dstBuffer + (y * dstWidth + x) * bytesPerPixel;
1405 for(unsigned int j = 0u; j < srcHeight; ++j)
1407 memcpy(currentBuffer + j * currentLineSize, srcBuffer + j * newLineSize, newLineSize);
1412 float outputColor[4u];
1414 // Blend the src pixel buffer with the dst pixel buffer as background.
1416 // fgColor, fgAlpha, bgColor, bgAlpha
1418 // alpha = 1 - ( 1 - fgAlpha ) * ( 1 - bgAlpha )
1419 // color = ( fgColor * fgAlpha / alpha ) + ( bgColor * bgAlpha * ( 1 - fgAlpha ) / alpha )
1421 // Jump till the 'x,y' position
1422 const unsigned int dstWidthBytes = dstWidth * bytesPerPixel;
1423 dstBuffer += (y * dstWidthBytes + x * bytesPerPixel);
1425 for(unsigned int j = 0u; j < srcHeight; ++j)
1427 const unsigned int srcLineIndex = j * srcWidth;
1428 for(unsigned int i = 0u; i < srcWidth; ++i)
1430 const float srcAlpha = TO_FLOAT * static_cast<float>(*(srcBuffer + bytesPerPixel * (srcLineIndex + i) + alphaIndex));
1431 const float dstAlpha = TO_FLOAT * static_cast<float>(*(dstBuffer + i * bytesPerPixel + alphaIndex));
1433 // Blends the alpha channel.
1434 const float oneMinusSrcAlpha = 1.f - srcAlpha;
1435 outputColor[alphaIndex] = 1.f - (oneMinusSrcAlpha * (1.f - dstAlpha));
1437 // Blends the RGB channels.
1438 const bool isOutputAlphaZero = outputColor[alphaIndex] < Dali::Math::MACHINE_EPSILON_1000;
1439 if(isOutputAlphaZero)
1441 std::fill(outputColor, outputColor + bytesPerPixel, 0.f);
1445 const float srcAlphaOverOutputAlpha = srcAlpha / outputColor[alphaIndex]; // fgAlpha / alpha
1446 const float dstAlphaOneMinusSrcAlphaOverOutputAlpha = dstAlpha * oneMinusSrcAlpha / outputColor[alphaIndex]; // bgAlpha * ( 1 - fgAlpha ) / alpha
1447 for(unsigned int index = 0u; index < alphaIndex; ++index)
1449 const float dstComponent = TO_FLOAT * static_cast<float>(*(dstBuffer + i * bytesPerPixel + index)) * dstAlpha;
1450 const float srcComponent = TO_FLOAT * static_cast<float>(*(srcBuffer + bytesPerPixel * (srcLineIndex + i) + index)) * srcAlpha;
1451 outputColor[index] = (srcComponent * srcAlphaOverOutputAlpha) + (dstComponent * dstAlphaOneMinusSrcAlphaOverOutputAlpha);
1455 for(unsigned int index = 0u; index < bytesPerPixel; ++index)
1457 *(dstBuffer + i * bytesPerPixel + index) = static_cast<unsigned char>(TO_UCHAR * outputColor[index]);
1461 dstBuffer += dstWidthBytes;
1466 Dali::Property::Array RenderForLastIndex(RendererParameters& textParameters)
1468 Property::Array offsetValues;
1469 if(textParameters.text.empty())
1471 return offsetValues;
1473 FontClient fontClient = FontClient::Get();
1475 metrics = Metrics::New(fontClient);
1477 Text::ModelPtr textModel = Text::Model::New();
1478 InternalDataModel internalData(fontClient, metrics, textModel);
1480 TextAbstraction::TextRenderer::Parameters rendererParameters(textModel->mVisualModel->mGlyphs,
1481 textModel->mVisualModel->mGlyphPositions,
1482 textModel->mVisualModel->mColors,
1483 textModel->mVisualModel->mColorIndices,
1484 internalData.blendingMode,
1485 internalData.isEmoji);
1487 rendererParameters.width = textParameters.textWidth;
1488 rendererParameters.height = textParameters.textHeight;
1490 ////////////////////////////////////////////////////////////////////////////////
1491 // Process the markup string if the mark-up processor is enabled.
1492 ////////////////////////////////////////////////////////////////////////////////
1493 ShapeTextPreprocess(textParameters, rendererParameters, internalData);
1495 ////////////////////////////////////////////////////////////////////////////////
1496 // Retrieve the glyphs. Text shaping
1497 ////////////////////////////////////////////////////////////////////////////////
1498 Dali::Vector<Dali::Toolkit::DevelText::EmbeddedItemInfo> embeddedItemLayout;
1499 ShapeText(rendererParameters, embeddedItemLayout, internalData);
1501 ////////////////////////////////////////////////////////////////////////////////
1502 // Retrieve the glyph's metrics.
1503 ////////////////////////////////////////////////////////////////////////////////
1504 metrics->GetGlyphMetrics(rendererParameters.glyphs.Begin(), internalData.numberOfGlyphs);
1506 ////////////////////////////////////////////////////////////////////////////////
1508 ////////////////////////////////////////////////////////////////////////////////
1509 int boundingBox = textParameters.textHeight - (textParameters.padding.top + textParameters.padding.bottom);
1510 textParameters.textHeight = MAX_INT; // layout for the entire area.
1511 LayoutText(textParameters, rendererParameters, embeddedItemLayout, internalData);
1513 ////////////////////////////////////////////////////////////////////////////////
1514 // Calculation last character index
1515 ////////////////////////////////////////////////////////////////////////////////
1516 Vector<LineRun>& lines = internalData.textModel->mVisualModel->mLines;
1517 unsigned int numberOfLines = lines.Count();
1518 int numberOfCharacters = 0;
1520 float lineSize = internalData.layoutEngine.GetDefaultLineSize();
1521 float lineOffset = 0.f;
1522 for(unsigned int index = 0u; index < numberOfLines; ++index)
1524 const LineRun& line = *(lines.Begin() + index);
1525 numberOfCharacters += line.characterRun.numberOfCharacters;
1527 lineOffset = lineSize > 0.f ? lineSize : GetLineHeight(line);
1529 if((penY + lineOffset) > boundingBox)
1531 offsetValues.PushBack(numberOfCharacters);
1537 // add remain character index
1538 offsetValues.PushBack(numberOfCharacters);
1541 return offsetValues;
1544 Dali::Property::Array GetLastCharacterIndex(RendererParameters& textParameters)
1546 Dali::Property::Array offsetValues = Toolkit::DevelText::RenderForLastIndex(textParameters);
1547 return offsetValues;
1550 } // namespace DevelText
1552 } // namespace Toolkit