dali-toolkit/internal/texture-manager/texture-manager-impl.cpp

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