dali-toolkit/internal/visuals/svg/svg-visual.cpp

   1 /*
   2  * Copyright (c) 2023 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 "svg-visual.h"
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  23 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
  24 #include <dali-toolkit/internal/visuals/svg/svg-task.h>
  25 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  26 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  27 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  28
  29 // EXTERNAL INCLUDES
  30 #include <dali/devel-api/common/stage.h>
  31 #include <dali/integration-api/debug.h>
  32 #include <dali/public-api/rendering/decorated-visual-renderer.h>
  33
  34 namespace Dali
  35 {
  36 namespace Toolkit
  37 {
  38 namespace Internal
  39 {
  40 namespace
  41 {
  42 const int CUSTOM_PROPERTY_COUNT(1); // atlas
  43
  44 // property name
  45 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
  46
  47 } // namespace
  48
  49 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
  50 {
  51   SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl, ImageDimensions{}));
  52   svgVisual->SetProperties(properties);
  53   svgVisual->Initialize();
  54   return svgVisual;
  55 }
  56
  57 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
  58 {
  59   SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl, size));
  60   svgVisual->Initialize();
  61   return svgVisual;
  62 }
  63
  64 SvgVisual::SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
  65 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::SVG),
  66   mImageVisualShaderFactory(shaderFactory),
  67   mAtlasRect(FULL_TEXTURE_RECT),
  68   mImageUrl(imageUrl),
  69   mVectorRenderer(VectorImageRenderer::New()),
  70   mDefaultWidth(0),
  71   mDefaultHeight(0),
  72   mPlacementActor(),
  73   mRasterizedSize(Vector2::ZERO),
  74   mDesiredSize(size),
  75   mLoadFailed(false),
  76   mAttemptAtlasing(false)
  77 {
  78   // the rasterized image is with pre-multiplied alpha format
  79   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
  80 }
  81
  82 SvgVisual::~SvgVisual()
  83 {
  84   if(Stage::IsInstalled())
  85   {
  86     if(mLoadingTask)
  87     {
  88       Dali::AsyncTaskManager::Get().RemoveTask(mLoadingTask);
  89     }
  90     if(mRasterizingTask)
  91     {
  92       Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
  93     }
  94   }
  95 }
  96
  97 void SvgVisual::OnInitialize()
  98 {
  99   Shader   shader   = GenerateShader();
 100   Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
 101   mImpl->mRenderer  = DecoratedVisualRenderer::New(geometry, shader);
 102   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
 103
 104   Vector2 dpi     = Stage::GetCurrent().GetDpi();
 105   float   meanDpi = (dpi.height + dpi.width) * 0.5f;
 106
 107   mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
 108
 109   if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
 110   {
 111     mLoadingTask->Process();
 112     mLoadingTask.Reset(); // We don't need it now
 113   }
 114   else
 115   {
 116     Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
 117   }
 118 }
 119
 120 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
 121 {
 122   // url already passed in from constructor
 123   for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
 124   {
 125     KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
 126     if(keyValue.first.type == Property::Key::INDEX)
 127     {
 128       DoSetProperty(keyValue.first.indexKey, keyValue.second);
 129     }
 130     else if(keyValue.first == IMAGE_ATLASING)
 131     {
 132       DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
 133     }
 134     else if(keyValue.first == SYNCHRONOUS_LOADING)
 135     {
 136       DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
 137     }
 138     else if(keyValue.first == IMAGE_DESIRED_WIDTH)
 139     {
 140       DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
 141     }
 142     else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
 143     {
 144       DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
 145     }
 146   }
 147 }
 148
 149 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
 150 {
 151   switch(index)
 152   {
 153     case Toolkit::ImageVisual::Property::ATLASING:
 154     {
 155       value.Get(mAttemptAtlasing);
 156       break;
 157     }
 158     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 159     {
 160       bool sync = false;
 161       if(value.Get(sync))
 162       {
 163         if(sync)
 164         {
 165           mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 166         }
 167         else
 168         {
 169           mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 170         }
 171       }
 172       else
 173       {
 174         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
 175       }
 176       break;
 177     }
 178     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 179     {
 180       int32_t desiredWidth = 0;
 181       if(value.Get(desiredWidth))
 182       {
 183         mDesiredSize.SetWidth(desiredWidth);
 184       }
 185       break;
 186     }
 187     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 188     {
 189       int32_t desiredHeight = 0;
 190       if(value.Get(desiredHeight))
 191       {
 192         mDesiredSize.SetHeight(desiredHeight);
 193       }
 194       break;
 195     }
 196   }
 197 }
 198
 199 void SvgVisual::DoSetOnScene(Actor& actor)
 200 {
 201   TextureSet textureSet = TextureSet::New();
 202   mImpl->mRenderer.SetTextures(textureSet);
 203
 204   // Register transform properties
 205   mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 206
 207   // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
 208
 209   // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
 210   mPlacementActor = actor;
 211
 212   if(mLoadFailed)
 213   {
 214     Vector2 imageSize = Vector2::ZERO;
 215     imageSize         = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 216     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 217     actor.AddRenderer(mImpl->mRenderer);
 218
 219     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 220   }
 221   else
 222   {
 223     if(mImpl->mEventObserver)
 224     {
 225       // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
 226       mImpl->mEventObserver->RelayoutRequest(*this);
 227     }
 228   }
 229 }
 230
 231 void SvgVisual::DoSetOffScene(Actor& actor)
 232 {
 233   // Remove loading & rasterizing task
 234   if(mLoadingTask)
 235   {
 236     Dali::AsyncTaskManager::Get().RemoveTask(mLoadingTask);
 237     mLoadingTask.Reset();
 238   }
 239   if(mRasterizingTask)
 240   {
 241     Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
 242     mRasterizingTask.Reset();
 243   }
 244
 245   actor.RemoveRenderer(mImpl->mRenderer);
 246   mPlacementActor.Reset();
 247
 248   // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
 249   mRasterizedSize = Vector2::ZERO;
 250 }
 251
 252 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
 253 {
 254   if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 255   {
 256     naturalSize.x = mDesiredSize.GetWidth();
 257     naturalSize.y = mDesiredSize.GetHeight();
 258   }
 259   else if(mLoadFailed && mImpl->mRenderer)
 260   {
 261     // Load failed, use broken image size
 262     auto textureSet = mImpl->mRenderer.GetTextures();
 263     if(textureSet && textureSet.GetTextureCount())
 264     {
 265       auto texture = textureSet.GetTexture(0);
 266       if(texture)
 267       {
 268         naturalSize.x = texture.GetWidth();
 269         naturalSize.y = texture.GetHeight();
 270         return;
 271       }
 272     }
 273   }
 274   else
 275   {
 276     naturalSize.x = mDefaultWidth;
 277     naturalSize.y = mDefaultHeight;
 278   }
 279 }
 280
 281 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
 282 {
 283   map.Clear();
 284   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
 285   if(mImageUrl.IsValid())
 286   {
 287     map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
 288     map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
 289   }
 290   map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
 291   map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 292   map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 293 }
 294
 295 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 296 {
 297   // Do nothing
 298 }
 299
 300 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
 301 {
 302   // Make always enable pre multiplied alpha whether preMultiplied value is false.
 303   if(!preMultiplied)
 304   {
 305     DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
 306   }
 307 }
 308
 309 void SvgVisual::AddRasterizationTask(const Vector2& size)
 310 {
 311   if(mImpl->mRenderer)
 312   {
 313     unsigned int width  = static_cast<unsigned int>(size.width);
 314     unsigned int height = static_cast<unsigned int>(size.height);
 315
 316     mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
 317
 318     if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
 319     {
 320       mRasterizingTask->Process();
 321       ApplyRasterizedImage(mRasterizingTask);
 322       mRasterizingTask.Reset(); // We don't need it now
 323     }
 324     else
 325     {
 326       Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
 327     }
 328   }
 329 }
 330
 331 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
 332 {
 333   if(task->HasSucceeded())
 334   {
 335     PixelData rasterizedPixelData = task->GetPixelData();
 336     if(mDefaultWidth == 0 || mDefaultHeight == 0)
 337     {
 338       task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
 339     }
 340
 341     // Rasterization success
 342     if(rasterizedPixelData && IsOnScene())
 343     {
 344       mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
 345       mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
 346
 347       TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
 348       if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
 349       {
 350         mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
 351       }
 352
 353       TextureSet textureSet;
 354
 355       if(mAttemptAtlasing && !mImpl->mCustomShader)
 356       {
 357         Vector4 atlasRect;
 358         textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
 359         if(textureSet) // atlasing
 360         {
 361           if(textureSet != currentTextureSet)
 362           {
 363             mImpl->mRenderer.SetTextures(textureSet);
 364           }
 365           mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
 366           mAtlasRect = atlasRect;
 367           mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 368         }
 369       }
 370
 371       if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
 372       {
 373         Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
 374         texture.Upload(rasterizedPixelData);
 375         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 376
 377         if(mAtlasRect == FULL_TEXTURE_RECT)
 378         {
 379           textureSet = currentTextureSet;
 380         }
 381         else
 382         {
 383           textureSet = TextureSet::New();
 384           mImpl->mRenderer.SetTextures(textureSet);
 385
 386           mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
 387           mAtlasRect = FULL_TEXTURE_RECT;
 388         }
 389
 390         if(textureSet)
 391         {
 392           textureSet.SetTexture(0, texture);
 393         }
 394       }
 395
 396       // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 397       Actor actor = mPlacementActor.GetHandle();
 398       if(actor)
 399       {
 400         actor.AddRenderer(mImpl->mRenderer);
 401         // reset the weak handle so that the renderer only get added to actor once
 402         mPlacementActor.Reset();
 403       }
 404
 405       // Svg loaded and ready to display
 406       ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 407     }
 408   }
 409   else if(!mLoadFailed)
 410   {
 411     mLoadFailed = true;
 412
 413     Actor actor = mPlacementActor.GetHandle();
 414     if(actor)
 415     {
 416       Vector2 imageSize = Vector2::ZERO;
 417       imageSize         = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 418       mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 419       actor.AddRenderer(mImpl->mRenderer);
 420     }
 421
 422     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 423   }
 424 }
 425
 426 void SvgVisual::OnSetTransform()
 427 {
 428   if(IsOnScene() && !mLoadFailed)
 429   {
 430     Vector2 size;
 431     if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 432     {
 433       // Use desired size
 434       size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
 435     }
 436     else
 437     {
 438       // Use visual size
 439       size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
 440     }
 441
 442     if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
 443     {
 444       mRasterizedSize = size;
 445       AddRasterizationTask(size);
 446     }
 447   }
 448
 449   if(mImpl->mRenderer)
 450   {
 451     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 452   }
 453 }
 454
 455 void SvgVisual::UpdateShader()
 456 {
 457   if(mImpl->mRenderer)
 458   {
 459     Shader shader = GenerateShader();
 460     mImpl->mRenderer.SetShader(shader);
 461   }
 462 }
 463
 464 Shader SvgVisual::GenerateShader() const
 465 {
 466   Shader shader;
 467   if(!mImpl->mCustomShader)
 468   {
 469     shader = mImageVisualShaderFactory.GetShader(
 470       mFactoryCache,
 471       ImageVisualShaderFeature::FeatureBuilder()
 472         .EnableTextureAtlas(mAttemptAtlasing)
 473         .EnableRoundedCorner(IsRoundedCornerRequired())
 474         .EnableBorderline(IsBorderlineRequired()));
 475   }
 476   else
 477   {
 478     shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
 479                          mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
 480                          mImpl->mCustomShader->mHints);
 481
 482     shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
 483   }
 484   return shader;
 485 }
 486
 487 } // namespace Internal
 488
 489 } // namespace Toolkit
 490
 491 } // namespace Dali