[dali_2.0.16] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / texture-manager-impl.cpp
1 /*
2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali-toolkit/internal/visuals/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/devel-api/common/hash.h>
26 #include <dali/integration-api/debug.h>
27 #include <dali/public-api/math/vector4.h>
28 #include <dali/public-api/rendering/geometry.h>
29 #include <cstdlib>
30 #include <string>
31
32 // INTERNAL HEADERS
33 #include <dali-toolkit/internal/image-loader/image-atlas-impl.h>
34 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
35 #include <dali-toolkit/internal/visuals/rendering-addon.h>
36 #include <dali-toolkit/public-api/image-loader/sync-image-loader.h>
37
38 namespace
39 {
40 constexpr auto INITIAL_CACHE_NUMBER                    = size_t{0u};
41 constexpr auto DEFAULT_NUMBER_OF_LOCAL_LOADER_THREADS  = size_t{4u};
42 constexpr auto DEFAULT_NUMBER_OF_REMOTE_LOADER_THREADS = size_t{8u};
43
44 constexpr auto NUMBER_OF_LOCAL_LOADER_THREADS_ENV  = "DALI_TEXTURE_LOCAL_THREADS";
45 constexpr auto NUMBER_OF_REMOTE_LOADER_THREADS_ENV = "DALI_TEXTURE_REMOTE_THREADS";
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 } // namespace
68
69 namespace Dali
70 {
71 namespace Toolkit
72 {
73 namespace Internal
74 {
75 namespace
76 {
77 #ifdef DEBUG_ENABLED
78 Debug::Filter* gTextureManagerLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_TEXTURE_MANAGER");
79
80 #define GET_LOAD_STATE_STRING(loadState)                                                                                                              \
81   loadState == TextureManager::LoadState::NOT_STARTED ? "NOT_STARTED" : loadState == TextureManager::LoadState::LOADING          ? "LOADING"          \
82                                                                       : loadState == TextureManager::LoadState::LOAD_FINISHED    ? "LOAD_FINISHED"    \
83                                                                       : loadState == TextureManager::LoadState::WAITING_FOR_MASK ? "WAITING_FOR_MASK" \
84                                                                       : loadState == TextureManager::LoadState::MASK_APPLYING    ? "MASK_APPLYING"    \
85                                                                       : loadState == TextureManager::LoadState::MASK_APPLIED     ? "MASK_APPLIED"     \
86                                                                       : loadState == TextureManager::LoadState::UPLOADED         ? "UPLOADED"         \
87                                                                       : loadState == TextureManager::LoadState::CANCELLED        ? "CANCELLED"        \
88                                                                       : loadState == TextureManager::LoadState::LOAD_FAILED      ? "LOAD_FAILED"      \
89                                                                                                                                  : "Unknown"
90
91 #endif
92
93 const uint32_t DEFAULT_ATLAS_SIZE(1024u);               ///< This size can fit 8 by 8 images of average size 128 * 128
94 const Vector4  FULL_ATLAS_RECT(0.0f, 0.0f, 1.0f, 1.0f); ///< UV Rectangle that covers the full Texture
95 const int      INVALID_INDEX(-1);                       ///< Invalid index used to represent a non-existant TextureInfo struct
96 const int      INVALID_CACHE_INDEX(-1);                 ///< Invalid Cache index
97
98 void PreMultiply(Devel::PixelBuffer pixelBuffer, TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
99 {
100   if(Pixel::HasAlpha(pixelBuffer.GetPixelFormat()))
101   {
102     if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
103     {
104       pixelBuffer.MultiplyColorByAlpha();
105     }
106   }
107   else
108   {
109     preMultiplyOnLoad = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
110   }
111 }
112
113 } // Anonymous namespace
114
115 TextureManager::MaskingData::MaskingData()
116 : mAlphaMaskUrl(),
117   mAlphaMaskId(INVALID_TEXTURE_ID),
118   mContentScaleFactor(1.0f),
119   mCropToMask(true)
120 {
121 }
122
123 TextureManager::TextureManager()
124 : mAsyncLocalLoaders(GetNumberOfLocalLoaderThreads(), [&]() { return AsyncLoadingHelper(*this); }),
125   mAsyncRemoteLoaders(GetNumberOfRemoteLoaderThreads(), [&]() { return AsyncLoadingHelper(*this); }),
126   mExternalTextures(),
127   mLifecycleObservers(),
128   mLoadQueue(),
129   mCurrentTextureId(0),
130   mQueueLoadFlag(false)
131 {
132   // Initialize the AddOn
133   RenderingAddOn::Get();
134 }
135
136 TextureManager::~TextureManager()
137 {
138   for(auto iter = mLifecycleObservers.Begin(), endIter = mLifecycleObservers.End(); iter != endIter; ++iter)
139   {
140     (*iter)->TextureManagerDestroyed();
141   }
142 }
143
144 TextureSet TextureManager::LoadAnimatedImageTexture(
145   Dali::AnimatedImageLoading animatedImageLoading, uint32_t frameIndex, Dali::SamplingMode::Type samplingMode, bool synchronousLoading, TextureManager::TextureId& textureId, Dali::WrapMode::Type wrapModeU, Dali::WrapMode::Type wrapModeV, TextureUploadObserver* textureObserver)
146 {
147   TextureSet textureSet;
148
149   if(synchronousLoading)
150   {
151     Devel::PixelBuffer pixelBuffer;
152     if(animatedImageLoading)
153     {
154       pixelBuffer = animatedImageLoading.LoadFrame(frameIndex);
155     }
156     if(!pixelBuffer)
157     {
158       DALI_LOG_ERROR("TextureManager::LoadAnimatedImageTexture: Synchronous loading is failed\n");
159     }
160     else
161     {
162       PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
163       if(!textureSet)
164       {
165         Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelData.GetPixelFormat(), pixelData.GetWidth(), pixelData.GetHeight());
166         texture.Upload(pixelData);
167         textureSet = TextureSet::New();
168         textureSet.SetTexture(0u, texture);
169       }
170     }
171   }
172   else
173   {
174     auto preMultiply                    = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
175     textureId                           = RequestLoadInternal(animatedImageLoading.GetUrl(), INVALID_TEXTURE_ID, 1.0f, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::BOX_THEN_LINEAR, TextureManager::NO_ATLAS, false, StorageType::UPLOAD_TO_TEXTURE, textureObserver, true, TextureManager::ReloadPolicy::CACHED, preMultiply, animatedImageLoading, frameIndex);
176     TextureManager::LoadState loadState = GetTextureStateInternal(textureId);
177     if(loadState == TextureManager::LoadState::UPLOADED)
178     {
179       // UploadComplete has already been called - keep the same texture set
180       textureSet = GetTextureSet(textureId);
181     }
182   }
183
184   if(textureSet)
185   {
186     Sampler sampler = Sampler::New();
187     sampler.SetWrapMode(wrapModeU, wrapModeV);
188     textureSet.SetSampler(0u, sampler);
189   }
190
191   return textureSet;
192 }
193
194 Devel::PixelBuffer TextureManager::LoadPixelBuffer(
195   const VisualUrl& url, Dali::ImageDimensions desiredSize, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode, bool synchronousLoading, TextureUploadObserver* textureObserver, bool orientationCorrection, TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
196 {
197   Devel::PixelBuffer pixelBuffer;
198   if(synchronousLoading)
199   {
200     if(url.IsValid())
201     {
202       pixelBuffer = LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
203       if(pixelBuffer && preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
204       {
205         PreMultiply(pixelBuffer, preMultiplyOnLoad);
206       }
207     }
208   }
209   else
210   {
211     RequestLoadInternal(url, INVALID_TEXTURE_ID, 1.0f, desiredSize, fittingMode, samplingMode, TextureManager::NO_ATLAS, false, StorageType::RETURN_PIXEL_BUFFER, textureObserver, orientationCorrection, TextureManager::ReloadPolicy::FORCED, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u);
212   }
213
214   return pixelBuffer;
215 }
216
217 TextureSet TextureManager::LoadTexture(
218   const VisualUrl& url, Dali::ImageDimensions desiredSize, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode, MaskingDataPointer& maskInfo, bool synchronousLoading, TextureManager::TextureId& textureId, Vector4& textureRect, Dali::ImageDimensions& textureRectSize, bool& atlasingStatus, bool& loadingStatus, Dali::WrapMode::Type wrapModeU, Dali::WrapMode::Type wrapModeV, TextureUploadObserver* textureObserver, AtlasUploadObserver* atlasObserver, ImageAtlasManagerPtr imageAtlasManager, bool orientationCorrection, TextureManager::ReloadPolicy reloadPolicy, TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
219 {
220   TextureSet textureSet;
221
222   loadingStatus = false;
223   textureRect   = FULL_ATLAS_RECT;
224
225   if(VisualUrl::TEXTURE == url.GetProtocolType())
226   {
227     std::string location = url.GetLocation();
228     if(location.size() > 0u)
229     {
230       TextureId id = std::stoi(location);
231       for(auto&& elem : mExternalTextures)
232       {
233         if(elem.textureId == id)
234         {
235           preMultiplyOnLoad = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
236           textureId         = elem.textureId;
237           return elem.textureSet;
238         }
239       }
240     }
241   }
242   else if(synchronousLoading)
243   {
244     PixelData data;
245     if(url.IsValid())
246     {
247       Devel::PixelBuffer pixelBuffer = LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
248       if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
249       {
250         Devel::PixelBuffer maskPixelBuffer = LoadImageFromFile(maskInfo->mAlphaMaskUrl.GetUrl(), ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, true);
251         if(maskPixelBuffer)
252         {
253           pixelBuffer.ApplyMask(maskPixelBuffer, maskInfo->mContentScaleFactor, maskInfo->mCropToMask);
254         }
255       }
256       if(pixelBuffer)
257       {
258         PreMultiply(pixelBuffer, preMultiplyOnLoad);
259         data = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
260       }
261     }
262     if(!data)
263     {
264       DALI_LOG_ERROR("TextureManager::LoadTexture: Synchronous loading is failed\n");
265     }
266     else
267     {
268       if(atlasingStatus) // attempt atlasing
269       {
270         textureSet = imageAtlasManager->Add(textureRect, data);
271       }
272       if(!textureSet) // big image, no atlasing or atlasing failed
273       {
274         atlasingStatus  = false;
275         Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, data.GetPixelFormat(), data.GetWidth(), data.GetHeight());
276         texture.Upload(data);
277         textureSet = TextureSet::New();
278         textureSet.SetTexture(0u, texture);
279       }
280       else
281       {
282         textureRectSize.SetWidth(data.GetWidth());
283         textureRectSize.SetHeight(data.GetHeight());
284       }
285     }
286   }
287   else
288   {
289     loadingStatus = true;
290     if(atlasingStatus)
291     {
292       textureSet = imageAtlasManager->Add(textureRect, url.GetUrl(), desiredSize, fittingMode, true, atlasObserver);
293     }
294     if(!textureSet) // big image, no atlasing or atlasing failed
295     {
296       atlasingStatus = false;
297       if(!maskInfo || !maskInfo->mAlphaMaskUrl.IsValid())
298       {
299         textureId = RequestLoad(url, desiredSize, fittingMode, samplingMode, TextureManager::NO_ATLAS, textureObserver, orientationCorrection, reloadPolicy, preMultiplyOnLoad);
300       }
301       else
302       {
303         maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl);
304         textureId              = RequestLoad(url,
305                                 maskInfo->mAlphaMaskId,
306                                 maskInfo->mContentScaleFactor,
307                                 desiredSize,
308                                 fittingMode,
309                                 samplingMode,
310                                 TextureManager::NO_ATLAS,
311                                 maskInfo->mCropToMask,
312                                 textureObserver,
313                                 orientationCorrection,
314                                 reloadPolicy,
315                                 preMultiplyOnLoad);
316       }
317
318       TextureManager::LoadState loadState = GetTextureStateInternal(textureId);
319       if(loadState == TextureManager::LoadState::UPLOADED)
320       {
321         // UploadComplete has already been called - keep the same texture set
322         textureSet = GetTextureSet(textureId);
323       }
324
325       // If we are loading the texture, or waiting for the ready signal handler to complete, inform
326       // caller that they need to wait.
327       loadingStatus = (loadState == TextureManager::LoadState::LOADING ||
328                        loadState == TextureManager::LoadState::WAITING_FOR_MASK ||
329                        loadState == TextureManager::LoadState::MASK_APPLYING ||
330                        loadState == TextureManager::LoadState::MASK_APPLIED ||
331                        loadState == TextureManager::LoadState::NOT_STARTED ||
332                        mQueueLoadFlag);
333     }
334     else
335     {
336       textureRectSize = desiredSize;
337     }
338   }
339
340   if(!atlasingStatus && textureSet)
341   {
342     Sampler sampler = Sampler::New();
343     sampler.SetWrapMode(wrapModeU, wrapModeV);
344     textureSet.SetSampler(0u, sampler);
345   }
346
347   return textureSet;
348 }
349
350 TextureManager::TextureId TextureManager::RequestLoad(
351   const VisualUrl&                url,
352   const ImageDimensions           desiredSize,
353   FittingMode::Type               fittingMode,
354   Dali::SamplingMode::Type        samplingMode,
355   const UseAtlas                  useAtlas,
356   TextureUploadObserver*          observer,
357   bool                            orientationCorrection,
358   TextureManager::ReloadPolicy    reloadPolicy,
359   TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
360 {
361   return RequestLoadInternal(url, INVALID_TEXTURE_ID, 1.0f, desiredSize, fittingMode, samplingMode, useAtlas, false, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u);
362 }
363
364 TextureManager::TextureId TextureManager::RequestLoad(
365   const VisualUrl&                url,
366   TextureId                       maskTextureId,
367   float                           contentScale,
368   const ImageDimensions           desiredSize,
369   FittingMode::Type               fittingMode,
370   Dali::SamplingMode::Type        samplingMode,
371   const UseAtlas                  useAtlas,
372   bool                            cropToMask,
373   TextureUploadObserver*          observer,
374   bool                            orientationCorrection,
375   TextureManager::ReloadPolicy    reloadPolicy,
376   TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
377 {
378   return RequestLoadInternal(url, maskTextureId, contentScale, desiredSize, fittingMode, samplingMode, useAtlas, cropToMask, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u);
379 }
380
381 TextureManager::TextureId TextureManager::RequestMaskLoad(const VisualUrl& maskUrl)
382 {
383   // Use the normal load procedure to get the alpha mask.
384   auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
385   return RequestLoadInternal(maskUrl, INVALID_TEXTURE_ID, 1.0f, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, NO_ATLAS, false, StorageType::KEEP_PIXEL_BUFFER, NULL, true, TextureManager::ReloadPolicy::CACHED, preMultiply, Dali::AnimatedImageLoading(), 0u);
386 }
387
388 TextureManager::TextureId TextureManager::RequestLoadInternal(
389   const VisualUrl&                url,
390   TextureId                       maskTextureId,
391   float                           contentScale,
392   const ImageDimensions           desiredSize,
393   FittingMode::Type               fittingMode,
394   Dali::SamplingMode::Type        samplingMode,
395   UseAtlas                        useAtlas,
396   bool                            cropToMask,
397   StorageType                     storageType,
398   TextureUploadObserver*          observer,
399   bool                            orientationCorrection,
400   TextureManager::ReloadPolicy    reloadPolicy,
401   TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
402   Dali::AnimatedImageLoading      animatedImageLoading,
403   uint32_t                        frameIndex)
404 {
405   // First check if the requested Texture is cached.
406   bool isAnimatedImage = (animatedImageLoading) ? true : false;
407
408   TextureHash textureHash = INITIAL_CACHE_NUMBER;
409   int         cacheIndex  = INVALID_CACHE_INDEX;
410   if(storageType != StorageType::RETURN_PIXEL_BUFFER && !isAnimatedImage)
411   {
412     textureHash = GenerateHash(url.GetUrl(), desiredSize, fittingMode, samplingMode, useAtlas, maskTextureId);
413
414     // Look up the texture by hash. Note: The extra parameters are used in case of a hash collision.
415     cacheIndex = FindCachedTexture(textureHash, url.GetUrl(), desiredSize, fittingMode, samplingMode, useAtlas, maskTextureId, preMultiplyOnLoad);
416   }
417
418   TextureManager::TextureId textureId = INVALID_TEXTURE_ID;
419   // Check if the requested Texture exists in the cache.
420   if(cacheIndex != INVALID_CACHE_INDEX)
421   {
422     if(TextureManager::ReloadPolicy::CACHED == reloadPolicy)
423     {
424       // Mark this texture being used by another client resource. Forced reload would replace the current texture
425       // without the need for incrementing the reference count.
426       ++(mTextureInfoContainer[cacheIndex].referenceCount);
427     }
428     textureId = mTextureInfoContainer[cacheIndex].textureId;
429
430     // Update preMultiplyOnLoad value. It should be changed according to preMultiplied value of the cached info.
431     preMultiplyOnLoad = mTextureInfoContainer[cacheIndex].preMultiplied ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
432
433     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestLoad( url=%s observer=%p ) Using cached texture id@%d, textureId=%d\n", url.GetUrl().c_str(), observer, cacheIndex, textureId);
434   }
435
436   if(textureId == INVALID_TEXTURE_ID) // There was no caching, or caching not required
437   {
438     // We need a new Texture.
439     textureId        = GenerateUniqueTextureId();
440     bool preMultiply = (preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
441     mTextureInfoContainer.push_back(TextureInfo(textureId, maskTextureId, url.GetUrl(), desiredSize, contentScale, fittingMode, samplingMode, false, cropToMask, useAtlas, textureHash, orientationCorrection, preMultiply, animatedImageLoading, frameIndex));
442     cacheIndex = mTextureInfoContainer.size() - 1u;
443
444     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestLoad( url=%s observer=%p ) New texture, cacheIndex:%d, textureId=%d\n", url.GetUrl().c_str(), observer, cacheIndex, textureId);
445   }
446
447   // The below code path is common whether we are using the cache or not.
448   // The textureInfoIndex now refers to either a pre-existing cached TextureInfo,
449   // or a new TextureInfo just created.
450   TextureInfo& textureInfo(mTextureInfoContainer[cacheIndex]);
451   textureInfo.maskTextureId         = maskTextureId;
452   textureInfo.storageType           = storageType;
453   textureInfo.orientationCorrection = orientationCorrection;
454
455   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureInfo loadState:%s\n", GET_LOAD_STATE_STRING(textureInfo.loadState));
456
457   // Force reloading of texture by setting loadState unless already loading or cancelled.
458   if(TextureManager::ReloadPolicy::FORCED == reloadPolicy &&
459      TextureManager::LoadState::LOADING != textureInfo.loadState &&
460      TextureManager::LoadState::WAITING_FOR_MASK != textureInfo.loadState &&
461      TextureManager::LoadState::MASK_APPLYING != textureInfo.loadState &&
462      TextureManager::LoadState::MASK_APPLIED != textureInfo.loadState &&
463      TextureManager::LoadState::CANCELLED != textureInfo.loadState)
464   {
465     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, "TextureManager::RequestLoad( url=%s observer=%p ) ForcedReload cacheIndex:%d, textureId=%d\n", url.GetUrl().c_str(), observer, cacheIndex, textureId);
466
467     textureInfo.loadState = TextureManager::LoadState::NOT_STARTED;
468   }
469
470   // Check if we should add the observer.
471   // Only do this if we have not loaded yet and it will not have loaded by the end of this method.
472   switch(textureInfo.loadState)
473   {
474     case TextureManager::LoadState::LOAD_FAILED: // Failed notifies observer which then stops observing.
475     case TextureManager::LoadState::NOT_STARTED:
476     {
477       LoadOrQueueTexture(textureInfo, observer); // If called inside NotifyObservers, queues until afterwards
478       break;
479     }
480     case TextureManager::LoadState::LOADING:
481     case TextureManager::LoadState::WAITING_FOR_MASK:
482     case TextureManager::LoadState::MASK_APPLYING:
483     case TextureManager::LoadState::MASK_APPLIED:
484     {
485       ObserveTexture(textureInfo, observer);
486       break;
487     }
488     case TextureManager::LoadState::UPLOADED:
489     {
490       if(observer)
491       {
492         LoadOrQueueTexture(textureInfo, observer);
493       }
494       break;
495     }
496     case TextureManager::LoadState::CANCELLED:
497     {
498       // A cancelled texture hasn't finished loading yet. Treat as a loading texture
499       // (it's ref count has already been incremented, above)
500       textureInfo.loadState = TextureManager::LoadState::LOADING;
501       ObserveTexture(textureInfo, observer);
502       break;
503     }
504     case TextureManager::LoadState::LOAD_FINISHED:
505     {
506       // Loading has already completed.
507       if(observer && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
508       {
509         LoadOrQueueTexture(textureInfo, observer);
510       }
511       break;
512     }
513   }
514
515   // Return the TextureId for which this Texture can now be referenced by externally.
516   return textureId;
517 }
518
519 void TextureManager::Remove(const TextureManager::TextureId textureId, TextureUploadObserver* observer)
520 {
521   int textureInfoIndex = GetCacheIndexFromId(textureId);
522   if(textureInfoIndex != INVALID_INDEX)
523   {
524     TextureInfo& textureInfo(mTextureInfoContainer[textureInfoIndex]);
525
526     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::Remove(%d) url:%s\n  cacheIdx:%d loadState:%s reference count = %d\n", textureId, textureInfo.url.GetUrl().c_str(), textureInfoIndex, GET_LOAD_STATE_STRING(textureInfo.loadState), textureInfo.referenceCount);
527
528     // Decrement the reference count and check if this is the last user of this Texture.
529     if(--textureInfo.referenceCount <= 0)
530     {
531       // This is the last remove for this Texture.
532       textureInfo.referenceCount = 0;
533       bool removeTextureInfo     = false;
534
535       // If loaded, we can remove the TextureInfo and the Atlas (if atlased).
536       if(textureInfo.loadState == LoadState::UPLOADED)
537       {
538         if(textureInfo.atlas)
539         {
540           textureInfo.atlas.Remove(textureInfo.atlasRect);
541         }
542         removeTextureInfo = true;
543       }
544       else if(textureInfo.loadState == LoadState::LOADING)
545       {
546         // We mark the textureInfo for removal.
547         // Once the load has completed, this method will be called again.
548         textureInfo.loadState = LoadState::CANCELLED;
549       }
550       else
551       {
552         // In other states, we are not waiting for a load so we are safe to remove the TextureInfo data.
553         removeTextureInfo = true;
554       }
555
556       // If the state allows us to remove the TextureInfo data, we do so.
557       if(removeTextureInfo)
558       {
559         // Permanently remove the textureInfo struct.
560         mTextureInfoContainer.erase(mTextureInfoContainer.begin() + textureInfoIndex);
561       }
562     }
563
564     if(observer)
565     {
566       // Remove element from the LoadQueue
567       for(auto&& element : mLoadQueue)
568       {
569         if(element.mObserver == observer)
570         {
571           mLoadQueue.Erase(&element);
572           break;
573         }
574       }
575     }
576   }
577 }
578
579 VisualUrl TextureManager::GetVisualUrl(TextureId textureId)
580 {
581   VisualUrl visualUrl("");
582   int       cacheIndex = GetCacheIndexFromId(textureId);
583
584   if(cacheIndex != INVALID_CACHE_INDEX)
585   {
586     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::GetVisualUrl. Using cached texture id=%d, textureId=%d\n", cacheIndex, textureId);
587
588     TextureInfo& cachedTextureInfo(mTextureInfoContainer[cacheIndex]);
589     visualUrl = cachedTextureInfo.url;
590   }
591   return visualUrl;
592 }
593
594 TextureManager::LoadState TextureManager::GetTextureState(TextureId textureId)
595 {
596   LoadState loadState = TextureManager::LoadState::NOT_STARTED;
597
598   int cacheIndex = GetCacheIndexFromId(textureId);
599   if(cacheIndex != INVALID_CACHE_INDEX)
600   {
601     TextureInfo& cachedTextureInfo(mTextureInfoContainer[cacheIndex]);
602     loadState = cachedTextureInfo.loadState;
603   }
604   else
605   {
606     for(auto&& elem : mExternalTextures)
607     {
608       if(elem.textureId == textureId)
609       {
610         loadState = LoadState::UPLOADED;
611         break;
612       }
613     }
614   }
615   return loadState;
616 }
617
618 TextureManager::LoadState TextureManager::GetTextureStateInternal(TextureId textureId)
619 {
620   LoadState loadState = TextureManager::LoadState::NOT_STARTED;
621
622   int cacheIndex = GetCacheIndexFromId(textureId);
623   if(cacheIndex != INVALID_CACHE_INDEX)
624   {
625     TextureInfo& cachedTextureInfo(mTextureInfoContainer[cacheIndex]);
626     loadState = cachedTextureInfo.loadState;
627   }
628
629   return loadState;
630 }
631
632 TextureSet TextureManager::GetTextureSet(TextureId textureId)
633 {
634   TextureSet textureSet; // empty handle
635
636   int cacheIndex = GetCacheIndexFromId(textureId);
637   if(cacheIndex != INVALID_CACHE_INDEX)
638   {
639     TextureInfo& cachedTextureInfo(mTextureInfoContainer[cacheIndex]);
640     textureSet = cachedTextureInfo.textureSet;
641   }
642   else
643   {
644     for(auto&& elem : mExternalTextures)
645     {
646       if(elem.textureId == textureId)
647       {
648         textureSet = elem.textureSet;
649         break;
650       }
651     }
652   }
653   return textureSet;
654 }
655
656 std::string TextureManager::AddExternalTexture(TextureSet& textureSet)
657 {
658   TextureManager::ExternalTextureInfo info;
659   info.textureId  = GenerateUniqueTextureId();
660   info.textureSet = textureSet;
661   mExternalTextures.emplace_back(info);
662   return VisualUrl::CreateTextureUrl(std::to_string(info.textureId));
663 }
664
665 TextureSet TextureManager::RemoveExternalTexture(const std::string& url)
666 {
667   if(url.size() > 0u)
668   {
669     // get the location from the Url
670     VisualUrl parseUrl(url);
671     if(VisualUrl::TEXTURE == parseUrl.GetProtocolType())
672     {
673       std::string location = parseUrl.GetLocation();
674       if(location.size() > 0u)
675       {
676         TextureId  id  = std::stoi(location);
677         const auto end = mExternalTextures.end();
678         for(auto iter = mExternalTextures.begin(); iter != end; ++iter)
679         {
680           if(iter->textureId == id)
681           {
682             auto textureSet = iter->textureSet;
683             mExternalTextures.erase(iter);
684             return textureSet;
685           }
686         }
687       }
688     }
689   }
690   return TextureSet();
691 }
692
693 void TextureManager::AddObserver(TextureManager::LifecycleObserver& observer)
694 {
695   // make sure an observer doesn't observe the same object twice
696   // otherwise it will get multiple calls to ObjectDestroyed()
697   DALI_ASSERT_DEBUG(mLifecycleObservers.End() == std::find(mLifecycleObservers.Begin(), mLifecycleObservers.End(), &observer));
698   mLifecycleObservers.PushBack(&observer);
699 }
700
701 void TextureManager::RemoveObserver(TextureManager::LifecycleObserver& observer)
702 {
703   // Find the observer...
704   auto endIter = mLifecycleObservers.End();
705   for(auto iter = mLifecycleObservers.Begin(); iter != endIter; ++iter)
706   {
707     if((*iter) == &observer)
708     {
709       mLifecycleObservers.Erase(iter);
710       break;
711     }
712   }
713   DALI_ASSERT_DEBUG(endIter != mLifecycleObservers.End());
714 }
715
716 void TextureManager::LoadOrQueueTexture(TextureInfo& textureInfo, TextureUploadObserver* observer)
717 {
718   switch(textureInfo.loadState)
719   {
720     case LoadState::NOT_STARTED:
721     case LoadState::LOAD_FAILED:
722     {
723       if(mQueueLoadFlag)
724       {
725         QueueLoadTexture(textureInfo, observer);
726       }
727       else
728       {
729         LoadTexture(textureInfo, observer);
730       }
731       break;
732     }
733     case LoadState::UPLOADED:
734     {
735       if(mQueueLoadFlag)
736       {
737         QueueLoadTexture(textureInfo, observer);
738       }
739       else
740       {
741         // The Texture has already loaded. The other observers have already been notified.
742         // We need to send a "late" loaded notification for this observer.
743         observer->UploadComplete(true, textureInfo.textureId, textureInfo.textureSet, textureInfo.useAtlas, textureInfo.atlasRect, textureInfo.preMultiplied);
744       }
745       break;
746     }
747     case LoadState::LOADING:
748     case LoadState::CANCELLED:
749     case LoadState::LOAD_FINISHED:
750     case LoadState::WAITING_FOR_MASK:
751     case LoadState::MASK_APPLYING:
752     case LoadState::MASK_APPLIED:
753     {
754       break;
755     }
756   }
757 }
758
759 void TextureManager::QueueLoadTexture(TextureInfo& textureInfo, TextureUploadObserver* observer)
760 {
761   auto textureId = textureInfo.textureId;
762   mLoadQueue.PushBack(LoadQueueElement(textureId, observer));
763
764   observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
765 }
766
767 void TextureManager::LoadTexture(TextureInfo& textureInfo, TextureUploadObserver* observer)
768 {
769   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::LoadTexture(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
770
771   textureInfo.loadState = LoadState::LOADING;
772   if(!textureInfo.loadSynchronously)
773   {
774     auto& loadersContainer  = textureInfo.url.IsLocalResource() ? mAsyncLocalLoaders : mAsyncRemoteLoaders;
775     auto  loadingHelperIt   = loadersContainer.GetNext();
776     auto  premultiplyOnLoad = (textureInfo.preMultiplyOnLoad && textureInfo.maskTextureId == INVALID_TEXTURE_ID) ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
777     DALI_ASSERT_ALWAYS(loadingHelperIt != loadersContainer.End());
778     if(textureInfo.animatedImageLoading)
779     {
780       loadingHelperIt->LoadAnimatedImage(textureInfo.textureId, textureInfo.animatedImageLoading, textureInfo.frameIndex);
781     }
782     else
783     {
784       loadingHelperIt->Load(textureInfo.textureId, textureInfo.url, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, textureInfo.orientationCorrection, premultiplyOnLoad);
785     }
786   }
787   ObserveTexture(textureInfo, observer);
788 }
789
790 void TextureManager::ProcessQueuedTextures()
791 {
792   for(auto&& element : mLoadQueue)
793   {
794     if(!element.mObserver)
795     {
796       continue;
797     }
798
799     int cacheIndex = GetCacheIndexFromId(element.mTextureId);
800     if(cacheIndex != INVALID_CACHE_INDEX)
801     {
802       TextureInfo& textureInfo(mTextureInfoContainer[cacheIndex]);
803       if(textureInfo.loadState == LoadState::UPLOADED)
804       {
805         element.mObserver->UploadComplete(true, textureInfo.textureId, textureInfo.textureSet, textureInfo.useAtlas, textureInfo.atlasRect, textureInfo.preMultiplied);
806       }
807       else if(textureInfo.loadState == LoadState::LOAD_FINISHED && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
808       {
809         element.mObserver->LoadComplete(true, textureInfo.pixelBuffer, textureInfo.url, textureInfo.preMultiplied);
810       }
811       else
812       {
813         LoadTexture(textureInfo, element.mObserver);
814       }
815     }
816   }
817   mLoadQueue.Clear();
818 }
819
820 void TextureManager::ObserveTexture(TextureInfo&           textureInfo,
821                                     TextureUploadObserver* observer)
822 {
823   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ObserveTexture(): url:%s observer:%p\n", textureInfo.url.GetUrl().c_str(), observer);
824
825   if(observer)
826   {
827     textureInfo.observerList.PushBack(observer);
828     observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
829   }
830 }
831
832 void TextureManager::AsyncLoadComplete(AsyncLoadingInfoContainerType& loadingContainer, uint32_t id, Devel::PixelBuffer pixelBuffer)
833 {
834   DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::AsyncLoadComplete( id:%d )\n", id);
835
836   if(loadingContainer.size() >= 1u)
837   {
838     AsyncLoadingInfo loadingInfo = loadingContainer.front();
839
840     if(loadingInfo.loadId == id)
841     {
842       int cacheIndex = GetCacheIndexFromId(loadingInfo.textureId);
843       if(cacheIndex != INVALID_CACHE_INDEX)
844       {
845         TextureInfo& textureInfo(mTextureInfoContainer[cacheIndex]);
846
847         DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "  textureId:%d Url:%s CacheIndex:%d LoadState: %d\n", textureInfo.textureId, textureInfo.url.GetUrl().c_str(), cacheIndex, textureInfo.loadState);
848
849         if(textureInfo.loadState != LoadState::CANCELLED)
850         {
851           // textureInfo can be invalidated after this call (as the mTextureInfoContainer may be modified)
852           PostLoad(textureInfo, pixelBuffer);
853         }
854         else
855         {
856           Remove(textureInfo.textureId, nullptr);
857         }
858       }
859     }
860
861     loadingContainer.pop_front();
862   }
863 }
864
865 void TextureManager::PostLoad(TextureInfo& textureInfo, Devel::PixelBuffer& pixelBuffer)
866 {
867   // Was the load successful?
868   if(pixelBuffer && (pixelBuffer.GetWidth() != 0) && (pixelBuffer.GetHeight() != 0))
869   {
870     // No atlas support for now
871     textureInfo.useAtlas      = NO_ATLAS;
872     textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
873
874     if(textureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE)
875     {
876       // If there is a mask texture ID associated with this texture, then apply the mask
877       // if it's already loaded. If it hasn't, and the mask is still loading,
878       // wait for the mask to finish loading.
879       if(textureInfo.maskTextureId != INVALID_TEXTURE_ID)
880       {
881         if(textureInfo.loadState == LoadState::MASK_APPLYING)
882         {
883           textureInfo.loadState = LoadState::MASK_APPLIED;
884           UploadTexture(pixelBuffer, textureInfo);
885           NotifyObservers(textureInfo, true);
886         }
887         else
888         {
889           LoadState maskLoadState = GetTextureStateInternal(textureInfo.maskTextureId);
890           textureInfo.pixelBuffer = pixelBuffer; // Store the pixel buffer temporarily
891           if(maskLoadState == LoadState::LOADING)
892           {
893             textureInfo.loadState = LoadState::WAITING_FOR_MASK;
894           }
895           else if(maskLoadState == LoadState::LOAD_FINISHED)
896           {
897             // Send New Task to Thread
898             ApplyMask(textureInfo, textureInfo.maskTextureId);
899           }
900         }
901       }
902       else
903       {
904         UploadTexture(pixelBuffer, textureInfo);
905         NotifyObservers(textureInfo, true);
906       }
907     }
908     else
909     {
910       textureInfo.pixelBuffer = pixelBuffer; // Store the pixel data
911       textureInfo.loadState   = LoadState::LOAD_FINISHED;
912
913       if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
914       {
915         NotifyObservers(textureInfo, true);
916       }
917       else
918       {
919         // Check if there was another texture waiting for this load to complete
920         // (e.g. if this was an image mask, and its load is on a different thread)
921         CheckForWaitingTexture(textureInfo);
922       }
923     }
924   }
925   else
926   {
927     textureInfo.loadState = LoadState::LOAD_FAILED;
928     CheckForWaitingTexture(textureInfo);
929     NotifyObservers(textureInfo, false);
930   }
931 }
932
933 void TextureManager::CheckForWaitingTexture(TextureInfo& maskTextureInfo)
934 {
935   // Search the cache, checking if any texture has this texture id as a
936   // maskTextureId:
937   const unsigned int size = mTextureInfoContainer.size();
938
939   for(unsigned int cacheIndex = 0; cacheIndex < size; ++cacheIndex)
940   {
941     if(mTextureInfoContainer[cacheIndex].maskTextureId == maskTextureInfo.textureId &&
942        mTextureInfoContainer[cacheIndex].loadState == LoadState::WAITING_FOR_MASK)
943     {
944       TextureInfo& textureInfo(mTextureInfoContainer[cacheIndex]);
945
946       if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED)
947       {
948         // Send New Task to Thread
949         ApplyMask(textureInfo, maskTextureInfo.textureId);
950       }
951       else
952       {
953         textureInfo.pixelBuffer.Reset();
954         textureInfo.loadState = LoadState::LOAD_FAILED;
955         NotifyObservers(textureInfo, false);
956       }
957     }
958   }
959 }
960
961 void TextureManager::ApplyMask(TextureInfo& textureInfo, TextureId maskTextureId)
962 {
963   int maskCacheIndex = GetCacheIndexFromId(maskTextureId);
964   if(maskCacheIndex != INVALID_CACHE_INDEX)
965   {
966     Devel::PixelBuffer maskPixelBuffer = mTextureInfoContainer[maskCacheIndex].pixelBuffer;
967     Devel::PixelBuffer pixelBuffer     = textureInfo.pixelBuffer;
968     textureInfo.pixelBuffer.Reset();
969
970     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ApplyMask(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
971
972     textureInfo.loadState   = LoadState::MASK_APPLYING;
973     auto& loadersContainer  = textureInfo.url.IsLocalResource() ? mAsyncLocalLoaders : mAsyncRemoteLoaders;
974     auto  loadingHelperIt   = loadersContainer.GetNext();
975     auto  premultiplyOnLoad = textureInfo.preMultiplyOnLoad ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
976     DALI_ASSERT_ALWAYS(loadingHelperIt != loadersContainer.End());
977     loadingHelperIt->ApplyMask(textureInfo.textureId, pixelBuffer, maskPixelBuffer, textureInfo.scaleFactor, textureInfo.cropToMask, premultiplyOnLoad);
978   }
979 }
980
981 void TextureManager::UploadTexture(Devel::PixelBuffer& pixelBuffer, TextureInfo& textureInfo)
982 {
983   if(textureInfo.useAtlas != USE_ATLAS)
984   {
985     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "  TextureManager::UploadTexture() New Texture for textureId:%d\n", textureInfo.textureId);
986
987     // Check if this pixelBuffer is premultiplied
988     textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
989
990     auto& renderingAddOn = RenderingAddOn::Get();
991     if(renderingAddOn.IsValid())
992     {
993       renderingAddOn.CreateGeometry(textureInfo.textureId, pixelBuffer);
994     }
995
996     Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelBuffer.GetPixelFormat(), pixelBuffer.GetWidth(), pixelBuffer.GetHeight());
997
998     PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer);
999     texture.Upload(pixelData);
1000     if(!textureInfo.textureSet)
1001     {
1002       textureInfo.textureSet = TextureSet::New();
1003     }
1004     textureInfo.textureSet.SetTexture(0u, texture);
1005   }
1006
1007   // Update the load state.
1008   // Note: This is regardless of success as we care about whether a
1009   // load attempt is in progress or not.  If unsuccessful, a broken
1010   // image is still loaded.
1011   textureInfo.loadState = LoadState::UPLOADED;
1012 }
1013
1014 void TextureManager::NotifyObservers(TextureInfo& textureInfo, bool success)
1015 {
1016   TextureId textureId = textureInfo.textureId;
1017
1018   // If there is an observer: Notify the load is complete, whether successful or not,
1019   // and erase it from the list
1020   TextureInfo* info = &textureInfo;
1021
1022   mQueueLoadFlag = true;
1023
1024   while(info->observerList.Count())
1025   {
1026     TextureUploadObserver* observer = info->observerList[0];
1027
1028     // During UploadComplete() a Control ResourceReady() signal is emitted.
1029     // During that signal the app may add remove /add Textures (e.g. via
1030     // ImageViews).
1031     // It is possible for observers to be removed from the observer list,
1032     // and it is also possible for the mTextureInfoContainer to be modified,
1033     // invalidating the reference to the textureInfo struct.
1034     // Texture load requests for the same URL are deferred until the end of this
1035     // method.
1036     DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "NotifyObservers() url:%s loadState:%s\n", textureInfo.url.GetUrl().c_str(), GET_LOAD_STATE_STRING(textureInfo.loadState));
1037
1038     // It is possible for the observer to be deleted.
1039     // Disconnect and remove the observer first.
1040     observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1041
1042     info->observerList.Erase(info->observerList.begin());
1043
1044     if(info->storageType == StorageType::RETURN_PIXEL_BUFFER)
1045     {
1046       observer->LoadComplete(success, info->pixelBuffer, info->url, info->preMultiplied);
1047     }
1048     else
1049     {
1050       observer->UploadComplete(success, info->textureId, info->textureSet, info->useAtlas, info->atlasRect, info->preMultiplied);
1051     }
1052
1053     // Get the textureInfo from the container again as it may have been invalidated.
1054     int textureInfoIndex = GetCacheIndexFromId(textureId);
1055     if(textureInfoIndex == INVALID_CACHE_INDEX)
1056     {
1057       break; // texture has been removed - can stop.
1058     }
1059     info = &mTextureInfoContainer[textureInfoIndex];
1060   }
1061
1062   mQueueLoadFlag = false;
1063   ProcessQueuedTextures();
1064
1065   if(info->storageType == StorageType::RETURN_PIXEL_BUFFER && info->observerList.Count() == 0)
1066   {
1067     Remove(info->textureId, nullptr);
1068   }
1069 }
1070
1071 TextureManager::TextureId TextureManager::GenerateUniqueTextureId()
1072 {
1073   return mCurrentTextureId++;
1074 }
1075
1076 int TextureManager::GetCacheIndexFromId(const TextureId textureId)
1077 {
1078   const unsigned int size = mTextureInfoContainer.size();
1079
1080   for(unsigned int i = 0; i < size; ++i)
1081   {
1082     if(mTextureInfoContainer[i].textureId == textureId)
1083     {
1084       return i;
1085     }
1086   }
1087
1088   return INVALID_CACHE_INDEX;
1089 }
1090
1091 TextureManager::TextureHash TextureManager::GenerateHash(
1092   const std::string&             url,
1093   const ImageDimensions          size,
1094   const FittingMode::Type        fittingMode,
1095   const Dali::SamplingMode::Type samplingMode,
1096   const UseAtlas                 useAtlas,
1097   TextureId                      maskTextureId)
1098 {
1099   std::string    hashTarget(url);
1100   const size_t   urlLength = hashTarget.length();
1101   const uint16_t width     = size.GetWidth();
1102   const uint16_t height    = size.GetWidth();
1103
1104   // If either the width or height has been specified, include the resizing options in the hash
1105   if(width != 0 || height != 0)
1106   {
1107     // We are appending 5 bytes to the URL to form the hash input.
1108     hashTarget.resize(urlLength + 5u);
1109     char* hashTargetPtr = &(hashTarget[urlLength]);
1110
1111     // Pack the width and height (4 bytes total).
1112     *hashTargetPtr++ = size.GetWidth() & 0xff;
1113     *hashTargetPtr++ = (size.GetWidth() >> 8u) & 0xff;
1114     *hashTargetPtr++ = size.GetHeight() & 0xff;
1115     *hashTargetPtr++ = (size.GetHeight() >> 8u) & 0xff;
1116
1117     // Bit-pack the FittingMode, SamplingMode and atlasing.
1118     // FittingMode=2bits, SamplingMode=3bits, useAtlas=1bit
1119     *hashTargetPtr = (fittingMode << 4u) | (samplingMode << 1) | useAtlas;
1120   }
1121   else
1122   {
1123     // We are not including sizing information, but we still need an extra byte for atlasing.
1124     hashTarget.resize(urlLength + 1u);
1125
1126     // Add the atlasing to the hash input.
1127     switch(useAtlas)
1128     {
1129       case UseAtlas::NO_ATLAS:
1130       {
1131         hashTarget[urlLength] = 'f';
1132         break;
1133       }
1134       case UseAtlas::USE_ATLAS:
1135       {
1136         hashTarget[urlLength] = 't';
1137         break;
1138       }
1139     }
1140   }
1141
1142   if(maskTextureId != INVALID_TEXTURE_ID)
1143   {
1144     auto textureIdIndex = hashTarget.length();
1145     hashTarget.resize(hashTarget.length() + sizeof(TextureId));
1146     unsigned char* hashTargetPtr = reinterpret_cast<unsigned char*>(&(hashTarget[textureIdIndex]));
1147
1148     // Append the texture id to the end of the URL byte by byte:
1149     // (to avoid SIGBUS / alignment issues)
1150     for(size_t byteIter = 0; byteIter < sizeof(TextureId); ++byteIter)
1151     {
1152       *hashTargetPtr++ = maskTextureId & 0xff;
1153       maskTextureId >>= 8u;
1154     }
1155   }
1156
1157   return Dali::CalculateHash(hashTarget);
1158 }
1159
1160 int TextureManager::FindCachedTexture(
1161   const TextureManager::TextureHash hash,
1162   const std::string&                url,
1163   const ImageDimensions             size,
1164   const FittingMode::Type           fittingMode,
1165   const Dali::SamplingMode::Type    samplingMode,
1166   const bool                        useAtlas,
1167   TextureId                         maskTextureId,
1168   TextureManager::MultiplyOnLoad    preMultiplyOnLoad)
1169 {
1170   // Default to an invalid ID, in case we do not find a match.
1171   int cacheIndex = INVALID_CACHE_INDEX;
1172
1173   // Iterate through our hashes to find a match.
1174   const unsigned int count = mTextureInfoContainer.size();
1175   for(unsigned int i = 0u; i < count; ++i)
1176   {
1177     if(mTextureInfoContainer[i].hash == hash)
1178     {
1179       // We have a match, now we check all the original parameters in case of a hash collision.
1180       TextureInfo& textureInfo(mTextureInfoContainer[i]);
1181
1182       if((url == textureInfo.url.GetUrl()) &&
1183          (useAtlas == textureInfo.useAtlas) &&
1184          (maskTextureId == textureInfo.maskTextureId) &&
1185          (size == textureInfo.desiredSize) &&
1186          ((size.GetWidth() == 0 && size.GetHeight() == 0) ||
1187           (fittingMode == textureInfo.fittingMode &&
1188            samplingMode == textureInfo.samplingMode)))
1189       {
1190         // 1. If preMultiplyOnLoad is MULTIPLY_ON_LOAD, then textureInfo.preMultiplyOnLoad should be true. The premultiplication result can be different.
1191         // 2. If preMultiplyOnLoad is LOAD_WITHOUT_MULTIPLY, then textureInfo.preMultiplied should be false.
1192         if((preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD && textureInfo.preMultiplyOnLoad) || (preMultiplyOnLoad == TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY && !textureInfo.preMultiplied))
1193         {
1194           // The found Texture is a match.
1195           cacheIndex = i;
1196           break;
1197         }
1198       }
1199     }
1200   }
1201
1202   return cacheIndex;
1203 }
1204
1205 void TextureManager::ObserverDestroyed(TextureUploadObserver* observer)
1206 {
1207   const unsigned int count = mTextureInfoContainer.size();
1208   for(unsigned int i = 0; i < count; ++i)
1209   {
1210     TextureInfo& textureInfo(mTextureInfoContainer[i]);
1211     for(TextureInfo::ObserverListType::Iterator j = textureInfo.observerList.Begin();
1212         j != textureInfo.observerList.End();)
1213     {
1214       if(*j == observer)
1215       {
1216         j = textureInfo.observerList.Erase(j);
1217       }
1218       else
1219       {
1220         ++j;
1221       }
1222     }
1223   }
1224
1225   // Remove element from the LoadQueue
1226   for(auto&& element : mLoadQueue)
1227   {
1228     if(element.mObserver == observer)
1229     {
1230       element.mObserver = nullptr;
1231     }
1232   }
1233 }
1234
1235 TextureManager::AsyncLoadingHelper::AsyncLoadingHelper(TextureManager& textureManager)
1236 : AsyncLoadingHelper(Toolkit::AsyncImageLoader::New(), textureManager, AsyncLoadingInfoContainerType())
1237 {
1238 }
1239
1240 void TextureManager::AsyncLoadingHelper::LoadAnimatedImage(TextureId                  textureId,
1241                                                            Dali::AnimatedImageLoading animatedImageLoading,
1242                                                            uint32_t                   frameIndex)
1243 {
1244   mLoadingInfoContainer.push_back(AsyncLoadingInfo(textureId));
1245   auto id                             = DevelAsyncImageLoader::LoadAnimatedImage(mLoader, animatedImageLoading, frameIndex);
1246   mLoadingInfoContainer.back().loadId = id;
1247 }
1248
1249 void TextureManager::AsyncLoadingHelper::Load(TextureId                                textureId,
1250                                               const VisualUrl&                         url,
1251                                               ImageDimensions                          desiredSize,
1252                                               FittingMode::Type                        fittingMode,
1253                                               SamplingMode::Type                       samplingMode,
1254                                               bool                                     orientationCorrection,
1255                                               DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad)
1256 {
1257   mLoadingInfoContainer.push_back(AsyncLoadingInfo(textureId));
1258   auto id                             = DevelAsyncImageLoader::Load(mLoader, url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection, preMultiplyOnLoad);
1259   mLoadingInfoContainer.back().loadId = id;
1260 }
1261
1262 void TextureManager::AsyncLoadingHelper::ApplyMask(TextureId                                textureId,
1263                                                    Devel::PixelBuffer                       pixelBuffer,
1264                                                    Devel::PixelBuffer                       maskPixelBuffer,
1265                                                    float                                    contentScale,
1266                                                    bool                                     cropToMask,
1267                                                    DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad)
1268 {
1269   mLoadingInfoContainer.push_back(AsyncLoadingInfo(textureId));
1270   auto id                             = DevelAsyncImageLoader::ApplyMask(mLoader, pixelBuffer, maskPixelBuffer, contentScale, cropToMask, preMultiplyOnLoad);
1271   mLoadingInfoContainer.back().loadId = id;
1272 }
1273
1274 TextureManager::AsyncLoadingHelper::AsyncLoadingHelper(AsyncLoadingHelper&& rhs)
1275 : AsyncLoadingHelper(rhs.mLoader, rhs.mTextureManager, std::move(rhs.mLoadingInfoContainer))
1276 {
1277 }
1278
1279 TextureManager::AsyncLoadingHelper::AsyncLoadingHelper(
1280   Toolkit::AsyncImageLoader       loader,
1281   TextureManager&                 textureManager,
1282   AsyncLoadingInfoContainerType&& loadingInfoContainer)
1283 : mLoader(loader),
1284   mTextureManager(textureManager),
1285   mLoadingInfoContainer(std::move(loadingInfoContainer))
1286 {
1287   DevelAsyncImageLoader::PixelBufferLoadedSignal(mLoader).Connect(
1288     this, &AsyncLoadingHelper::AsyncLoadComplete);
1289 }
1290
1291 void TextureManager::AsyncLoadingHelper::AsyncLoadComplete(uint32_t           id,
1292                                                            Devel::PixelBuffer pixelBuffer)
1293 {
1294   mTextureManager.AsyncLoadComplete(mLoadingInfoContainer, id, pixelBuffer);
1295 }
1296
1297 Geometry TextureManager::GetRenderGeometry(TextureId textureId, uint32_t& frontElements, uint32_t& backElements)
1298 {
1299   return RenderingAddOn::Get().IsValid() ? RenderingAddOn::Get().GetGeometry(textureId, frontElements, backElements) : Geometry();
1300 }
1301
1302 } // namespace Internal
1303
1304 } // namespace Toolkit
1305
1306 } // namespace Dali