dali-toolkit/internal/texture-manager/texture-manager-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
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
  20
  21 // EXTERNAL HEADERS
  22 #include <dali/devel-api/adaptor-framework/environment-variable.h>
  23 #include <dali/devel-api/adaptor-framework/image-loading.h>
  24 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  25 #include <dali/integration-api/adaptor-framework/adaptor.h>
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/public-api/rendering/geometry.h>
  28
  29 // INTERNAL HEADERS
  30 #include <dali-toolkit/internal/texture-manager/texture-async-loading-helper.h>
  31 #include <dali-toolkit/internal/texture-manager/texture-cache-manager.h>
  32 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  33 #include <dali-toolkit/internal/visuals/rendering-addon.h>
  34
  35 namespace
  36 {
  37 constexpr auto INITIAL_HASH_NUMBER = size_t{0u};
  38
  39 constexpr auto TEXTURE_INDEX      = 0u; ///< The Index for texture
  40 constexpr auto MASK_TEXTURE_INDEX = 1u; ///< The Index for mask texture
  41
  42 constexpr auto NUMBER_OF_LOCAL_LOADER_THREADS_ENV  = "DALI_TEXTURE_LOCAL_THREADS";
  43 constexpr auto NUMBER_OF_REMOTE_LOADER_THREADS_ENV = "DALI_TEXTURE_REMOTE_THREADS";
  44 constexpr auto LOAD_IMAGE_YUV_PLANES_ENV           = "DALI_LOAD_IMAGE_YUV_PLANES";
  45
  46 bool NeedToLoadYuvPlanes()
  47 {
  48   auto loadYuvPlanesString = Dali::EnvironmentVariable::GetEnvironmentVariable(LOAD_IMAGE_YUV_PLANES_ENV);
  49   bool loadYuvPlanes       = loadYuvPlanesString ? std::atoi(loadYuvPlanesString) : false;
  50   return loadYuvPlanes;
  51 }
  52 } // namespace
  53
  54 namespace Dali
  55 {
  56 namespace Toolkit
  57 {
  58 namespace Internal
  59 {
  60 #ifdef DEBUG_ENABLED
  61 // Define logfilter Internal namespace level so other files (e.g. texture-cache-manager.cpp) can also use this filter.
  62 Debug::Filter* gTextureManagerLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_TEXTURE_MANAGER");
  63
  64 // clang-format off
  65 #define GET_LOAD_STATE_STRING(loadState) \
  66   loadState == TextureManagerType::LoadState::NOT_STARTED      ? "NOT_STARTED"      : \
  67   loadState == TextureManagerType::LoadState::LOADING          ? "LOADING"          : \
  68   loadState == TextureManagerType::LoadState::LOAD_FINISHED    ? "LOAD_FINISHED"    : \
  69   loadState == TextureManagerType::LoadState::WAITING_FOR_MASK ? "WAITING_FOR_MASK" : \
  70   loadState == TextureManagerType::LoadState::MASK_APPLYING    ? "MASK_APPLYING"    : \
  71   loadState == TextureManagerType::LoadState::MASK_APPLIED     ? "MASK_APPLIED"     : \
  72   loadState == TextureManagerType::LoadState::UPLOADED         ? "UPLOADED"         : \
  73   loadState == TextureManagerType::LoadState::CANCELLED        ? "CANCELLED"        : \
  74   loadState == TextureManagerType::LoadState::MASK_CANCELLED   ? "MASK_CANCELLED"   : \
  75   loadState == TextureManagerType::LoadState::LOAD_FAILED      ? "LOAD_FAILED"      : \
  76                                                                  "Unknown"
  77 // clang-format on
  78 #endif
  79
  80 namespace
  81 {
  82 const uint32_t DEFAULT_ATLAS_SIZE(1024u);               ///< This size can fit 8 by 8 images of average size 128 * 128
  83 const Vector4  FULL_ATLAS_RECT(0.0f, 0.0f, 1.0f, 1.0f); ///< UV Rectangle that covers the full Texture
  84
  85 void PreMultiply(Devel::PixelBuffer pixelBuffer, TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
  86 {
  87   if(Pixel::HasAlpha(pixelBuffer.GetPixelFormat()))
  88   {
  89     if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
  90     {
  91       pixelBuffer.MultiplyColorByAlpha();
  92     }
  93   }
  94   else
  95   {
  96     preMultiplyOnLoad = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
  97   }
  98 }
  99
 100 } // Anonymous namespace
 101
 102 TextureManager::MaskingData::MaskingData()
 103 : mAlphaMaskUrl(),
 104   mAlphaMaskId(INVALID_TEXTURE_ID),
 105   mContentScaleFactor(1.0f),
 106   mCropToMask(true),
 107   mPreappliedMasking(true),
 108   mMaskImageLoadingFailed(false)
 109 {
 110 }
 111
 112 TextureManager::TextureManager()
 113 : mTextureCacheManager(),
 114   mAsyncLoader(std::unique_ptr<TextureAsyncLoadingHelper>(new TextureAsyncLoadingHelper(*this))),
 115   mLifecycleObservers(),
 116   mLoadQueue(),
 117   mLoadingQueueTextureId(INVALID_TEXTURE_ID),
 118   mRemoveQueue(),
 119   mLoadYuvPlanes(NeedToLoadYuvPlanes()),
 120   mRemoveProcessorRegistered(false)
 121 {
 122   // Initialize the AddOn
 123   RenderingAddOn::Get();
 124 }
 125
 126 TextureManager::~TextureManager()
 127 {
 128   if(mRemoveProcessorRegistered && Adaptor::IsAvailable())
 129   {
 130     Adaptor::Get().UnregisterProcessor(*this, true);
 131     mRemoveProcessorRegistered = false;
 132   }
 133
 134   for(auto iter = mLifecycleObservers.Begin(), endIter = mLifecycleObservers.End(); iter != endIter; ++iter)
 135   {
 136     (*iter)->TextureManagerDestroyed();
 137   }
 138 }
 139
 140 TextureSet TextureManager::LoadAnimatedImageTexture(
 141   const VisualUrl&                url,
 142   Dali::AnimatedImageLoading      animatedImageLoading,
 143   const uint32_t&                 frameIndex,
 144   TextureManager::TextureId&      textureId,
 145   MaskingDataPointer&             maskInfo,
 146   const Dali::ImageDimensions&    desiredSize,
 147   const Dali::FittingMode::Type&  fittingMode,
 148   const Dali::SamplingMode::Type& samplingMode,
 149   const bool&                     synchronousLoading,
 150   TextureUploadObserver*          textureObserver,
 151   TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
 152 {
 153   TextureSet textureSet;
 154
 155   if(synchronousLoading)
 156   {
 157     Devel::PixelBuffer pixelBuffer;
 158     if(animatedImageLoading)
 159     {
 160       pixelBuffer = animatedImageLoading.LoadFrame(frameIndex, desiredSize, fittingMode, samplingMode);
 161     }
 162     if(!pixelBuffer)
 163     {
 164       DALI_LOG_ERROR("TextureManager::LoadAnimatedImageTexture: Synchronous loading is failed\n");
 165     }
 166     else
 167     {
 168       Texture maskTexture;
 169       if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
 170       {
 171         Devel::PixelBuffer maskPixelBuffer = LoadImageFromFile(maskInfo->mAlphaMaskUrl.GetUrl(), desiredSize, fittingMode, samplingMode, true);
 172         if(maskPixelBuffer)
 173         {
 174           if(!maskInfo->mPreappliedMasking)
 175           {
 176             PixelData maskPixelData = Devel::PixelBuffer::Convert(maskPixelBuffer); // takes ownership of buffer
 177             maskTexture             = Texture::New(Dali::TextureType::TEXTURE_2D, maskPixelData.GetPixelFormat(), maskPixelData.GetWidth(), maskPixelData.GetHeight());
 178             maskTexture.Upload(maskPixelData);
 179           }
 180           else
 181           {
 182             pixelBuffer.ApplyMask(maskPixelBuffer, maskInfo->mContentScaleFactor, maskInfo->mCropToMask);
 183           }
 184         }
 185         else
 186         {
 187           DALI_LOG_ERROR("TextureManager::LoadAnimatedImageTexture: Synchronous mask image loading is failed\n");
 188         }
 189       }
 190
 191       if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
 192       {
 193         PreMultiply(pixelBuffer, preMultiplyOnLoad);
 194       }
 195
 196       PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
 197       if(!textureSet)
 198       {
 199         Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelData.GetPixelFormat(), pixelData.GetWidth(), pixelData.GetHeight());
 200         texture.Upload(pixelData);
 201         textureSet = TextureSet::New();
 202         textureSet.SetTexture(TEXTURE_INDEX, texture);
 203         if(maskTexture)
 204         {
 205           textureSet.SetTexture(MASK_TEXTURE_INDEX, maskTexture);
 206         }
 207       }
 208     }
 209   }
 210   else
 211   {
 212     TextureId alphaMaskId        = INVALID_TEXTURE_ID;
 213     float     contentScaleFactor = 1.0f;
 214     bool      cropToMask         = false;
 215     if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
 216     {
 217       maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, maskInfo->mPreappliedMasking ? StorageType::KEEP_PIXEL_BUFFER : StorageType::KEEP_TEXTURE);
 218       alphaMaskId            = maskInfo->mAlphaMaskId;
 219       if(maskInfo->mPreappliedMasking)
 220       {
 221         contentScaleFactor = maskInfo->mContentScaleFactor;
 222         cropToMask         = maskInfo->mCropToMask;
 223       }
 224     }
 225
 226     textureId = RequestLoadInternal(url, alphaMaskId, contentScaleFactor, desiredSize, fittingMode, samplingMode, UseAtlas::NO_ATLAS, cropToMask, StorageType::UPLOAD_TO_TEXTURE, textureObserver, true, TextureManager::ReloadPolicy::CACHED, preMultiplyOnLoad, animatedImageLoading, frameIndex, false);
 227
 228     TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
 229     if(loadState == TextureManager::LoadState::UPLOADED)
 230     {
 231       // LoadComplete has already been called - keep the same texture set
 232       textureSet = GetTextureSet(textureId);
 233     }
 234   }
 235
 236   return textureSet;
 237 }
 238
 239 Devel::PixelBuffer TextureManager::LoadPixelBuffer(
 240   const VisualUrl&                url,
 241   const Dali::ImageDimensions&    desiredSize,
 242   const Dali::FittingMode::Type&  fittingMode,
 243   const Dali::SamplingMode::Type& samplingMode,
 244   const bool&                     synchronousLoading,
 245   TextureUploadObserver*          textureObserver,
 246   const bool&                     orientationCorrection,
 247   TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
 248 {
 249   Devel::PixelBuffer pixelBuffer;
 250   if(synchronousLoading)
 251   {
 252     if(url.IsValid())
 253     {
 254       if(url.IsBufferResource())
 255       {
 256         const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url);
 257         if(encodedImageBuffer)
 258         {
 259           pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
 260         }
 261       }
 262       else
 263       {
 264         pixelBuffer = LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
 265       }
 266       if(pixelBuffer && preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
 267       {
 268         PreMultiply(pixelBuffer, preMultiplyOnLoad);
 269       }
 270     }
 271   }
 272   else
 273   {
 274     RequestLoadInternal(url, INVALID_TEXTURE_ID, 1.0f, desiredSize, fittingMode, samplingMode, UseAtlas::NO_ATLAS, false, StorageType::RETURN_PIXEL_BUFFER, textureObserver, orientationCorrection, TextureManager::ReloadPolicy::FORCED, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u, false);
 275   }
 276
 277   return pixelBuffer;
 278 }
 279
 280 TextureSet TextureManager::LoadTexture(
 281   const VisualUrl&                    url,
 282   const Dali::ImageDimensions&        desiredSize,
 283   const Dali::FittingMode::Type&      fittingMode,
 284   const Dali::SamplingMode::Type&     samplingMode,
 285   MaskingDataPointer&                 maskInfo,
 286   const bool&                         synchronousLoading,
 287   TextureManager::TextureId&          textureId,
 288   Vector4&                            textureRect,
 289   Dali::ImageDimensions&              textureRectSize,
 290   bool&                               atlasingStatus,
 291   bool&                               loadingStatus,
 292   TextureUploadObserver*              textureObserver,
 293   AtlasUploadObserver*                atlasObserver,
 294   ImageAtlasManagerPtr                imageAtlasManager,
 295   const bool&                         orientationCorrection,
 296   const TextureManager::ReloadPolicy& reloadPolicy,
 297   TextureManager::MultiplyOnLoad&     preMultiplyOnLoad)
 298 {
 299   TextureSet textureSet;
 300
 301   loadingStatus = false;
 302   textureRect   = FULL_ATLAS_RECT;
 303
 304   if(VisualUrl::TEXTURE == url.GetProtocolType())
 305   {
 306     std::string location = url.GetLocation();
 307     if(location.size() > 0u)
 308     {
 309       TextureId id                  = std::stoi(location);
 310       auto      externalTextureInfo = mTextureCacheManager.GetExternalTextureInfo(id);
 311       if(externalTextureInfo.textureSet)
 312       {
 313         textureId = id;
 314
 315         if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
 316         {
 317           // Change preMultiplyOnLoad value so make caller determine to preMultiplyAlpha or not.
 318           // TODO : Should we seperate input and output value?
 319           preMultiplyOnLoad = externalTextureInfo.preMultiplied ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 320         }
 321
 322         TextureId alphaMaskId = INVALID_TEXTURE_ID;
 323         if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
 324         {
 325           maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, StorageType::KEEP_TEXTURE, synchronousLoading);
 326           alphaMaskId            = maskInfo->mAlphaMaskId;
 327           textureId              = RequestLoad(url, alphaMaskId, 1.0f, desiredSize, fittingMode, samplingMode, UseAtlas::NO_ATLAS, false, textureObserver, orientationCorrection, reloadPolicy, preMultiplyOnLoad, synchronousLoading);
 328
 329           TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
 330           if(loadState == TextureManager::LoadState::UPLOADED)
 331           {
 332             textureSet = GetTextureSet(textureId);
 333           }
 334         }
 335         else
 336         {
 337           textureSet = TextureSet::New();
 338           textureSet.SetTexture(TEXTURE_INDEX, externalTextureInfo.textureSet.GetTexture(TEXTURE_INDEX));
 339         }
 340       }
 341     }
 342   }
 343   else
 344   {
 345     // For Atlas
 346     if(synchronousLoading && atlasingStatus)
 347     {
 348       const bool synchronousAtlasAvaliable = (desiredSize != ImageDimensions() || url.IsLocalResource()) ? imageAtlasManager->CheckAtlasAvailable(url, desiredSize)
 349                                                                                                          : false;
 350       if(synchronousAtlasAvaliable)
 351       {
 352         std::vector<Devel::PixelBuffer> pixelBuffers;
 353         LoadImageSynchronously(url, desiredSize, fittingMode, samplingMode, orientationCorrection, false, pixelBuffers);
 354
 355         if(!pixelBuffers.empty() && maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
 356         {
 357           std::vector<Devel::PixelBuffer> maskPixelBuffers;
 358           LoadImageSynchronously(maskInfo->mAlphaMaskUrl, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, true, false, maskPixelBuffers);
 359           if(!maskPixelBuffers.empty())
 360           {
 361             pixelBuffers[0].ApplyMask(maskPixelBuffers[0], maskInfo->mContentScaleFactor, maskInfo->mCropToMask);
 362           }
 363         }
 364
 365         PixelData data;
 366         if(!pixelBuffers.empty())
 367         {
 368           PreMultiply(pixelBuffers[0], preMultiplyOnLoad);
 369           data = Devel::PixelBuffer::Convert(pixelBuffers[0]); // takes ownership of buffer
 370
 371           if(data)
 372           {
 373             textureSet = imageAtlasManager->Add(textureRect, data);
 374             if(textureSet)
 375             {
 376               textureRectSize.SetWidth(data.GetWidth());
 377               textureRectSize.SetHeight(data.GetHeight());
 378             }
 379           }
 380           else
 381           {
 382             DALI_LOG_ERROR("TextureManager::LoadTexture: Synchronous Texture loading with atlasing is failed.\n");
 383           }
 384         }
 385         if(!textureSet)
 386         {
 387           atlasingStatus = false;
 388         }
 389       }
 390     }
 391
 392     if(!textureSet)
 393     {
 394       loadingStatus = true;
 395       // Atlas manager can chage desired size when it is set by 0,0.
 396       // We should store into textureRectSize only if atlasing successed.
 397       // So copy inputed desiredSize, and replace value into textureRectSize only if atlasing success.
 398       Dali::ImageDimensions atlasDesiredSize = desiredSize;
 399       if(atlasingStatus)
 400       {
 401         if(url.IsBufferResource())
 402         {
 403           const EncodedImageBuffer& encodedImageBuffer = GetEncodedImageBuffer(url.GetUrl());
 404           if(encodedImageBuffer)
 405           {
 406             textureSet = imageAtlasManager->Add(textureRect, encodedImageBuffer, desiredSize, fittingMode, true, atlasObserver);
 407           }
 408         }
 409         else
 410         {
 411           textureSet = imageAtlasManager->Add(textureRect, url, atlasDesiredSize, fittingMode, true, atlasObserver);
 412         }
 413       }
 414       if(!textureSet) // big image, no atlasing or atlasing failed
 415       {
 416         atlasingStatus = false;
 417
 418         TextureId alphaMaskId        = INVALID_TEXTURE_ID;
 419         float     contentScaleFactor = 1.0f;
 420         bool      cropToMask         = false;
 421         if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
 422         {
 423           maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, maskInfo->mPreappliedMasking ? StorageType::KEEP_PIXEL_BUFFER : StorageType::KEEP_TEXTURE, synchronousLoading);
 424           alphaMaskId            = maskInfo->mAlphaMaskId;
 425           if(maskInfo && maskInfo->mPreappliedMasking)
 426           {
 427             contentScaleFactor = maskInfo->mContentScaleFactor;
 428             cropToMask         = maskInfo->mCropToMask;
 429           }
 430         }
 431
 432         textureId = RequestLoad(
 433           url,
 434           alphaMaskId,
 435           contentScaleFactor,
 436           desiredSize,
 437           fittingMode,
 438           samplingMode,
 439           UseAtlas::NO_ATLAS,
 440           cropToMask,
 441           textureObserver,
 442           orientationCorrection,
 443           reloadPolicy,
 444           preMultiplyOnLoad,
 445           synchronousLoading);
 446
 447         TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
 448         if(loadState == TextureManager::LoadState::UPLOADED)
 449         {
 450           // LoadComplete has already been called - keep the same texture set
 451           textureSet = GetTextureSet(textureId);
 452         }
 453
 454         // If we are loading the texture, or waiting for the ready signal handler to complete, inform
 455         // caller that they need to wait.
 456         loadingStatus = (loadState == TextureManager::LoadState::LOADING ||
 457                          loadState == TextureManager::LoadState::WAITING_FOR_MASK ||
 458                          loadState == TextureManager::LoadState::MASK_APPLYING ||
 459                          loadState == TextureManager::LoadState::MASK_APPLIED ||
 460                          loadState == TextureManager::LoadState::NOT_STARTED ||
 461                          mLoadingQueueTextureId != INVALID_TEXTURE_ID);
 462       }
 463       else
 464       {
 465         textureRectSize = atlasDesiredSize;
 466       }
 467     }
 468   }
 469
 470   if(synchronousLoading)
 471   {
 472     loadingStatus = false;
 473   }
 474
 475   return textureSet;
 476 }
 477
 478 TextureManager::TextureId TextureManager::RequestLoad(
 479   const VisualUrl&                    url,
 480   const ImageDimensions&              desiredSize,
 481   const Dali::FittingMode::Type&      fittingMode,
 482   const Dali::SamplingMode::Type&     samplingMode,
 483   const UseAtlas&                     useAtlas,
 484   TextureUploadObserver*              observer,
 485   const bool&                         orientationCorrection,
 486   const TextureManager::ReloadPolicy& reloadPolicy,
 487   TextureManager::MultiplyOnLoad&     preMultiplyOnLoad,
 488   const bool&                         synchronousLoading)
 489 {
 490   return RequestLoadInternal(url, INVALID_TEXTURE_ID, 1.0f, desiredSize, fittingMode, samplingMode, useAtlas, false, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
 491 }
 492
 493 TextureManager::TextureId TextureManager::RequestLoad(
 494   const VisualUrl&                    url,
 495   const TextureManager::TextureId&    maskTextureId,
 496   const float&                        contentScale,
 497   const Dali::ImageDimensions&        desiredSize,
 498   const Dali::FittingMode::Type&      fittingMode,
 499   const Dali::SamplingMode::Type&     samplingMode,
 500   const TextureManager::UseAtlas&     useAtlas,
 501   const bool&                         cropToMask,
 502   TextureUploadObserver*              observer,
 503   const bool&                         orientationCorrection,
 504   const TextureManager::ReloadPolicy& reloadPolicy,
 505   TextureManager::MultiplyOnLoad&     preMultiplyOnLoad,
 506   const bool&                         synchronousLoading)
 507 {
 508   return RequestLoadInternal(url, maskTextureId, contentScale, desiredSize, fittingMode, samplingMode, useAtlas, cropToMask, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
 509 }
 510
 511 TextureManager::TextureId TextureManager::RequestMaskLoad(
 512   const VisualUrl& maskUrl,
 513   StorageType      storageType,
 514   const bool&      synchronousLoading)
 515 {
 516   // Use the normal load procedure to get the alpha mask.
 517   auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 518   return RequestLoadInternal(maskUrl, INVALID_TEXTURE_ID, 1.0f, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, UseAtlas::NO_ATLAS, false, storageType, NULL, true, TextureManager::ReloadPolicy::CACHED, preMultiply, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
 519 }
 520
 521 TextureManager::TextureId TextureManager::RequestLoadInternal(
 522   const VisualUrl&                    url,
 523   const TextureManager::TextureId&    maskTextureId,
 524   const float&                        contentScale,
 525   const Dali::ImageDimensions&        desiredSize,
 526   const Dali::FittingMode::Type&      fittingMode,
 527   const Dali::SamplingMode::Type&     samplingMode,
 528   const TextureManager::UseAtlas&     useAtlas,
 529   const bool&                         cropToMask,
 530   const TextureManager::StorageType&  storageType,
 531   TextureUploadObserver*              observer,
 532   const bool&                         orientationCorrection,
 533   const TextureManager::ReloadPolicy& reloadPolicy,
 534   TextureManager::MultiplyOnLoad&     preMultiplyOnLoad,
 535   Dali::AnimatedImageLoading          animatedImageLoading,
 536   const std::uint32_t&                frameIndex,
 537   const bool&                         synchronousLoading)
 538 {
 539   TextureHash       textureHash   = INITIAL_HASH_NUMBER;
 540   TextureCacheIndex cacheIndex    = INVALID_CACHE_INDEX;
 541   bool              loadYuvPlanes = (mLoadYuvPlanes && maskTextureId == INVALID_TEXTURE_ID && storageType == StorageType::UPLOAD_TO_TEXTURE);
 542
 543   if(storageType != StorageType::RETURN_PIXEL_BUFFER)
 544   {
 545     textureHash = mTextureCacheManager.GenerateHash(url, desiredSize, fittingMode, samplingMode, useAtlas, maskTextureId, cropToMask, frameIndex);
 546
 547     // Look up the texture by hash. Note: The extra parameters are used in case of a hash collision.
 548     cacheIndex = mTextureCacheManager.FindCachedTexture(textureHash, url, desiredSize, fittingMode, samplingMode, useAtlas, storageType, maskTextureId, cropToMask, preMultiplyOnLoad, (animatedImageLoading) ? true : false, frameIndex);
 549   }
 550
 551   TextureManager::TextureId textureId = INVALID_TEXTURE_ID;
 552   // Check if the requested Texture exists in the cache.
 553   if(cacheIndex != INVALID_CACHE_INDEX)
 554   {
 555     if(TextureManager::ReloadPolicy::CACHED == reloadPolicy)
 556     {
 557       // Mark this texture being used by another client resource. Forced reload would replace the current texture
 558       // without the need for incrementing the reference count.
 559       ++(mTextureCacheManager[cacheIndex].referenceCount);
 560     }
 561     textureId = mTextureCacheManager[cacheIndex].textureId;
 562
 563     // Update preMultiplyOnLoad value. It should be changed according to preMultiplied value of the cached info.
 564     preMultiplyOnLoad = mTextureCacheManager[cacheIndex].preMultiplied ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 565     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestLoad( url=%s observer=%p ) Using cached texture id@%d, textureId=%d, maskTextureId=%d, frameindex=%d, premultiplied=%d\n", url.GetUrl().c_str(), observer, cacheIndex.GetIndex(), textureId, maskTextureId, frameIndex, mTextureCacheManager[cacheIndex].preMultiplied ? 1 : 0);
 566   }
 567
 568   if(textureId == INVALID_TEXTURE_ID) // There was no caching, or caching not required
 569   {
 570     textureId = mTextureCacheManager.GenerateTextureId();
 571
 572     bool preMultiply = (preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
 573
 574     // Cache new texutre, and get cacheIndex.
 575     cacheIndex = mTextureCacheManager.AppendCache(TextureInfo(textureId, maskTextureId, url, desiredSize, contentScale, fittingMode, samplingMode, false, cropToMask, useAtlas, textureHash, orientationCorrection, preMultiply, animatedImageLoading, frameIndex, loadYuvPlanes));
 576     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestLoad( url=%s observer=%p ) New texture, cacheIndex:%d, textureId=%d, maskTextureId=%d, frameindex=%d premultiply=%d\n", url.GetUrl().c_str(), observer, cacheIndex.GetIndex(), textureId, maskTextureId, frameIndex, preMultiply);
 577   }
 578
 579   // The below code path is common whether we are using the cache or not.
 580   // The textureInfoIndex now refers to either a pre-existing cached TextureInfo,
 581   // or a new TextureInfo just created.
 582   TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
 583   textureInfo.maskTextureId         = maskTextureId;
 584   textureInfo.storageType           = storageType;
 585   textureInfo.orientationCorrection = orientationCorrection;
 586
 587   // the case using external texture has already been loaded texture, so change its status to WAITING_FOR_MASK.
 588   if(url.GetProtocolType() == VisualUrl::TEXTURE)
 589   {
 590     if(textureInfo.loadState != LoadState::UPLOADED)
 591     {
 592       textureInfo.loadState = TextureManager::LoadState::WAITING_FOR_MASK;
 593     }
 594   }
 595
 596   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureInfo loadState:%s\n", GET_LOAD_STATE_STRING(textureInfo.loadState));
 597
 598   // Force reloading of texture by setting loadState unless already loading or cancelled.
 599   if(TextureManager::ReloadPolicy::FORCED == reloadPolicy &&
 600      TextureManager::LoadState::LOADING != textureInfo.loadState &&
 601      TextureManager::LoadState::WAITING_FOR_MASK != textureInfo.loadState &&
 602      TextureManager::LoadState::MASK_APPLYING != textureInfo.loadState &&
 603      TextureManager::LoadState::MASK_APPLIED != textureInfo.loadState &&
 604      TextureManager::LoadState::CANCELLED != textureInfo.loadState &&
 605      TextureManager::LoadState::MASK_CANCELLED != textureInfo.loadState)
 606   {
 607     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, "TextureManager::RequestLoad( url=%s observer=%p ) ForcedReload cacheIndex:%d, textureId=%d, maskTextureId=%d\n", url.GetUrl().c_str(), observer, cacheIndex.GetIndex(), textureId, maskTextureId);
 608     textureInfo.loadState = TextureManager::LoadState::NOT_STARTED;
 609   }
 610
 611   if(!synchronousLoading)
 612   {
 613     // Check if we should add the observer.
 614     // Only do this if we have not loaded yet and it will not have loaded by the end of this method.
 615     switch(textureInfo.loadState)
 616     {
 617       case TextureManager::LoadState::LOAD_FAILED: // Failed notifies observer which then stops observing.
 618       case TextureManager::LoadState::NOT_STARTED:
 619       {
 620         LoadOrQueueTexture(textureInfo, observer); // If called inside NotifyObservers, queues until afterwards
 621         break;
 622       }
 623       case TextureManager::LoadState::LOADING:
 624       case TextureManager::LoadState::WAITING_FOR_MASK:
 625       case TextureManager::LoadState::MASK_APPLYING:
 626       case TextureManager::LoadState::MASK_APPLIED:
 627       {
 628         ObserveTexture(textureInfo, observer);
 629         break;
 630       }
 631       case TextureManager::LoadState::UPLOADED:
 632       {
 633         if(observer)
 634         {
 635           LoadOrQueueTexture(textureInfo, observer);
 636         }
 637         break;
 638       }
 639       case TextureManager::LoadState::CANCELLED:
 640       {
 641         // A cancelled texture hasn't finished loading yet. Treat as a loading texture
 642         // (it's ref count has already been incremented, above)
 643         textureInfo.loadState = TextureManager::LoadState::LOADING;
 644         ObserveTexture(textureInfo, observer);
 645         break;
 646       }
 647       case TextureManager::LoadState::MASK_CANCELLED:
 648       {
 649         // A cancelled texture hasn't finished mask applying yet. Treat as a mask applying texture
 650         // (it's ref count has already been incremented, above)
 651         textureInfo.loadState = TextureManager::LoadState::MASK_APPLYING;
 652         ObserveTexture(textureInfo, observer);
 653         break;
 654       }
 655       case TextureManager::LoadState::LOAD_FINISHED:
 656       {
 657         // Loading has already completed.
 658         if(observer && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
 659         {
 660           LoadOrQueueTexture(textureInfo, observer);
 661         }
 662         break;
 663       }
 664     }
 665   }
 666   else
 667   {
 668     // If the image is already finished to load, use cached texture.
 669     // We don't need to consider Observer because this is synchronous loading.
 670     if(!(textureInfo.loadState == TextureManager::LoadState::UPLOADED ||
 671          textureInfo.loadState == TextureManager::LoadState::LOAD_FINISHED))
 672     {
 673       if(url.GetProtocolType() == VisualUrl::TEXTURE)
 674       {
 675         // Get external textureSet from cacheManager.
 676         std::string location = textureInfo.url.GetLocation();
 677         if(!location.empty())
 678         {
 679           TextureId id                  = std::stoi(location);
 680           auto      externalTextureInfo = mTextureCacheManager.GetExternalTextureInfo(id);
 681           textureInfo.textures.push_back(externalTextureInfo.textureSet.GetTexture(0));
 682           textureInfo.loadState = LoadState::UPLOADED;
 683         }
 684       }
 685       else
 686       {
 687         std::vector<Devel::PixelBuffer> pixelBuffers;
 688         LoadImageSynchronously(url, desiredSize, fittingMode, samplingMode, orientationCorrection, loadYuvPlanes, pixelBuffers);
 689
 690         if(pixelBuffers.empty())
 691         {
 692           // If pixelBuffer loading is failed in synchronously, call RequestRemove() method.
 693           RequestRemove(textureId, nullptr);
 694           return INVALID_TEXTURE_ID;
 695         }
 696
 697         if(storageType == StorageType::KEEP_PIXEL_BUFFER) // For the mask image loading.
 698         {
 699           textureInfo.pixelBuffer = pixelBuffers[0]; // Store the pixel data
 700           textureInfo.loadState   = LoadState::LOAD_FINISHED;
 701         }
 702         else // For the image loading.
 703         {
 704           Texture maskTexture;
 705           if(maskTextureId != INVALID_TEXTURE_ID)
 706           {
 707             TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
 708             if(maskCacheIndex != INVALID_CACHE_INDEX)
 709             {
 710               if(mTextureCacheManager[maskCacheIndex].storageType == StorageType::KEEP_PIXEL_BUFFER)
 711               {
 712                 Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
 713                 if(maskPixelBuffer)
 714                 {
 715                   pixelBuffers[0].ApplyMask(maskPixelBuffer, contentScale, cropToMask);
 716                 }
 717                 else
 718                 {
 719                   DALI_LOG_ERROR("Mask image cached invalid pixel buffer!\n");
 720                 }
 721               }
 722             }
 723             else
 724             {
 725               DALI_LOG_ERROR("Mask image is not stored in cache.\n");
 726             }
 727           }
 728           PreMultiply(pixelBuffers[0], preMultiplyOnLoad);
 729
 730           // Upload texture
 731           UploadTextures(pixelBuffers, textureInfo);
 732         }
 733       }
 734     }
 735   }
 736
 737   return textureId;
 738 }
 739
 740 void TextureManager::RequestRemove(const TextureManager::TextureId& textureId, TextureUploadObserver* observer)
 741 {
 742   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestRemove( textureId=%d observer=%p )\n", textureId, observer);
 743
 744   // Queue to remove.
 745   if(textureId != INVALID_TEXTURE_ID)
 746   {
 747     if(observer)
 748     {
 749       // Remove observer from cached texture info
 750       TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
 751       if(textureCacheIndex != INVALID_CACHE_INDEX)
 752       {
 753         TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
 754         RemoveTextureObserver(textureInfo, observer);
 755       }
 756     }
 757     mRemoveQueue.PushBack(textureId);
 758
 759     if(!mRemoveProcessorRegistered && Adaptor::IsAvailable())
 760     {
 761       mRemoveProcessorRegistered = true;
 762       Adaptor::Get().RegisterProcessor(*this, true);
 763     }
 764   }
 765 }
 766
 767 void TextureManager::Remove(const TextureManager::TextureId& textureId)
 768 {
 769   if(textureId != INVALID_TEXTURE_ID)
 770   {
 771     TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
 772     if(textureCacheIndex != INVALID_CACHE_INDEX)
 773     {
 774       TextureManager::TextureId maskTextureId = INVALID_TEXTURE_ID;
 775       TextureInfo&              textureInfo(mTextureCacheManager[textureCacheIndex]);
 776       // We only need to consider maskTextureId when texture's loadState is not cancelled. Because it is already deleted.
 777       if(textureInfo.loadState != LoadState::CANCELLED && textureInfo.loadState != LoadState::MASK_CANCELLED)
 778       {
 779         if(textureInfo.maskTextureId != INVALID_TEXTURE_ID)
 780         {
 781           maskTextureId = textureInfo.maskTextureId;
 782         }
 783       }
 784
 785       DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::Remove( textureId=%d ) cacheIndex:%d removal maskTextureId=%d, loadingQueueTextureId=%d, loadState=%s\n", textureId, textureCacheIndex.GetIndex(), maskTextureId, mLoadingQueueTextureId, GET_LOAD_STATE_STRING(textureInfo.loadState));
 786
 787       // Remove textureId in CacheManager. Now, textureInfo is invalidate.
 788       mTextureCacheManager.RemoveCache(textureInfo);
 789
 790       // Remove maskTextureId in CacheManager
 791       if(maskTextureId != INVALID_TEXTURE_ID)
 792       {
 793         TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
 794         if(maskCacheIndex != INVALID_CACHE_INDEX)
 795         {
 796           TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
 797           mTextureCacheManager.RemoveCache(maskTextureInfo);
 798         }
 799       }
 800     }
 801   }
 802 }
 803
 804 void TextureManager::ProcessRemoveQueue()
 805 {
 806   // Note that RemoveQueue is not be changed during Remove().
 807   for(auto&& textureId : mRemoveQueue)
 808   {
 809     if(textureId != INVALID_TEXTURE_ID)
 810     {
 811       Remove(textureId);
 812     }
 813   }
 814   mRemoveQueue.Clear();
 815 }
 816
 817 void TextureManager::Process(bool postProcessor)
 818 {
 819   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::Process()\n");
 820
 821   ProcessRemoveQueue();
 822
 823   if(Adaptor::IsAvailable())
 824   {
 825     Adaptor::Get().UnregisterProcessor(*this, true);
 826     mRemoveProcessorRegistered = false;
 827   }
 828 }
 829
 830 void TextureManager::LoadImageSynchronously(
 831   const VisualUrl&                 url,
 832   const Dali::ImageDimensions&     desiredSize,
 833   const Dali::FittingMode::Type&   fittingMode,
 834   const Dali::SamplingMode::Type&  samplingMode,
 835   const bool&                      orientationCorrection,
 836   const bool&                      loadYuvPlanes,
 837   std::vector<Devel::PixelBuffer>& pixelBuffers)
 838 {
 839   Devel::PixelBuffer pixelBuffer;
 840   if(url.IsBufferResource())
 841   {
 842     const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url);
 843     if(encodedImageBuffer)
 844     {
 845       pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
 846     }
 847   }
 848   else
 849   {
 850     if(loadYuvPlanes)
 851     {
 852       Dali::LoadImagePlanesFromFile(url.GetUrl(), pixelBuffers, desiredSize, fittingMode, samplingMode, orientationCorrection);
 853     }
 854     else
 855     {
 856       pixelBuffer = Dali::LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
 857     }
 858   }
 859
 860   if(pixelBuffer)
 861   {
 862     pixelBuffers.push_back(pixelBuffer);
 863   }
 864 }
 865
 866 void TextureManager::AddObserver(TextureManager::LifecycleObserver& observer)
 867 {
 868   // make sure an observer doesn't observe the same object twice
 869   // otherwise it will get multiple calls to ObjectDestroyed()
 870   DALI_ASSERT_DEBUG(mLifecycleObservers.End() == std::find(mLifecycleObservers.Begin(), mLifecycleObservers.End(), &observer));
 871   mLifecycleObservers.PushBack(&observer);
 872 }
 873
 874 void TextureManager::RemoveObserver(TextureManager::LifecycleObserver& observer)
 875 {
 876   // Find the observer...
 877   auto endIter = mLifecycleObservers.End();
 878   for(auto iter = mLifecycleObservers.Begin(); iter != endIter; ++iter)
 879   {
 880     if((*iter) == &observer)
 881     {
 882       mLifecycleObservers.Erase(iter);
 883       break;
 884     }
 885   }
 886   DALI_ASSERT_DEBUG(endIter != mLifecycleObservers.End());
 887 }
 888
 889 void TextureManager::LoadOrQueueTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
 890 {
 891   switch(textureInfo.loadState)
 892   {
 893     case LoadState::NOT_STARTED:
 894     case LoadState::LOAD_FAILED:
 895     {
 896       if(mLoadingQueueTextureId != INVALID_TEXTURE_ID)
 897       {
 898         QueueLoadTexture(textureInfo, observer);
 899       }
 900       else
 901       {
 902         LoadTexture(textureInfo, observer);
 903       }
 904       break;
 905     }
 906     case LoadState::UPLOADED:
 907     {
 908       if(mLoadingQueueTextureId != INVALID_TEXTURE_ID)
 909       {
 910         QueueLoadTexture(textureInfo, observer);
 911       }
 912       else
 913       {
 914         // The Texture has already loaded. The other observers have already been notified.
 915         // We need to send a "late" loaded notification for this observer.
 916         EmitLoadComplete(observer, textureInfo, true);
 917       }
 918       break;
 919     }
 920     case LoadState::LOADING:
 921     case LoadState::CANCELLED:
 922     case LoadState::MASK_CANCELLED:
 923     case LoadState::LOAD_FINISHED:
 924     case LoadState::WAITING_FOR_MASK:
 925     case LoadState::MASK_APPLYING:
 926     case LoadState::MASK_APPLIED:
 927     {
 928       break;
 929     }
 930   }
 931 }
 932
 933 void TextureManager::QueueLoadTexture(const TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
 934 {
 935   const auto& textureId = textureInfo.textureId;
 936   mLoadQueue.PushBack(QueueElement(textureId, observer));
 937
 938   if(observer)
 939   {
 940     observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
 941   }
 942 }
 943
 944 void TextureManager::LoadTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
 945 {
 946   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::LoadTexture(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
 947   textureInfo.loadState = LoadState::LOADING;
 948   if(!textureInfo.loadSynchronously)
 949   {
 950     auto premultiplyOnLoad = (textureInfo.preMultiplyOnLoad && textureInfo.maskTextureId == INVALID_TEXTURE_ID) ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
 951     if(textureInfo.animatedImageLoading)
 952     {
 953       mAsyncLoader->LoadAnimatedImage(textureInfo.textureId, textureInfo.animatedImageLoading, textureInfo.frameIndex, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, premultiplyOnLoad);
 954     }
 955     else
 956     {
 957       mAsyncLoader->Load(textureInfo.textureId, textureInfo.url, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, textureInfo.orientationCorrection, premultiplyOnLoad, textureInfo.loadYuvPlanes);
 958     }
 959   }
 960   ObserveTexture(textureInfo, observer);
 961 }
 962
 963 void TextureManager::ProcessLoadQueue()
 964 {
 965   for(auto&& element : mLoadQueue)
 966   {
 967     if(element.mTextureId == INVALID_TEXTURE_ID)
 968     {
 969       continue;
 970     }
 971
 972     TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(element.mTextureId);
 973     if(cacheIndex != INVALID_CACHE_INDEX)
 974     {
 975       TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
 976       if((textureInfo.loadState == LoadState::UPLOADED) || (textureInfo.loadState == LoadState::LOAD_FINISHED && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER))
 977       {
 978         if(element.mObserver)
 979         {
 980           EmitLoadComplete(element.mObserver, textureInfo, true);
 981         }
 982       }
 983       else if(textureInfo.loadState == LoadState::LOADING)
 984       {
 985         // Note : LOADING state texture cannot be queue.
 986         // This case be occured when same texture id are queue in mLoadQueue.
 987         ObserveTexture(textureInfo, element.mObserver);
 988       }
 989       else
 990       {
 991         LoadTexture(textureInfo, element.mObserver);
 992       }
 993     }
 994   }
 995   mLoadQueue.Clear();
 996 }
 997
 998 void TextureManager::ObserveTexture(TextureManager::TextureInfo& textureInfo,
 999                                     TextureUploadObserver*       observer)
1000 {
1001   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ObserveTexture(): url:%s observer:%p\n", textureInfo.url.GetUrl().c_str(), observer);
1002
1003   if(observer)
1004   {
1005     textureInfo.observerList.PushBack(observer);
1006     observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
1007   }
1008 }
1009
1010 void TextureManager::AsyncLoadComplete(const TextureManager::TextureId& textureId, std::vector<Devel::PixelBuffer>& pixelBuffers)
1011 {
1012   TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1013   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::AsyncLoadComplete( textureId:%d CacheIndex:%d )\n", textureId, cacheIndex.GetIndex());
1014   if(cacheIndex != INVALID_CACHE_INDEX)
1015   {
1016     TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1017
1018     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "  textureId:%d Url:%s CacheIndex:%d LoadState: %s\n", textureInfo.textureId, textureInfo.url.GetUrl().c_str(), cacheIndex.GetIndex(), GET_LOAD_STATE_STRING(textureInfo.loadState));
1019     if(textureInfo.loadState != LoadState::CANCELLED && textureInfo.loadState != LoadState::MASK_CANCELLED)
1020     {
1021       // textureInfo can be invalidated after this call (as the mTextureInfoContainer may be modified)
1022       PostLoad(textureInfo, pixelBuffers);
1023     }
1024     else
1025     {
1026       RequestRemove(textureInfo.textureId, nullptr);
1027     }
1028   }
1029 }
1030
1031 void TextureManager::PostLoad(TextureManager::TextureInfo& textureInfo, std::vector<Devel::PixelBuffer>& pixelBuffers)
1032 {
1033   // Was the load successful?
1034   if(!pixelBuffers.empty())
1035   {
1036     if(pixelBuffers.size() == 1)
1037     {
1038       Devel::PixelBuffer pixelBuffer = pixelBuffers[0];
1039       if(pixelBuffer && (pixelBuffer.GetWidth() != 0) && (pixelBuffer.GetHeight() != 0))
1040       {
1041         // No atlas support for now
1042         textureInfo.useAtlas      = UseAtlas::NO_ATLAS;
1043         textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
1044
1045         if(textureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE)
1046         {
1047           // If there is a mask texture ID associated with this texture, then apply the mask
1048           // if it's already loaded. If it hasn't, and the mask is still loading,
1049           // wait for the mask to finish loading.
1050           // note, If the texture is already uploaded synchronously during loading,
1051           // we don't need to apply mask.
1052           if(textureInfo.loadState != LoadState::UPLOADED &&
1053              textureInfo.maskTextureId != INVALID_TEXTURE_ID)
1054           {
1055             if(textureInfo.loadState == LoadState::MASK_APPLYING)
1056             {
1057               textureInfo.loadState = LoadState::MASK_APPLIED;
1058               UploadTextures(pixelBuffers, textureInfo);
1059               NotifyObservers(textureInfo, true);
1060             }
1061             else
1062             {
1063               LoadState maskLoadState = mTextureCacheManager.GetTextureStateInternal(textureInfo.maskTextureId);
1064               textureInfo.pixelBuffer = pixelBuffer; // Store the pixel buffer temporarily
1065               if(maskLoadState == LoadState::LOADING)
1066               {
1067                 textureInfo.loadState = LoadState::WAITING_FOR_MASK;
1068               }
1069               else if(maskLoadState == LoadState::LOAD_FINISHED || maskLoadState == LoadState::UPLOADED)
1070               {
1071                 // Send New Task to Thread
1072                 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureInfo.maskTextureId);
1073                 if(maskCacheIndex != INVALID_CACHE_INDEX)
1074                 {
1075                   TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
1076                   if(maskTextureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER)
1077                   {
1078                     // Send New Task to Thread
1079                     ApplyMask(textureInfo, textureInfo.maskTextureId);
1080                   }
1081                   else if(maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1082                   {
1083                     // Upload image texture. textureInfo.loadState will be UPLOADED.
1084                     UploadTextures(pixelBuffers, textureInfo);
1085
1086                     // notify mask texture set.
1087                     NotifyObservers(textureInfo, true);
1088                   }
1089                 }
1090               }
1091               else // maskLoadState == LoadState::LOAD_FAILED
1092               {
1093                 // Url texture load success, But alpha mask texture load failed. Run as normal image upload.
1094                 DALI_LOG_ERROR("Alpha mask image loading failed! Image will not be masked\n");
1095                 UploadTextures(pixelBuffers, textureInfo);
1096                 NotifyObservers(textureInfo, true);
1097               }
1098             }
1099           }
1100           else
1101           {
1102             UploadTextures(pixelBuffers, textureInfo);
1103             NotifyObservers(textureInfo, true);
1104           }
1105         }
1106         else
1107         {
1108           textureInfo.pixelBuffer = pixelBuffer; // Store the pixel data
1109           textureInfo.loadState   = LoadState::LOAD_FINISHED;
1110
1111           if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
1112           {
1113             NotifyObservers(textureInfo, true);
1114           }
1115           else // for the StorageType::KEEP_PIXEL_BUFFER and StorageType::KEEP_TEXTURE
1116           {
1117             // Check if there was another texture waiting for this load to complete
1118             // (e.g. if this was an image mask, and its load is on a different thread)
1119             CheckForWaitingTexture(textureInfo);
1120           }
1121         }
1122       }
1123     }
1124     else
1125     {
1126       // YUV case
1127       // No atlas support for now
1128       textureInfo.useAtlas      = UseAtlas::NO_ATLAS;
1129       textureInfo.preMultiplied = false;
1130
1131       UploadTextures(pixelBuffers, textureInfo);
1132       NotifyObservers(textureInfo, true);
1133     }
1134   }
1135   else
1136   {
1137     textureInfo.loadState = LoadState::LOAD_FAILED;
1138     if(textureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER || textureInfo.storageType == StorageType::KEEP_TEXTURE)
1139     {
1140       // Check if there was another texture waiting for this load to complete
1141       // (e.g. if this was an image mask, and its load is on a different thread)
1142       CheckForWaitingTexture(textureInfo);
1143     }
1144     else
1145     {
1146       NotifyObservers(textureInfo, false);
1147     }
1148   }
1149 }
1150
1151 void TextureManager::CheckForWaitingTexture(TextureManager::TextureInfo& maskTextureInfo)
1152 {
1153   if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED &&
1154      maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1155   {
1156     // Upload mask texture. textureInfo.loadState will be UPLOADED.
1157     std::vector<Devel::PixelBuffer> pixelBuffers;
1158     pixelBuffers.push_back(maskTextureInfo.pixelBuffer);
1159     UploadTextures(pixelBuffers, maskTextureInfo);
1160   }
1161
1162   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::CheckForWaitingTexture(): maskTextureId=%d, maskTextureUrl=%s\n", maskTextureInfo.textureId, maskTextureInfo.url.GetUrl().c_str());
1163
1164   // Search the cache, checking if any texture has this texture id as a maskTextureId
1165   const std::size_t size = mTextureCacheManager.size();
1166
1167   // Keep notify observer required textureIds.
1168   // Note : NotifyObservers can change mTextureCacheManager cache struct. We should check id's validation before notify.
1169   std::vector<TextureId> notifyRequiredTextureIds;
1170
1171   // TODO : Refactorize here to not iterate whole cached image.
1172   for(TextureCacheIndex cacheIndex = TextureCacheIndex(TextureManagerType::TEXTURE_CACHE_INDEX_TYPE_LOCAL, 0u); cacheIndex.GetIndex() < size; ++cacheIndex.detailValue.index)
1173   {
1174     if(mTextureCacheManager[cacheIndex].maskTextureId == maskTextureInfo.textureId &&
1175        mTextureCacheManager[cacheIndex].loadState == LoadState::WAITING_FOR_MASK)
1176     {
1177       TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1178
1179       if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED)
1180       {
1181         if(maskTextureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER)
1182         {
1183           // Send New Task to Thread
1184           ApplyMask(textureInfo, maskTextureInfo.textureId);
1185         }
1186       }
1187       else if(maskTextureInfo.loadState == LoadState::UPLOADED)
1188       {
1189         if(maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1190         {
1191           if(textureInfo.url.GetProtocolType() == VisualUrl::TEXTURE)
1192           {
1193             // Get external textureSet from cacheManager.
1194             std::string location = textureInfo.url.GetLocation();
1195             if(!location.empty())
1196             {
1197               TextureId id                  = std::stoi(location);
1198               auto      externalTextureInfo = mTextureCacheManager.GetExternalTextureInfo(id);
1199               textureInfo.textures.push_back(externalTextureInfo.textureSet.GetTexture(0));
1200               textureInfo.loadState = LoadState::UPLOADED;
1201             }
1202           }
1203           else
1204           {
1205             // Upload image texture. textureInfo.loadState will be UPLOADED.
1206             std::vector<Devel::PixelBuffer> pixelBuffers;
1207             pixelBuffers.push_back(textureInfo.pixelBuffer);
1208             UploadTextures(pixelBuffers, textureInfo);
1209           }
1210
1211           // Increase reference counts for notify required textureId.
1212           // Now we can assume that we don't remove & re-assign this textureId
1213           // during NotifyObserver signal emit.
1214           maskTextureInfo.referenceCount++;
1215           textureInfo.referenceCount++;
1216
1217           DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::CheckForWaitingTexture(): Ready to notify textureId=%d\n", textureInfo.textureId);
1218
1219           notifyRequiredTextureIds.push_back(textureInfo.textureId);
1220         }
1221       }
1222       else // maskTextureInfo.loadState == LoadState::LOAD_FAILED
1223       {
1224         // Url texture load success, But alpha mask texture load failed. Run as normal image upload.
1225         DALI_LOG_ERROR("Alpha mask image loading failed! Image will not be masked\n");
1226         std::vector<Devel::PixelBuffer> pixelBuffers;
1227         pixelBuffers.push_back(textureInfo.pixelBuffer);
1228         UploadTextures(pixelBuffers, textureInfo);
1229
1230         // Increase reference counts for notify required textureId.
1231         // Now we can assume that we don't remove & re-assign this textureId
1232         // during NotifyObserver signal emit.
1233         maskTextureInfo.referenceCount++;
1234         textureInfo.referenceCount++;
1235
1236         DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::CheckForWaitingTexture(): Ready to notify textureId=%d\n", textureInfo.textureId);
1237
1238         notifyRequiredTextureIds.push_back(textureInfo.textureId);
1239       }
1240     }
1241   }
1242
1243   // Notify textures are masked
1244   for(const auto textureId : notifyRequiredTextureIds)
1245   {
1246     TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1247     if(textureCacheIndex != INVALID_CACHE_INDEX)
1248     {
1249       TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
1250       NotifyObservers(textureInfo, true);
1251     }
1252   }
1253
1254   // Decrease reference count
1255   for(const auto textureId : notifyRequiredTextureIds)
1256   {
1257     RequestRemove(textureId, nullptr);
1258   }
1259 }
1260
1261 void TextureManager::ApplyMask(TextureManager::TextureInfo& textureInfo, const TextureManager::TextureId& maskTextureId)
1262 {
1263   TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
1264   if(maskCacheIndex != INVALID_CACHE_INDEX)
1265   {
1266     Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
1267     Devel::PixelBuffer pixelBuffer     = textureInfo.pixelBuffer;
1268     textureInfo.pixelBuffer.Reset();
1269
1270     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ApplyMask(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
1271
1272     textureInfo.loadState  = LoadState::MASK_APPLYING;
1273     auto premultiplyOnLoad = textureInfo.preMultiplyOnLoad ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
1274     mAsyncLoader->ApplyMask(textureInfo.textureId, pixelBuffer, maskPixelBuffer, textureInfo.scaleFactor, textureInfo.cropToMask, premultiplyOnLoad);
1275   }
1276 }
1277
1278 void TextureManager::UploadTextures(std::vector<Devel::PixelBuffer>& pixelBuffers, TextureManager::TextureInfo& textureInfo)
1279 {
1280   if(!pixelBuffers.empty() && textureInfo.loadState != LoadState::UPLOADED && textureInfo.useAtlas != UseAtlas::USE_ATLAS)
1281   {
1282     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "  TextureManager::UploadTextures() New Texture for textureId:%d\n", textureInfo.textureId);
1283
1284     // Check if this pixelBuffer is premultiplied
1285     textureInfo.preMultiplied = pixelBuffers[0].IsAlphaPreMultiplied();
1286
1287     auto& renderingAddOn = RenderingAddOn::Get();
1288     if(renderingAddOn.IsValid())
1289     {
1290       renderingAddOn.CreateGeometry(textureInfo.textureId, pixelBuffers[0]);
1291     }
1292
1293     // Remove previous textures and insert new textures
1294     textureInfo.textures.clear();
1295
1296     for(auto&& pixelBuffer : pixelBuffers)
1297     {
1298       Texture   texture   = Texture::New(Dali::TextureType::TEXTURE_2D, pixelBuffer.GetPixelFormat(), pixelBuffer.GetWidth(), pixelBuffer.GetHeight());
1299       PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer);
1300       texture.Upload(pixelData);
1301       textureInfo.textures.push_back(texture);
1302     }
1303   }
1304
1305   // Update the load state.
1306   // Note: This is regardless of success as we care about whether a
1307   // load attempt is in progress or not.  If unsuccessful, a broken
1308   // image is still loaded.
1309   textureInfo.loadState = LoadState::UPLOADED;
1310 }
1311
1312 void TextureManager::NotifyObservers(TextureManager::TextureInfo& textureInfo, const bool& success)
1313 {
1314   TextureId textureId = textureInfo.textureId;
1315
1316   // If there is an observer: Notify the load is complete, whether successful or not,
1317   // and erase it from the list
1318   TextureInfo* info = &textureInfo;
1319
1320   if(info->animatedImageLoading)
1321   {
1322     // If loading failed, we don't need to get frameCount and frameInterval.
1323     if(success)
1324     {
1325       info->frameCount    = info->animatedImageLoading.GetImageCount();
1326       info->frameInterval = info->animatedImageLoading.GetFrameInterval(info->frameIndex);
1327     }
1328     info->animatedImageLoading.Reset();
1329   }
1330
1331   mLoadingQueueTextureId = textureId;
1332
1333   // Reverse observer list that we can pop_back the observer.
1334   std::reverse(info->observerList.Begin(), info->observerList.End());
1335
1336   while(info->observerList.Count())
1337   {
1338     TextureUploadObserver* observer = *(info->observerList.End() - 1u);
1339
1340     // During LoadComplete() a Control ResourceReady() signal is emitted.
1341     // During that signal the app may add remove /add Textures (e.g. via
1342     // ImageViews).
1343     // It is possible for observers to be removed from the observer list,
1344     // and it is also possible for the mTextureInfoContainer to be modified,
1345     // invalidating the reference to the textureInfo struct.
1346     // Texture load requests for the same URL are deferred until the end of this
1347     // method.
1348     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::NotifyObservers() textureId:%d url:%s loadState:%s\n", textureId, info->url.GetUrl().c_str(), GET_LOAD_STATE_STRING(info->loadState));
1349     // It is possible for the observer to be deleted.
1350     // Disconnect and remove the observer first.
1351     observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1352
1353     info->observerList.Erase(info->observerList.End() - 1u);
1354
1355     EmitLoadComplete(observer, *info, success);
1356
1357     // Get the textureInfo from the container again as it may have been invalidated.
1358     TextureCacheIndex textureInfoIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1359     if(textureInfoIndex == INVALID_CACHE_INDEX)
1360     {
1361       break; // texture has been removed - can stop.
1362     }
1363     info = &mTextureCacheManager[textureInfoIndex];
1364   }
1365
1366   mLoadingQueueTextureId = INVALID_TEXTURE_ID;
1367   ProcessLoadQueue();
1368
1369   if(info->storageType == StorageType::RETURN_PIXEL_BUFFER && info->observerList.Count() == 0)
1370   {
1371     RequestRemove(info->textureId, nullptr);
1372   }
1373 }
1374
1375 void TextureManager::ObserverDestroyed(TextureUploadObserver* observer)
1376 {
1377   const std::size_t size = mTextureCacheManager.size();
1378   for(TextureCacheIndex cacheIndex = TextureCacheIndex(TextureManagerType::TEXTURE_CACHE_INDEX_TYPE_LOCAL, 0u); cacheIndex.GetIndex() < size; ++cacheIndex.detailValue.index)
1379   {
1380     TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1381     for(TextureInfo::ObserverListType::Iterator j = textureInfo.observerList.Begin();
1382         j != textureInfo.observerList.End();)
1383     {
1384       if(*j == observer)
1385       {
1386         j = textureInfo.observerList.Erase(j);
1387       }
1388       else
1389       {
1390         ++j;
1391       }
1392     }
1393   }
1394
1395   // Remove element from the LoadQueue
1396   for(auto&& element : mLoadQueue)
1397   {
1398     if(element.mObserver == observer)
1399     {
1400       element.mTextureId = INVALID_TEXTURE_ID;
1401       element.mObserver  = nullptr;
1402     }
1403   }
1404 }
1405
1406 Dali::Geometry TextureManager::GetRenderGeometry(const TextureManager::TextureId& textureId, std::uint32_t& frontElements, std::uint32_t& backElements)
1407 {
1408   return RenderingAddOn::Get().IsValid() ? RenderingAddOn::Get().GetGeometry(textureId, frontElements, backElements) : Geometry();
1409 }
1410
1411 void TextureManager::EmitLoadComplete(TextureUploadObserver* observer, TextureManager::TextureInfo& textureInfo, const bool& success)
1412 {
1413   if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
1414   {
1415     observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::PIXEL_BUFFER, textureInfo.pixelBuffer, textureInfo.url.GetUrl(), textureInfo.preMultiplied));
1416   }
1417   else
1418   {
1419     TextureSet textureSet = GetTextureSet(textureInfo);
1420     if(textureInfo.isAnimatedImageFormat)
1421     {
1422       observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::ANIMATED_IMAGE_TEXTURE, textureInfo.textureId, textureSet, textureInfo.frameCount, textureInfo.frameInterval));
1423     }
1424     else
1425     {
1426       observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::TEXTURE, textureInfo.textureId, textureSet, (textureInfo.useAtlas == UseAtlas::USE_ATLAS) ? true : false, textureInfo.atlasRect, textureInfo.preMultiplied));
1427     }
1428   }
1429 }
1430
1431 TextureSet TextureManager::GetTextureSet(const TextureManager::TextureId& textureId)
1432 {
1433   TextureSet                textureSet;
1434   TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
1435   if(loadState == TextureManager::LoadState::UPLOADED)
1436   {
1437     // LoadComplete has already been called - keep the same texture set
1438     TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1439     if(textureCacheIndex != INVALID_CACHE_INDEX)
1440     {
1441       TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
1442       textureSet = GetTextureSet(textureInfo);
1443     }
1444   }
1445   else
1446   {
1447     DALI_LOG_ERROR("GetTextureSet is failed. texture is not uploaded \n");
1448   }
1449   return textureSet;
1450 }
1451
1452 TextureSet TextureManager::GetTextureSet(const TextureManager::TextureInfo& textureInfo)
1453 {
1454   TextureSet textureSet;
1455
1456   // LoadComplete has already been called - keep the same texture set
1457   textureSet = TextureSet::New();
1458   if(!textureInfo.textures.empty())
1459   {
1460     if(textureInfo.textures.size() > 1) // For YUV case
1461     {
1462       uint32_t index = 0u;
1463       for(auto&& texture : textureInfo.textures)
1464       {
1465         textureSet.SetTexture(index++, texture);
1466       }
1467     }
1468     else
1469     {
1470       textureSet.SetTexture(TEXTURE_INDEX, textureInfo.textures[0]);
1471       TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureInfo.maskTextureId);
1472       if(maskCacheIndex != INVALID_CACHE_INDEX)
1473       {
1474         TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
1475         if(maskTextureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE || maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1476         {
1477           if(!maskTextureInfo.textures.empty())
1478           {
1479             textureSet.SetTexture(MASK_TEXTURE_INDEX, maskTextureInfo.textures[0]);
1480           }
1481         }
1482       }
1483     }
1484   }
1485   return textureSet;
1486 }
1487
1488 void TextureManager::RemoveTextureObserver(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
1489 {
1490   // Remove its observer
1491   if(observer)
1492   {
1493     const auto iterEnd = textureInfo.observerList.End();
1494     const auto iter    = std::find(textureInfo.observerList.Begin(), iterEnd, observer);
1495     if(iter != iterEnd)
1496     {
1497       // Disconnect and remove the observer.
1498       observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1499       textureInfo.observerList.Erase(iter);
1500     }
1501   }
1502 }
1503
1504 } // namespace Internal
1505
1506 } // namespace Toolkit
1507
1508 } // namespace Dali