Merge "Caching texture instead of textureSet in TextureManager" into devel/master
[platform/core/uifw/dali-toolkit.git] / 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   mQueueLoadFlag(false),
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                          mQueueLoadFlag);
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     if(mQueueLoadFlag)
710     {
711       // Remove textureId after NotifyObserver finished
712       mRemoveQueue.PushBack(textureId);
713     }
714     else
715     {
716       // Remove textureId in CacheManager.
717       mTextureCacheManager.RemoveCache(textureId);
718     }
719
720     if(observer)
721     {
722       // Remove element from the LoadQueue
723       for(auto&& element : mLoadQueue)
724       {
725         if(element.mObserver == observer)
726         {
727           // Do not erase the item. We will clear it later in ProcessLoadQueue().
728           element.mObserver = nullptr;
729           break;
730         }
731       }
732     }
733   }
734 }
735
736 void TextureManager::LoadImageSynchronously(
737   const VisualUrl&                 url,
738   const Dali::ImageDimensions&     desiredSize,
739   const Dali::FittingMode::Type&   fittingMode,
740   const Dali::SamplingMode::Type&  samplingMode,
741   const bool&                      orientationCorrection,
742   const bool&                      loadYuvPlanes,
743   std::vector<Devel::PixelBuffer>& pixelBuffers)
744 {
745   Devel::PixelBuffer pixelBuffer;
746   if(url.IsBufferResource())
747   {
748     const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url);
749     if(encodedImageBuffer)
750     {
751       pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
752     }
753   }
754   else
755   {
756     if(loadYuvPlanes)
757     {
758       Dali::LoadImagePlanesFromFile(url.GetUrl(), pixelBuffers, desiredSize, fittingMode, samplingMode, orientationCorrection);
759     }
760     else
761     {
762       pixelBuffer = Dali::LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
763     }
764   }
765
766   if(pixelBuffer)
767   {
768     pixelBuffers.push_back(pixelBuffer);
769   }
770 }
771
772 void TextureManager::AddObserver(TextureManager::LifecycleObserver& observer)
773 {
774   // make sure an observer doesn't observe the same object twice
775   // otherwise it will get multiple calls to ObjectDestroyed()
776   DALI_ASSERT_DEBUG(mLifecycleObservers.End() == std::find(mLifecycleObservers.Begin(), mLifecycleObservers.End(), &observer));
777   mLifecycleObservers.PushBack(&observer);
778 }
779
780 void TextureManager::RemoveObserver(TextureManager::LifecycleObserver& observer)
781 {
782   // Find the observer...
783   auto endIter = mLifecycleObservers.End();
784   for(auto iter = mLifecycleObservers.Begin(); iter != endIter; ++iter)
785   {
786     if((*iter) == &observer)
787     {
788       mLifecycleObservers.Erase(iter);
789       break;
790     }
791   }
792   DALI_ASSERT_DEBUG(endIter != mLifecycleObservers.End());
793 }
794
795 void TextureManager::LoadOrQueueTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
796 {
797   switch(textureInfo.loadState)
798   {
799     case LoadState::NOT_STARTED:
800     case LoadState::LOAD_FAILED:
801     {
802       if(mQueueLoadFlag)
803       {
804         QueueLoadTexture(textureInfo, observer);
805       }
806       else
807       {
808         LoadTexture(textureInfo, observer);
809       }
810       break;
811     }
812     case LoadState::UPLOADED:
813     {
814       if(mQueueLoadFlag)
815       {
816         QueueLoadTexture(textureInfo, observer);
817       }
818       else
819       {
820         // The Texture has already loaded. The other observers have already been notified.
821         // We need to send a "late" loaded notification for this observer.
822         EmitLoadComplete(observer, textureInfo, true);
823       }
824       break;
825     }
826     case LoadState::LOADING:
827     case LoadState::CANCELLED:
828     case LoadState::LOAD_FINISHED:
829     case LoadState::WAITING_FOR_MASK:
830     case LoadState::MASK_APPLYING:
831     case LoadState::MASK_APPLIED:
832     {
833       break;
834     }
835   }
836 }
837
838 void TextureManager::QueueLoadTexture(const TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
839 {
840   const auto& textureId = textureInfo.textureId;
841   mLoadQueue.PushBack(LoadQueueElement(textureId, observer));
842
843   observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
844 }
845
846 void TextureManager::LoadTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
847 {
848   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::LoadTexture(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
849
850   textureInfo.loadState = LoadState::LOADING;
851   if(!textureInfo.loadSynchronously)
852   {
853     auto& loadersContainer  = (textureInfo.url.IsLocalResource() || textureInfo.url.IsBufferResource()) ? mAsyncLocalLoaders : mAsyncRemoteLoaders;
854     auto  loadingHelperIt   = loadersContainer.GetNext();
855     auto  premultiplyOnLoad = (textureInfo.preMultiplyOnLoad && textureInfo.maskTextureId == INVALID_TEXTURE_ID) ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
856     DALI_ASSERT_ALWAYS(loadingHelperIt != loadersContainer.End());
857     if(textureInfo.animatedImageLoading)
858     {
859       loadingHelperIt->LoadAnimatedImage(textureInfo.textureId, textureInfo.animatedImageLoading, textureInfo.frameIndex, premultiplyOnLoad);
860     }
861     else
862     {
863       loadingHelperIt->Load(textureInfo.textureId, textureInfo.url, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, textureInfo.orientationCorrection, premultiplyOnLoad, textureInfo.loadYuvPlanes);
864     }
865   }
866   ObserveTexture(textureInfo, observer);
867 }
868
869 void TextureManager::ProcessLoadQueue()
870 {
871   for(auto&& element : mLoadQueue)
872   {
873     if(!element.mObserver)
874     {
875       continue;
876     }
877
878     TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(element.mTextureId);
879     if(cacheIndex != INVALID_CACHE_INDEX)
880     {
881       TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
882       if((textureInfo.loadState == LoadState::UPLOADED) || (textureInfo.loadState == LoadState::LOAD_FINISHED && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER))
883       {
884         EmitLoadComplete(element.mObserver, textureInfo, true);
885       }
886       else if(textureInfo.loadState == LoadState::LOADING)
887       {
888         // Note : LOADING state texture cannot be queue.
889         // This case be occured when same texture id are queue in mLoadQueue.
890         ObserveTexture(textureInfo, element.mObserver);
891       }
892       else
893       {
894         LoadTexture(textureInfo, element.mObserver);
895       }
896     }
897   }
898   mLoadQueue.Clear();
899 }
900
901 void TextureManager::ProcessRemoveQueue()
902 {
903   for(const auto& textureId : mRemoveQueue)
904   {
905     mTextureCacheManager.RemoveCache(textureId);
906   }
907   mRemoveQueue.Clear();
908 }
909
910 void TextureManager::ObserveTexture(TextureManager::TextureInfo& textureInfo,
911                                     TextureUploadObserver*       observer)
912 {
913   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ObserveTexture(): url:%s observer:%p\n", textureInfo.url.GetUrl().c_str(), observer);
914
915   if(observer)
916   {
917     textureInfo.observerList.PushBack(observer);
918     observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
919   }
920 }
921
922 void TextureManager::AsyncLoadComplete(const TextureManager::TextureId& textureId, std::vector<Devel::PixelBuffer>& pixelBuffers)
923 {
924   TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
925   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::AsyncLoadComplete( textureId:%d CacheIndex:%d )\n", textureId, cacheIndex.GetIndex());
926   if(cacheIndex != INVALID_CACHE_INDEX)
927   {
928     TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
929
930     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));
931
932     if(textureInfo.loadState != LoadState::CANCELLED)
933     {
934       // textureInfo can be invalidated after this call (as the mTextureInfoContainer may be modified)
935       PostLoad(textureInfo, pixelBuffers);
936     }
937     else
938     {
939       Remove(textureInfo.textureId, nullptr);
940     }
941   }
942 }
943
944 void TextureManager::PostLoad(TextureManager::TextureInfo& textureInfo, std::vector<Devel::PixelBuffer>& pixelBuffers)
945 {
946   // Was the load successful?
947   if(!pixelBuffers.empty())
948   {
949     if(pixelBuffers.size() == 1)
950     {
951       Devel::PixelBuffer pixelBuffer = pixelBuffers[0];
952       if(pixelBuffer && (pixelBuffer.GetWidth() != 0) && (pixelBuffer.GetHeight() != 0))
953       {
954         // No atlas support for now
955         textureInfo.useAtlas      = UseAtlas::NO_ATLAS;
956         textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
957
958         if(textureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE)
959         {
960           // If there is a mask texture ID associated with this texture, then apply the mask
961           // if it's already loaded. If it hasn't, and the mask is still loading,
962           // wait for the mask to finish loading.
963           // note, If the texture is already uploaded synchronously during loading,
964           // we don't need to apply mask.
965           if(textureInfo.loadState != LoadState::UPLOADED &&
966              textureInfo.maskTextureId != INVALID_TEXTURE_ID)
967           {
968             if(textureInfo.loadState == LoadState::MASK_APPLYING)
969             {
970               textureInfo.loadState = LoadState::MASK_APPLIED;
971               UploadTextures(pixelBuffers, textureInfo);
972               NotifyObservers(textureInfo, true);
973             }
974             else
975             {
976               LoadState maskLoadState = mTextureCacheManager.GetTextureStateInternal(textureInfo.maskTextureId);
977               textureInfo.pixelBuffer = pixelBuffer; // Store the pixel buffer temporarily
978               if(maskLoadState == LoadState::LOADING)
979               {
980                 textureInfo.loadState = LoadState::WAITING_FOR_MASK;
981               }
982               else if(maskLoadState == LoadState::LOAD_FINISHED || maskLoadState == LoadState::UPLOADED)
983               {
984                 // Send New Task to Thread
985                 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureInfo.maskTextureId);
986                 if(maskCacheIndex != INVALID_CACHE_INDEX)
987                 {
988                   TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
989                   if(maskTextureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER)
990                   {
991                     // Send New Task to Thread
992                     ApplyMask(textureInfo, textureInfo.maskTextureId);
993                   }
994                   else if(maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
995                   {
996                     // Upload image texture. textureInfo.loadState will be UPLOADED.
997                     UploadTextures(pixelBuffers, textureInfo);
998
999                     // notify mask texture set.
1000                     NotifyObservers(textureInfo, true);
1001                   }
1002                 }
1003               }
1004               else // maskLoadState == LoadState::LOAD_FAILED
1005               {
1006                 // Url texture load success, But alpha mask texture load failed. Run as normal image upload.
1007                 DALI_LOG_ERROR("Alpha mask image loading failed! Image will not be masked\n");
1008                 UploadTextures(pixelBuffers, textureInfo);
1009                 NotifyObservers(textureInfo, true);
1010               }
1011             }
1012           }
1013           else
1014           {
1015             UploadTextures(pixelBuffers, textureInfo);
1016             NotifyObservers(textureInfo, true);
1017           }
1018         }
1019         else
1020         {
1021           textureInfo.pixelBuffer = pixelBuffer; // Store the pixel data
1022           textureInfo.loadState   = LoadState::LOAD_FINISHED;
1023
1024           if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
1025           {
1026             NotifyObservers(textureInfo, true);
1027           }
1028           else // for the StorageType::KEEP_PIXEL_BUFFER and StorageType::KEEP_TEXTURE
1029           {
1030             // Check if there was another texture waiting for this load to complete
1031             // (e.g. if this was an image mask, and its load is on a different thread)
1032             CheckForWaitingTexture(textureInfo);
1033           }
1034         }
1035       }
1036     }
1037     else
1038     {
1039       // YUV case
1040       // No atlas support for now
1041       textureInfo.useAtlas      = UseAtlas::NO_ATLAS;
1042       textureInfo.preMultiplied = false;
1043
1044       UploadTextures(pixelBuffers, textureInfo);
1045       NotifyObservers(textureInfo, true);
1046     }
1047   }
1048   else
1049   {
1050     textureInfo.loadState = LoadState::LOAD_FAILED;
1051     if(textureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER || textureInfo.storageType == StorageType::KEEP_TEXTURE)
1052     {
1053       // Check if there was another texture waiting for this load to complete
1054       // (e.g. if this was an image mask, and its load is on a different thread)
1055       CheckForWaitingTexture(textureInfo);
1056     }
1057     else
1058     {
1059       NotifyObservers(textureInfo, false);
1060     }
1061   }
1062 }
1063
1064 void TextureManager::CheckForWaitingTexture(TextureManager::TextureInfo& maskTextureInfo)
1065 {
1066   if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED &&
1067      maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1068   {
1069     // Upload mask texture. textureInfo.loadState will be UPLOADED.
1070     std::vector<Devel::PixelBuffer> pixelBuffers;
1071     pixelBuffers.push_back(maskTextureInfo.pixelBuffer);
1072     UploadTextures(pixelBuffers, maskTextureInfo);
1073   }
1074
1075   // Search the cache, checking if any texture has this texture id as a
1076   // maskTextureId:
1077   const std::size_t size = mTextureCacheManager.size();
1078
1079   // TODO : Refactorize here to not iterate whole cached image.
1080   for(TextureCacheIndex cacheIndex = TextureCacheIndex(TextureManagerType::TEXTURE_CACHE_INDEX_TYPE_LOCAL, 0u); cacheIndex.GetIndex() < size; ++cacheIndex.detailValue.index)
1081   {
1082     if(mTextureCacheManager[cacheIndex].maskTextureId == maskTextureInfo.textureId &&
1083        mTextureCacheManager[cacheIndex].loadState == LoadState::WAITING_FOR_MASK)
1084     {
1085       TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1086
1087       if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED)
1088       {
1089         if(maskTextureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER)
1090         {
1091           // Send New Task to Thread
1092           ApplyMask(textureInfo, maskTextureInfo.textureId);
1093         }
1094       }
1095       else if(maskTextureInfo.loadState == LoadState::UPLOADED)
1096       {
1097         if(maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1098         {
1099           // Upload image texture. textureInfo.loadState will be UPLOADED.
1100           std::vector<Devel::PixelBuffer> pixelBuffers;
1101           pixelBuffers.push_back(textureInfo.pixelBuffer);
1102           UploadTextures(pixelBuffers, textureInfo);
1103
1104           // notify mask texture set.
1105           NotifyObservers(textureInfo, true);
1106         }
1107       }
1108       else
1109       {
1110         // Url texture load success, But alpha mask texture load failed. Run as normal image upload.
1111         DALI_LOG_ERROR("Alpha mask image loading failed! Image will not be masked\n");
1112         std::vector<Devel::PixelBuffer> pixelBuffers;
1113         pixelBuffers.push_back(textureInfo.pixelBuffer);
1114         UploadTextures(pixelBuffers, textureInfo);
1115         NotifyObservers(textureInfo, true);
1116       }
1117     }
1118   }
1119 }
1120
1121 void TextureManager::ApplyMask(TextureManager::TextureInfo& textureInfo, const TextureManager::TextureId& maskTextureId)
1122 {
1123   TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
1124   if(maskCacheIndex != INVALID_CACHE_INDEX)
1125   {
1126     Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
1127     Devel::PixelBuffer pixelBuffer     = textureInfo.pixelBuffer;
1128     textureInfo.pixelBuffer.Reset();
1129
1130     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ApplyMask(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
1131
1132     textureInfo.loadState   = LoadState::MASK_APPLYING;
1133     auto& loadersContainer  = (textureInfo.url.IsLocalResource() || textureInfo.url.IsBufferResource()) ? mAsyncLocalLoaders : mAsyncRemoteLoaders;
1134     auto  loadingHelperIt   = loadersContainer.GetNext();
1135     auto  premultiplyOnLoad = textureInfo.preMultiplyOnLoad ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
1136     DALI_ASSERT_ALWAYS(loadingHelperIt != loadersContainer.End());
1137     loadingHelperIt->ApplyMask(textureInfo.textureId, pixelBuffer, maskPixelBuffer, textureInfo.scaleFactor, textureInfo.cropToMask, premultiplyOnLoad);
1138   }
1139 }
1140
1141 void TextureManager::UploadTextures(std::vector<Devel::PixelBuffer>& pixelBuffers, TextureManager::TextureInfo& textureInfo)
1142 {
1143   if(!pixelBuffers.empty() && textureInfo.loadState != LoadState::UPLOADED && textureInfo.useAtlas != UseAtlas::USE_ATLAS)
1144   {
1145     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "  TextureManager::UploadTextures() New Texture for textureId:%d\n", textureInfo.textureId);
1146
1147     // Check if this pixelBuffer is premultiplied
1148     textureInfo.preMultiplied = pixelBuffers[0].IsAlphaPreMultiplied();
1149
1150     auto& renderingAddOn = RenderingAddOn::Get();
1151     if(renderingAddOn.IsValid())
1152     {
1153       renderingAddOn.CreateGeometry(textureInfo.textureId, pixelBuffers[0]);
1154     }
1155
1156     // Remove previous textures and insert new textures
1157     textureInfo.textures.clear();
1158
1159     for(auto&& pixelBuffer : pixelBuffers)
1160     {
1161       Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelBuffer.GetPixelFormat(), pixelBuffer.GetWidth(), pixelBuffer.GetHeight());
1162       PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer);
1163       texture.Upload(pixelData);
1164       textureInfo.textures.push_back(texture);
1165     }
1166   }
1167
1168   // Update the load state.
1169   // Note: This is regardless of success as we care about whether a
1170   // load attempt is in progress or not.  If unsuccessful, a broken
1171   // image is still loaded.
1172   textureInfo.loadState = LoadState::UPLOADED;
1173 }
1174
1175 void TextureManager::NotifyObservers(TextureManager::TextureInfo& textureInfo, const bool& success)
1176 {
1177   TextureId textureId = textureInfo.textureId;
1178
1179   // If there is an observer: Notify the load is complete, whether successful or not,
1180   // and erase it from the list
1181   TextureInfo* info = &textureInfo;
1182
1183   if(info->animatedImageLoading)
1184   {
1185     // If loading failed, we don't need to get frameCount and frameInterval.
1186     if(success)
1187     {
1188       info->frameCount    = info->animatedImageLoading.GetImageCount();
1189       info->frameInterval = info->animatedImageLoading.GetFrameInterval(info->frameIndex);
1190     }
1191     info->animatedImageLoading.Reset();
1192   }
1193
1194   mQueueLoadFlag = true;
1195
1196   // Reverse observer list that we can pop_back the observer.
1197   std::reverse(info->observerList.Begin(), info->observerList.End());
1198
1199   while(info->observerList.Count())
1200   {
1201     TextureUploadObserver* observer = *(info->observerList.End() - 1u);
1202
1203     // During LoadComplete() a Control ResourceReady() signal is emitted.
1204     // During that signal the app may add remove /add Textures (e.g. via
1205     // ImageViews).
1206     // It is possible for observers to be removed from the observer list,
1207     // and it is also possible for the mTextureInfoContainer to be modified,
1208     // invalidating the reference to the textureInfo struct.
1209     // Texture load requests for the same URL are deferred until the end of this
1210     // method.
1211     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));
1212
1213     // It is possible for the observer to be deleted.
1214     // Disconnect and remove the observer first.
1215     observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1216
1217     info->observerList.Erase(info->observerList.End() - 1u);
1218
1219     EmitLoadComplete(observer, *info, success);
1220
1221     // Get the textureInfo from the container again as it may have been invalidated.
1222     TextureCacheIndex textureInfoIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1223     if(textureInfoIndex == INVALID_CACHE_INDEX)
1224     {
1225       break; // texture has been removed - can stop.
1226     }
1227     info = &mTextureCacheManager[textureInfoIndex];
1228   }
1229
1230   mQueueLoadFlag = false;
1231   ProcessLoadQueue();
1232   ProcessRemoveQueue();
1233
1234   if(info->storageType == StorageType::RETURN_PIXEL_BUFFER && info->observerList.Count() == 0)
1235   {
1236     Remove(info->textureId, nullptr);
1237   }
1238 }
1239
1240 void TextureManager::ObserverDestroyed(TextureUploadObserver* observer)
1241 {
1242   const std::size_t size = mTextureCacheManager.size();
1243   for(TextureCacheIndex cacheIndex = TextureCacheIndex(TextureManagerType::TEXTURE_CACHE_INDEX_TYPE_LOCAL, 0u); cacheIndex.GetIndex() < size; ++cacheIndex.detailValue.index)
1244   {
1245     TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1246     for(TextureInfo::ObserverListType::Iterator j = textureInfo.observerList.Begin();
1247         j != textureInfo.observerList.End();)
1248     {
1249       if(*j == observer)
1250       {
1251         j = textureInfo.observerList.Erase(j);
1252       }
1253       else
1254       {
1255         ++j;
1256       }
1257     }
1258   }
1259
1260   // Remove element from the LoadQueue
1261   for(auto&& element : mLoadQueue)
1262   {
1263     if(element.mObserver == observer)
1264     {
1265       element.mObserver = nullptr;
1266     }
1267   }
1268 }
1269
1270 Dali::Geometry TextureManager::GetRenderGeometry(const TextureManager::TextureId& textureId, std::uint32_t& frontElements, std::uint32_t& backElements)
1271 {
1272   return RenderingAddOn::Get().IsValid() ? RenderingAddOn::Get().GetGeometry(textureId, frontElements, backElements) : Geometry();
1273 }
1274
1275 void TextureManager::EmitLoadComplete(TextureUploadObserver* observer, TextureManager::TextureInfo& textureInfo, const bool& success)
1276 {
1277   if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
1278   {
1279     observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::PIXEL_BUFFER, textureInfo.pixelBuffer, textureInfo.url.GetUrl(), textureInfo.preMultiplied));
1280   }
1281   else
1282   {
1283     TextureSet textureSet = GetTextureSet(textureInfo);
1284     if(textureInfo.isAnimatedImageFormat)
1285     {
1286       observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::ANIMATED_IMAGE_TEXTURE, textureInfo.textureId, textureSet, textureInfo.frameCount, textureInfo.frameInterval));
1287     }
1288     else
1289     {
1290       observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::TEXTURE, textureInfo.textureId, textureSet, (textureInfo.useAtlas == UseAtlas::USE_ATLAS) ? true : false, textureInfo.atlasRect, textureInfo.preMultiplied));
1291     }
1292   }
1293 }
1294
1295 TextureSet TextureManager::GetTextureSet(const TextureManager::TextureId& textureId)
1296 {
1297   TextureSet textureSet;
1298   TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
1299   if(loadState == TextureManager::LoadState::UPLOADED)
1300   {
1301     // LoadComplete has already been called - keep the same texture set
1302     TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1303     if(textureCacheIndex != INVALID_CACHE_INDEX)
1304     {
1305       TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
1306       textureSet = GetTextureSet(textureInfo);
1307     }
1308   }
1309   else
1310   {
1311     DALI_LOG_ERROR("GetTextureSet is failed. texture is not uploaded \n");
1312   }
1313   return textureSet;
1314 }
1315
1316 TextureSet TextureManager::GetTextureSet(const TextureManager::TextureInfo& textureInfo)
1317 {
1318   TextureSet textureSet;
1319
1320   // LoadComplete has already been called - keep the same texture set
1321   textureSet = TextureSet::New();
1322   if(!textureInfo.textures.empty())
1323   {
1324     if(textureInfo.textures.size() > 1) // For YUV case
1325     {
1326       uint32_t index = 0u;
1327       for(auto&& texture : textureInfo.textures)
1328       {
1329         textureSet.SetTexture(index++, texture);
1330       }
1331     }
1332     else
1333     {
1334       textureSet.SetTexture(TEXTURE_INDEX, textureInfo.textures[0]);
1335       TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureInfo.maskTextureId);
1336       if(maskCacheIndex != INVALID_CACHE_INDEX)
1337       {
1338         TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
1339         if(maskTextureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE || maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1340         {
1341           if(!maskTextureInfo.textures.empty())
1342           {
1343             textureSet.SetTexture(MASK_TEXTURE_INDEX, maskTextureInfo.textures[0]);
1344           }
1345         }
1346       }
1347     }
1348   }
1349   return textureSet;
1350 }
1351
1352 } // namespace Internal
1353
1354 } // namespace Toolkit
1355
1356 } // namespace Dali