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