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