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 }
  97
  98 void SvgVisual::OnInitialize()
  99 {
 100   Shader   shader   = GenerateShader();
 101   Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
 102   mImpl->mRenderer  = DecoratedVisualRenderer::New(geometry, shader);
 103   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
 104
 105   Vector2 dpi     = Stage::GetCurrent().GetDpi();
 106   float   meanDpi = (dpi.height + dpi.width) * 0.5f;
 107
 108   mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
 109
 110   if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
 111   {
 112     mLoadingTask->Process();
 113     if(!mLoadingTask->HasSucceeded())
 114     {
 115       mLoadFailed = true;
 116     }
 117     mLoadingTask.Reset(); // We don't need it anymore.
 118   }
 119   else
 120   {
 121     Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
 122   }
 123 }
 124
 125 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
 126 {
 127   // url already passed in from constructor
 128   for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
 129   {
 130     KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
 131     if(keyValue.first.type == Property::Key::INDEX)
 132     {
 133       DoSetProperty(keyValue.first.indexKey, keyValue.second);
 134     }
 135     else if(keyValue.first == IMAGE_ATLASING)
 136     {
 137       DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
 138     }
 139     else if(keyValue.first == SYNCHRONOUS_LOADING)
 140     {
 141       DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
 142     }
 143     else if(keyValue.first == IMAGE_DESIRED_WIDTH)
 144     {
 145       DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
 146     }
 147     else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
 148     {
 149       DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
 150     }
 151   }
 152 }
 153
 154 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
 155 {
 156   switch(index)
 157   {
 158     case Toolkit::ImageVisual::Property::ATLASING:
 159     {
 160       value.Get(mAttemptAtlasing);
 161       break;
 162     }
 163     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 164     {
 165       bool sync = false;
 166       if(value.Get(sync))
 167       {
 168         if(sync)
 169         {
 170           mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 171         }
 172         else
 173         {
 174           mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 175         }
 176       }
 177       else
 178       {
 179         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
 180       }
 181       break;
 182     }
 183     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 184     {
 185       int32_t desiredWidth = 0;
 186       if(value.Get(desiredWidth))
 187       {
 188         mDesiredSize.SetWidth(desiredWidth);
 189       }
 190       break;
 191     }
 192     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 193     {
 194       int32_t desiredHeight = 0;
 195       if(value.Get(desiredHeight))
 196       {
 197         mDesiredSize.SetHeight(desiredHeight);
 198       }
 199       break;
 200     }
 201   }
 202 }
 203
 204 void SvgVisual::DoSetOnScene(Actor& actor)
 205 {
 206   TextureSet textureSet = TextureSet::New();
 207   mImpl->mRenderer.SetTextures(textureSet);
 208
 209   // Register transform properties
 210   mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 211
 212   // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
 213
 214   // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
 215   mPlacementActor = actor;
 216
 217   if(mLoadFailed)
 218   {
 219     Vector2 imageSize = Vector2::ZERO;
 220     imageSize         = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 221     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 222     actor.AddRenderer(mImpl->mRenderer);
 223
 224     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 225   }
 226   else
 227   {
 228     if(mImpl->mEventObserver)
 229     {
 230       // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
 231       mImpl->mEventObserver->RelayoutRequest(*this);
 232     }
 233   }
 234 }
 235
 236 void SvgVisual::DoSetOffScene(Actor& actor)
 237 {
 238   // Remove rasterizing task
 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     // Remove previous task
 314     if(mRasterizingTask)
 315     {
 316       Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
 317       mRasterizingTask.Reset();
 318     }
 319
 320     unsigned int width  = static_cast<unsigned int>(size.width);
 321     unsigned int height = static_cast<unsigned int>(size.height);
 322
 323     mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
 324
 325 #ifdef TRACE_ENABLED
 326     reinterpret_cast<SvgRasterizingTask*>(mRasterizingTask.Get())->SetUrl(mImageUrl);
 327 #endif
 328
 329     if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
 330     {
 331       mRasterizingTask->Process();
 332       ApplyRasterizedImage(mRasterizingTask);
 333       mRasterizingTask.Reset(); // We don't need it anymore.
 334     }
 335     else
 336     {
 337       Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
 338     }
 339   }
 340 }
 341
 342 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
 343 {
 344   SvgVisualPtr self = this; // Keep reference until this API finished
 345
 346   if(task->HasSucceeded())
 347   {
 348     PixelData rasterizedPixelData = task->GetPixelData();
 349     if(mDefaultWidth == 0 || mDefaultHeight == 0)
 350     {
 351       task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
 352     }
 353
 354     // We don't need to keep tasks anymore. reset now.
 355     if(task == mLoadingTask)
 356     {
 357       mLoadingTask.Reset();
 358     }
 359     if(task == mRasterizingTask)
 360     {
 361       mRasterizingTask.Reset();
 362     }
 363
 364     // Rasterization success
 365     if(rasterizedPixelData && IsOnScene())
 366     {
 367       mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
 368       mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
 369
 370       TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
 371       if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
 372       {
 373         mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
 374       }
 375
 376       TextureSet textureSet;
 377
 378       if(mAttemptAtlasing && !mImpl->mCustomShader)
 379       {
 380         Vector4 atlasRect;
 381         textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
 382         if(textureSet) // atlasing
 383         {
 384           if(textureSet != currentTextureSet)
 385           {
 386             mImpl->mRenderer.SetTextures(textureSet);
 387           }
 388           mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
 389           mAtlasRect = atlasRect;
 390           mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 391         }
 392       }
 393
 394       if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
 395       {
 396         Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
 397         texture.Upload(rasterizedPixelData);
 398         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 399
 400         if(mAtlasRect == FULL_TEXTURE_RECT)
 401         {
 402           textureSet = currentTextureSet;
 403         }
 404         else
 405         {
 406           textureSet = TextureSet::New();
 407           mImpl->mRenderer.SetTextures(textureSet);
 408
 409           mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
 410           mAtlasRect = FULL_TEXTURE_RECT;
 411         }
 412
 413         if(textureSet)
 414         {
 415           textureSet.SetTexture(0, texture);
 416         }
 417       }
 418
 419       // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 420       Actor actor = mPlacementActor.GetHandle();
 421       if(actor)
 422       {
 423         actor.AddRenderer(mImpl->mRenderer);
 424         // reset the weak handle so that the renderer only get added to actor once
 425         mPlacementActor.Reset();
 426       }
 427
 428       // Svg loaded and ready to display
 429       ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 430     }
 431   }
 432   else if(!mLoadFailed)
 433   {
 434     mLoadFailed = true;
 435
 436     // Remove rasterizing task if we requested before.
 437     if(mRasterizingTask)
 438     {
 439       Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
 440       mRasterizingTask.Reset();
 441     }
 442
 443     // We don't need to keep tasks anymore. reset now.
 444     if(task == mLoadingTask)
 445     {
 446       mLoadingTask.Reset();
 447     }
 448
 449     Actor actor = mPlacementActor.GetHandle();
 450     if(actor)
 451     {
 452       Vector2 imageSize = Vector2::ZERO;
 453       imageSize         = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 454       mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 455       actor.AddRenderer(mImpl->mRenderer);
 456     }
 457
 458     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 459   }
 460 }
 461
 462 void SvgVisual::OnSetTransform()
 463 {
 464   if(IsOnScene() && !mLoadFailed)
 465   {
 466     Vector2 size;
 467     if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 468     {
 469       // Use desired size
 470       size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
 471     }
 472     else
 473     {
 474       // Use visual size
 475       size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
 476     }
 477
 478     if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
 479     {
 480       mRasterizedSize = size;
 481       AddRasterizationTask(size);
 482     }
 483   }
 484
 485   if(mImpl->mRenderer)
 486   {
 487     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 488   }
 489 }
 490
 491 void SvgVisual::UpdateShader()
 492 {
 493   if(mImpl->mRenderer)
 494   {
 495     Shader shader = GenerateShader();
 496     mImpl->mRenderer.SetShader(shader);
 497   }
 498 }
 499
 500 Shader SvgVisual::GenerateShader() const
 501 {
 502   Shader shader;
 503   if(!mImpl->mCustomShader)
 504   {
 505     shader = mImageVisualShaderFactory.GetShader(
 506       mFactoryCache,
 507       ImageVisualShaderFeatureBuilder()
 508         .EnableTextureAtlas(mAttemptAtlasing)
 509         .EnableRoundedCorner(IsRoundedCornerRequired())
 510         .EnableBorderline(IsBorderlineRequired()));
 511   }
 512   else
 513   {
 514     shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
 515                          mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
 516                          mImpl->mCustomShader->mHints);
 517
 518     shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
 519   }
 520   return shader;
 521 }
 522
 523 } // namespace Internal
 524
 525 } // namespace Toolkit
 526
 527 } // namespace Dali