2 * Copyright (c) 2020 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);
177 if(textParameters.markupEnabled)
179 ProcessMarkupString(textParameters.text, markupProcessData);
180 textSize = markupProcessData.markupProcessedText.size();
182 // This is a bit horrible but std::string returns a (signed) char*
183 utf8 = reinterpret_cast<const uint8_t*>(markupProcessData.markupProcessedText.c_str());
187 textSize = textParameters.text.size();
189 // This is a bit horrible but std::string returns a (signed) char*
190 utf8 = reinterpret_cast<const uint8_t*>(textParameters.text.c_str());
193 ////////////////////////////////////////////////////////////////////////////////
194 // Convert from utf8 to utf32
195 ////////////////////////////////////////////////////////////////////////////////
197 utf32Characters.Resize(textSize);
199 // Transform a text array encoded in utf8 into an array encoded in utf32.
200 // It returns the actual number of characters.
201 numberOfCharacters = Utf8ToUtf32(utf8, textSize, utf32Characters.Begin());
202 utf32Characters.Resize(numberOfCharacters);
204 ////////////////////////////////////////////////////////////////////////////////
205 // Retrieve the Line and Word Break Info.
206 ////////////////////////////////////////////////////////////////////////////////
208 lineBreakInfo.Resize(numberOfCharacters, LINE_NO_BREAK);
210 SetLineBreakInfo(utf32Characters,
215 ////////////////////////////////////////////////////////////////////////////////
216 // Retrieve the script runs.
217 ////////////////////////////////////////////////////////////////////////////////
219 multilanguageSupport.SetScripts(utf32Characters,
224 // Check if there are emojis.
225 // If there are an RGBA8888 pixel format is needed.
226 for(const auto& run : scripts)
228 if(run.script == TextAbstraction::Script::EMOJI)
230 rendererParameters.pixelFormat = TextAbstraction::TextRenderer::Parameters::RGBA8888;
235 ////////////////////////////////////////////////////////////////////////////////
236 // Retrieve the font runs.
237 ////////////////////////////////////////////////////////////////////////////////
239 // Set the description font run with the given text parameters.
240 FontDescriptionRun fontDescriptionRun;
241 fontDescriptionRun.characterRun.characterIndex = 0u;
242 fontDescriptionRun.characterRun.numberOfCharacters = numberOfCharacters;
244 fontDescriptionRun.familyLength = 0u;
245 fontDescriptionRun.familyName = nullptr;
246 fontDescriptionRun.familyDefined = !textParameters.fontFamily.empty();
247 if(fontDescriptionRun.familyDefined)
249 // The allocated memory will be freed when the logical model is destroyed.
250 fontDescriptionRun.familyLength = textParameters.fontFamily.size();
251 fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
252 memcpy(fontDescriptionRun.familyName, textParameters.fontFamily.c_str(), fontDescriptionRun.familyLength);
255 fontDescriptionRun.weightDefined = !textParameters.fontWeight.empty();
256 if(fontDescriptionRun.weightDefined)
258 fontDescriptionRun.weight = StringToWeight(textParameters.fontWeight.c_str());
261 fontDescriptionRun.widthDefined = !textParameters.fontWidth.empty();
262 if(fontDescriptionRun.widthDefined)
264 fontDescriptionRun.width = StringToWidth(textParameters.fontWidth.c_str());
267 fontDescriptionRun.slantDefined = !textParameters.fontSlant.empty();
268 if(fontDescriptionRun.slantDefined)
270 fontDescriptionRun.slant = StringToSlant(textParameters.fontSlant.c_str());
273 fontDescriptionRun.sizeDefined = !EqualsZero(textParameters.fontSize);
274 if(fontDescriptionRun.sizeDefined)
276 fontDescriptionRun.size = static_cast<unsigned int>(textParameters.fontSize * TO_POINT_26_DOT_6);
279 fontDescriptionRuns.PushBack(fontDescriptionRun);
281 // Validates the fonts. If there is a character with no assigned font it sets a default one.
282 // After this call, fonts are validated.
283 multilanguageSupport.ValidateFonts(utf32Characters,
286 defaultFontDescription,
292 ////////////////////////////////////////////////////////////////////////////////
293 // Retrieve the Bidirectional info.
294 ////////////////////////////////////////////////////////////////////////////////
296 bidirectionalInfo.Reserve(1u);
298 SetBidirectionalInfo(utf32Characters,
305 const bool hasBidirectionalText = 0u != bidirectionalInfo.Count();
306 if(hasBidirectionalText)
308 // Only set the character directions if there is right to left characters.
309 GetCharactersDirection(bidirectionalInfo,
315 // This paragraph has right to left text. Some characters may need to be mirrored.
316 // TODO: consider if the mirrored string can be stored as well.
318 internalDataModel.isTextMirrored = GetMirroredText(utf32Characters,
323 mirroredUtf32Characters);
327 void ShapeText(TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel)
329 Vector<GlyphIndex> newParagraphGlyphs; // Glyphs for the new paragraph characters.
330 const Length numberOfCharacters = internalDataModel.numberOfCharacters;
331 const bool isTextMirrored = internalDataModel.isTextMirrored;
332 Text::ModelPtr& textModel = internalDataModel.textModel;
333 const Vector<Character>& mirroredUtf32Characters = internalDataModel.mirroredUtf32Characters;
334 FontClient& fontClient = internalDataModel.fontClient;
335 const Vector<Character>& utf32Characters = textModel->mLogicalModel->mText; // Characters encoded in utf32.
336 const Vector<LineBreakInfo>& lineBreakInfo = textModel->mLogicalModel->mLineBreakInfo; // The line break info.
337 const Vector<ScriptRun>& scripts = textModel->mLogicalModel->mScriptRuns; // Charactes's script.
338 const Vector<FontRun>& validFonts = textModel->mLogicalModel->mFontRuns; // Validated fonts.
340 Vector<CharacterIndex>& glyphsToCharacters = textModel->mVisualModel->mGlyphsToCharacters; // Glyphs to character map.
341 Vector<Length>& charactersPerGlyph = textModel->mVisualModel->mCharactersPerGlyph; // Number of characters per glyph.
343 ////////////////////////////////////////////////////////////////////////////////
344 // Retrieve the glyphs. Text shaping
345 ////////////////////////////////////////////////////////////////////////////////
347 const Vector<Character>& textToShape = isTextMirrored ? mirroredUtf32Characters : utf32Characters;
349 newParagraphGlyphs.Reserve(1u);
352 ShapeText(textToShape,
359 rendererParameters.glyphs,
364 // Create the 'number of glyphs' per character and the glyph to character conversion tables.
365 textModel->mVisualModel->CreateGlyphsPerCharacterTable(0u, 0u, numberOfCharacters);
366 textModel->mVisualModel->CreateCharacterToGlyphTable(0u, 0u, numberOfCharacters);
368 internalDataModel.numberOfGlyphs = rendererParameters.glyphs.Count();
370 // Once the text has been shaped and the glyphs created it's possible to replace the font id of those glyphs
371 // that represent an image or an item and create the embedded item layout info.
372 // Note: the position of the embedded item can't be set until the text is laid-out.
373 embeddedItemLayout.Reserve(textModel->mLogicalModel->mEmbeddedItems.Count());
374 for(const auto& item : textModel->mLogicalModel->mEmbeddedItems)
376 // Get the glyph that matches with the character index.
377 const GlyphIndex glyphIndex = textModel->mVisualModel->mCharactersToGlyph[item.characterIndex];
378 GlyphInfo& glyph = rendererParameters.glyphs[glyphIndex];
381 Pixel::Format pixelFormat = Pixel::A8;
382 TextAbstraction::FontClient::EmbeddedItemDescription description = {std::string(item.url, item.urlLength), item.width, item.height, item.colorBlendingMode};
383 glyph.index = fontClient.CreateEmbeddedItem(description, pixelFormat); // Set here an index to an item.
385 if((Pixel::RGBA8888 == pixelFormat) || (Pixel::BGRA8888 == pixelFormat))
387 rendererParameters.pixelFormat = TextAbstraction::TextRenderer::Parameters::RGBA8888;
390 // 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.
391 if(description.url.empty())
393 EmbeddedItemInfo embeddedInfo =
398 Size(static_cast<float>(item.width), static_cast<float>(item.height)),
399 Size(static_cast<float>(item.width), static_cast<float>(item.height)),
401 item.colorBlendingMode};
403 embeddedItemLayout.PushBack(embeddedInfo);
408 void SetColorSegmentation(const RendererParameters& textParameters, InternalDataModel& internalDataModel)
410 Text::ModelPtr& textModel = internalDataModel.textModel;
411 Vector<ColorBlendingMode>& blendingMode = internalDataModel.blendingMode;
413 Vector<ColorRun>& colorRuns = textModel->mLogicalModel->mColorRuns; // colors of the text.
415 Vector<GlyphIndex>& charactersToGlyph = textModel->mVisualModel->mCharactersToGlyph; // Characters to glyphs map.
416 Vector<Length>& glyphsPerCharacter = textModel->mVisualModel->mGlyphsPerCharacter; // The number of glyphs that are shaped.
418 ////////////////////////////////////////////////////////////////////////////////
419 // Set the color runs in glyphs.
420 ////////////////////////////////////////////////////////////////////////////////
422 SetColorSegmentationInfo(colorRuns,
427 internalDataModel.numberOfCharacters,
428 textModel->mVisualModel->mColors,
429 textModel->mVisualModel->mColorIndices);
431 // Insert the default color at the beginning of the vector.
432 textModel->mVisualModel->mColors.Insert(textModel->mVisualModel->mColors.Begin(), textParameters.textColor);
434 // Set how the embedded items are blended with text color.
435 blendingMode.Resize(internalDataModel.numberOfGlyphs, textParameters.isTextColorSet ? ColorBlendingMode::MULTIPLY : ColorBlendingMode::NONE);
437 if(!textParameters.isTextColorSet)
439 // Traverse the color runs.
440 for(const auto& run : colorRuns)
442 const GlyphIndex firstGlyph = textModel->mVisualModel->mCharactersToGlyph[run.characterRun.characterIndex];
443 const CharacterIndex lastCharacter = run.characterRun.characterIndex + run.characterRun.numberOfCharacters - 1u;
444 const GlyphIndex lastGlyphPlusOne = textModel->mVisualModel->mCharactersToGlyph[lastCharacter] + textModel->mVisualModel->mGlyphsPerCharacter[lastCharacter];
446 for(GlyphIndex index = firstGlyph; index < lastGlyphPlusOne; ++index)
448 blendingMode[index] = ColorBlendingMode::MULTIPLY;
453 // Traverse the embedded items and update the blending mode vector.
454 for(const auto& item : textModel->mLogicalModel->mEmbeddedItems)
456 const GlyphIndex glyphIndex = textModel->mVisualModel->mCharactersToGlyph[item.characterIndex];
457 blendingMode[glyphIndex] = item.colorBlendingMode;
461 void SetEmojiVector(InternalDataModel& internalDataModel)
463 Vector<bool>& isEmoji = internalDataModel.isEmoji;
464 Text::ModelPtr& textModel = internalDataModel.textModel;
465 const Length numberOfGlyphs = internalDataModel.numberOfGlyphs;
467 const Vector<ScriptRun>& scripts = textModel->mLogicalModel->mScriptRuns; // Charactes's script.
468 ////////////////////////////////////////////////////////////////////////////////
469 // Set the isEmoji Vector
470 ////////////////////////////////////////////////////////////////////////////////
472 isEmoji.Resize(numberOfGlyphs, false);
474 for(const auto& run : scripts)
476 if(run.script == TextAbstraction::Script::EMOJI)
478 const GlyphIndex firstGlyph = textModel->mVisualModel->mCharactersToGlyph[run.characterRun.characterIndex];
479 const CharacterIndex lastCharacter = run.characterRun.characterIndex + run.characterRun.numberOfCharacters - 1u;
480 const GlyphIndex lastGlyphPlusOne = textModel->mVisualModel->mCharactersToGlyph[lastCharacter] + textModel->mVisualModel->mGlyphsPerCharacter[lastCharacter];
482 for(GlyphIndex index = firstGlyph; index < lastGlyphPlusOne; ++index)
484 isEmoji[index] = true;
490 void Align(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel, const Size& newLayoutSize)
492 Text::Layout::Engine& layoutEngine = internalDataModel.layoutEngine;
493 Text::ModelPtr& textModel = internalDataModel.textModel;
494 const Length numberOfCharacters = internalDataModel.numberOfCharacters;
495 Size& textLayoutArea = internalDataModel.textLayoutArea;
497 Vector<LineRun>& lines = textModel->mVisualModel->mLines; // The laid out lines.
499 ////////////////////////////////////////////////////////////////////////////////
501 ////////////////////////////////////////////////////////////////////////////////
503 HorizontalAlignment::Type horizontalAlignment = Toolkit::HorizontalAlignment::CENTER;
504 HorizontalAlignment::Type horizontalCircularAlignment = Toolkit::HorizontalAlignment::CENTER;
505 VerticalAlignment::Type verticalAlignment = VerticalAlignment::CENTER;
506 CircularAlignment::Type circularAlignment = CircularAlignment::BEGIN;
508 Layout::Type layout = Layout::SINGLELINE;
510 // Sets the alignment
511 Property::Value horizontalAlignmentStr(textParameters.horizontalAlignment);
512 GetHorizontalAlignmentEnumeration(horizontalAlignmentStr, horizontalAlignment);
513 horizontalCircularAlignment = horizontalAlignment;
515 Property::Value verticalAlignmentStr(textParameters.verticalAlignment);
516 GetVerticalAlignmentEnumeration(verticalAlignmentStr, verticalAlignment);
518 Property::Value circularAlignmentStr(textParameters.circularAlignment);
519 GetCircularAlignmentEnumeration(circularAlignmentStr, circularAlignment);
521 Property::Value layoutStr(textParameters.layout);
522 GetLayoutEnumeration(layoutStr, layout);
524 // Whether the layout is circular.
525 const bool isCircularTextLayout = (Layout::CIRCULAR == layout);
526 const bool isClockwise = isCircularTextLayout && (0.f < textParameters.incrementAngle);
528 // Convert CircularAlignment to HorizontalAlignment.
529 if(isCircularTextLayout)
531 switch(circularAlignment)
533 case CircularAlignment::BEGIN:
535 horizontalCircularAlignment = Toolkit::HorizontalAlignment::BEGIN;
538 case CircularAlignment::CENTER:
540 horizontalCircularAlignment = Toolkit::HorizontalAlignment::CENTER;
543 case CircularAlignment::END:
545 horizontalCircularAlignment = Toolkit::HorizontalAlignment::END;
550 textModel->mHorizontalAlignment = isCircularTextLayout ? horizontalCircularAlignment : horizontalAlignment;
552 // Retrieve the line of text to know the direction and the width. @todo multi-line
553 const LineRun& line = lines[0u];
555 if(isCircularTextLayout)
557 // Set the circular alignment.
558 rendererParameters.circularLayout = isClockwise ? TextRenderer::Parameters::CLOCKWISE : TextRenderer::Parameters::COUNTER_CLOCKWISE;
560 // Update the text's height to be used by the ellipsis code.
561 textLayoutArea.height = newLayoutSize.height;
563 // Set the size of the text laid out on a straight horizontal line.
564 rendererParameters.circularWidth = static_cast<unsigned int>(newLayoutSize.width);
565 rendererParameters.circularHeight = static_cast<unsigned int>(newLayoutSize.height);
567 // Calculate the center of the circular text according the horizontal and vertical alingments and the radius.
568 switch(horizontalAlignment)
570 case HorizontalAlignment::BEGIN:
572 rendererParameters.centerX = static_cast<int>(textParameters.radius);
575 case HorizontalAlignment::CENTER:
577 rendererParameters.centerX = static_cast<int>(textParameters.textWidth / 2u);
580 case HorizontalAlignment::END:
582 rendererParameters.centerX = static_cast<int>(textParameters.textWidth) - static_cast<int>(textParameters.radius);
587 switch(verticalAlignment)
589 case VerticalAlignment::TOP:
591 rendererParameters.centerY = static_cast<int>(textParameters.radius);
594 case VerticalAlignment::CENTER:
596 rendererParameters.centerY = static_cast<int>(textParameters.textHeight / 2u);
599 case VerticalAlignment::BOTTOM:
601 rendererParameters.centerY = static_cast<int>(textParameters.textHeight) - static_cast<int>(textParameters.radius);
606 // Calculate the beginning angle according with the given horizontal alignment.
607 const bool isRTL = RTL == line.direction;
609 CircularAlignment::Type alignment = circularAlignment;
612 // Swap the alignment type if the line is right to left.
615 case CircularAlignment::BEGIN:
617 alignment = CircularAlignment::END;
620 case CircularAlignment::CENTER:
625 case CircularAlignment::END:
627 alignment = CircularAlignment::BEGIN;
633 float angleOffset = 0.f;
637 case CircularAlignment::BEGIN:
642 case CircularAlignment::CENTER:
644 const bool isNeg = textParameters.incrementAngle < 0.f;
645 const float textWidth = static_cast<float>(rendererParameters.circularWidth);
646 angleOffset = (isNeg ? -0.5f : 0.5f) * (textLayoutArea.width - textWidth) / static_cast<float>(rendererParameters.radius);
649 case CircularAlignment::END:
651 const bool isNeg = textParameters.incrementAngle < 0.f;
652 const float textWidth = static_cast<float>(rendererParameters.circularWidth);
653 angleOffset = (isNeg ? -1.f : 1.f) * (textLayoutArea.width - textWidth) / static_cast<float>(rendererParameters.radius);
658 // Update the beginning angle with the calculated offset.
659 rendererParameters.beginAngle = Radian(Degree(textParameters.beginAngle)) + angleOffset;
661 // Set the vertical position of the glyphs.
662 for(auto& position : rendererParameters.positions)
669 // Calculate the vertical offset according with the given alignment.
672 switch(verticalAlignment)
674 case VerticalAlignment::TOP:
676 penY = line.ascender;
679 case VerticalAlignment::CENTER:
681 penY = line.ascender + 0.5f * (textLayoutArea.height - (line.ascender - line.descender));
684 case VerticalAlignment::BOTTOM:
686 penY = textLayoutArea.height;
691 // Calculate the horizontal offset according with the given alignment.
692 float alignmentOffset = 0.f;
693 layoutEngine.Align(textLayoutArea,
699 Dali::LayoutDirection::LEFT_TO_RIGHT,
702 // Update the position of the glyphs with the calculated offsets.
703 for(auto& position : rendererParameters.positions)
705 position.x += line.alignmentOffset;
710 // Cairo adds the bearing to the position of the glyph
711 // that has already been added by the DALi's layout engine,
712 // so it's needed to be removed here.
713 for(unsigned int index = 0u; index < rendererParameters.glyphs.Count(); ++index)
715 const GlyphInfo& glyph = rendererParameters.glyphs[index];
716 Vector2& position = rendererParameters.positions[index];
718 position.x -= glyph.xBearing;
721 // Set the position of the embedded items (if there is any).
722 EmbeddedItemInfo* embeddedItemLayoutBuffer = embeddedItemLayout.Begin();
724 for(Length index = 0u, endIndex = embeddedItemLayout.Count(); index < endIndex; ++index)
726 EmbeddedItemInfo& embeddedItem = *(embeddedItemLayoutBuffer + index);
728 embeddedItem.position = rendererParameters.positions[embeddedItem.glyphIndex];
730 if(isCircularTextLayout)
732 // Calculate the new position of the embedded item in the circular path.
734 // Center of the bitmap.
735 const float halfWidth = 0.5f * embeddedItem.size.width;
736 const float halfHeight = 0.5f * embeddedItem.size.height;
737 double centerX = static_cast<double>(embeddedItem.position.x + halfWidth);
738 double centerY = static_cast<double>(embeddedItem.position.y - halfHeight);
740 Dali::TextAbstraction::CircularTextParameters circularTextParameters;
742 circularTextParameters.radius = static_cast<double>(rendererParameters.radius);
743 circularTextParameters.invRadius = 1.0 / circularTextParameters.radius;
744 circularTextParameters.beginAngle = static_cast<double>(-rendererParameters.beginAngle + Dali::Math::PI_2);
745 circularTextParameters.centerX = 0.5f * static_cast<double>(textParameters.textWidth);
746 circularTextParameters.centerY = 0.5f * static_cast<double>(textParameters.textHeight);
748 // Calculate the rotation angle.
749 float radians = rendererParameters.beginAngle;
752 radians += static_cast<float>(circularTextParameters.invRadius * centerX);
757 radians -= static_cast<float>(circularTextParameters.invRadius * centerX);
758 radians = -radians + Dali::Math::PI;
760 embeddedItem.angle = Degree(Radian(radians));
762 Dali::TextAbstraction::TransformToArc(circularTextParameters, centerX, centerY);
764 // Recalculate the size of the embedded item after the rotation to position it correctly.
765 float width = embeddedItem.size.width;
766 float height = embeddedItem.size.height;
768 // Transform the input angle into the range [0..2PI]
769 radians = fmod(radians, TWO_PI);
770 radians += (radians < 0.f) ? TWO_PI : 0.f;
772 // Does the same operations than rotate by shear.
773 if((radians > Math::PI_4) && (radians <= RAD_135))
775 std::swap(width, height);
776 radians -= Math::PI_2;
778 else if((radians > RAD_135) && (radians <= RAD_225))
782 else if((radians > RAD_225) && (radians <= RAD_315))
784 std::swap(width, height);
788 if(fabs(radians) > Dali::Math::MACHINE_EPSILON_10)
790 const float angleSinus = fabs(sin(radians));
791 const float angleCosinus = cos(radians);
793 // Calculate the rotated image dimensions.
794 embeddedItem.rotatedSize.height = width * angleSinus + height * angleCosinus;
795 embeddedItem.rotatedSize.width = height * angleSinus + width * angleCosinus + 1.f;
798 embeddedItem.position.x = floor(static_cast<float>(centerX) - 0.5f * embeddedItem.rotatedSize.width);
799 embeddedItem.position.y = floor(static_cast<float>(centerY) - 0.5f * embeddedItem.rotatedSize.height);
803 embeddedItem.position.y -= embeddedItem.size.height;
808 void Ellipsis(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel)
810 Text::ModelPtr& textModel = internalDataModel.textModel;
811 FontClient& fontClient = internalDataModel.fontClient;
813 Vector<LineRun>& lines = textModel->mVisualModel->mLines; // The laid out lines.
814 Vector<bool>& isEmoji = internalDataModel.isEmoji;
815 const Size textLayoutArea = internalDataModel.textLayoutArea;
816 ////////////////////////////////////////////////////////////////////////////////
817 // Ellipsis the text.
818 ////////////////////////////////////////////////////////////////////////////////
820 if(textParameters.ellipsisEnabled)
822 const LineRun& line = lines[0u]; // TODO: multi-line
826 Length finalNumberOfGlyphs = 0u;
828 if((line.ascender - line.descender) > textLayoutArea.height)
830 // The height of the line is bigger than the height of the text area.
831 // Show the ellipsis glyph even if it doesn't fit in the text area.
832 // If no text is rendered then issues are rised and it may be a while
833 // until is find out that the text area is too small.
835 // Get the first glyph which is going to be replaced and the ellipsis glyph.
836 GlyphInfo& glyphInfo = rendererParameters.glyphs[0u];
837 const GlyphInfo& ellipsisGlyph = fontClient.GetEllipsisGlyph(fontClient.GetPointSize(glyphInfo.fontId));
839 // Change the 'x' and 'y' position of the ellipsis glyph.
840 Vector2& position = rendererParameters.positions[0u];
841 position.x = ellipsisGlyph.xBearing;
842 position.y = textLayoutArea.height - ellipsisGlyph.yBearing;
844 // Replace the glyph by the ellipsis glyph.
845 glyphInfo = ellipsisGlyph;
847 // Set the final number of glyphs
848 finalNumberOfGlyphs = 1u;
852 // firstPenX, penY and firstPenSet are used to position the ellipsis glyph if needed.
853 float firstPenX = 0.f; // Used if rtl text is elided.
854 bool firstPenSet = false;
856 // Add the ellipsis glyph.
857 bool inserted = false;
858 float removedGlypsWidth = 0.f;
859 Length numberOfRemovedGlyphs = 0u;
860 if(line.glyphRun.numberOfGlyphs > 0u)
862 GlyphIndex index = line.glyphRun.numberOfGlyphs - 1u;
864 GlyphInfo* glyphs = rendererParameters.glyphs.Begin();
865 Vector2* glyphPositions = rendererParameters.positions.Begin();
869 // The ellipsis glyph has to fit in the place where the last glyph(s) is(are) removed.
872 const GlyphInfo& glyphToRemove = *(glyphs + index);
874 if(0u != glyphToRemove.fontId)
876 // i.e. The font id of the glyph shaped from the '\n' character is zero.
878 // Need to reshape the glyph as the font may be different in size.
879 const GlyphInfo& ellipsisGlyph = fontClient.GetEllipsisGlyph(fontClient.GetPointSize(glyphToRemove.fontId));
883 const Vector2& position = *(glyphPositions + index);
885 // Calculates the penY of the current line. It will be used to position the ellipsis glyph.
888 // Calculates the first penX which will be used if rtl text is elided.
889 firstPenX = position.x - glyphToRemove.xBearing;
890 if(firstPenX < -ellipsisGlyph.xBearing)
892 // Avoids to exceed the bounding box when rtl text is elided.
893 firstPenX = -ellipsisGlyph.xBearing;
896 removedGlypsWidth = -ellipsisGlyph.xBearing;
901 removedGlypsWidth += std::min(glyphToRemove.advance, (glyphToRemove.xBearing + glyphToRemove.width));
903 // Calculate the width of the ellipsis glyph and check if it fits.
904 const float ellipsisGlyphWidth = ellipsisGlyph.width + ellipsisGlyph.xBearing;
905 if(ellipsisGlyphWidth < removedGlypsWidth)
907 GlyphInfo& glyphInfo = *(glyphs + index);
908 Vector2& position = *(glyphPositions + index);
909 position.x -= (0.f > glyphInfo.xBearing) ? glyphInfo.xBearing : 0.f;
911 // Replace the glyph by the ellipsis glyph.
912 glyphInfo = ellipsisGlyph;
914 // Update the isEmoji vector
915 isEmoji[index] = false;
917 // Change the 'x' and 'y' position of the ellipsis glyph.
919 if(position.x > firstPenX)
921 position.x = firstPenX + removedGlypsWidth - ellipsisGlyphWidth;
924 position.x += ellipsisGlyph.xBearing;
939 // No space for the ellipsis.
942 ++numberOfRemovedGlyphs;
945 // Set the final number of glyphs
946 finalNumberOfGlyphs = line.glyphRun.numberOfGlyphs - numberOfRemovedGlyphs;
950 // Resize the number of glyphs/positions
951 rendererParameters.glyphs.Resize(finalNumberOfGlyphs);
952 rendererParameters.positions.Resize(finalNumberOfGlyphs);
954 // Remove from the embedded items those exceding the last laid out glyph.
955 embeddedItemLayout.Erase(std::remove_if(embeddedItemLayout.Begin(),
956 embeddedItemLayout.End(),
957 [finalNumberOfGlyphs](const EmbeddedItemInfo& item) {
958 return item.glyphIndex >= finalNumberOfGlyphs;
960 embeddedItemLayout.End());
966 Size LayoutText(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout, InternalDataModel& internalDataModel)
968 ////////////////////////////////////////////////////////////////////////////////
970 ////////////////////////////////////////////////////////////////////////////////
971 Text::ModelPtr& textModel = internalDataModel.textModel;
972 Text::Layout::Engine& layoutEngine = internalDataModel.layoutEngine;
973 FontClient& fontClient = internalDataModel.fontClient;
974 const Length numberOfGlyphs = internalDataModel.numberOfGlyphs;
975 const bool isTextMirrored = internalDataModel.isTextMirrored;
976 const Vector<Character>& mirroredUtf32Characters = internalDataModel.mirroredUtf32Characters;
977 const Length numberOfCharacters = internalDataModel.numberOfCharacters;
979 Layout::Type layout = Layout::SINGLELINE;
981 Property::Value layoutStr(textParameters.layout);
982 GetLayoutEnumeration(layoutStr, layout);
984 // Whether the layout is multi-line.
985 const Text::Layout::Engine::Type horizontalLayout = (Layout::MULTILINE == layout) ? Text::Layout::Engine::MULTI_LINE_BOX : Text::Layout::Engine::SINGLE_LINE_BOX;
986 layoutEngine.SetLayout(horizontalLayout); // TODO: multi-line.
988 // Set minimun line size
989 layoutEngine.SetDefaultLineSize(textParameters.minLineSize);
991 // Whether the layout is circular.
992 const bool isCircularTextLayout = (Layout::CIRCULAR == layout);
993 const bool isClockwise = isCircularTextLayout && (0.f < textParameters.incrementAngle);
995 // Calculates the max ascender or the max descender.
996 // Is used to calculate the radius of the base line of the text.
997 float maxAscenderDescender = 0.f;
998 if(isCircularTextLayout)
1000 FontId currentFontId = 0u;
1001 for(const auto& glyph : rendererParameters.glyphs)
1003 if(currentFontId != glyph.fontId)
1005 currentFontId = glyph.fontId;
1006 FontMetrics metrics;
1007 fontClient.GetFontMetrics(currentFontId, metrics);
1008 maxAscenderDescender = std::max(maxAscenderDescender, isClockwise ? metrics.ascender : metrics.descender);
1012 const unsigned int radius = textParameters.radius - static_cast<unsigned int>(maxAscenderDescender);
1014 // Set the layout parameters.
1015 Size textLayoutArea = Size(static_cast<float>(textParameters.textWidth),
1016 static_cast<float>(textParameters.textHeight));
1019 Extents padding = textParameters.padding;
1020 internalDataModel.textLayoutArea = Size(textLayoutArea.x - ( padding.start + padding.end ), textLayoutArea.y - ( padding.top + padding.bottom ) );
1023 if(isCircularTextLayout)
1025 // In a circular layout, the length of the text area depends on the radius.
1026 rendererParameters.radius = radius;
1027 internalDataModel.textLayoutArea.width = fabs(Radian(Degree(textParameters.incrementAngle)) * static_cast<float>(rendererParameters.radius));
1029 // Resize the vector of positions to have the same size than the vector of glyphs.
1030 rendererParameters.positions.Resize(numberOfGlyphs);
1032 textModel->mLineWrapMode = LineWrap::WORD;
1033 textModel->mIgnoreSpacesAfterText = false;
1034 textModel->mMatchSystemLanguageDirection = false;
1035 Text::Layout::Parameters layoutParameters(internalDataModel.textLayoutArea,
1038 // Whether the last character is a new paragraph character.
1039 const Vector<Character>& textToShape = isTextMirrored ? mirroredUtf32Characters : textModel->mLogicalModel->mText;
1040 layoutParameters.isLastNewParagraph = TextAbstraction::IsNewParagraph(textToShape[numberOfCharacters - 1u]);
1042 // The initial glyph and the number of glyphs to layout.
1043 layoutParameters.startGlyphIndex = 0u;
1044 layoutParameters.numberOfGlyphs = numberOfGlyphs;
1045 layoutParameters.startLineIndex = 0u;
1046 layoutParameters.estimatedNumberOfLines = 1u;
1047 layoutParameters.interGlyphExtraAdvance = 0.f;
1049 // Update the visual model.
1051 bool isAutoScrollEnabled = false;
1052 layoutEngine.LayoutText(layoutParameters,
1054 textParameters.ellipsisEnabled,
1055 isAutoScrollEnabled);
1057 return newLayoutSize;
1060 Devel::PixelBuffer RenderText(const RendererParameters& textParameters, TextAbstraction::TextRenderer::Parameters& rendererParameters)
1062 ////////////////////////////////////////////////////////////////////////////////
1064 ////////////////////////////////////////////////////////////////////////////////
1066 rendererParameters.width = textParameters.textWidth;
1067 rendererParameters.height = textParameters.textHeight;
1069 TextAbstraction::TextRenderer renderer = TextAbstraction::TextRenderer::Get();
1070 return renderer.Render(rendererParameters);
1073 Devel::PixelBuffer Render(const RendererParameters& textParameters, Vector<EmbeddedItemInfo>& embeddedItemLayout)
1075 if(textParameters.text.empty())
1077 Dali::Devel::PixelBuffer pixelBuffer = Dali::Devel::PixelBuffer::New(textParameters.textWidth,
1078 textParameters.textHeight,
1079 Dali::Pixel::RGBA8888);
1081 const unsigned int bufferSize = textParameters.textWidth * textParameters.textHeight * Dali::Pixel::GetBytesPerPixel(Dali::Pixel::RGBA8888);
1082 unsigned char* buffer = pixelBuffer.GetBuffer();
1083 memset(buffer, 0, bufferSize);
1088 FontClient fontClient = FontClient::Get();
1090 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
1091 metrics = Metrics::New(fontClient);
1093 Text::ModelPtr textModel = Text::Model::New();
1094 InternalDataModel internalData(fontClient, metrics, textModel);
1096 TextAbstraction::TextRenderer::Parameters rendererParameters(internalData.textModel->mVisualModel->mGlyphs,
1097 internalData.textModel->mVisualModel->mGlyphPositions,
1098 internalData.textModel->mVisualModel->mColors,
1099 internalData.textModel->mVisualModel->mColorIndices,
1100 internalData.blendingMode,
1101 internalData.isEmoji);
1103 rendererParameters.width = textParameters.textWidth;
1104 rendererParameters.height = textParameters.textHeight;
1105 rendererParameters.pixelFormat = TextAbstraction::TextRenderer::Parameters::RGBA8888; // @note: At the moment all textures are generated RGBA8888
1107 ////////////////////////////////////////////////////////////////////////////////
1108 // Process the markup string if the mark-up processor is enabled.
1109 ////////////////////////////////////////////////////////////////////////////////
1110 ShapeTextPreprocess(textParameters, rendererParameters, internalData);
1112 ////////////////////////////////////////////////////////////////////////////////
1113 // Retrieve the glyphs. Text shaping
1114 ////////////////////////////////////////////////////////////////////////////////
1115 ShapeText(rendererParameters, embeddedItemLayout, internalData);
1117 ////////////////////////////////////////////////////////////////////////////////
1118 // Retrieve the glyph's metrics.
1119 ////////////////////////////////////////////////////////////////////////////////
1121 metrics->GetGlyphMetrics(rendererParameters.glyphs.Begin(), internalData.numberOfGlyphs);
1123 ////////////////////////////////////////////////////////////////////////////////
1124 // Set the color runs in glyphs.
1125 ////////////////////////////////////////////////////////////////////////////////
1126 SetColorSegmentation(textParameters, internalData);
1128 ////////////////////////////////////////////////////////////////////////////////
1129 // Set the isEmoji Vector
1130 ////////////////////////////////////////////////////////////////////////////////
1131 SetEmojiVector(internalData);
1133 ////////////////////////////////////////////////////////////////////////////////
1135 ////////////////////////////////////////////////////////////////////////////////
1136 Size newLayoutSize = LayoutText(textParameters, rendererParameters, embeddedItemLayout, internalData);
1138 ////////////////////////////////////////////////////////////////////////////////
1140 ////////////////////////////////////////////////////////////////////////////////
1141 Align(textParameters, rendererParameters, embeddedItemLayout, internalData, newLayoutSize);
1143 ////////////////////////////////////////////////////////////////////////////////
1144 // Ellipsis the text.
1145 ////////////////////////////////////////////////////////////////////////////////
1146 Ellipsis(textParameters, rendererParameters, embeddedItemLayout, internalData);
1148 ////////////////////////////////////////////////////////////////////////////////
1150 ////////////////////////////////////////////////////////////////////////////////
1151 return RenderText(textParameters, rendererParameters);
1154 Devel::PixelBuffer CreateShadow(const ShadowParameters& shadowParameters)
1156 // The size of the pixel data.
1157 const int width = static_cast<int>(shadowParameters.input.GetWidth());
1158 const int height = static_cast<int>(shadowParameters.input.GetHeight());
1160 // The shadow's offset.
1161 const int xOffset = static_cast<int>(shadowParameters.offset.x);
1162 const int yOffset = static_cast<int>(shadowParameters.offset.y);
1164 // The size in bytes of the pixel of the input's buffer.
1165 const Pixel::Format inputFormat = shadowParameters.input.GetPixelFormat();
1166 const unsigned int inputPixelSize = Pixel::GetBytesPerPixel(inputFormat);
1167 const bool isA8 = Pixel::A8 == inputFormat;
1169 // Creates the output pixel buffer.
1170 Devel::PixelBuffer outputPixelBuffer = Devel::PixelBuffer::New(width, height, Pixel::RGBA8888);
1172 // Clear the output buffer
1173 unsigned char* outputPixelBufferPtr = outputPixelBuffer.GetBuffer();
1174 memset(outputPixelBufferPtr, 0, width * height * Pixel::GetBytesPerPixel(Pixel::RGBA8888));
1176 // Gets the buffer of the input pixel buffer.
1177 const unsigned char* const inputPixelBuffer = shadowParameters.input.GetBuffer();
1179 float textColor[4u];
1182 memcpy(textColor, shadowParameters.textColor.AsFloat(), 4u * sizeof(float));
1184 const float* const shadowColor = shadowParameters.color.AsFloat();
1186 // Traverse the input pixel buffer and write the text on the foreground and the shadow on the background.
1187 for(int rowIndex = 0; rowIndex < height; ++rowIndex)
1189 // Calculates the rowIndex to the input pixel buffer for the shadow and whether it's within the boundaries.
1190 const int yOffsetIndex = rowIndex - yOffset;
1191 const bool isValidRowIndex = ((yOffsetIndex >= 0) && (yOffsetIndex < height));
1193 const int rows = rowIndex * width;
1194 const int offsetRows = yOffsetIndex * width;
1195 for(int columnIndex = 0; columnIndex < width; ++columnIndex)
1197 // Index to the input buffer to retrieve the alpha value of the foreground text.
1198 const unsigned int index = inputPixelSize * static_cast<unsigned int>(rows + columnIndex);
1200 // Build the index to the input buffer to retrieve the alpha value of the background shadow.
1201 unsigned int shadowIndex = 0u;
1202 bool isValidShadowIndex = false;
1205 const int xOffsetIndex = columnIndex - xOffset;
1206 isValidShadowIndex = ((xOffsetIndex >= 0) && (xOffsetIndex < width));
1208 if(isValidShadowIndex)
1210 shadowIndex = inputPixelSize * static_cast<unsigned int>(offsetRows + xOffsetIndex);
1214 // If the input buffer is an alpha mask, retrieve the values for the foreground text and the background shadow.
1215 // If not retrieve the color.
1216 float inputShadowOffsetAlphaValue = 1.f;
1217 float inputAlphaValue = 1.f;
1220 // Retrieve the alpha value for the shadow.
1221 inputShadowOffsetAlphaValue = isValidShadowIndex ? (static_cast<float>(*(inputPixelBuffer + shadowIndex)) / 255.f) : 0.f;
1223 // Retrieve the alpha value for the text.
1224 inputAlphaValue = static_cast<float>(*(inputPixelBuffer + index)) / 255.f;
1228 // The input buffer is not an alpha mask. Retrieve the color.
1229 textColor[0u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 0u));
1230 textColor[1u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 1u));
1231 textColor[2u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 2u));
1232 textColor[3u] = TO_FLOAT * static_cast<float>(*(inputPixelBuffer + index + 3u));
1233 inputAlphaValue = textColor[3u];
1234 inputShadowOffsetAlphaValue = isValidShadowIndex ? TO_FLOAT * static_cast<float>(*(inputPixelBuffer + shadowIndex + 3u)) : 0.f;
1237 // Build the output color.
1238 float outputColor[4u];
1240 if(shadowParameters.blendShadow)
1242 // Blend the shadow's color with the text's color on top
1243 const float textAlpha = textColor[3u] * inputAlphaValue;
1244 const float shadowAlpha = shadowColor[3u] * inputShadowOffsetAlphaValue;
1246 // Blends the alpha.
1247 outputColor[3u] = 1.f - ((1.f - textAlpha) * (1.f - shadowAlpha));
1248 const bool isOutputAlphaZero = outputColor[3u] < Dali::Math::MACHINE_EPSILON_1000;
1249 if(isOutputAlphaZero)
1251 std::fill(outputColor, outputColor + 4u, 0.f);
1255 // Blends the RGB components.
1256 float shadowComponent = 0.f;
1257 float textComponent = 0.f;
1259 shadowComponent = shadowColor[0u] * inputShadowOffsetAlphaValue;
1260 textComponent = textColor[0u] * inputAlphaValue;
1261 outputColor[0u] = (textComponent * textAlpha / outputColor[3u]) + (shadowComponent * shadowAlpha * (1.f - textAlpha) / outputColor[3u]);
1263 shadowComponent = shadowColor[1u] * inputShadowOffsetAlphaValue;
1264 textComponent = textColor[1u] * inputAlphaValue;
1265 outputColor[1u] = (textComponent * textAlpha / outputColor[3u]) + (shadowComponent * shadowAlpha * (1.f - textAlpha) / outputColor[3u]);
1267 shadowComponent = shadowColor[2u] * inputShadowOffsetAlphaValue;
1268 textComponent = textColor[2u] * inputAlphaValue;
1269 outputColor[2u] = (textComponent * textAlpha / outputColor[3u]) + (shadowComponent * shadowAlpha * (1.f - textAlpha) / outputColor[3u]);
1275 std::fill(outputColor, outputColor + 4u, 0.f);
1277 const float textAlpha = textColor[3u];
1278 const float shadowAlpha = shadowColor[3u] * inputShadowOffsetAlphaValue;
1280 // Write shadow first.
1281 if(shadowAlpha > Dali::Math::MACHINE_EPSILON_1000)
1283 outputColor[0u] = shadowColor[0u] * inputShadowOffsetAlphaValue;
1284 outputColor[1u] = shadowColor[1u] * inputShadowOffsetAlphaValue;
1285 outputColor[2u] = shadowColor[2u] * inputShadowOffsetAlphaValue;
1286 outputColor[3u] = shadowAlpha;
1289 // Write character on top.
1290 if(textAlpha > Dali::Math::MACHINE_EPSILON_1000)
1292 outputColor[0u] = textColor[0u];
1293 outputColor[1u] = textColor[1u];
1294 outputColor[2u] = textColor[2u];
1295 outputColor[3u] = textAlpha;
1299 // Write the color into the output pixel buffer.
1300 const unsigned int outputIndex = 4u * (rows + columnIndex);
1301 *(outputPixelBufferPtr + outputIndex + 0u) = static_cast<unsigned char>(TO_UCHAR * outputColor[0u]);
1302 *(outputPixelBufferPtr + outputIndex + 1u) = static_cast<unsigned char>(TO_UCHAR * outputColor[1u]);
1303 *(outputPixelBufferPtr + outputIndex + 2u) = static_cast<unsigned char>(TO_UCHAR * outputColor[2u]);
1304 *(outputPixelBufferPtr + outputIndex + 3u) = static_cast<unsigned char>(TO_UCHAR * outputColor[3u]);
1308 // Returns the pixel buffer.
1309 return outputPixelBuffer;
1312 Devel::PixelBuffer ConvertToRgba8888(Devel::PixelBuffer pixelBuffer, const Vector4& color, bool multiplyByAlpha)
1314 if(Dali::Pixel::A8 != pixelBuffer.GetPixelFormat())
1320 const unsigned int width = pixelBuffer.GetWidth();
1321 const unsigned int height = pixelBuffer.GetHeight();
1322 Devel::PixelBuffer newPixelBuffer = Devel::PixelBuffer::New(width, height, Dali::Pixel::RGBA8888);
1324 unsigned char* dstBuffer = newPixelBuffer.GetBuffer();
1325 const unsigned char* const srcBuffer = pixelBuffer.GetBuffer();
1327 const unsigned char r = static_cast<unsigned char>(TO_UCHAR * color.r);
1328 const unsigned char g = static_cast<unsigned char>(TO_UCHAR * color.g);
1329 const unsigned char b = static_cast<unsigned char>(TO_UCHAR * color.b);
1331 unsigned char dstColor[4];
1332 for(unsigned int j = 0u; j < height; ++j)
1334 const unsigned int lineIndex = j * width;
1335 for(unsigned int i = 0u; i < width; ++i)
1337 const unsigned int srcIndex = lineIndex + i;
1339 const float srcAlpha = static_cast<float>(*(srcBuffer + srcIndex));
1343 dstColor[0u] = static_cast<unsigned char>(srcAlpha * color.r);
1344 dstColor[1u] = static_cast<unsigned char>(srcAlpha * color.g);
1345 dstColor[2u] = static_cast<unsigned char>(srcAlpha * color.b);
1346 dstColor[3u] = static_cast<unsigned char>(srcAlpha * color.a);
1353 dstColor[3u] = static_cast<unsigned char>(srcAlpha);
1356 const unsigned int dstIndex = srcIndex * 4u;
1357 memcpy(dstBuffer + dstIndex, dstColor, 4u);
1361 return newPixelBuffer;
1364 void UpdateBuffer(Devel::PixelBuffer src, Devel::PixelBuffer dst, unsigned int x, unsigned int y, bool blend)
1366 const Dali::Pixel::Format pixelFormat = dst.GetPixelFormat();
1367 if(src.GetPixelFormat() != pixelFormat)
1369 DALI_LOG_ERROR("PixelBuffer::SetBuffer. The pixel format of the new data must be the same of the current pixel buffer.");
1373 const unsigned int srcWidth = src.GetWidth();
1374 const unsigned int srcHeight = src.GetHeight();
1375 const unsigned int dstWidth = dst.GetWidth();
1376 const unsigned int dstHeight = dst.GetHeight();
1378 if((x > dstWidth) ||
1380 (x + srcWidth > dstWidth) ||
1381 (y + srcHeight > dstHeight))
1383 DALI_LOG_ERROR("PixelBuffer::SetBuffer. The source pixel buffer is out of the boundaries of the destination pixel buffer.");
1387 const unsigned int bytesPerPixel = Dali::Pixel::GetBytesPerPixel(pixelFormat);
1388 if(bytesPerPixel == 0u || bytesPerPixel == 12u || bytesPerPixel == 24u)
1392 const unsigned int alphaIndex = bytesPerPixel - 1u;
1394 const unsigned char* const srcBuffer = src.GetBuffer();
1395 unsigned char* dstBuffer = dst.GetBuffer();
1399 const unsigned int currentLineSize = dstWidth * bytesPerPixel;
1400 const unsigned int newLineSize = srcWidth * bytesPerPixel;
1401 unsigned char* currentBuffer = dstBuffer + (y * dstWidth + x) * bytesPerPixel;
1402 for(unsigned int j = 0u; j < srcHeight; ++j)
1404 memcpy(currentBuffer + j * currentLineSize, srcBuffer + j * newLineSize, newLineSize);
1409 float outputColor[4u];
1411 // Blend the src pixel buffer with the dst pixel buffer as background.
1413 // fgColor, fgAlpha, bgColor, bgAlpha
1415 // alpha = 1 - ( 1 - fgAlpha ) * ( 1 - bgAlpha )
1416 // color = ( fgColor * fgAlpha / alpha ) + ( bgColor * bgAlpha * ( 1 - fgAlpha ) / alpha )
1418 // Jump till the 'x,y' position
1419 const unsigned int dstWidthBytes = dstWidth * bytesPerPixel;
1420 dstBuffer += (y * dstWidthBytes + x * bytesPerPixel);
1422 for(unsigned int j = 0u; j < srcHeight; ++j)
1424 const unsigned int srcLineIndex = j * srcWidth;
1425 for(unsigned int i = 0u; i < srcWidth; ++i)
1427 const float srcAlpha = TO_FLOAT * static_cast<float>(*(srcBuffer + bytesPerPixel * (srcLineIndex + i) + alphaIndex));
1428 const float dstAlpha = TO_FLOAT * static_cast<float>(*(dstBuffer + i * bytesPerPixel + alphaIndex));
1430 // Blends the alpha channel.
1431 const float oneMinusSrcAlpha = 1.f - srcAlpha;
1432 outputColor[alphaIndex] = 1.f - (oneMinusSrcAlpha * (1.f - dstAlpha));
1434 // Blends the RGB channels.
1435 const bool isOutputAlphaZero = outputColor[alphaIndex] < Dali::Math::MACHINE_EPSILON_1000;
1436 if(isOutputAlphaZero)
1438 std::fill(outputColor, outputColor + bytesPerPixel, 0.f);
1442 const float srcAlphaOverOutputAlpha = srcAlpha / outputColor[alphaIndex]; // fgAlpha / alpha
1443 const float dstAlphaOneMinusSrcAlphaOverOutputAlpha = dstAlpha * oneMinusSrcAlpha / outputColor[alphaIndex]; // bgAlpha * ( 1 - fgAlpha ) / alpha
1444 for(unsigned int index = 0u; index < alphaIndex; ++index)
1446 const float dstComponent = TO_FLOAT * static_cast<float>(*(dstBuffer + i * bytesPerPixel + index)) * dstAlpha;
1447 const float srcComponent = TO_FLOAT * static_cast<float>(*(srcBuffer + bytesPerPixel * (srcLineIndex + i) + index)) * srcAlpha;
1448 outputColor[index] = (srcComponent * srcAlphaOverOutputAlpha) + (dstComponent * dstAlphaOneMinusSrcAlphaOverOutputAlpha);
1452 for(unsigned int index = 0u; index < bytesPerPixel; ++index)
1454 *(dstBuffer + i * bytesPerPixel + index) = static_cast<unsigned char>(TO_UCHAR * outputColor[index]);
1458 dstBuffer += dstWidthBytes;
1463 Dali::Property::Array RenderForLastIndex(RendererParameters& textParameters)
1465 Property::Array offsetValues;
1466 if(textParameters.text.empty())
1468 return offsetValues;
1470 FontClient fontClient = FontClient::Get();
1472 metrics = Metrics::New(fontClient);
1474 Text::ModelPtr textModel = Text::Model::New();
1475 InternalDataModel internalData(fontClient, metrics, textModel);
1477 TextAbstraction::TextRenderer::Parameters rendererParameters(textModel->mVisualModel->mGlyphs,
1478 textModel->mVisualModel->mGlyphPositions,
1479 textModel->mVisualModel->mColors,
1480 textModel->mVisualModel->mColorIndices,
1481 internalData.blendingMode,
1482 internalData.isEmoji);
1484 rendererParameters.width = textParameters.textWidth;
1485 rendererParameters.height = textParameters.textHeight;
1487 ////////////////////////////////////////////////////////////////////////////////
1488 // Process the markup string if the mark-up processor is enabled.
1489 ////////////////////////////////////////////////////////////////////////////////
1490 ShapeTextPreprocess(textParameters, rendererParameters, internalData);
1492 ////////////////////////////////////////////////////////////////////////////////
1493 // Retrieve the glyphs. Text shaping
1494 ////////////////////////////////////////////////////////////////////////////////
1495 Dali::Vector<Dali::Toolkit::DevelText::EmbeddedItemInfo> embeddedItemLayout;
1496 ShapeText(rendererParameters, embeddedItemLayout, internalData);
1498 ////////////////////////////////////////////////////////////////////////////////
1499 // Retrieve the glyph's metrics.
1500 ////////////////////////////////////////////////////////////////////////////////
1501 metrics->GetGlyphMetrics(rendererParameters.glyphs.Begin(), internalData.numberOfGlyphs);
1503 ////////////////////////////////////////////////////////////////////////////////
1505 ////////////////////////////////////////////////////////////////////////////////
1506 int boundingBox = textParameters.textHeight - (textParameters.padding.top + textParameters.padding.bottom);
1507 textParameters.textHeight = MAX_INT; // layout for the entire area.
1508 LayoutText(textParameters, rendererParameters, embeddedItemLayout, internalData);
1510 ////////////////////////////////////////////////////////////////////////////////
1511 // Calculation last character index
1512 ////////////////////////////////////////////////////////////////////////////////
1513 Vector<LineRun>& lines = internalData.textModel->mVisualModel->mLines;
1514 unsigned int numberOfLines = lines.Count();
1515 int numberOfCharacters = 0;
1517 float lineSize = internalData.layoutEngine.GetDefaultLineSize();
1518 float lineOffset = 0.f;
1519 for(unsigned int index = 0u; index < numberOfLines; ++index)
1521 const LineRun& line = *(lines.Begin() + index);
1522 numberOfCharacters += line.characterRun.numberOfCharacters;
1524 lineOffset = lineSize > 0.f ? lineSize : (line.ascender + -line.descender);
1526 if((penY + lineOffset) > boundingBox)
1528 offsetValues.PushBack(numberOfCharacters);
1534 // add remain character index
1535 offsetValues.PushBack(numberOfCharacters);
1538 return offsetValues;
1541 Dali::Property::Array GetLastCharacterIndex(RendererParameters& textParameters)
1543 Dali::Property::Array offsetValues = Toolkit::DevelText::RenderForLastIndex(textParameters);
1544 return offsetValues;
1547 } // namespace DevelText
1549 } // namespace Toolkit