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     if(!mLoadingTask->HasSucceeded())
 113     {
 114       mLoadFailed = true;
 115     }
 116     mLoadingTask.Reset(); // We don't need it anymore.
 117   }
 118   else
 119   {
 120     Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
 121   }
 122 }
 123
 124 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
 125 {
 126   // url already passed in from constructor
 127   for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
 128   {
 129     KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
 130     if(keyValue.first.type == Property::Key::INDEX)
 131     {
 132       DoSetProperty(keyValue.first.indexKey, keyValue.second);
 133     }
 134     else if(keyValue.first == IMAGE_ATLASING)
 135     {
 136       DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
 137     }
 138     else if(keyValue.first == SYNCHRONOUS_LOADING)
 139     {
 140       DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
 141     }
 142     else if(keyValue.first == IMAGE_DESIRED_WIDTH)
 143     {
 144       DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
 145     }
 146     else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
 147     {
 148       DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
 149     }
 150   }
 151 }
 152
 153 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
 154 {
 155   switch(index)
 156   {
 157     case Toolkit::ImageVisual::Property::ATLASING:
 158     {
 159       value.Get(mAttemptAtlasing);
 160       break;
 161     }
 162     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 163     {
 164       bool sync = false;
 165       if(value.Get(sync))
 166       {
 167         if(sync)
 168         {
 169           mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 170         }
 171         else
 172         {
 173           mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 174         }
 175       }
 176       else
 177       {
 178         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
 179       }
 180       break;
 181     }
 182     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 183     {
 184       int32_t desiredWidth = 0;
 185       if(value.Get(desiredWidth))
 186       {
 187         mDesiredSize.SetWidth(desiredWidth);
 188       }
 189       break;
 190     }
 191     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 192     {
 193       int32_t desiredHeight = 0;
 194       if(value.Get(desiredHeight))
 195       {
 196         mDesiredSize.SetHeight(desiredHeight);
 197       }
 198       break;
 199     }
 200   }
 201 }
 202
 203 void SvgVisual::DoSetOnScene(Actor& actor)
 204 {
 205   TextureSet textureSet = TextureSet::New();
 206   mImpl->mRenderer.SetTextures(textureSet);
 207
 208   // Register transform properties
 209   mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 210
 211   // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
 212
 213   // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
 214   mPlacementActor = actor;
 215
 216   if(mLoadFailed)
 217   {
 218     Vector2 imageSize = Vector2::ZERO;
 219     imageSize         = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 220     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 221     actor.AddRenderer(mImpl->mRenderer);
 222
 223     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 224   }
 225   else
 226   {
 227     if(mImpl->mEventObserver)
 228     {
 229       // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
 230       mImpl->mEventObserver->RelayoutRequest(*this);
 231     }
 232   }
 233 }
 234
 235 void SvgVisual::DoSetOffScene(Actor& actor)
 236 {
 237   // Remove loading & rasterizing task
 238   if(mLoadingTask)
 239   {
 240     Dali::AsyncTaskManager::Get().RemoveTask(mLoadingTask);
 241     mLoadingTask.Reset();
 242   }
 243   if(mRasterizingTask)
 244   {
 245     Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
 246     mRasterizingTask.Reset();
 247   }
 248
 249   actor.RemoveRenderer(mImpl->mRenderer);
 250   mPlacementActor.Reset();
 251
 252   // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
 253   mRasterizedSize = Vector2::ZERO;
 254 }
 255
 256 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
 257 {
 258   if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 259   {
 260     naturalSize.x = mDesiredSize.GetWidth();
 261     naturalSize.y = mDesiredSize.GetHeight();
 262   }
 263   else if(mLoadFailed && mImpl->mRenderer)
 264   {
 265     // Load failed, use broken image size
 266     auto textureSet = mImpl->mRenderer.GetTextures();
 267     if(textureSet && textureSet.GetTextureCount())
 268     {
 269       auto texture = textureSet.GetTexture(0);
 270       if(texture)
 271       {
 272         naturalSize.x = texture.GetWidth();
 273         naturalSize.y = texture.GetHeight();
 274         return;
 275       }
 276     }
 277   }
 278   else
 279   {
 280     naturalSize.x = mDefaultWidth;
 281     naturalSize.y = mDefaultHeight;
 282   }
 283 }
 284
 285 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
 286 {
 287   map.Clear();
 288   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
 289   if(mImageUrl.IsValid())
 290   {
 291     map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
 292     map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
 293   }
 294   map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
 295   map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 296   map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 297 }
 298
 299 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 300 {
 301   // Do nothing
 302 }
 303
 304 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
 305 {
 306   // Make always enable pre multiplied alpha whether preMultiplied value is false.
 307   if(!preMultiplied)
 308   {
 309     DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
 310   }
 311 }
 312
 313 void SvgVisual::AddRasterizationTask(const Vector2& size)
 314 {
 315   if(mImpl->mRenderer)
 316   {
 317     // Remove previous task
 318     if(mRasterizingTask)
 319     {
 320       Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
 321       mRasterizingTask.Reset();
 322     }
 323
 324     unsigned int width  = static_cast<unsigned int>(size.width);
 325     unsigned int height = static_cast<unsigned int>(size.height);
 326
 327     mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
 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   if(task->HasSucceeded())
 345   {
 346     PixelData rasterizedPixelData = task->GetPixelData();
 347     if(mDefaultWidth == 0 || mDefaultHeight == 0)
 348     {
 349       task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
 350     }
 351
 352     // Rasterization success
 353     if(rasterizedPixelData && IsOnScene())
 354     {
 355       mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
 356       mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
 357
 358       TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
 359       if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
 360       {
 361         mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
 362       }
 363
 364       TextureSet textureSet;
 365
 366       if(mAttemptAtlasing && !mImpl->mCustomShader)
 367       {
 368         Vector4 atlasRect;
 369         textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
 370         if(textureSet) // atlasing
 371         {
 372           if(textureSet != currentTextureSet)
 373           {
 374             mImpl->mRenderer.SetTextures(textureSet);
 375           }
 376           mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
 377           mAtlasRect = atlasRect;
 378           mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 379         }
 380       }
 381
 382       if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
 383       {
 384         Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
 385         texture.Upload(rasterizedPixelData);
 386         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 387
 388         if(mAtlasRect == FULL_TEXTURE_RECT)
 389         {
 390           textureSet = currentTextureSet;
 391         }
 392         else
 393         {
 394           textureSet = TextureSet::New();
 395           mImpl->mRenderer.SetTextures(textureSet);
 396
 397           mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
 398           mAtlasRect = FULL_TEXTURE_RECT;
 399         }
 400
 401         if(textureSet)
 402         {
 403           textureSet.SetTexture(0, texture);
 404         }
 405       }
 406
 407       // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 408       Actor actor = mPlacementActor.GetHandle();
 409       if(actor)
 410       {
 411         actor.AddRenderer(mImpl->mRenderer);
 412         // reset the weak handle so that the renderer only get added to actor once
 413         mPlacementActor.Reset();
 414       }
 415
 416       // Svg loaded and ready to display
 417       ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 418     }
 419   }
 420   else if(!mLoadFailed)
 421   {
 422     mLoadFailed = true;
 423
 424     Actor actor = mPlacementActor.GetHandle();
 425     if(actor)
 426     {
 427       Vector2 imageSize = Vector2::ZERO;
 428       imageSize         = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 429       mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 430       actor.AddRenderer(mImpl->mRenderer);
 431     }
 432
 433     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 434   }
 435
 436   // We don't need to keep tasks anymore. reset now.
 437   if(task == mLoadingTask)
 438   {
 439     mLoadingTask.Reset();
 440   }
 441   if(task == mRasterizingTask)
 442   {
 443     mRasterizingTask.Reset();
 444   }
 445 }
 446
 447 void SvgVisual::OnSetTransform()
 448 {
 449   if(IsOnScene() && !mLoadFailed)
 450   {
 451     Vector2 size;
 452     if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 453     {
 454       // Use desired size
 455       size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
 456     }
 457     else
 458     {
 459       // Use visual size
 460       size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
 461     }
 462
 463     if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
 464     {
 465       mRasterizedSize = size;
 466       AddRasterizationTask(size);
 467     }
 468   }
 469
 470   if(mImpl->mRenderer)
 471   {
 472     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 473   }
 474 }
 475
 476 void SvgVisual::UpdateShader()
 477 {
 478   if(mImpl->mRenderer)
 479   {
 480     Shader shader = GenerateShader();
 481     mImpl->mRenderer.SetShader(shader);
 482   }
 483 }
 484
 485 Shader SvgVisual::GenerateShader() const
 486 {
 487   Shader shader;
 488   if(!mImpl->mCustomShader)
 489   {
 490     shader = mImageVisualShaderFactory.GetShader(
 491       mFactoryCache,
 492       ImageVisualShaderFeature::FeatureBuilder()
 493         .EnableTextureAtlas(mAttemptAtlasing)
 494         .EnableRoundedCorner(IsRoundedCornerRequired())
 495         .EnableBorderline(IsBorderlineRequired()));
 496   }
 497   else
 498   {
 499     shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
 500                          mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
 501                          mImpl->mCustomShader->mHints);
 502
 503     shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
 504   }
 505   return shader;
 506 }
 507
 508 } // namespace Internal
 509
 510 } // namespace Toolkit
 511
 512 } // namespace Dali