2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "texture-manager-impl.h"
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>
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>
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};
40 constexpr auto NUMBER_OF_LOCAL_LOADER_THREADS_ENV = "DALI_TEXTURE_LOCAL_THREADS";
41 constexpr auto NUMBER_OF_REMOTE_LOADER_THREADS_ENV = "DALI_TEXTURE_REMOTE_THREADS";
43 size_t GetNumberOfThreads(const char* environmentVariable, size_t defaultValue)
45 using Dali::EnvironmentVariable::GetEnvironmentVariable;
46 auto numberString = GetEnvironmentVariable(environmentVariable);
47 auto numberOfThreads = numberString ? std::strtoul(numberString, nullptr, 10) : 0;
48 constexpr auto MAX_NUMBER_OF_THREADS = 100u;
49 DALI_ASSERT_DEBUG(numberOfThreads < MAX_NUMBER_OF_THREADS);
50 return (numberOfThreads > 0 && numberOfThreads < MAX_NUMBER_OF_THREADS) ? numberOfThreads : defaultValue;
53 size_t GetNumberOfLocalLoaderThreads()
55 return GetNumberOfThreads(NUMBER_OF_LOCAL_LOADER_THREADS_ENV, DEFAULT_NUMBER_OF_LOCAL_LOADER_THREADS);
58 size_t GetNumberOfRemoteLoaderThreads()
60 return GetNumberOfThreads(NUMBER_OF_REMOTE_LOADER_THREADS_ENV, DEFAULT_NUMBER_OF_REMOTE_LOADER_THREADS);
72 // Define logfilter Internal namespace level so other files (e.g. texture-cache-manager.cpp) can also use this filter.
73 Debug::Filter* gTextureManagerLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_TEXTURE_MANAGER");
76 #define GET_LOAD_STATE_STRING(loadState) \
77 loadState == TextureManagerType::LoadState::NOT_STARTED ? "NOT_STARTED" : \
78 loadState == TextureManagerType::LoadState::LOADING ? "LOADING" : \
79 loadState == TextureManagerType::LoadState::LOAD_FINISHED ? "LOAD_FINISHED" : \
80 loadState == TextureManagerType::LoadState::WAITING_FOR_MASK ? "WAITING_FOR_MASK" : \
81 loadState == TextureManagerType::LoadState::MASK_APPLYING ? "MASK_APPLYING" : \
82 loadState == TextureManagerType::LoadState::MASK_APPLIED ? "MASK_APPLIED" : \
83 loadState == TextureManagerType::LoadState::UPLOADED ? "UPLOADED" : \
84 loadState == TextureManagerType::LoadState::CANCELLED ? "CANCELLED" : \
85 loadState == TextureManagerType::LoadState::LOAD_FAILED ? "LOAD_FAILED" : \
92 const uint32_t DEFAULT_ATLAS_SIZE(1024u); ///< This size can fit 8 by 8 images of average size 128 * 128
93 const Vector4 FULL_ATLAS_RECT(0.0f, 0.0f, 1.0f, 1.0f); ///< UV Rectangle that covers the full Texture
95 void PreMultiply(Devel::PixelBuffer pixelBuffer, TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
97 if(Pixel::HasAlpha(pixelBuffer.GetPixelFormat()))
99 if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
101 pixelBuffer.MultiplyColorByAlpha();
106 preMultiplyOnLoad = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
110 } // Anonymous namespace
112 TextureManager::MaskingData::MaskingData()
114 mAlphaMaskId(INVALID_TEXTURE_ID),
115 mContentScaleFactor(1.0f),
120 TextureManager::TextureManager()
121 : mTextureCacheManager(),
122 mAsyncLocalLoaders(GetNumberOfLocalLoaderThreads(), [&]() { return TextureAsyncLoadingHelper(*this); }),
123 mAsyncRemoteLoaders(GetNumberOfRemoteLoaderThreads(), [&]() { return TextureAsyncLoadingHelper(*this); }),
124 mLifecycleObservers(),
126 mQueueLoadFlag(false)
128 // Initialize the AddOn
129 RenderingAddOn::Get();
132 TextureManager::~TextureManager()
134 for(auto iter = mLifecycleObservers.Begin(), endIter = mLifecycleObservers.End(); iter != endIter; ++iter)
136 (*iter)->TextureManagerDestroyed();
140 TextureSet TextureManager::LoadAnimatedImageTexture(
141 Dali::AnimatedImageLoading animatedImageLoading,
142 const std::uint32_t& frameIndex,
143 const Dali::SamplingMode::Type& samplingMode,
144 const bool& synchronousLoading,
145 TextureManager::TextureId& textureId,
146 const Dali::WrapMode::Type& wrapModeU,
147 const Dali::WrapMode::Type& wrapModeV,
148 TextureUploadObserver* textureObserver)
150 TextureSet textureSet;
152 if(synchronousLoading)
154 Devel::PixelBuffer pixelBuffer;
155 if(animatedImageLoading)
157 pixelBuffer = animatedImageLoading.LoadFrame(frameIndex);
161 DALI_LOG_ERROR("TextureManager::LoadAnimatedImageTexture: Synchronous loading is failed\n");
165 PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
168 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelData.GetPixelFormat(), pixelData.GetWidth(), pixelData.GetHeight());
169 texture.Upload(pixelData);
170 textureSet = TextureSet::New();
171 textureSet.SetTexture(0u, texture);
177 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
178 textureId = RequestLoadInternal(animatedImageLoading.GetUrl(), INVALID_TEXTURE_ID, 1.0f, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::BOX_THEN_LINEAR, UseAtlas::NO_ATLAS, false, StorageType::UPLOAD_TO_TEXTURE, textureObserver, true, TextureManager::ReloadPolicy::CACHED, preMultiply, animatedImageLoading, frameIndex, false);
179 TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
180 if(loadState == TextureManager::LoadState::UPLOADED)
182 // LoadComplete has already been called - keep the same texture set
183 textureSet = GetTextureSet(textureId);
189 Sampler sampler = Sampler::New();
190 sampler.SetWrapMode(wrapModeU, wrapModeV);
191 textureSet.SetSampler(0u, sampler);
197 Devel::PixelBuffer TextureManager::LoadPixelBuffer(
198 const VisualUrl& url,
199 const Dali::ImageDimensions& desiredSize,
200 const Dali::FittingMode::Type& fittingMode,
201 const Dali::SamplingMode::Type& samplingMode,
202 const bool& synchronousLoading,
203 TextureUploadObserver* textureObserver,
204 const bool& orientationCorrection,
205 TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
207 Devel::PixelBuffer pixelBuffer;
208 if(synchronousLoading)
212 if(url.IsBufferResource())
214 const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url.GetUrl());
215 if(encodedImageBuffer)
217 pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
222 pixelBuffer = LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
224 if(pixelBuffer && preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
226 PreMultiply(pixelBuffer, preMultiplyOnLoad);
232 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);
238 TextureSet TextureManager::LoadTexture(
239 const VisualUrl& url,
240 const Dali::ImageDimensions& desiredSize,
241 const Dali::FittingMode::Type& fittingMode,
242 const Dali::SamplingMode::Type& samplingMode,
243 MaskingDataPointer& maskInfo,
244 const bool& synchronousLoading,
245 TextureManager::TextureId& textureId,
246 Vector4& textureRect,
247 Dali::ImageDimensions& textureRectSize,
248 bool& atlasingStatus,
250 const Dali::WrapMode::Type& wrapModeU,
251 const Dali::WrapMode::Type& wrapModeV,
252 TextureUploadObserver* textureObserver,
253 AtlasUploadObserver* atlasObserver,
254 ImageAtlasManagerPtr imageAtlasManager,
255 const bool& orientationCorrection,
256 const TextureManager::ReloadPolicy& reloadPolicy,
257 TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
259 TextureSet textureSet;
261 loadingStatus = false;
262 textureRect = FULL_ATLAS_RECT;
264 if(VisualUrl::TEXTURE == url.GetProtocolType())
266 std::string location = url.GetLocation();
267 if(location.size() > 0u)
269 TextureId id = std::stoi(location);
270 textureSet = mTextureCacheManager.GetExternalTextureSet(id);
273 preMultiplyOnLoad = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
282 if(synchronousLoading && atlasingStatus && imageAtlasManager->CheckAtlasAvailable(url, desiredSize))
284 Devel::PixelBuffer pixelBuffer = LoadImageSynchronously(url, desiredSize, fittingMode, samplingMode, orientationCorrection);
286 if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
288 Devel::PixelBuffer maskPixelBuffer = LoadImageSynchronously(maskInfo->mAlphaMaskUrl.GetUrl(), ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, true);
291 pixelBuffer.ApplyMask(maskPixelBuffer, maskInfo->mContentScaleFactor, maskInfo->mCropToMask);
298 PreMultiply(pixelBuffer, preMultiplyOnLoad);
299 data = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
303 textureSet = imageAtlasManager->Add(textureRect, data);
306 textureRectSize.SetWidth(data.GetWidth());
307 textureRectSize.SetHeight(data.GetHeight());
312 DALI_LOG_ERROR("TextureManager::LoadTexture: Synchronous Texture loading with atlasing is failed.\n");
317 atlasingStatus = false;
323 loadingStatus = true;
324 // Atlas manager can chage desired size when it is set by 0,0.
325 // We should store into textureRectSize only if atlasing successed.
326 // So copy inputed desiredSize, and replace value into textureRectSize only if atlasing success.
327 Dali::ImageDimensions atlasDesiredSize = desiredSize;
330 textureSet = imageAtlasManager->Add(textureRect, url.GetUrl(), atlasDesiredSize, fittingMode, true, atlasObserver);
332 if(!textureSet) // big image, no atlasing or atlasing failed
334 atlasingStatus = false;
335 if(!maskInfo || !maskInfo->mAlphaMaskUrl.IsValid())
337 textureId = RequestLoad(
344 orientationCorrection,
351 maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, synchronousLoading);
352 textureId = RequestLoad(
354 maskInfo->mAlphaMaskId,
355 maskInfo->mContentScaleFactor,
360 maskInfo->mCropToMask,
362 orientationCorrection,
368 TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
369 if(loadState == TextureManager::LoadState::UPLOADED)
371 // LoadComplete has already been called - keep the same texture set
372 textureSet = mTextureCacheManager.GetTextureSet(textureId);
375 // If we are loading the texture, or waiting for the ready signal handler to complete, inform
376 // caller that they need to wait.
377 loadingStatus = (loadState == TextureManager::LoadState::LOADING ||
378 loadState == TextureManager::LoadState::WAITING_FOR_MASK ||
379 loadState == TextureManager::LoadState::MASK_APPLYING ||
380 loadState == TextureManager::LoadState::MASK_APPLIED ||
381 loadState == TextureManager::LoadState::NOT_STARTED ||
386 textureRectSize = atlasDesiredSize;
391 if(!atlasingStatus && textureSet)
393 Sampler sampler = Sampler::New();
394 sampler.SetWrapMode(wrapModeU, wrapModeV);
395 textureSet.SetSampler(0u, sampler);
398 if(synchronousLoading)
400 loadingStatus = false;
406 TextureManager::TextureId TextureManager::RequestLoad(
407 const VisualUrl& url,
408 const ImageDimensions& desiredSize,
409 const Dali::FittingMode::Type& fittingMode,
410 const Dali::SamplingMode::Type& samplingMode,
411 const UseAtlas& useAtlas,
412 TextureUploadObserver* observer,
413 const bool& orientationCorrection,
414 const TextureManager::ReloadPolicy& reloadPolicy,
415 TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
416 const bool& synchronousLoading)
418 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);
421 TextureManager::TextureId TextureManager::RequestLoad(
422 const VisualUrl& url,
423 const TextureManager::TextureId& maskTextureId,
424 const float& contentScale,
425 const Dali::ImageDimensions& desiredSize,
426 const Dali::FittingMode::Type& fittingMode,
427 const Dali::SamplingMode::Type& samplingMode,
428 const TextureManager::UseAtlas& useAtlas,
429 const bool& cropToMask,
430 TextureUploadObserver* observer,
431 const bool& orientationCorrection,
432 const TextureManager::ReloadPolicy& reloadPolicy,
433 TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
434 const bool& synchronousLoading)
436 return RequestLoadInternal(url, maskTextureId, contentScale, desiredSize, fittingMode, samplingMode, useAtlas, cropToMask, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
439 TextureManager::TextureId TextureManager::RequestMaskLoad(
440 const VisualUrl& maskUrl,
441 const bool& synchronousLoading)
443 // Use the normal load procedure to get the alpha mask.
444 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
445 return RequestLoadInternal(maskUrl, INVALID_TEXTURE_ID, 1.0f, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, UseAtlas::NO_ATLAS, false, StorageType::KEEP_PIXEL_BUFFER, NULL, true, TextureManager::ReloadPolicy::CACHED, preMultiply, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
448 TextureManager::TextureId TextureManager::RequestLoadInternal(
449 const VisualUrl& url,
450 const TextureManager::TextureId& maskTextureId,
451 const float& contentScale,
452 const Dali::ImageDimensions& desiredSize,
453 const Dali::FittingMode::Type& fittingMode,
454 const Dali::SamplingMode::Type& samplingMode,
455 const TextureManager::UseAtlas& useAtlas,
456 const bool& cropToMask,
457 const TextureManager::StorageType& storageType,
458 TextureUploadObserver* observer,
459 const bool& orientationCorrection,
460 const TextureManager::ReloadPolicy& reloadPolicy,
461 TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
462 Dali::AnimatedImageLoading animatedImageLoading,
463 const std::uint32_t& frameIndex,
464 const bool& synchronousLoading)
466 // First check if the requested Texture is cached.
467 bool isAnimatedImage = (animatedImageLoading) ? true : false;
469 TextureHash textureHash = INITIAL_HASH_NUMBER;
470 TextureCacheIndex cacheIndex = INVALID_CACHE_INDEX;
471 if(storageType != StorageType::RETURN_PIXEL_BUFFER && !isAnimatedImage)
473 textureHash = mTextureCacheManager.GenerateHash(url.GetUrl(), desiredSize, fittingMode, samplingMode, useAtlas, maskTextureId);
475 // Look up the texture by hash. Note: The extra parameters are used in case of a hash collision.
476 cacheIndex = mTextureCacheManager.FindCachedTexture(textureHash, url.GetUrl(), desiredSize, fittingMode, samplingMode, useAtlas, maskTextureId, preMultiplyOnLoad);
479 TextureManager::TextureId textureId = INVALID_TEXTURE_ID;
480 // Check if the requested Texture exists in the cache.
481 if(cacheIndex != INVALID_CACHE_INDEX)
483 if(TextureManager::ReloadPolicy::CACHED == reloadPolicy)
485 // Mark this texture being used by another client resource. Forced reload would replace the current texture
486 // without the need for incrementing the reference count.
487 ++(mTextureCacheManager[cacheIndex].referenceCount);
489 textureId = mTextureCacheManager[cacheIndex].textureId;
491 // Update preMultiplyOnLoad value. It should be changed according to preMultiplied value of the cached info.
492 preMultiplyOnLoad = mTextureCacheManager[cacheIndex].preMultiplied ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
494 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);
497 if(textureId == INVALID_TEXTURE_ID) // There was no caching, or caching not required
499 if(VisualUrl::BUFFER == url.GetProtocolType())
501 std::string location = url.GetLocation();
502 if(location.size() > 0u)
504 TextureId targetId = std::stoi(location);
505 const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(targetId);
506 if(encodedImageBuffer)
508 textureId = targetId;
510 // Increase EncodedImageBuffer reference during it contains mTextureInfoContainer.
511 // TODO! We should change action when reload policy is FORCE.
512 // Eunki Hong will fix it after refactoring patch merged.
513 mTextureCacheManager.UseExternalResource(url.GetUrl());
518 if(textureId == INVALID_TEXTURE_ID)
520 textureId = mTextureCacheManager.GenerateUniqueTextureId();
523 bool preMultiply = (preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
525 // Cache new texutre, and get cacheIndex.
526 cacheIndex = mTextureCacheManager.AppendCache(TextureInfo(textureId, maskTextureId, url, desiredSize, contentScale, fittingMode, samplingMode, false, cropToMask, useAtlas, textureHash, orientationCorrection, preMultiply, animatedImageLoading, frameIndex));
528 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);
531 // The below code path is common whether we are using the cache or not.
532 // The textureInfoIndex now refers to either a pre-existing cached TextureInfo,
533 // or a new TextureInfo just created.
534 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
535 textureInfo.maskTextureId = maskTextureId;
536 textureInfo.storageType = storageType;
537 textureInfo.orientationCorrection = orientationCorrection;
539 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureInfo loadState:%s\n", GET_LOAD_STATE_STRING(textureInfo.loadState));
541 // Force reloading of texture by setting loadState unless already loading or cancelled.
542 if(TextureManager::ReloadPolicy::FORCED == reloadPolicy &&
543 TextureManager::LoadState::LOADING != textureInfo.loadState &&
544 TextureManager::LoadState::WAITING_FOR_MASK != textureInfo.loadState &&
545 TextureManager::LoadState::MASK_APPLYING != textureInfo.loadState &&
546 TextureManager::LoadState::MASK_APPLIED != textureInfo.loadState &&
547 TextureManager::LoadState::CANCELLED != textureInfo.loadState)
549 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);
551 textureInfo.loadState = TextureManager::LoadState::NOT_STARTED;
554 if(!synchronousLoading)
556 // Check if we should add the observer.
557 // Only do this if we have not loaded yet and it will not have loaded by the end of this method.
558 switch(textureInfo.loadState)
560 case TextureManager::LoadState::LOAD_FAILED: // Failed notifies observer which then stops observing.
561 case TextureManager::LoadState::NOT_STARTED:
563 LoadOrQueueTexture(textureInfo, observer); // If called inside NotifyObservers, queues until afterwards
566 case TextureManager::LoadState::LOADING:
567 case TextureManager::LoadState::WAITING_FOR_MASK:
568 case TextureManager::LoadState::MASK_APPLYING:
569 case TextureManager::LoadState::MASK_APPLIED:
571 ObserveTexture(textureInfo, observer);
574 case TextureManager::LoadState::UPLOADED:
578 LoadOrQueueTexture(textureInfo, observer);
582 case TextureManager::LoadState::CANCELLED:
584 // A cancelled texture hasn't finished loading yet. Treat as a loading texture
585 // (it's ref count has already been incremented, above)
586 textureInfo.loadState = TextureManager::LoadState::LOADING;
587 ObserveTexture(textureInfo, observer);
590 case TextureManager::LoadState::LOAD_FINISHED:
592 // Loading has already completed.
593 if(observer && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
595 LoadOrQueueTexture(textureInfo, observer);
603 // If the image is already finished to load, use cached texture.
604 // We don't need to consider Observer because this is synchronous loading.
605 if(textureInfo.loadState == TextureManager::LoadState::UPLOADED ||
606 textureInfo.loadState == TextureManager::LoadState::LOAD_FINISHED)
612 Devel::PixelBuffer pixelBuffer = LoadImageSynchronously(url, desiredSize, fittingMode, samplingMode, orientationCorrection);
616 // If pixelBuffer loading is failed in synchronously, call Remove() method.
617 Remove(textureId, nullptr);
618 return INVALID_TEXTURE_ID;
621 if(storageType == StorageType::KEEP_PIXEL_BUFFER) // For the mask image loading.
623 textureInfo.pixelBuffer = pixelBuffer; // Store the pixel data
624 textureInfo.loadState = LoadState::LOAD_FINISHED;
626 else // For the image loading.
628 if(maskTextureId != INVALID_TEXTURE_ID)
630 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
631 if(maskCacheIndex != INVALID_CACHE_INDEX)
633 Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
636 pixelBuffer.ApplyMask(maskPixelBuffer, contentScale, cropToMask);
641 DALI_LOG_ERROR("Mask image is not stored in cache.\n");
644 PreMultiply(pixelBuffer, preMultiplyOnLoad);
647 UploadTexture(pixelBuffer, textureInfo);
652 // Return the TextureId for which this Texture can now be referenced by externally.
656 void TextureManager::Remove(const TextureManager::TextureId& textureId, TextureUploadObserver* observer)
658 // Remove textureId in CacheManager.
659 mTextureCacheManager.RemoveCache(textureId);
663 // Remove element from the LoadQueue
664 for(auto&& element : mLoadQueue)
666 if(element.mObserver == observer)
668 // Do not erase the item. We will clear it later in ProcessQueuedTextures().
669 element.mObserver = nullptr;
676 Devel::PixelBuffer TextureManager::LoadImageSynchronously(
677 const VisualUrl& url,
678 const Dali::ImageDimensions& desiredSize,
679 const Dali::FittingMode::Type& fittingMode,
680 const Dali::SamplingMode::Type& samplingMode,
681 const bool& orientationCorrection)
683 Devel::PixelBuffer pixelBuffer;
684 if(url.IsBufferResource())
686 const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url.GetUrl());
687 if(encodedImageBuffer)
689 pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
694 pixelBuffer = LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
699 void TextureManager::AddObserver(TextureManager::LifecycleObserver& observer)
701 // make sure an observer doesn't observe the same object twice
702 // otherwise it will get multiple calls to ObjectDestroyed()
703 DALI_ASSERT_DEBUG(mLifecycleObservers.End() == std::find(mLifecycleObservers.Begin(), mLifecycleObservers.End(), &observer));
704 mLifecycleObservers.PushBack(&observer);
707 void TextureManager::RemoveObserver(TextureManager::LifecycleObserver& observer)
709 // Find the observer...
710 auto endIter = mLifecycleObservers.End();
711 for(auto iter = mLifecycleObservers.Begin(); iter != endIter; ++iter)
713 if((*iter) == &observer)
715 mLifecycleObservers.Erase(iter);
719 DALI_ASSERT_DEBUG(endIter != mLifecycleObservers.End());
722 void TextureManager::LoadOrQueueTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
724 switch(textureInfo.loadState)
726 case LoadState::NOT_STARTED:
727 case LoadState::LOAD_FAILED:
731 QueueLoadTexture(textureInfo, observer);
735 LoadTexture(textureInfo, observer);
739 case LoadState::UPLOADED:
743 QueueLoadTexture(textureInfo, observer);
747 // The Texture has already loaded. The other observers have already been notified.
748 // We need to send a "late" loaded notification for this observer.
749 observer->LoadComplete(true, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::TEXTURE, textureInfo.textureId, textureInfo.textureSet, (textureInfo.useAtlas == UseAtlas::USE_ATLAS) ? true : false, textureInfo.atlasRect, textureInfo.preMultiplied));
753 case LoadState::LOADING:
754 case LoadState::CANCELLED:
755 case LoadState::LOAD_FINISHED:
756 case LoadState::WAITING_FOR_MASK:
757 case LoadState::MASK_APPLYING:
758 case LoadState::MASK_APPLIED:
765 void TextureManager::QueueLoadTexture(const TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
767 const auto& textureId = textureInfo.textureId;
768 mLoadQueue.PushBack(LoadQueueElement(textureId, observer));
770 observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
773 void TextureManager::LoadTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
775 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::LoadTexture(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
777 textureInfo.loadState = LoadState::LOADING;
778 if(!textureInfo.loadSynchronously)
780 auto& loadersContainer = (textureInfo.url.IsLocalResource() || textureInfo.url.IsBufferResource()) ? mAsyncLocalLoaders : mAsyncRemoteLoaders;
781 auto loadingHelperIt = loadersContainer.GetNext();
782 auto premultiplyOnLoad = (textureInfo.preMultiplyOnLoad && textureInfo.maskTextureId == INVALID_TEXTURE_ID) ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
783 DALI_ASSERT_ALWAYS(loadingHelperIt != loadersContainer.End());
784 if(textureInfo.animatedImageLoading)
786 loadingHelperIt->LoadAnimatedImage(textureInfo.textureId, textureInfo.animatedImageLoading, textureInfo.frameIndex);
790 loadingHelperIt->Load(textureInfo.textureId, textureInfo.url, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, textureInfo.orientationCorrection, premultiplyOnLoad);
793 ObserveTexture(textureInfo, observer);
796 void TextureManager::ProcessQueuedTextures()
798 for(auto&& element : mLoadQueue)
800 if(!element.mObserver)
805 TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(element.mTextureId);
806 if(cacheIndex != INVALID_CACHE_INDEX)
808 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
809 if(textureInfo.loadState == LoadState::UPLOADED)
811 element.mObserver->LoadComplete(true, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::TEXTURE, textureInfo.textureId, textureInfo.textureSet, (textureInfo.useAtlas == UseAtlas::USE_ATLAS) ? true : false, textureInfo.atlasRect, textureInfo.preMultiplied));
813 else if(textureInfo.loadState == LoadState::LOAD_FINISHED && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
815 element.mObserver->LoadComplete(true, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::PIXEL_BUFFER, textureInfo.pixelBuffer, textureInfo.url.GetUrl(), textureInfo.preMultiplied));
819 LoadTexture(textureInfo, element.mObserver);
826 void TextureManager::ObserveTexture(TextureManager::TextureInfo& textureInfo,
827 TextureUploadObserver* observer)
829 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ObserveTexture(): url:%s observer:%p\n", textureInfo.url.GetUrl().c_str(), observer);
833 textureInfo.observerList.PushBack(observer);
834 observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
838 void TextureManager::AsyncLoadComplete(const TextureManager::TextureId& textureId, Devel::PixelBuffer pixelBuffer)
840 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::AsyncLoadComplete( textureId:%d )\n", textureId);
841 TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
842 if(cacheIndex != INVALID_CACHE_INDEX)
844 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
846 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, " textureId:%d Url:%s CacheIndex:%d LoadState: %s\n", textureInfo.textureId, textureInfo.url.GetUrl().c_str(), cacheIndex, GET_LOAD_STATE_STRING(textureInfo.loadState));
848 if(textureInfo.loadState != LoadState::CANCELLED)
850 // textureInfo can be invalidated after this call (as the mTextureInfoContainer may be modified)
851 PostLoad(textureInfo, pixelBuffer);
855 Remove(textureInfo.textureId, nullptr);
860 void TextureManager::PostLoad(TextureManager::TextureInfo& textureInfo, Devel::PixelBuffer& pixelBuffer)
862 // Was the load successful?
863 if(pixelBuffer && (pixelBuffer.GetWidth() != 0) && (pixelBuffer.GetHeight() != 0))
865 // No atlas support for now
866 textureInfo.useAtlas = UseAtlas::NO_ATLAS;
867 textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
869 if(textureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE)
871 // If there is a mask texture ID associated with this texture, then apply the mask
872 // if it's already loaded. If it hasn't, and the mask is still loading,
873 // wait for the mask to finish loading.
874 // note, If the texture is already uploaded synchronously during loading,
875 // we don't need to apply mask.
876 if(textureInfo.loadState != LoadState::UPLOADED &&
877 textureInfo.maskTextureId != INVALID_TEXTURE_ID)
879 if(textureInfo.loadState == LoadState::MASK_APPLYING)
881 textureInfo.loadState = LoadState::MASK_APPLIED;
882 UploadTexture(pixelBuffer, textureInfo);
883 NotifyObservers(textureInfo, true);
887 LoadState maskLoadState = mTextureCacheManager.GetTextureStateInternal(textureInfo.maskTextureId);
888 textureInfo.pixelBuffer = pixelBuffer; // Store the pixel buffer temporarily
889 if(maskLoadState == LoadState::LOADING)
891 textureInfo.loadState = LoadState::WAITING_FOR_MASK;
893 else if(maskLoadState == LoadState::LOAD_FINISHED)
895 // Send New Task to Thread
896 ApplyMask(textureInfo, textureInfo.maskTextureId);
902 UploadTexture(pixelBuffer, textureInfo);
903 NotifyObservers(textureInfo, true);
908 textureInfo.pixelBuffer = pixelBuffer; // Store the pixel data
909 textureInfo.loadState = LoadState::LOAD_FINISHED;
911 if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
913 NotifyObservers(textureInfo, true);
917 // Check if there was another texture waiting for this load to complete
918 // (e.g. if this was an image mask, and its load is on a different thread)
919 CheckForWaitingTexture(textureInfo);
925 textureInfo.loadState = LoadState::LOAD_FAILED;
926 CheckForWaitingTexture(textureInfo);
927 NotifyObservers(textureInfo, false);
931 void TextureManager::CheckForWaitingTexture(TextureManager::TextureInfo& maskTextureInfo)
933 // Search the cache, checking if any texture has this texture id as a
935 const TextureCacheIndex size = static_cast<TextureCacheIndex>(mTextureCacheManager.size());
937 for(TextureCacheIndex cacheIndex = 0; cacheIndex < size; ++cacheIndex)
939 if(mTextureCacheManager[cacheIndex].maskTextureId == maskTextureInfo.textureId &&
940 mTextureCacheManager[cacheIndex].loadState == LoadState::WAITING_FOR_MASK)
942 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
944 if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED)
946 // Send New Task to Thread
947 ApplyMask(textureInfo, maskTextureInfo.textureId);
951 textureInfo.pixelBuffer.Reset();
952 textureInfo.loadState = LoadState::LOAD_FAILED;
953 NotifyObservers(textureInfo, false);
959 void TextureManager::ApplyMask(TextureManager::TextureInfo& textureInfo, const TextureManager::TextureId& maskTextureId)
961 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
962 if(maskCacheIndex != INVALID_CACHE_INDEX)
964 Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
965 Devel::PixelBuffer pixelBuffer = textureInfo.pixelBuffer;
966 textureInfo.pixelBuffer.Reset();
968 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ApplyMask(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
970 textureInfo.loadState = LoadState::MASK_APPLYING;
971 auto& loadersContainer = (textureInfo.url.IsLocalResource() || textureInfo.url.IsBufferResource()) ? mAsyncLocalLoaders : mAsyncRemoteLoaders;
972 auto loadingHelperIt = loadersContainer.GetNext();
973 auto premultiplyOnLoad = textureInfo.preMultiplyOnLoad ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
974 DALI_ASSERT_ALWAYS(loadingHelperIt != loadersContainer.End());
975 loadingHelperIt->ApplyMask(textureInfo.textureId, pixelBuffer, maskPixelBuffer, textureInfo.scaleFactor, textureInfo.cropToMask, premultiplyOnLoad);
979 void TextureManager::UploadTexture(Devel::PixelBuffer& pixelBuffer, TextureManager::TextureInfo& textureInfo)
981 if(textureInfo.loadState != LoadState::UPLOADED && textureInfo.useAtlas != UseAtlas::USE_ATLAS)
983 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, " TextureManager::UploadTexture() New Texture for textureId:%d\n", textureInfo.textureId);
985 // Check if this pixelBuffer is premultiplied
986 textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
988 auto& renderingAddOn = RenderingAddOn::Get();
989 if(renderingAddOn.IsValid())
991 renderingAddOn.CreateGeometry(textureInfo.textureId, pixelBuffer);
994 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelBuffer.GetPixelFormat(), pixelBuffer.GetWidth(), pixelBuffer.GetHeight());
996 PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer);
997 texture.Upload(pixelData);
998 if(!textureInfo.textureSet)
1000 textureInfo.textureSet = TextureSet::New();
1002 textureInfo.textureSet.SetTexture(0u, texture);
1005 // Update the load state.
1006 // Note: This is regardless of success as we care about whether a
1007 // load attempt is in progress or not. If unsuccessful, a broken
1008 // image is still loaded.
1009 textureInfo.loadState = LoadState::UPLOADED;
1012 void TextureManager::NotifyObservers(TextureManager::TextureInfo& textureInfo, const bool& success)
1014 TextureId textureId = textureInfo.textureId;
1016 // If there is an observer: Notify the load is complete, whether successful or not,
1017 // and erase it from the list
1018 TextureInfo* info = &textureInfo;
1020 mQueueLoadFlag = true;
1022 while(info->observerList.Count())
1024 TextureUploadObserver* observer = info->observerList[0];
1026 // During LoadComplete() a Control ResourceReady() signal is emitted.
1027 // During that signal the app may add remove /add Textures (e.g. via
1029 // It is possible for observers to be removed from the observer list,
1030 // and it is also possible for the mTextureInfoContainer to be modified,
1031 // invalidating the reference to the textureInfo struct.
1032 // Texture load requests for the same URL are deferred until the end of this
1034 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::NotifyObservers() textureId:%d url:%s loadState:%s\n", textureId, textureInfo.url.GetUrl().c_str(), GET_LOAD_STATE_STRING(textureInfo.loadState));
1036 // It is possible for the observer to be deleted.
1037 // Disconnect and remove the observer first.
1038 observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1040 info->observerList.Erase(info->observerList.Begin());
1042 if(info->storageType == StorageType::RETURN_PIXEL_BUFFER)
1044 observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::PIXEL_BUFFER, info->pixelBuffer, info->url.GetUrl(), info->preMultiplied));
1048 observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::TEXTURE, info->textureId, info->textureSet, (info->useAtlas == UseAtlas::USE_ATLAS) ? true : false, info->atlasRect, info->preMultiplied));
1051 // Get the textureInfo from the container again as it may have been invalidated.
1052 TextureCacheIndex textureInfoIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1053 if(textureInfoIndex == INVALID_CACHE_INDEX)
1055 break; // texture has been removed - can stop.
1057 info = &mTextureCacheManager[textureInfoIndex];
1060 mQueueLoadFlag = false;
1061 ProcessQueuedTextures();
1063 if(info->storageType == StorageType::RETURN_PIXEL_BUFFER && info->observerList.Count() == 0)
1065 Remove(info->textureId, nullptr);
1069 void TextureManager::ObserverDestroyed(TextureUploadObserver* observer)
1071 const TextureCacheIndex count = static_cast<TextureCacheIndex>(mTextureCacheManager.size());
1072 for(TextureCacheIndex i = 0; i < count; ++i)
1074 TextureInfo& textureInfo(mTextureCacheManager[i]);
1075 for(TextureInfo::ObserverListType::Iterator j = textureInfo.observerList.Begin();
1076 j != textureInfo.observerList.End();)
1080 j = textureInfo.observerList.Erase(j);
1089 // Remove element from the LoadQueue
1090 for(auto&& element : mLoadQueue)
1092 if(element.mObserver == observer)
1094 element.mObserver = nullptr;
1099 Dali::Geometry TextureManager::GetRenderGeometry(const TextureManager::TextureId& textureId, std::uint32_t& frontElements, std::uint32_t& backElements)
1101 return RenderingAddOn::Get().IsValid() ? RenderingAddOn::Get().GetGeometry(textureId, frontElements, backElements) : Geometry();
1104 } // namespace Internal
1106 } // namespace Toolkit