dali-toolkit/internal/visuals/visual-factory-impl.cpp

   1 /*
   2  * Copyright (c) 2024 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 // CLASS HEADER
  18 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/scripting/scripting.h>
  22 #include <dali/integration-api/adaptor-framework/adaptor.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/public-api/object/property-array.h>
  25 #include <dali/public-api/object/type-registry-helper.h>
  26 #include <dali/public-api/object/type-registry.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
  30 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
  31 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  32 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
  33 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
  34 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
  35 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
  36 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
  37 #include <dali-toolkit/internal/visuals/border/border-visual.h>
  38 #include <dali-toolkit/internal/visuals/color/color-visual.h>
  39 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
  40 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
  41 #include <dali-toolkit/internal/visuals/image/image-visual.h>
  42 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
  43 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
  44 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
  45 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
  46 #include <dali-toolkit/internal/visuals/text-visual-shader-factory.h>
  47 #include <dali-toolkit/internal/visuals/text/text-visual.h>
  48 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  49 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  50 #include <dali-toolkit/internal/visuals/visual-url.h>
  51 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
  52 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  53 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
  54 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  55
  56 namespace Dali
  57 {
  58 namespace Toolkit
  59 {
  60 namespace Internal
  61 {
  62 namespace
  63 {
  64 #if defined(DEBUG_ENABLED)
  65 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
  66 #endif
  67
  68 BaseHandle Create()
  69 {
  70   BaseHandle handle = Toolkit::VisualFactory::Get();
  71
  72   return handle;
  73 }
  74
  75 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
  76 DALI_TYPE_REGISTRATION_END()
  77 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
  78
  79 static constexpr auto  SHADER_TYPE_COUNT = 2u;
  80 const std::string_view VertexPredefines[SHADER_TYPE_COUNT]{
  81   "",                                     //VisualFactoryCache::COLOR_SHADER
  82   "#define IS_REQUIRED_ROUNDED_CORNER\n", //VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER
  83 };
  84 const std::string_view FragmentPredefines[SHADER_TYPE_COUNT]{
  85   "",                                     //VisualFactoryCache::COLOR_SHADER
  86   "#define IS_REQUIRED_ROUNDED_CORNER\n", //VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER
  87 };
  88
  89 } // namespace
  90
  91 VisualFactory::VisualFactory(bool debugEnabled)
  92 : mFactoryCache(),
  93   mImageVisualShaderFactory(),
  94   mTextVisualShaderFactory(),
  95   mSlotDelegate(this),
  96   mIdleCallback(nullptr),
  97   mDebugEnabled(debugEnabled),
  98   mPreMultiplyOnLoad(true),
  99   mPrecompiledShaderRequested(false)
 100 {
 101 }
 102
 103 VisualFactory::~VisualFactory()
 104 {
 105   if(mIdleCallback && Adaptor::IsAvailable())
 106   {
 107     // Removes the callback from the callback manager in case the control is destroyed before the callback is executed.
 108     Adaptor::Get().RemoveIdle(mIdleCallback);
 109     mIdleCallback = nullptr;
 110   }
 111 }
 112
 113 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
 114 {
 115   if(type == StyleChange::THEME_CHANGE)
 116   {
 117     SetBrokenImageUrl(styleManager);
 118   }
 119 }
 120
 121 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
 122 {
 123   SetBrokenImageUrl(styleManager);
 124 }
 125
 126 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
 127 {
 128   Visual::BasePtr visualPtr;
 129
 130   Property::Value*           typeValue  = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
 131   Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
 132   if(typeValue)
 133   {
 134     Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
 135   }
 136
 137   switch(visualType)
 138   {
 139     case Toolkit::Visual::BORDER:
 140     {
 141       visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
 142       break;
 143     }
 144
 145     case Toolkit::Visual::COLOR:
 146     {
 147       visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
 148       break;
 149     }
 150
 151     case Toolkit::Visual::GRADIENT:
 152     {
 153       visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
 154       break;
 155     }
 156
 157     case Toolkit::Visual::IMAGE:
 158     {
 159       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 160       std::string      imageUrl;
 161       if(imageURLValue)
 162       {
 163         if(imageURLValue->Get(imageUrl))
 164         {
 165           if(!imageUrl.empty())
 166           {
 167             VisualUrl visualUrl(imageUrl);
 168
 169             switch(visualUrl.GetType())
 170             {
 171               case VisualUrl::N_PATCH:
 172               {
 173                 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 174                 break;
 175               }
 176               case VisualUrl::TVG:
 177               case VisualUrl::SVG:
 178               {
 179                 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 180                 break;
 181               }
 182               case VisualUrl::GIF:
 183               case VisualUrl::WEBP:
 184               {
 185                 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 186                 break;
 187               }
 188               case VisualUrl::JSON:
 189               {
 190                 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 191                 break;
 192               }
 193               case VisualUrl::REGULAR_IMAGE:
 194               {
 195                 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 196                 break;
 197               }
 198             }
 199           }
 200         }
 201         else
 202         {
 203           Property::Array* array = imageURLValue->GetArray();
 204           if(array && array->Count() > 0)
 205           {
 206             visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
 207           }
 208         }
 209       }
 210       break;
 211     }
 212
 213     case Toolkit::Visual::MESH:
 214     {
 215       visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
 216       break;
 217     }
 218
 219     case Toolkit::Visual::PRIMITIVE:
 220     {
 221       visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
 222       break;
 223     }
 224
 225     case Toolkit::Visual::WIREFRAME:
 226     {
 227       visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
 228       break;
 229     }
 230
 231     case Toolkit::Visual::TEXT:
 232     {
 233       visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
 234       break;
 235     }
 236
 237     case Toolkit::Visual::N_PATCH:
 238     {
 239       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 240       std::string      imageUrl;
 241       if(imageURLValue && imageURLValue->Get(imageUrl))
 242       {
 243         if(!imageUrl.empty())
 244         {
 245           visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 246         }
 247       }
 248       break;
 249     }
 250
 251     case Toolkit::Visual::SVG:
 252     {
 253       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 254       std::string      imageUrl;
 255       if(imageURLValue && imageURLValue->Get(imageUrl))
 256       {
 257         if(!imageUrl.empty())
 258         {
 259           visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 260         }
 261       }
 262       break;
 263     }
 264
 265     case Toolkit::Visual::ANIMATED_IMAGE:
 266     {
 267       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 268       std::string      imageUrl;
 269       if(imageURLValue)
 270       {
 271         if(imageURLValue->Get(imageUrl))
 272         {
 273           if(!imageUrl.empty())
 274           {
 275             visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 276           }
 277         }
 278         else
 279         {
 280           Property::Array* array = imageURLValue->GetArray();
 281           if(array && array->Count() > 0)
 282           {
 283             visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
 284           }
 285         }
 286       }
 287       break;
 288     }
 289
 290     case Toolkit::DevelVisual::ANIMATED_GRADIENT:
 291     {
 292       visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
 293       break;
 294     }
 295
 296     case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
 297     {
 298       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 299       std::string      imageUrl;
 300       if(imageURLValue && imageURLValue->Get(imageUrl))
 301       {
 302         if(!imageUrl.empty())
 303         {
 304           visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 305         }
 306       }
 307       break;
 308     }
 309
 310     case Toolkit::DevelVisual::ARC:
 311     {
 312       visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
 313       break;
 314     }
 315   }
 316
 317   DALI_LOG_INFO(gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n", Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>(visualType, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT), (visualType == Toolkit::DevelVisual::IMAGE) ? "url:" : "", (visualType == Toolkit::DevelVisual::IMAGE) ? (([&]() {
 318                   // Return URL if present in PropertyMap else return "not found message"
 319                   Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 320                   return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
 321                 })())
 322                                                                                                                                                                                                                                                                                                                             : "");
 323
 324   if(!visualPtr)
 325   {
 326     DALI_LOG_ERROR("VisualType unknown\n");
 327   }
 328
 329   if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
 330   {
 331     //Create a WireframeVisual if we have debug enabled
 332     visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
 333   }
 334
 335   return Toolkit::Visual::Base(visualPtr.Get());
 336 }
 337
 338 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
 339 {
 340   Visual::BasePtr visualPtr;
 341
 342   if(!url.empty())
 343   {
 344     // first resolve url type to know which visual to create
 345     VisualUrl visualUrl(url);
 346     switch(visualUrl.GetType())
 347     {
 348       case VisualUrl::N_PATCH:
 349       {
 350         visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
 351         break;
 352       }
 353       case VisualUrl::TVG:
 354       case VisualUrl::SVG:
 355       {
 356         visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 357         break;
 358       }
 359       case VisualUrl::GIF:
 360       case VisualUrl::WEBP:
 361       {
 362         visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 363         break;
 364       }
 365       case VisualUrl::JSON:
 366       {
 367         visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 368         break;
 369       }
 370       case VisualUrl::REGULAR_IMAGE:
 371       {
 372         visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 373         break;
 374       }
 375     }
 376   }
 377
 378   if(mDebugEnabled)
 379   {
 380     //Create a WireframeVisual if we have debug enabled
 381     visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
 382   }
 383
 384   return Toolkit::Visual::Base(visualPtr.Get());
 385 }
 386
 387 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
 388 {
 389   if(mPreMultiplyOnLoad != preMultiply)
 390   {
 391     GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
 392   }
 393   mPreMultiplyOnLoad = preMultiply;
 394 }
 395
 396 bool VisualFactory::GetPreMultiplyOnLoad() const
 397 {
 398   return mPreMultiplyOnLoad;
 399 }
 400
 401 void VisualFactory::DiscardVisual(Toolkit::Visual::Base visual)
 402 {
 403   mDiscardedVisuals.emplace_back(visual);
 404
 405   RegisterDiscardCallback();
 406 }
 407
 408 void VisualFactory::UsePreCompiledShader()
 409 {
 410   if(mPrecompiledShaderRequested)
 411   {
 412     return;
 413   }
 414   mPrecompiledShaderRequested = true;
 415
 416   ShaderPreCompiler::Get().Enable();
 417
 418   // Get image shader
 419   std::vector<RawShaderData> rawShaderList;
 420   RawShaderData              imageShaderData;
 421   GetImageVisualShaderFactory().GetPreCompiledShader(imageShaderData);
 422   rawShaderList.push_back(imageShaderData);
 423
 424   // Get text shader
 425   RawShaderData textShaderData;
 426   GetTextVisualShaderFactory().GetPreCompiledShader(textShaderData);
 427   rawShaderList.push_back(textShaderData);
 428
 429   // Get color shader
 430   RawShaderData colorShaderData;
 431   GetPreCompiledShader(colorShaderData);
 432   rawShaderList.push_back(colorShaderData);
 433
 434   // Save all shader
 435   ShaderPreCompiler::Get().SavePreCompileShaderList(rawShaderList);
 436 }
 437
 438 Internal::TextureManager& VisualFactory::GetTextureManager()
 439 {
 440   return GetFactoryCache().GetTextureManager();
 441 }
 442
 443 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
 444 {
 445   const std::string        imageDirPath   = AssetManager::GetDaliImagePath();
 446   std::string              brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
 447   std::vector<std::string> customBrokenImageUrlList;
 448
 449   if(styleManager)
 450   {
 451     customBrokenImageUrlList       = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
 452     const auto brokenImageUrlValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("brokenImageUrl", Property::Type::STRING);
 453     if(brokenImageUrlValue)
 454     {
 455       brokenImageUrlValue->Get(brokenImageUrl);
 456     }
 457   }
 458
 459   // Add default image
 460   mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
 461 }
 462
 463 void VisualFactory::GetPreCompiledShader(RawShaderData& shaders)
 464 {
 465   std::vector<std::string_view> vertexPrefix;
 466   std::vector<std::string_view> fragmentPrefix;
 467   int                           shaderCount = 0;
 468   shaders.shaderCount                       = 0;
 469   for(uint32_t i = 0u; i < SHADER_TYPE_COUNT; ++i)
 470   {
 471     vertexPrefix.push_back(VertexPredefines[i]);
 472     fragmentPrefix.push_back(FragmentPredefines[i]);
 473     shaderCount++;
 474   }
 475
 476   shaders.vertexPrefix   = vertexPrefix;
 477   shaders.fragmentPrefix = fragmentPrefix;
 478   shaders.vertexShader   = SHADER_COLOR_VISUAL_SHADER_VERT;
 479   shaders.fragmentShader = SHADER_COLOR_VISUAL_SHADER_FRAG;
 480   shaders.shaderCount    = shaderCount;
 481 }
 482
 483 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
 484 {
 485   if(!mFactoryCache)
 486   {
 487     mFactoryCache                      = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
 488     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 489     if(styleManager)
 490     {
 491       styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
 492       Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
 493     }
 494     SetBrokenImageUrl(styleManager);
 495   }
 496
 497   return *mFactoryCache;
 498 }
 499
 500 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
 501 {
 502   if(!mImageVisualShaderFactory)
 503   {
 504     mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
 505   }
 506   return *mImageVisualShaderFactory;
 507 }
 508
 509 TextVisualShaderFactory& VisualFactory::GetTextVisualShaderFactory()
 510 {
 511   if(!mTextVisualShaderFactory)
 512   {
 513     mTextVisualShaderFactory = std::unique_ptr<TextVisualShaderFactory>(new TextVisualShaderFactory());
 514   }
 515   return *mTextVisualShaderFactory;
 516 }
 517
 518 void VisualFactory::OnDiscardCallback()
 519 {
 520   mIdleCallback = nullptr;
 521
 522   // Discard visual now.
 523   mDiscardedVisuals.clear();
 524 }
 525
 526 void VisualFactory::RegisterDiscardCallback()
 527 {
 528   if(!mIdleCallback && Adaptor::IsAvailable())
 529   {
 530     // The callback manager takes the ownership of the callback object.
 531     mIdleCallback = MakeCallback(this, &VisualFactory::OnDiscardCallback);
 532
 533     Adaptor& adaptor = Adaptor::Get();
 534
 535     if(DALI_UNLIKELY(!adaptor.AddIdle(mIdleCallback, false)))
 536     {
 537       DALI_LOG_ERROR("Fail to add idle callback for visual factory. Call it synchronously.\n");
 538       OnDiscardCallback();
 539     }
 540   }
 541 }
 542
 543 } // namespace Internal
 544
 545 } // namespace Toolkit
 546
 547 } // namespace Dali