DALi Version 2.1.32
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / text / text-visual.cpp
1 /*
2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali-toolkit/internal/visuals/text/text-visual.h>
20
21 // EXTERNAL INCLUDES
22 #include <dali/devel-api/adaptor-framework/image-loading.h>
23 #include <dali/devel-api/images/pixel-data-devel.h>
24 #include <dali/devel-api/rendering/renderer-devel.h>
25 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
26 #include <dali/integration-api/debug.h>
27 #include <string.h>
28
29 // INTERNAL HEADER
30 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
31 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
32 #include <dali-toolkit/devel-api/visuals/text-visual-properties-devel.h>
33 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
34 #include <dali-toolkit/internal/text/script-run.h>
35 #include <dali-toolkit/internal/text/text-effects-style.h>
36 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
37 #include <dali-toolkit/internal/text/text-font-style.h>
38 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
39 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
40 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
41 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
42 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
43 #include <dali-toolkit/public-api/visuals/visual-properties.h>
44
45 namespace Dali
46 {
47 namespace Toolkit
48 {
49 namespace Internal
50 {
51 namespace
52 {
53 const int CUSTOM_PROPERTY_COUNT(5); // anim,premul,size,offset,multicol
54
55 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
56
57 /**
58  * Return Property index for the given string key
59  * param[in] stringKey the string index key
60  * return the key as an index
61  */
62
63 Dali::Property::Index StringKeyToIndexKey(const std::string& stringKey)
64 {
65   Dali::Property::Index result = Property::INVALID_KEY;
66
67   if(stringKey == VISUAL_TYPE)
68   {
69     result = Toolkit::Visual::Property::TYPE;
70   }
71   else if(stringKey == TEXT_PROPERTY)
72   {
73     result = Toolkit::TextVisual::Property::TEXT;
74   }
75   else if(stringKey == FONT_FAMILY_PROPERTY)
76   {
77     result = Toolkit::TextVisual::Property::FONT_FAMILY;
78   }
79   else if(stringKey == FONT_STYLE_PROPERTY)
80   {
81     result = Toolkit::TextVisual::Property::FONT_STYLE;
82   }
83   else if(stringKey == POINT_SIZE_PROPERTY)
84   {
85     result = Toolkit::TextVisual::Property::POINT_SIZE;
86   }
87   else if(stringKey == MULTI_LINE_PROPERTY)
88   {
89     result = Toolkit::TextVisual::Property::MULTI_LINE;
90   }
91   else if(stringKey == HORIZONTAL_ALIGNMENT_PROPERTY)
92   {
93     result = Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT;
94   }
95   else if(stringKey == VERTICAL_ALIGNMENT_PROPERTY)
96   {
97     result = Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT;
98   }
99   else if(stringKey == TEXT_COLOR_PROPERTY)
100   {
101     result = Toolkit::TextVisual::Property::TEXT_COLOR;
102   }
103   else if(stringKey == ENABLE_MARKUP_PROPERTY)
104   {
105     result = Toolkit::TextVisual::Property::ENABLE_MARKUP;
106   }
107   else if(stringKey == SHADOW_PROPERTY)
108   {
109     result = Toolkit::TextVisual::Property::SHADOW;
110   }
111   else if(stringKey == UNDERLINE_PROPERTY)
112   {
113     result = Toolkit::TextVisual::Property::UNDERLINE;
114   }
115   else if(stringKey == OUTLINE_PROPERTY)
116   {
117     result = Toolkit::DevelTextVisual::Property::OUTLINE;
118   }
119   else if(stringKey == BACKGROUND_PROPERTY)
120   {
121     result = Toolkit::DevelTextVisual::Property::BACKGROUND;
122   }
123
124   return result;
125 }
126
127 void TextColorConstraint(Vector4& current, const PropertyInputContainer& inputs)
128 {
129   Vector4 color = inputs[0]->GetVector4();
130   current.r     = color.r * color.a;
131   current.g     = color.g * color.a;
132   current.b     = color.b * color.a;
133   current.a     = color.a;
134 }
135
136 void OpacityConstraint(float& current, const PropertyInputContainer& inputs)
137 {
138   // Make zero if the alpha value of text color is zero to skip rendering text
139   if(EqualsZero(inputs[0]->GetVector4().a))
140   {
141     current = 0.0f;
142   }
143   else
144   {
145     current = 1.0f;
146   }
147 }
148
149 } // unnamed namespace
150
151 TextVisualPtr TextVisual::New(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory, const Property::Map& properties)
152 {
153   TextVisualPtr textVisualPtr(new TextVisual(factoryCache, shaderFactory));
154   textVisualPtr->SetProperties(properties);
155   textVisualPtr->Initialize();
156   return textVisualPtr;
157 }
158
159 Property::Map TextVisual::ConvertStringKeysToIndexKeys(const Property::Map& propertyMap)
160 {
161   Property::Map outMap;
162
163   for(Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index)
164   {
165     const KeyValuePair& keyValue = propertyMap.GetKeyValue(index);
166
167     Property::Index indexKey = keyValue.first.indexKey;
168
169     if(keyValue.first.type == Property::Key::STRING)
170     {
171       indexKey = StringKeyToIndexKey(keyValue.first.stringKey);
172     }
173
174     outMap.Insert(indexKey, keyValue.second);
175   }
176
177   return outMap;
178 }
179
180 float TextVisual::GetHeightForWidth(float width)
181 {
182   return mController->GetHeightForWidth(width);
183 }
184
185 void TextVisual::GetNaturalSize(Vector2& naturalSize)
186 {
187   naturalSize = mController->GetNaturalSize().GetVectorXY();
188 }
189
190 void TextVisual::DoCreatePropertyMap(Property::Map& map) const
191 {
192   Property::Value value;
193
194   map.Clear();
195   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
196
197   std::string text;
198   mController->GetText(text);
199   map.Insert(Toolkit::TextVisual::Property::TEXT, text);
200
201   map.Insert(Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily());
202
203   GetFontStyleProperty(mController, value, Text::FontStyle::DEFAULT);
204   map.Insert(Toolkit::TextVisual::Property::FONT_STYLE, value);
205
206   map.Insert(Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultFontSize(Text::Controller::POINT_SIZE));
207
208   map.Insert(Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled());
209
210   map.Insert(Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, mController->GetHorizontalAlignment());
211
212   map.Insert(Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, mController->GetVerticalAlignment());
213
214   map.Insert(Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor());
215
216   map.Insert(Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled());
217
218   GetShadowProperties(mController, value, Text::EffectStyle::DEFAULT);
219   map.Insert(Toolkit::TextVisual::Property::SHADOW, value);
220
221   GetUnderlineProperties(mController, value, Text::EffectStyle::DEFAULT);
222   map.Insert(Toolkit::TextVisual::Property::UNDERLINE, value);
223
224   GetOutlineProperties(mController, value, Text::EffectStyle::DEFAULT);
225   map.Insert(Toolkit::DevelTextVisual::Property::OUTLINE, value);
226
227   GetBackgroundProperties(mController, value, Text::EffectStyle::DEFAULT);
228   map.Insert(Toolkit::DevelTextVisual::Property::BACKGROUND, value);
229
230   GetStrikethroughProperties(mController, value, Text::EffectStyle::DEFAULT);
231   map.Insert(Toolkit::DevelTextVisual::Property::STRIKETHROUGH, value);
232 }
233
234 void TextVisual::DoCreateInstancePropertyMap(Property::Map& map) const
235 {
236   map.Clear();
237   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
238   std::string text;
239   mController->GetText(text);
240   map.Insert(Toolkit::TextVisual::Property::TEXT, text);
241 }
242
243 void TextVisual::EnablePreMultipliedAlpha(bool preMultiplied)
244 {
245   // Make always enable pre multiplied alpha whether preMultiplied value is false.
246   if(!preMultiplied)
247   {
248     DALI_LOG_WARNING("Note : TextVisual cannot disable PreMultipliedAlpha\n");
249   }
250 }
251
252 TextVisual::TextVisual(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory)
253 : Visual::Base(factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO, Toolkit::Visual::TEXT),
254   mController(Text::Controller::New()),
255   mTypesetter(Text::Typesetter::New(mController->GetTextModel())),
256   mTextVisualShaderFactory(shaderFactory),
257   mTextShaderFeatureCache(),
258   mAnimatableTextColorPropertyIndex(Property::INVALID_INDEX),
259   mTextColorAnimatableIndex(Property::INVALID_INDEX),
260   mRendererUpdateNeeded(false)
261 {
262   // Enable the pre-multiplied alpha to improve the text quality
263   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
264 }
265
266 TextVisual::~TextVisual()
267 {
268 }
269
270 void TextVisual::OnInitialize()
271 {
272   Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
273   Shader   shader   = GetTextShader(mFactoryCache, TextVisualShaderFeature::FeatureBuilder());
274
275   mImpl->mRenderer = VisualRenderer::New(geometry, shader);
276   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
277 }
278
279 void TextVisual::DoSetProperties(const Property::Map& propertyMap)
280 {
281   for(Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index)
282   {
283     const KeyValuePair& keyValue = propertyMap.GetKeyValue(index);
284
285     Property::Index indexKey = keyValue.first.indexKey;
286
287     if(keyValue.first.type == Property::Key::STRING)
288     {
289       indexKey = StringKeyToIndexKey(keyValue.first.stringKey);
290     }
291
292     DoSetProperty(indexKey, keyValue.second);
293   }
294
295   // Elide the text if it exceeds the boundaries.
296   mController->SetTextElideEnabled(true);
297
298   // Retrieve the layout engine to set the cursor's width.
299   Text::Layout::Engine& engine = mController->GetLayoutEngine();
300
301   // Sets 0 as cursor's width.
302   engine.SetCursorWidth(0u); // Do not layout space for the cursor.
303 }
304
305 void TextVisual::DoSetOnScene(Actor& actor)
306 {
307   mControl = actor;
308
309   mImpl->mRenderer.SetProperty(Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT);
310
311   const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
312   if(mTextColorAnimatableIndex == Property::INVALID_INDEX)
313   {
314     mTextColorAnimatableIndex = mImpl->mRenderer.RegisterUniqueProperty("uTextColorAnimatable", defaultColor);
315   }
316   else
317   {
318     mImpl->mRenderer.SetProperty(mTextColorAnimatableIndex, defaultColor);
319   }
320
321   if(mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX)
322   {
323     // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
324     if(mTextColorAnimatableIndex != Property::INVALID_INDEX)
325     {
326       if(!mColorConstraint)
327       {
328         mColorConstraint = Constraint::New<Vector4>(mImpl->mRenderer, mTextColorAnimatableIndex, TextColorConstraint);
329         mColorConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
330       }
331       mColorConstraint.Apply();
332     }
333
334     // Make zero if the alpha value of text color is zero to skip rendering text
335     if(!mOpacityConstraint)
336     {
337       // VisualRenderer::Property::OPACITY uses same animatable property internally.
338       mOpacityConstraint = Constraint::New<float>(mImpl->mRenderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint);
339       mOpacityConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
340     }
341     mOpacityConstraint.Apply();
342   }
343
344   // Renderer needs textures and to be added to control
345   mRendererUpdateNeeded = true;
346
347   UpdateRenderer();
348 }
349
350 void TextVisual::RemoveRenderer(Actor& actor)
351 {
352   for(RendererContainer::iterator iter = mRendererList.begin(); iter != mRendererList.end(); ++iter)
353   {
354     Renderer renderer = (*iter);
355     if(renderer)
356     {
357       // Removes the renderer from the actor.
358       actor.RemoveRenderer(renderer);
359     }
360   }
361   // Clear the renderer list
362   mRendererList.clear();
363 }
364
365 void TextVisual::DoSetOffScene(Actor& actor)
366 {
367   if(mColorConstraint)
368   {
369     mColorConstraint.Remove();
370   }
371   if(mOpacityConstraint)
372   {
373     mOpacityConstraint.Remove();
374   }
375
376   RemoveRenderer(actor);
377
378   // Resets the control handle.
379   mControl.Reset();
380 }
381
382 void TextVisual::OnSetTransform()
383 {
384   UpdateRenderer();
385 }
386
387 void TextVisual::DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue)
388 {
389   switch(index)
390   {
391     case Toolkit::TextVisual::Property::ENABLE_MARKUP:
392     {
393       const bool enableMarkup = propertyValue.Get<bool>();
394       mController->SetMarkupProcessorEnabled(enableMarkup);
395       break;
396     }
397     case Toolkit::TextVisual::Property::TEXT:
398     {
399       mController->SetText(propertyValue.Get<std::string>());
400       break;
401     }
402     case Toolkit::TextVisual::Property::FONT_FAMILY:
403     {
404       SetFontFamilyProperty(mController, propertyValue);
405       break;
406     }
407     case Toolkit::TextVisual::Property::FONT_STYLE:
408     {
409       SetFontStyleProperty(mController, propertyValue, Text::FontStyle::DEFAULT);
410       break;
411     }
412     case Toolkit::TextVisual::Property::POINT_SIZE:
413     {
414       const float pointSize = propertyValue.Get<float>();
415       if(!Equals(mController->GetDefaultFontSize(Text::Controller::POINT_SIZE), pointSize))
416       {
417         mController->SetDefaultFontSize(pointSize, Text::Controller::POINT_SIZE);
418       }
419       break;
420     }
421     case Toolkit::TextVisual::Property::MULTI_LINE:
422     {
423       mController->SetMultiLineEnabled(propertyValue.Get<bool>());
424       break;
425     }
426     case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
427     {
428       if(mController)
429       {
430         Text::HorizontalAlignment::Type alignment(static_cast<Text::HorizontalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
431         if(Toolkit::Text::GetHorizontalAlignmentEnumeration(propertyValue, alignment))
432         {
433           mController->SetHorizontalAlignment(alignment);
434         }
435       }
436       break;
437     }
438     case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
439     {
440       if(mController)
441       {
442         Toolkit::Text::VerticalAlignment::Type alignment(static_cast<Text::VerticalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
443         if(Toolkit::Text::GetVerticalAlignmentEnumeration(propertyValue, alignment))
444         {
445           mController->SetVerticalAlignment(alignment);
446         }
447       }
448       break;
449     }
450     case Toolkit::TextVisual::Property::TEXT_COLOR:
451     {
452       const Vector4& textColor = propertyValue.Get<Vector4>();
453       if(mController->GetDefaultColor() != textColor)
454       {
455         mController->SetDefaultColor(textColor);
456       }
457       break;
458     }
459     case Toolkit::TextVisual::Property::SHADOW:
460     {
461       SetShadowProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
462       break;
463     }
464     case Toolkit::TextVisual::Property::UNDERLINE:
465     {
466       SetUnderlineProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
467       break;
468     }
469     case Toolkit::DevelTextVisual::Property::OUTLINE:
470     {
471       SetOutlineProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
472       break;
473     }
474     case Toolkit::DevelTextVisual::Property::BACKGROUND:
475     {
476       SetBackgroundProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
477       break;
478     }
479     case Toolkit::DevelTextVisual::Property::STRIKETHROUGH:
480     {
481       SetStrikethroughProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
482       break;
483     }
484   }
485 }
486
487 void TextVisual::UpdateRenderer()
488 {
489   Actor control = mControl.GetHandle();
490   if(!control)
491   {
492     // Nothing to do.
493     return;
494   }
495
496   // Calculates the size to be used to relayout.
497   Vector2 relayoutSize;
498
499   const bool isWidthRelative  = fabsf(mImpl->mTransform.mOffsetSizeMode.z) < Math::MACHINE_EPSILON_1000;
500   const bool isHeightRelative = fabsf(mImpl->mTransform.mOffsetSizeMode.w) < Math::MACHINE_EPSILON_1000;
501
502   // Round the size and offset to avoid pixel alignement issues.
503   relayoutSize.width  = floorf(0.5f + (isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width));
504   relayoutSize.height = floorf(0.5f + (isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height));
505
506   std::string text;
507   mController->GetText(text);
508
509   if((fabsf(relayoutSize.width) < Math::MACHINE_EPSILON_1000) || (fabsf(relayoutSize.height) < Math::MACHINE_EPSILON_1000) || text.empty())
510   {
511     // Remove the texture set and any renderer previously set.
512     RemoveRenderer(control);
513
514     // Nothing else to do if the relayout size is zero.
515     ResourceReady(Toolkit::Visual::ResourceStatus::READY);
516     return;
517   }
518
519   Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(control);
520
521   const Text::Controller::UpdateTextType updateTextType = mController->Relayout(relayoutSize, layoutDirection);
522
523   if(Text::Controller::NONE_UPDATED != (Text::Controller::MODEL_UPDATED & updateTextType) || mRendererUpdateNeeded)
524   {
525     mRendererUpdateNeeded = false;
526
527     // Remove the texture set and any renderer previously set.
528     RemoveRenderer(control);
529
530     if((relayoutSize.width > Math::MACHINE_EPSILON_1000) &&
531        (relayoutSize.height > Math::MACHINE_EPSILON_1000))
532     {
533       // Check whether it is a markup text with multiple text colors
534       const Vector4* const colorsBuffer          = mController->GetTextModel()->GetColors();
535       bool                 hasMultipleTextColors = (NULL != colorsBuffer);
536
537       // Check whether the text contains any color glyph
538       bool containsColorGlyph = false;
539
540       TextAbstraction::FontClient  fontClient     = TextAbstraction::FontClient::Get();
541       const Text::GlyphInfo* const glyphsBuffer   = mController->GetTextModel()->GetGlyphs();
542       const Text::Length           numberOfGlyphs = mController->GetTextModel()->GetNumberOfGlyphs();
543       for(Text::Length glyphIndex = 0; glyphIndex < numberOfGlyphs; glyphIndex++)
544       {
545         // Retrieve the glyph's info.
546         const Text::GlyphInfo* const glyphInfo = glyphsBuffer + glyphIndex;
547
548         // Whether the current glyph is a color one.
549         if(fontClient.IsColorGlyph(glyphInfo->fontId, glyphInfo->index))
550         {
551           containsColorGlyph = true;
552           break;
553         }
554       }
555
556       // Check whether the text contains any style colors (e.g. underline color, shadow color, etc.)
557
558       bool           shadowEnabled = false;
559       const Vector2& shadowOffset  = mController->GetTextModel()->GetShadowOffset();
560       if(fabsf(shadowOffset.x) > Math::MACHINE_EPSILON_1 || fabsf(shadowOffset.y) > Math::MACHINE_EPSILON_1)
561       {
562         shadowEnabled = true;
563       }
564
565       const bool outlineEnabled             = (mController->GetTextModel()->GetOutlineWidth() > Math::MACHINE_EPSILON_1);
566       const bool backgroundEnabled          = mController->GetTextModel()->IsBackgroundEnabled();
567       const bool markupProcessorEnabled     = mController->IsMarkupProcessorEnabled();
568       const bool markupUnderlineEnabled     = markupProcessorEnabled && mController->GetTextModel()->IsMarkupUnderlineSet();
569       const bool markupStrikethroughEnabled = markupProcessorEnabled && mController->GetTextModel()->IsMarkupStrikethroughSet();
570       const bool underlineEnabled           = mController->GetTextModel()->IsUnderlineEnabled() || markupUnderlineEnabled;
571       const bool strikethroughEnabled       = mController->GetTextModel()->IsStrikethroughEnabled() || markupStrikethroughEnabled;
572       const bool styleEnabled   = (shadowEnabled || outlineEnabled || backgroundEnabled || markupProcessorEnabled);
573       const bool isOverlayStyle = underlineEnabled || strikethroughEnabled;
574
575       AddRenderer(control, relayoutSize, hasMultipleTextColors, containsColorGlyph, styleEnabled, isOverlayStyle);
576
577       // Text rendered and ready to display
578       ResourceReady(Toolkit::Visual::ResourceStatus::READY);
579     }
580   }
581 }
582
583 void TextVisual::AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex)
584 {
585   Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D,
586                                  data.GetPixelFormat(),
587                                  data.GetWidth(),
588                                  data.GetHeight());
589   texture.Upload(data);
590
591   textureSet.SetTexture(textureSetIndex, texture);
592   textureSet.SetSampler(textureSetIndex, sampler);
593 }
594
595 PixelData TextVisual::ConvertToPixelData(unsigned char* buffer, int width, int height, int offsetPosition, const Pixel::Format textPixelFormat)
596 {
597   int            bpp        = Pixel::GetBytesPerPixel(textPixelFormat);
598   unsigned int   bufferSize = width * height * bpp;
599   unsigned char* dstBuffer  = static_cast<unsigned char*>(malloc(bufferSize));
600   memcpy(dstBuffer, buffer + offsetPosition * bpp, bufferSize);
601   PixelData pixelData = Dali::PixelData::New(dstBuffer,
602                                              bufferSize,
603                                              width,
604                                              height,
605                                              textPixelFormat,
606                                              Dali::PixelData::FREE);
607   return pixelData;
608 }
609
610 void TextVisual::CreateTextureSet(TilingInfo& info, VisualRenderer& renderer, Sampler& sampler)
611 {
612   TextureSet   textureSet      = TextureSet::New();
613   unsigned int textureSetIndex = 0u;
614
615   // Convert the buffer to pixel data to make it a texture.
616
617   if(info.textBuffer)
618   {
619     PixelData data = ConvertToPixelData(info.textBuffer, info.width, info.height, info.offsetPosition, info.textPixelFormat);
620     AddTexture(textureSet, data, sampler, textureSetIndex);
621     ++textureSetIndex;
622   }
623
624   if(mTextShaderFeatureCache.IsEnabledStyle() && info.styleBuffer)
625   {
626     PixelData styleData = ConvertToPixelData(info.styleBuffer, info.width, info.height, info.offsetPosition, Pixel::RGBA8888);
627     AddTexture(textureSet, styleData, sampler, textureSetIndex);
628     ++textureSetIndex;
629   }
630
631   if(mTextShaderFeatureCache.IsEnabledOverlay() && info.overlayStyleBuffer)
632   {
633     PixelData overlayStyleData = ConvertToPixelData(info.overlayStyleBuffer, info.width, info.height, info.offsetPosition, Pixel::RGBA8888);
634     AddTexture(textureSet, overlayStyleData, sampler, textureSetIndex);
635     ++textureSetIndex;
636   }
637
638   if(mTextShaderFeatureCache.IsEnabledEmoji() && !mTextShaderFeatureCache.IsEnabledMultiColor() && info.maskBuffer)
639   {
640     PixelData maskData = ConvertToPixelData(info.maskBuffer, info.width, info.height, info.offsetPosition, Pixel::L8);
641     AddTexture(textureSet, maskData, sampler, textureSetIndex);
642   }
643
644   renderer.SetTextures(textureSet);
645
646   //Register transform properties
647   mImpl->mTransform.SetUniforms(renderer, Direction::LEFT_TO_RIGHT);
648
649   // Enable the pre-multiplied alpha to improve the text quality
650   renderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, true);
651   renderer.RegisterProperty(PREMULTIPLIED_ALPHA, 1.0f);
652
653   // Set size and offset for the tiling.
654   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_SIZE, Vector2(info.width, info.height));
655   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_OFFSET, Vector2(info.offSet.x, info.offSet.y));
656   renderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
657   renderer.RegisterProperty("uHasMultipleTextColors", static_cast<float>(mTextShaderFeatureCache.IsEnabledMultiColor()));
658
659   mRendererList.push_back(renderer);
660 }
661
662 void TextVisual::AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle)
663 {
664   Shader shader = GetTextShader(mFactoryCache, TextVisualShaderFeature::FeatureBuilder().EnableMultiColor(hasMultipleTextColors).EnableEmoji(containsColorGlyph).EnableStyle(styleEnabled).EnableOverlay(isOverlayStyle));
665   mImpl->mRenderer.SetShader(shader);
666
667   // Get the maximum size.
668   const int maxTextureSize = Dali::GetMaxTextureSize();
669
670   // No tiling required. Use the default renderer.
671   if(size.height < maxTextureSize)
672   {
673     TextureSet textureSet = GetTextTexture(size);
674
675     mImpl->mRenderer.SetTextures(textureSet);
676     //Register transform properties
677     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
678     mImpl->mRenderer.RegisterProperty("uHasMultipleTextColors", static_cast<float>(hasMultipleTextColors));
679     mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
680
681     mRendererList.push_back(mImpl->mRenderer);
682   }
683   // If the pixel data exceeds the maximum size, tiling is required.
684   else
685   {
686     // Filter mode needs to be set to linear to produce better quality while scaling.
687     Sampler sampler = Sampler::New();
688     sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
689
690     // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
691     Pixel::Format textPixelFormat = (containsColorGlyph || hasMultipleTextColors) ? Pixel::RGBA8888 : Pixel::L8;
692
693     // Check the text direction
694     Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
695
696     // Create a texture for the text without any styles
697     PixelData data = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat);
698
699     int verifiedWidth  = data.GetWidth();
700     int verifiedHeight = data.GetHeight();
701
702     // Set information for creating textures.
703     TilingInfo info(verifiedWidth, maxTextureSize, textPixelFormat);
704
705     // Get the buffer of text.
706     Dali::DevelPixelData::PixelDataBuffer textPixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(data);
707     info.textBuffer                                     = textPixelData.buffer;
708
709     if(mTextShaderFeatureCache.IsEnabledStyle())
710     {
711       // Create RGBA texture for all the text styles (without the text itself)
712       PixelData                             styleData      = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888);
713       Dali::DevelPixelData::PixelDataBuffer stylePixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(styleData);
714       info.styleBuffer                                     = stylePixelData.buffer;
715     }
716
717     if(mTextShaderFeatureCache.IsEnabledOverlay())
718     {
719       // Create RGBA texture for all the overlay styles
720       PixelData                             overlayStyleData      = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_OVERLAY_STYLE, false, Pixel::RGBA8888);
721       Dali::DevelPixelData::PixelDataBuffer overlayStylePixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(overlayStyleData);
722       info.overlayStyleBuffer                                     = overlayStylePixelData.buffer;
723     }
724
725     if(mTextShaderFeatureCache.IsEnabledEmoji() && !mTextShaderFeatureCache.IsEnabledMultiColor())
726     {
727       // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
728       PixelData                             maskData      = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8);
729       Dali::DevelPixelData::PixelDataBuffer maskPixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(maskData);
730       info.maskBuffer                                     = maskPixelData.buffer;
731     }
732
733     // Get the current offset for recalculate the offset when tiling.
734     Property::Map retMap;
735     mImpl->mTransform.GetPropertyMap(retMap);
736     Property::Value* offsetValue = retMap.Find(Dali::Toolkit::Visual::Transform::Property::OFFSET);
737     if(offsetValue)
738     {
739       offsetValue->Get(info.offSet);
740     }
741
742     // Create a textureset in the default renderer.
743     CreateTextureSet(info, mImpl->mRenderer, sampler);
744
745     verifiedHeight -= maxTextureSize;
746
747     Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
748
749     int offsetPosition = verifiedWidth * maxTextureSize;
750     // Create a renderer by cutting maxTextureSize.
751     while(verifiedHeight > 0)
752     {
753       VisualRenderer tilingRenderer = VisualRenderer::New(geometry, shader);
754       tilingRenderer.SetProperty(Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT);
755       // New offset position of buffer for tiling.
756       info.offsetPosition += offsetPosition;
757       // New height for tiling.
758       info.height = (verifiedHeight - maxTextureSize) > 0 ? maxTextureSize : verifiedHeight;
759       // New offset for tiling.
760       info.offSet.y += maxTextureSize;
761       // Create a textureset int the new tiling renderer.
762       CreateTextureSet(info, tilingRenderer, sampler);
763
764       verifiedHeight -= maxTextureSize;
765     }
766   }
767
768   mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
769
770   const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
771
772   for(RendererContainer::iterator iter = mRendererList.begin(); iter != mRendererList.end(); ++iter)
773   {
774     Renderer renderer = (*iter);
775     if(renderer)
776     {
777       actor.AddRenderer(renderer);
778
779       if(renderer != mImpl->mRenderer)
780       {
781         // Set constraint for text label's color for non-default renderers.
782         if(mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX)
783         {
784           // Register unique property, or get property for default renderer.
785           Property::Index index = renderer.RegisterUniqueProperty("uTextColorAnimatable", defaultColor);
786
787           // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
788           if(index != Property::INVALID_INDEX)
789           {
790             Constraint colorConstraint = Constraint::New<Vector4>(renderer, index, TextColorConstraint);
791             colorConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
792             colorConstraint.Apply();
793           }
794
795           // Make zero if the alpha value of text color is zero to skip rendering text
796           // VisualRenderer::Property::OPACITY uses same animatable property internally.
797           Constraint opacityConstraint = Constraint::New<float>(renderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint);
798           opacityConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
799           opacityConstraint.Apply();
800         }
801       }
802     }
803   }
804 }
805
806 TextureSet TextVisual::GetTextTexture(const Vector2& size)
807 {
808   // Filter mode needs to be set to linear to produce better quality while scaling.
809   Sampler sampler = Sampler::New();
810   sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
811
812   TextureSet textureSet = TextureSet::New();
813
814   // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
815   Pixel::Format textPixelFormat = (mTextShaderFeatureCache.IsEnabledEmoji() || mTextShaderFeatureCache.IsEnabledMultiColor()) ? Pixel::RGBA8888 : Pixel::L8;
816
817   // Check the text direction
818   Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
819
820   // Create a texture for the text without any styles
821   PixelData data = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat);
822
823   // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
824   // In that case, create a texture. TODO: should tile the text.
825   unsigned int textureSetIndex = 0u;
826   AddTexture(textureSet, data, sampler, textureSetIndex);
827   ++textureSetIndex;
828
829   if(mTextShaderFeatureCache.IsEnabledStyle())
830   {
831     // Create RGBA texture for all the text styles that render in the background (without the text itself)
832     PixelData styleData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888);
833     AddTexture(textureSet, styleData, sampler, textureSetIndex);
834     ++textureSetIndex;
835   }
836
837   if(mTextShaderFeatureCache.IsEnabledOverlay())
838   {
839     // Create RGBA texture for overlay styles such as underline and strikethrough (without the text itself)
840     PixelData overlayStyleData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_OVERLAY_STYLE, false, Pixel::RGBA8888);
841     AddTexture(textureSet, overlayStyleData, sampler, textureSetIndex);
842     ++textureSetIndex;
843   }
844
845   if(mTextShaderFeatureCache.IsEnabledEmoji() && !mTextShaderFeatureCache.IsEnabledMultiColor())
846   {
847     // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
848     PixelData maskData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8);
849
850     AddTexture(textureSet, maskData, sampler, textureSetIndex);
851   }
852
853   return textureSet;
854 }
855
856 Shader TextVisual::GetTextShader(VisualFactoryCache& factoryCache, const TextVisualShaderFeature::FeatureBuilder& featureBuilder)
857 {
858   // Cache feature builder informations.
859   mTextShaderFeatureCache = featureBuilder;
860
861   Shader shader = mTextVisualShaderFactory.GetShader(factoryCache, mTextShaderFeatureCache);
862   shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
863   return shader;
864 }
865
866 } // namespace Internal
867
868 } // namespace Toolkit
869
870 } // namespace Dali