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