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