2 * Copyright (c) 2023 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 <dali-toolkit/internal/texture-manager/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/adaptor-framework/adaptor.h>
26 #include <dali/integration-api/debug.h>
27 #include <dali/public-api/rendering/geometry.h>
30 #include <dali-toolkit/internal/texture-manager/texture-async-loading-helper.h>
31 #include <dali-toolkit/internal/texture-manager/texture-cache-manager.h>
32 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
33 #include <dali-toolkit/internal/visuals/rendering-addon.h>
37 constexpr auto INITIAL_HASH_NUMBER = size_t{0u};
39 constexpr auto TEXTURE_INDEX = 0u; ///< The Index for texture
40 constexpr auto MASK_TEXTURE_INDEX = 1u; ///< The Index for mask texture
42 constexpr auto NUMBER_OF_LOCAL_LOADER_THREADS_ENV = "DALI_TEXTURE_LOCAL_THREADS";
43 constexpr auto NUMBER_OF_REMOTE_LOADER_THREADS_ENV = "DALI_TEXTURE_REMOTE_THREADS";
44 constexpr auto LOAD_IMAGE_YUV_PLANES_ENV = "DALI_LOAD_IMAGE_YUV_PLANES";
46 bool NeedToLoadYuvPlanes()
48 auto loadYuvPlanesString = Dali::EnvironmentVariable::GetEnvironmentVariable(LOAD_IMAGE_YUV_PLANES_ENV);
49 bool loadYuvPlanes = loadYuvPlanesString ? std::atoi(loadYuvPlanesString) : false;
61 // Define logfilter Internal namespace level so other files (e.g. texture-cache-manager.cpp) can also use this filter.
62 Debug::Filter* gTextureManagerLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_TEXTURE_MANAGER");
65 #define GET_LOAD_STATE_STRING(loadState) \
66 loadState == TextureManagerType::LoadState::NOT_STARTED ? "NOT_STARTED" : \
67 loadState == TextureManagerType::LoadState::LOADING ? "LOADING" : \
68 loadState == TextureManagerType::LoadState::LOAD_FINISHED ? "LOAD_FINISHED" : \
69 loadState == TextureManagerType::LoadState::WAITING_FOR_MASK ? "WAITING_FOR_MASK" : \
70 loadState == TextureManagerType::LoadState::MASK_APPLYING ? "MASK_APPLYING" : \
71 loadState == TextureManagerType::LoadState::MASK_APPLIED ? "MASK_APPLIED" : \
72 loadState == TextureManagerType::LoadState::UPLOADED ? "UPLOADED" : \
73 loadState == TextureManagerType::LoadState::CANCELLED ? "CANCELLED" : \
74 loadState == TextureManagerType::LoadState::MASK_CANCELLED ? "MASK_CANCELLED" : \
75 loadState == TextureManagerType::LoadState::LOAD_FAILED ? "LOAD_FAILED" : \
82 const uint32_t DEFAULT_ATLAS_SIZE(1024u); ///< This size can fit 8 by 8 images of average size 128 * 128
83 const Vector4 FULL_ATLAS_RECT(0.0f, 0.0f, 1.0f, 1.0f); ///< UV Rectangle that covers the full Texture
85 void PreMultiply(Devel::PixelBuffer pixelBuffer, TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
87 if(Pixel::HasAlpha(pixelBuffer.GetPixelFormat()))
89 if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
91 pixelBuffer.MultiplyColorByAlpha();
96 preMultiplyOnLoad = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
100 } // Anonymous namespace
102 TextureManager::MaskingData::MaskingData()
104 mAlphaMaskId(INVALID_TEXTURE_ID),
105 mContentScaleFactor(1.0f),
107 mPreappliedMasking(true),
108 mMaskImageLoadingFailed(false)
112 TextureManager::TextureManager()
113 : mTextureCacheManager(),
114 mAsyncLoader(std::unique_ptr<TextureAsyncLoadingHelper>(new TextureAsyncLoadingHelper(*this))),
115 mLifecycleObservers(),
117 mLoadingQueueTextureId(INVALID_TEXTURE_ID),
119 mLoadYuvPlanes(NeedToLoadYuvPlanes()),
120 mRemoveProcessorRegistered(false)
122 // Initialize the AddOn
123 RenderingAddOn::Get();
126 TextureManager::~TextureManager()
128 if(mRemoveProcessorRegistered && Adaptor::IsAvailable())
130 Adaptor::Get().UnregisterProcessor(*this, true);
131 mRemoveProcessorRegistered = false;
134 for(auto iter = mLifecycleObservers.Begin(), endIter = mLifecycleObservers.End(); iter != endIter; ++iter)
136 (*iter)->TextureManagerDestroyed();
140 TextureSet TextureManager::LoadAnimatedImageTexture(
141 const VisualUrl& url,
142 Dali::AnimatedImageLoading animatedImageLoading,
143 const uint32_t& frameIndex,
144 TextureManager::TextureId& textureId,
145 MaskingDataPointer& maskInfo,
146 const Dali::ImageDimensions& desiredSize,
147 const Dali::FittingMode::Type& fittingMode,
148 const Dali::SamplingMode::Type& samplingMode,
149 const bool& synchronousLoading,
150 TextureUploadObserver* textureObserver,
151 TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
153 TextureSet textureSet;
155 if(synchronousLoading)
157 Devel::PixelBuffer pixelBuffer;
158 if(animatedImageLoading)
160 pixelBuffer = animatedImageLoading.LoadFrame(frameIndex, desiredSize, fittingMode, samplingMode);
164 DALI_LOG_ERROR("TextureManager::LoadAnimatedImageTexture: Synchronous loading is failed\n");
169 if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
171 Devel::PixelBuffer maskPixelBuffer = LoadImageFromFile(maskInfo->mAlphaMaskUrl.GetUrl(), desiredSize, fittingMode, samplingMode, true);
174 if(!maskInfo->mPreappliedMasking)
176 PixelData maskPixelData = Devel::PixelBuffer::Convert(maskPixelBuffer); // takes ownership of buffer
177 maskTexture = Texture::New(Dali::TextureType::TEXTURE_2D, maskPixelData.GetPixelFormat(), maskPixelData.GetWidth(), maskPixelData.GetHeight());
178 maskTexture.Upload(maskPixelData);
182 pixelBuffer.ApplyMask(maskPixelBuffer, maskInfo->mContentScaleFactor, maskInfo->mCropToMask);
187 DALI_LOG_ERROR("TextureManager::LoadAnimatedImageTexture: Synchronous mask image loading is failed\n");
191 if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
193 PreMultiply(pixelBuffer, preMultiplyOnLoad);
196 PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer); // takes ownership of buffer
199 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelData.GetPixelFormat(), pixelData.GetWidth(), pixelData.GetHeight());
200 texture.Upload(pixelData);
201 textureSet = TextureSet::New();
202 textureSet.SetTexture(TEXTURE_INDEX, texture);
205 textureSet.SetTexture(MASK_TEXTURE_INDEX, maskTexture);
212 TextureId alphaMaskId = INVALID_TEXTURE_ID;
213 float contentScaleFactor = 1.0f;
214 bool cropToMask = false;
215 if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
217 maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, maskInfo->mPreappliedMasking ? StorageType::KEEP_PIXEL_BUFFER : StorageType::KEEP_TEXTURE);
218 alphaMaskId = maskInfo->mAlphaMaskId;
219 if(maskInfo->mPreappliedMasking)
221 contentScaleFactor = maskInfo->mContentScaleFactor;
222 cropToMask = maskInfo->mCropToMask;
226 textureId = RequestLoadInternal(url, alphaMaskId, textureId, contentScaleFactor, desiredSize, fittingMode, samplingMode, UseAtlas::NO_ATLAS, cropToMask, StorageType::UPLOAD_TO_TEXTURE, textureObserver, true, TextureManager::ReloadPolicy::CACHED, preMultiplyOnLoad, animatedImageLoading, frameIndex, false);
228 TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
229 if(loadState == TextureManager::LoadState::UPLOADED)
231 // LoadComplete has already been called - keep the same texture set
232 textureSet = GetTextureSet(textureId);
239 Devel::PixelBuffer TextureManager::LoadPixelBuffer(
240 const VisualUrl& url,
241 const Dali::ImageDimensions& desiredSize,
242 const Dali::FittingMode::Type& fittingMode,
243 const Dali::SamplingMode::Type& samplingMode,
244 const bool& synchronousLoading,
245 TextureUploadObserver* textureObserver,
246 const bool& orientationCorrection,
247 TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
249 Devel::PixelBuffer pixelBuffer;
250 if(synchronousLoading)
254 if(url.IsBufferResource())
256 const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url);
257 if(encodedImageBuffer)
259 pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
264 pixelBuffer = LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
266 if(pixelBuffer && preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
268 PreMultiply(pixelBuffer, preMultiplyOnLoad);
274 RequestLoadInternal(url, INVALID_TEXTURE_ID, 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);
280 TextureSet TextureManager::LoadTexture(
281 const VisualUrl& url,
282 const Dali::ImageDimensions& desiredSize,
283 const Dali::FittingMode::Type& fittingMode,
284 const Dali::SamplingMode::Type& samplingMode,
285 MaskingDataPointer& maskInfo,
286 const bool& synchronousLoading,
287 TextureManager::TextureId& textureId,
288 Vector4& textureRect,
289 Dali::ImageDimensions& textureRectSize,
290 bool& atlasingStatus,
292 TextureUploadObserver* textureObserver,
293 AtlasUploadObserver* atlasObserver,
294 ImageAtlasManagerPtr imageAtlasManager,
295 const bool& orientationCorrection,
296 const TextureManager::ReloadPolicy& reloadPolicy,
297 TextureManager::MultiplyOnLoad& preMultiplyOnLoad)
299 TextureSet textureSet;
301 loadingStatus = false;
302 textureRect = FULL_ATLAS_RECT;
304 if(VisualUrl::TEXTURE == url.GetProtocolType())
306 std::string location = url.GetLocation();
307 if(location.size() > 0u)
309 TextureId id = std::stoi(location);
310 auto externalTextureInfo = mTextureCacheManager.GetExternalTextureInfo(id);
311 if(externalTextureInfo.textureSet)
313 if(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD)
315 // Change preMultiplyOnLoad value so make caller determine to preMultiplyAlpha or not.
316 // TODO : Should we seperate input and output value?
317 preMultiplyOnLoad = externalTextureInfo.preMultiplied ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
320 TextureId alphaMaskId = INVALID_TEXTURE_ID;
321 if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
323 maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, StorageType::KEEP_TEXTURE, synchronousLoading);
324 alphaMaskId = maskInfo->mAlphaMaskId;
326 // Create new textureId. this textureId is not same as location
327 textureId = RequestLoad(url, alphaMaskId, textureId, 1.0f, desiredSize, fittingMode, samplingMode, UseAtlas::NO_ATLAS, false, textureObserver, orientationCorrection, reloadPolicy, preMultiplyOnLoad, synchronousLoading);
329 TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
330 if(loadState == TextureManager::LoadState::UPLOADED)
332 textureSet = GetTextureSet(textureId);
337 // TextureId is same as location
340 textureSet = TextureSet::New();
341 textureSet.SetTexture(TEXTURE_INDEX, externalTextureInfo.textureSet.GetTexture(TEXTURE_INDEX));
349 if(synchronousLoading && atlasingStatus)
351 const bool synchronousAtlasAvaliable = (desiredSize != ImageDimensions() || url.IsLocalResource()) ? imageAtlasManager->CheckAtlasAvailable(url, desiredSize)
353 if(synchronousAtlasAvaliable)
355 std::vector<Devel::PixelBuffer> pixelBuffers;
356 LoadImageSynchronously(url, desiredSize, fittingMode, samplingMode, orientationCorrection, false, pixelBuffers);
358 if(!pixelBuffers.empty() && maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
360 std::vector<Devel::PixelBuffer> maskPixelBuffers;
361 LoadImageSynchronously(maskInfo->mAlphaMaskUrl, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, true, false, maskPixelBuffers);
362 if(!maskPixelBuffers.empty())
364 pixelBuffers[0].ApplyMask(maskPixelBuffers[0], maskInfo->mContentScaleFactor, maskInfo->mCropToMask);
369 if(!pixelBuffers.empty())
371 PreMultiply(pixelBuffers[0], preMultiplyOnLoad);
372 data = Devel::PixelBuffer::Convert(pixelBuffers[0]); // takes ownership of buffer
376 textureSet = imageAtlasManager->Add(textureRect, data);
379 textureRectSize.SetWidth(data.GetWidth());
380 textureRectSize.SetHeight(data.GetHeight());
385 DALI_LOG_ERROR("TextureManager::LoadTexture: Synchronous Texture loading with atlasing is failed.\n");
390 atlasingStatus = false;
397 loadingStatus = true;
398 // Atlas manager can chage desired size when it is set by 0,0.
399 // We should store into textureRectSize only if atlasing successed.
400 // So copy inputed desiredSize, and replace value into textureRectSize only if atlasing success.
401 Dali::ImageDimensions atlasDesiredSize = desiredSize;
404 if(url.IsBufferResource())
406 const EncodedImageBuffer& encodedImageBuffer = GetEncodedImageBuffer(url.GetUrl());
407 if(encodedImageBuffer)
409 textureSet = imageAtlasManager->Add(textureRect, encodedImageBuffer, desiredSize, fittingMode, true, atlasObserver);
414 textureSet = imageAtlasManager->Add(textureRect, url, atlasDesiredSize, fittingMode, true, atlasObserver);
417 if(!textureSet) // big image, no atlasing or atlasing failed
419 atlasingStatus = false;
421 TextureId alphaMaskId = INVALID_TEXTURE_ID;
422 float contentScaleFactor = 1.0f;
423 bool cropToMask = false;
424 if(maskInfo && maskInfo->mAlphaMaskUrl.IsValid())
426 maskInfo->mAlphaMaskId = RequestMaskLoad(maskInfo->mAlphaMaskUrl, maskInfo->mPreappliedMasking ? StorageType::KEEP_PIXEL_BUFFER : StorageType::KEEP_TEXTURE, synchronousLoading);
427 alphaMaskId = maskInfo->mAlphaMaskId;
428 if(maskInfo && maskInfo->mPreappliedMasking)
430 contentScaleFactor = maskInfo->mContentScaleFactor;
431 cropToMask = maskInfo->mCropToMask;
435 textureId = RequestLoad(
446 orientationCorrection,
451 TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
452 if(loadState == TextureManager::LoadState::UPLOADED)
454 // LoadComplete has already been called - keep the same texture set
455 textureSet = GetTextureSet(textureId);
458 // If we are loading the texture, or waiting for the ready signal handler to complete, inform
459 // caller that they need to wait.
460 loadingStatus = (loadState == TextureManager::LoadState::LOADING ||
461 loadState == TextureManager::LoadState::WAITING_FOR_MASK ||
462 loadState == TextureManager::LoadState::MASK_APPLYING ||
463 loadState == TextureManager::LoadState::MASK_APPLIED ||
464 loadState == TextureManager::LoadState::NOT_STARTED ||
465 mLoadingQueueTextureId != INVALID_TEXTURE_ID);
469 textureRectSize = atlasDesiredSize;
474 if(synchronousLoading)
476 loadingStatus = false;
482 TextureManager::TextureId TextureManager::RequestLoad(
483 const VisualUrl& url,
484 const ImageDimensions& desiredSize,
485 const Dali::FittingMode::Type& fittingMode,
486 const Dali::SamplingMode::Type& samplingMode,
487 const UseAtlas& useAtlas,
488 TextureUploadObserver* observer,
489 const bool& orientationCorrection,
490 const TextureManager::ReloadPolicy& reloadPolicy,
491 TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
492 const bool& synchronousLoading)
494 return RequestLoadInternal(url, INVALID_TEXTURE_ID, INVALID_TEXTURE_ID, 1.0f, desiredSize, fittingMode, samplingMode, useAtlas, false, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
497 TextureManager::TextureId TextureManager::RequestLoad(
498 const VisualUrl& url,
499 const TextureManager::TextureId& maskTextureId,
500 const TextureManager::TextureId& previousTextureId,
501 const float& contentScale,
502 const Dali::ImageDimensions& desiredSize,
503 const Dali::FittingMode::Type& fittingMode,
504 const Dali::SamplingMode::Type& samplingMode,
505 const TextureManager::UseAtlas& useAtlas,
506 const bool& cropToMask,
507 TextureUploadObserver* observer,
508 const bool& orientationCorrection,
509 const TextureManager::ReloadPolicy& reloadPolicy,
510 TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
511 const bool& synchronousLoading)
513 return RequestLoadInternal(url, maskTextureId, previousTextureId, contentScale, desiredSize, fittingMode, samplingMode, useAtlas, cropToMask, StorageType::UPLOAD_TO_TEXTURE, observer, orientationCorrection, reloadPolicy, preMultiplyOnLoad, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
516 TextureManager::TextureId TextureManager::RequestMaskLoad(
517 const VisualUrl& maskUrl,
518 StorageType storageType,
519 const bool& synchronousLoading)
521 // Use the normal load procedure to get the alpha mask.
522 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
523 return RequestLoadInternal(maskUrl, INVALID_TEXTURE_ID, INVALID_TEXTURE_ID, 1.0f, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::NO_FILTER, UseAtlas::NO_ATLAS, false, storageType, NULL, true, TextureManager::ReloadPolicy::CACHED, preMultiply, Dali::AnimatedImageLoading(), 0u, synchronousLoading);
526 TextureManager::TextureId TextureManager::RequestLoadInternal(
527 const VisualUrl& url,
528 const TextureManager::TextureId& maskTextureId,
529 const TextureManager::TextureId& previousTextureId,
530 const float& contentScale,
531 const Dali::ImageDimensions& desiredSize,
532 const Dali::FittingMode::Type& fittingMode,
533 const Dali::SamplingMode::Type& samplingMode,
534 const TextureManager::UseAtlas& useAtlas,
535 const bool& cropToMask,
536 const TextureManager::StorageType& storageType,
537 TextureUploadObserver* observer,
538 const bool& orientationCorrection,
539 const TextureManager::ReloadPolicy& reloadPolicy,
540 TextureManager::MultiplyOnLoad& preMultiplyOnLoad,
541 Dali::AnimatedImageLoading animatedImageLoading,
542 const std::uint32_t& frameIndex,
543 const bool& synchronousLoading)
545 TextureHash textureHash = INITIAL_HASH_NUMBER;
546 TextureCacheIndex cacheIndex = INVALID_CACHE_INDEX;
547 bool loadYuvPlanes = (mLoadYuvPlanes && maskTextureId == INVALID_TEXTURE_ID && storageType == StorageType::UPLOAD_TO_TEXTURE);
549 if(storageType != StorageType::RETURN_PIXEL_BUFFER)
551 textureHash = mTextureCacheManager.GenerateHash(url, desiredSize, fittingMode, samplingMode, useAtlas, maskTextureId, cropToMask, frameIndex);
553 // Look up the texture by hash. Note: The extra parameters are used in case of a hash collision.
554 cacheIndex = mTextureCacheManager.FindCachedTexture(textureHash, url, desiredSize, fittingMode, samplingMode, useAtlas, storageType, maskTextureId, cropToMask, preMultiplyOnLoad, (animatedImageLoading) ? true : false, frameIndex);
557 TextureManager::TextureId textureId = INVALID_TEXTURE_ID;
558 // Check if the requested Texture exists in the cache.
559 if(cacheIndex != INVALID_CACHE_INDEX)
561 if(TextureManager::ReloadPolicy::CACHED == reloadPolicy || TextureManager::INVALID_TEXTURE_ID == previousTextureId)
563 // Mark this texture being used by another client resource, or Reload forced without request load before.
564 // Forced reload which have current texture before, would replace the current texture.
565 // without the need for incrementing the reference count.
566 ++(mTextureCacheManager[cacheIndex].referenceCount);
568 textureId = mTextureCacheManager[cacheIndex].textureId;
570 // Update preMultiplyOnLoad value. It should be changed according to preMultiplied value of the cached info.
571 preMultiplyOnLoad = mTextureCacheManager[cacheIndex].preMultiplied ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
572 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestLoad( url=%s observer=%p ) Using cached texture id@%d, textureId=%d, maskTextureId=%d, prevTextureId=%d, frameindex=%d, premultiplied=%d, refCount=%d\n", url.GetUrl().c_str(), observer, cacheIndex.GetIndex(), textureId, maskTextureId, previousTextureId, frameIndex, mTextureCacheManager[cacheIndex].preMultiplied ? 1 : 0, static_cast<int>(mTextureCacheManager[cacheIndex].referenceCount));
575 if(textureId == INVALID_TEXTURE_ID) // There was no caching, or caching not required
577 textureId = mTextureCacheManager.GenerateTextureId();
579 bool preMultiply = (preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
581 // Cache new texutre, and get cacheIndex.
582 cacheIndex = mTextureCacheManager.AppendCache(TextureInfo(textureId, maskTextureId, url, desiredSize, contentScale, fittingMode, samplingMode, false, cropToMask, useAtlas, textureHash, orientationCorrection, preMultiply, animatedImageLoading, frameIndex, loadYuvPlanes));
583 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestLoad( url=%s observer=%p ) New texture, cacheIndex:%d, textureId=%d, maskTextureId=%d, frameindex=%d premultiply=%d\n", url.GetUrl().c_str(), observer, cacheIndex.GetIndex(), textureId, maskTextureId, frameIndex, preMultiply);
586 // The below code path is common whether we are using the cache or not.
587 // The textureInfoIndex now refers to either a pre-existing cached TextureInfo,
588 // or a new TextureInfo just created.
589 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
590 textureInfo.maskTextureId = maskTextureId;
591 textureInfo.storageType = storageType;
592 textureInfo.orientationCorrection = orientationCorrection;
594 // the case using external texture has already been loaded texture, so change its status to WAITING_FOR_MASK.
595 if(url.GetProtocolType() == VisualUrl::TEXTURE)
597 if(textureInfo.loadState != LoadState::UPLOADED)
599 textureInfo.loadState = TextureManager::LoadState::WAITING_FOR_MASK;
603 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureInfo loadState:%s\n", GET_LOAD_STATE_STRING(textureInfo.loadState));
605 // Force reloading of texture by setting loadState unless already loading or cancelled.
606 if(TextureManager::ReloadPolicy::FORCED == reloadPolicy &&
607 TextureManager::LoadState::LOADING != textureInfo.loadState &&
608 TextureManager::LoadState::WAITING_FOR_MASK != textureInfo.loadState &&
609 TextureManager::LoadState::MASK_APPLYING != textureInfo.loadState &&
610 TextureManager::LoadState::MASK_APPLIED != textureInfo.loadState &&
611 TextureManager::LoadState::CANCELLED != textureInfo.loadState &&
612 TextureManager::LoadState::MASK_CANCELLED != textureInfo.loadState)
614 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, "TextureManager::RequestLoad( url=%s observer=%p ) ForcedReload cacheIndex:%d, textureId=%d, maskTextureId=%d, prevTextureId=%d\n", url.GetUrl().c_str(), observer, cacheIndex.GetIndex(), textureId, maskTextureId, previousTextureId);
615 textureInfo.loadState = TextureManager::LoadState::NOT_STARTED;
618 if(!synchronousLoading)
620 // Check if we should add the observer.
621 // Only do this if we have not loaded yet and it will not have loaded by the end of this method.
622 switch(textureInfo.loadState)
624 case TextureManager::LoadState::LOAD_FAILED: // Failed notifies observer which then stops observing.
625 case TextureManager::LoadState::NOT_STARTED:
627 LoadOrQueueTexture(textureInfo, observer); // If called inside NotifyObservers, queues until afterwards
630 case TextureManager::LoadState::LOADING:
631 case TextureManager::LoadState::WAITING_FOR_MASK:
632 case TextureManager::LoadState::MASK_APPLYING:
633 case TextureManager::LoadState::MASK_APPLIED:
635 // Do not observe even we reload forced when texture is already loading state.
636 if(TextureManager::ReloadPolicy::CACHED == reloadPolicy || TextureManager::INVALID_TEXTURE_ID == previousTextureId)
638 ObserveTexture(textureInfo, observer);
642 case TextureManager::LoadState::UPLOADED:
646 LoadOrQueueTexture(textureInfo, observer);
650 case TextureManager::LoadState::CANCELLED:
652 // A cancelled texture hasn't finished loading yet. Treat as a loading texture
653 // (it's ref count has already been incremented, above)
654 textureInfo.loadState = TextureManager::LoadState::LOADING;
655 ObserveTexture(textureInfo, observer);
658 case TextureManager::LoadState::MASK_CANCELLED:
660 // A cancelled texture hasn't finished mask applying yet. Treat as a mask applying texture
661 // (it's ref count has already been incremented, above)
662 textureInfo.loadState = TextureManager::LoadState::MASK_APPLYING;
663 ObserveTexture(textureInfo, observer);
666 case TextureManager::LoadState::LOAD_FINISHED:
668 // Loading has already completed.
669 if(observer && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
671 LoadOrQueueTexture(textureInfo, observer);
679 // If the image is already finished to load, use cached texture.
680 // We don't need to consider Observer because this is synchronous loading.
681 if(!(textureInfo.loadState == TextureManager::LoadState::UPLOADED ||
682 textureInfo.loadState == TextureManager::LoadState::LOAD_FINISHED))
684 if(url.GetProtocolType() == VisualUrl::TEXTURE)
686 // Get external textureSet from cacheManager.
687 std::string location = textureInfo.url.GetLocation();
688 if(!location.empty())
690 TextureId id = std::stoi(location);
691 auto externalTextureInfo = mTextureCacheManager.GetExternalTextureInfo(id);
692 textureInfo.textures.push_back(externalTextureInfo.textureSet.GetTexture(0));
693 textureInfo.loadState = LoadState::UPLOADED;
698 std::vector<Devel::PixelBuffer> pixelBuffers;
699 LoadImageSynchronously(url, desiredSize, fittingMode, samplingMode, orientationCorrection, loadYuvPlanes, pixelBuffers);
701 if(pixelBuffers.empty())
703 // If pixelBuffer loading is failed in synchronously, call RequestRemove() method.
704 RequestRemove(textureId, nullptr);
705 return INVALID_TEXTURE_ID;
708 if(storageType == StorageType::KEEP_PIXEL_BUFFER) // For the mask image loading.
710 textureInfo.pixelBuffer = pixelBuffers[0]; // Store the pixel data
711 textureInfo.loadState = LoadState::LOAD_FINISHED;
713 else // For the image loading.
716 if(maskTextureId != INVALID_TEXTURE_ID)
718 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
719 if(maskCacheIndex != INVALID_CACHE_INDEX)
721 if(mTextureCacheManager[maskCacheIndex].storageType == StorageType::KEEP_PIXEL_BUFFER)
723 Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
726 pixelBuffers[0].ApplyMask(maskPixelBuffer, contentScale, cropToMask);
730 DALI_LOG_ERROR("Mask image cached invalid pixel buffer!\n");
736 DALI_LOG_ERROR("Mask image is not stored in cache.\n");
739 PreMultiply(pixelBuffers[0], preMultiplyOnLoad);
742 UploadTextures(pixelBuffers, textureInfo);
751 void TextureManager::RequestRemove(const TextureManager::TextureId& textureId, TextureUploadObserver* observer)
753 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::RequestRemove( textureId=%d observer=%p )\n", textureId, observer);
756 if(textureId != INVALID_TEXTURE_ID)
758 TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
759 if(textureCacheIndex != INVALID_CACHE_INDEX)
763 // Remove observer from cached texture info
764 TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
765 RemoveTextureObserver(textureInfo, observer);
768 mRemoveQueue.PushBack(textureId);
770 if(!mRemoveProcessorRegistered && Adaptor::IsAvailable())
772 mRemoveProcessorRegistered = true;
773 Adaptor::Get().RegisterProcessor(*this, true);
779 void TextureManager::Remove(const TextureManager::TextureId& textureId)
781 if(textureId != INVALID_TEXTURE_ID)
783 TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
784 if(textureCacheIndex != INVALID_CACHE_INDEX)
786 TextureManager::TextureId maskTextureId = INVALID_TEXTURE_ID;
787 TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
788 // We only need to consider maskTextureId when texture's loadState is not cancelled. Because it is already deleted.
789 if(textureInfo.loadState != LoadState::CANCELLED && textureInfo.loadState != LoadState::MASK_CANCELLED)
791 if(textureInfo.maskTextureId != INVALID_TEXTURE_ID)
793 maskTextureId = textureInfo.maskTextureId;
797 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::Remove( textureId=%d ) cacheIndex:%d removal maskTextureId=%d, loadState=%s\n", textureId, textureCacheIndex.GetIndex(), maskTextureId, GET_LOAD_STATE_STRING(textureInfo.loadState));
799 // Remove textureId in CacheManager. Now, textureInfo is invalidate.
800 mTextureCacheManager.RemoveCache(textureInfo);
802 // Remove maskTextureId in CacheManager
803 if(maskTextureId != INVALID_TEXTURE_ID)
805 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
806 if(maskCacheIndex != INVALID_CACHE_INDEX)
808 TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
810 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::Remove mask texture( maskTextureId=%d ) cacheIndex:%d, loadState=%s\n", maskTextureId, maskCacheIndex.GetIndex(), GET_LOAD_STATE_STRING(maskTextureInfo.loadState));
812 mTextureCacheManager.RemoveCache(maskTextureInfo);
819 void TextureManager::ProcessRemoveQueue()
821 // Note that RemoveQueue is not be changed during Remove().
822 for(auto&& textureId : mRemoveQueue)
824 if(textureId != INVALID_TEXTURE_ID)
829 mRemoveQueue.Clear();
832 void TextureManager::Process(bool postProcessor)
834 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::Process()\n");
836 ProcessRemoveQueue();
838 if(Adaptor::IsAvailable())
840 Adaptor::Get().UnregisterProcessor(*this, true);
841 mRemoveProcessorRegistered = false;
845 void TextureManager::LoadImageSynchronously(
846 const VisualUrl& url,
847 const Dali::ImageDimensions& desiredSize,
848 const Dali::FittingMode::Type& fittingMode,
849 const Dali::SamplingMode::Type& samplingMode,
850 const bool& orientationCorrection,
851 const bool& loadYuvPlanes,
852 std::vector<Devel::PixelBuffer>& pixelBuffers)
854 Devel::PixelBuffer pixelBuffer;
855 if(url.IsBufferResource())
857 const EncodedImageBuffer& encodedImageBuffer = mTextureCacheManager.GetEncodedImageBuffer(url);
858 if(encodedImageBuffer)
860 pixelBuffer = LoadImageFromBuffer(encodedImageBuffer.GetRawBuffer(), desiredSize, fittingMode, samplingMode, orientationCorrection);
867 Dali::LoadImagePlanesFromFile(url.GetUrl(), pixelBuffers, desiredSize, fittingMode, samplingMode, orientationCorrection);
871 pixelBuffer = Dali::LoadImageFromFile(url.GetUrl(), desiredSize, fittingMode, samplingMode, orientationCorrection);
877 pixelBuffers.push_back(pixelBuffer);
881 void TextureManager::AddObserver(TextureManager::LifecycleObserver& observer)
883 // make sure an observer doesn't observe the same object twice
884 // otherwise it will get multiple calls to ObjectDestroyed()
885 DALI_ASSERT_DEBUG(mLifecycleObservers.End() == std::find(mLifecycleObservers.Begin(), mLifecycleObservers.End(), &observer));
886 mLifecycleObservers.PushBack(&observer);
889 void TextureManager::RemoveObserver(TextureManager::LifecycleObserver& observer)
891 // Find the observer...
892 auto endIter = mLifecycleObservers.End();
893 for(auto iter = mLifecycleObservers.Begin(); iter != endIter; ++iter)
895 if((*iter) == &observer)
897 mLifecycleObservers.Erase(iter);
901 DALI_ASSERT_DEBUG(endIter != mLifecycleObservers.End());
904 void TextureManager::LoadOrQueueTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
906 switch(textureInfo.loadState)
908 case LoadState::NOT_STARTED:
909 case LoadState::LOAD_FAILED:
911 if(mLoadingQueueTextureId != INVALID_TEXTURE_ID)
913 QueueLoadTexture(textureInfo, observer);
917 LoadTexture(textureInfo, observer);
921 case LoadState::UPLOADED:
923 if(mLoadingQueueTextureId != INVALID_TEXTURE_ID)
925 QueueLoadTexture(textureInfo, observer);
929 // The Texture has already loaded. The other observers have already been notified.
930 // We need to send a "late" loaded notification for this observer.
933 EmitLoadComplete(observer, textureInfo, true);
938 case LoadState::LOADING:
939 case LoadState::CANCELLED:
940 case LoadState::MASK_CANCELLED:
941 case LoadState::LOAD_FINISHED:
942 case LoadState::WAITING_FOR_MASK:
943 case LoadState::MASK_APPLYING:
944 case LoadState::MASK_APPLIED:
951 void TextureManager::QueueLoadTexture(const TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
953 const auto& textureId = textureInfo.textureId;
954 mLoadQueue.PushBack(QueueElement(textureId, observer));
958 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, " Connect DestructionSignal to observer:%p\n", observer);
959 observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
963 void TextureManager::LoadTexture(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
965 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::LoadTexture(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
966 textureInfo.loadState = LoadState::LOADING;
967 if(!textureInfo.loadSynchronously)
969 auto premultiplyOnLoad = (textureInfo.preMultiplyOnLoad && textureInfo.maskTextureId == INVALID_TEXTURE_ID) ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
970 if(textureInfo.animatedImageLoading)
972 mAsyncLoader->LoadAnimatedImage(textureInfo.textureId, textureInfo.animatedImageLoading, textureInfo.frameIndex, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, premultiplyOnLoad);
976 mAsyncLoader->Load(textureInfo.textureId, textureInfo.url, textureInfo.desiredSize, textureInfo.fittingMode, textureInfo.samplingMode, textureInfo.orientationCorrection, premultiplyOnLoad, textureInfo.loadYuvPlanes);
979 ObserveTexture(textureInfo, observer);
982 void TextureManager::ProcessLoadQueue()
984 for(auto&& element : mLoadQueue)
986 if(element.mTextureId == INVALID_TEXTURE_ID)
991 TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(element.mTextureId);
992 if(cacheIndex != INVALID_CACHE_INDEX)
994 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
996 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, "TextureManager::ProcessLoadQueue() textureId=%d, observer=%p, cacheIndex=@%d, loadState:%s\n", element.mTextureId, element.mObserver, cacheIndex.GetIndex(), GET_LOAD_STATE_STRING(textureInfo.loadState));
998 if((textureInfo.loadState == LoadState::UPLOADED) || (textureInfo.loadState == LoadState::LOAD_FINISHED && textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER))
1000 if(element.mObserver)
1002 EmitLoadComplete(element.mObserver, textureInfo, true);
1005 else if(textureInfo.loadState == LoadState::LOADING)
1007 // Note : LOADING state texture cannot be queue.
1008 // This case be occured when same texture id are queue in mLoadQueue.
1009 ObserveTexture(textureInfo, element.mObserver);
1013 LoadTexture(textureInfo, element.mObserver);
1020 void TextureManager::ObserveTexture(TextureManager::TextureInfo& textureInfo,
1021 TextureUploadObserver* observer)
1023 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ObserveTexture(): url:%s observer:%p\n", textureInfo.url.GetUrl().c_str(), observer);
1027 textureInfo.observerList.PushBack(observer);
1029 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, " Connect DestructionSignal to observer:%p\n", observer);
1030 observer->DestructionSignal().Connect(this, &TextureManager::ObserverDestroyed);
1034 void TextureManager::AsyncLoadComplete(const TextureManager::TextureId& textureId, std::vector<Devel::PixelBuffer>& pixelBuffers)
1036 TextureCacheIndex cacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1037 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::AsyncLoadComplete( textureId:%d CacheIndex:%d )\n", textureId, cacheIndex.GetIndex());
1038 if(cacheIndex != INVALID_CACHE_INDEX)
1040 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1042 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, " textureId:%d Url:%s CacheIndex:%d LoadState: %s\n", textureInfo.textureId, textureInfo.url.GetUrl().c_str(), cacheIndex.GetIndex(), GET_LOAD_STATE_STRING(textureInfo.loadState));
1043 if(textureInfo.loadState != LoadState::CANCELLED && textureInfo.loadState != LoadState::MASK_CANCELLED)
1045 // textureInfo can be invalidated after this call (as the mTextureInfoContainer may be modified)
1046 PostLoad(textureInfo, pixelBuffers);
1050 RequestRemove(textureInfo.textureId, nullptr);
1055 void TextureManager::PostLoad(TextureManager::TextureInfo& textureInfo, std::vector<Devel::PixelBuffer>& pixelBuffers)
1057 // Was the load successful?
1058 if(!pixelBuffers.empty())
1060 if(pixelBuffers.size() == 1)
1062 Devel::PixelBuffer pixelBuffer = pixelBuffers[0];
1063 if(pixelBuffer && (pixelBuffer.GetWidth() != 0) && (pixelBuffer.GetHeight() != 0))
1065 // No atlas support for now
1066 textureInfo.useAtlas = UseAtlas::NO_ATLAS;
1067 textureInfo.preMultiplied = pixelBuffer.IsAlphaPreMultiplied();
1069 if(textureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE)
1071 // If there is a mask texture ID associated with this texture, then apply the mask
1072 // if it's already loaded. If it hasn't, and the mask is still loading,
1073 // wait for the mask to finish loading.
1074 // note, If the texture is already uploaded synchronously during loading,
1075 // we don't need to apply mask.
1076 if(textureInfo.loadState != LoadState::UPLOADED &&
1077 textureInfo.maskTextureId != INVALID_TEXTURE_ID)
1079 if(textureInfo.loadState == LoadState::MASK_APPLYING)
1081 textureInfo.loadState = LoadState::MASK_APPLIED;
1082 UploadTextures(pixelBuffers, textureInfo);
1083 NotifyObservers(textureInfo, true);
1087 LoadState maskLoadState = mTextureCacheManager.GetTextureStateInternal(textureInfo.maskTextureId);
1088 textureInfo.pixelBuffer = pixelBuffer; // Store the pixel buffer temporarily
1089 if(maskLoadState == LoadState::LOADING)
1091 textureInfo.loadState = LoadState::WAITING_FOR_MASK;
1093 else if(maskLoadState == LoadState::LOAD_FINISHED || maskLoadState == LoadState::UPLOADED)
1095 // Send New Task to Thread
1096 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureInfo.maskTextureId);
1097 if(maskCacheIndex != INVALID_CACHE_INDEX)
1099 TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
1100 if(maskTextureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER)
1102 // Send New Task to Thread
1103 ApplyMask(textureInfo, textureInfo.maskTextureId);
1105 else if(maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1107 // Upload image texture. textureInfo.loadState will be UPLOADED.
1108 UploadTextures(pixelBuffers, textureInfo);
1110 // notify mask texture set.
1111 NotifyObservers(textureInfo, true);
1115 else // maskLoadState == LoadState::LOAD_FAILED
1117 // Url texture load success, But alpha mask texture load failed. Run as normal image upload.
1118 DALI_LOG_ERROR("Alpha mask image loading failed! Image will not be masked\n");
1119 UploadTextures(pixelBuffers, textureInfo);
1120 NotifyObservers(textureInfo, true);
1126 UploadTextures(pixelBuffers, textureInfo);
1127 NotifyObservers(textureInfo, true);
1132 textureInfo.pixelBuffer = pixelBuffer; // Store the pixel data
1133 textureInfo.loadState = LoadState::LOAD_FINISHED;
1135 if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
1137 NotifyObservers(textureInfo, true);
1139 else // for the StorageType::KEEP_PIXEL_BUFFER and StorageType::KEEP_TEXTURE
1141 // Check if there was another texture waiting for this load to complete
1142 // (e.g. if this was an image mask, and its load is on a different thread)
1143 CheckForWaitingTexture(textureInfo);
1151 // No atlas support for now
1152 textureInfo.useAtlas = UseAtlas::NO_ATLAS;
1153 textureInfo.preMultiplied = false;
1155 UploadTextures(pixelBuffers, textureInfo);
1156 NotifyObservers(textureInfo, true);
1161 textureInfo.loadState = LoadState::LOAD_FAILED;
1162 if(textureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER || textureInfo.storageType == StorageType::KEEP_TEXTURE)
1164 // Check if there was another texture waiting for this load to complete
1165 // (e.g. if this was an image mask, and its load is on a different thread)
1166 CheckForWaitingTexture(textureInfo);
1170 NotifyObservers(textureInfo, false);
1175 void TextureManager::CheckForWaitingTexture(TextureManager::TextureInfo& maskTextureInfo)
1177 if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED &&
1178 maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1180 // Upload mask texture. textureInfo.loadState will be UPLOADED.
1181 std::vector<Devel::PixelBuffer> pixelBuffers;
1182 pixelBuffers.push_back(maskTextureInfo.pixelBuffer);
1183 UploadTextures(pixelBuffers, maskTextureInfo);
1186 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::CheckForWaitingTexture(): maskTextureId=%d, maskTextureUrl=%s\n", maskTextureInfo.textureId, maskTextureInfo.url.GetUrl().c_str());
1188 // Search the cache, checking if any texture has this texture id as a maskTextureId
1189 const std::size_t size = mTextureCacheManager.size();
1191 // Keep notify observer required textureIds.
1192 // Note : NotifyObservers can change mTextureCacheManager cache struct. We should check id's validation before notify.
1193 std::vector<TextureId> notifyRequiredTextureIds;
1195 // TODO : Refactorize here to not iterate whole cached image.
1196 for(TextureCacheIndex cacheIndex = TextureCacheIndex(TextureManagerType::TEXTURE_CACHE_INDEX_TYPE_LOCAL, 0u); cacheIndex.GetIndex() < size; ++cacheIndex.detailValue.index)
1198 if(mTextureCacheManager[cacheIndex].maskTextureId == maskTextureInfo.textureId &&
1199 mTextureCacheManager[cacheIndex].loadState == LoadState::WAITING_FOR_MASK)
1201 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1203 if(maskTextureInfo.loadState == LoadState::LOAD_FINISHED)
1205 if(maskTextureInfo.storageType == StorageType::KEEP_PIXEL_BUFFER)
1207 // Send New Task to Thread
1208 ApplyMask(textureInfo, maskTextureInfo.textureId);
1211 else if(maskTextureInfo.loadState == LoadState::UPLOADED)
1213 if(maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1215 if(textureInfo.url.GetProtocolType() == VisualUrl::TEXTURE)
1217 // Get external textureSet from cacheManager.
1218 std::string location = textureInfo.url.GetLocation();
1219 if(!location.empty())
1221 TextureId id = std::stoi(location);
1222 auto externalTextureInfo = mTextureCacheManager.GetExternalTextureInfo(id);
1223 textureInfo.textures.push_back(externalTextureInfo.textureSet.GetTexture(0));
1224 textureInfo.loadState = LoadState::UPLOADED;
1229 // Upload image texture. textureInfo.loadState will be UPLOADED.
1230 std::vector<Devel::PixelBuffer> pixelBuffers;
1231 pixelBuffers.push_back(textureInfo.pixelBuffer);
1232 UploadTextures(pixelBuffers, textureInfo);
1235 // Increase reference counts for notify required textureId.
1236 // Now we can assume that we don't remove & re-assign this textureId
1237 // during NotifyObserver signal emit.
1238 maskTextureInfo.referenceCount++;
1239 textureInfo.referenceCount++;
1241 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::CheckForWaitingTexture(): Ready to notify textureId=%d\n", textureInfo.textureId);
1243 notifyRequiredTextureIds.push_back(textureInfo.textureId);
1246 else // maskTextureInfo.loadState == LoadState::LOAD_FAILED
1248 // Url texture load success, But alpha mask texture load failed. Run as normal image upload.
1249 DALI_LOG_ERROR("Alpha mask image loading failed! Image will not be masked\n");
1250 std::vector<Devel::PixelBuffer> pixelBuffers;
1251 pixelBuffers.push_back(textureInfo.pixelBuffer);
1252 UploadTextures(pixelBuffers, textureInfo);
1254 // Increase reference counts for notify required textureId.
1255 // Now we can assume that we don't remove & re-assign this textureId
1256 // during NotifyObserver signal emit.
1257 maskTextureInfo.referenceCount++;
1258 textureInfo.referenceCount++;
1260 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::CheckForWaitingTexture(): Ready to notify textureId=%d\n", textureInfo.textureId);
1262 notifyRequiredTextureIds.push_back(textureInfo.textureId);
1267 // Notify textures are masked
1268 for(const auto textureId : notifyRequiredTextureIds)
1270 TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1271 if(textureCacheIndex != INVALID_CACHE_INDEX)
1273 TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
1274 NotifyObservers(textureInfo, true);
1278 // Decrease reference count
1279 for(const auto textureId : notifyRequiredTextureIds)
1281 RequestRemove(textureId, nullptr);
1285 void TextureManager::ApplyMask(TextureManager::TextureInfo& textureInfo, const TextureManager::TextureId& maskTextureId)
1287 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(maskTextureId);
1288 if(maskCacheIndex != INVALID_CACHE_INDEX)
1290 Devel::PixelBuffer maskPixelBuffer = mTextureCacheManager[maskCacheIndex].pixelBuffer;
1291 Devel::PixelBuffer pixelBuffer = textureInfo.pixelBuffer;
1292 textureInfo.pixelBuffer.Reset();
1294 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::ApplyMask(): url:%s sync:%s\n", textureInfo.url.GetUrl().c_str(), textureInfo.loadSynchronously ? "T" : "F");
1296 textureInfo.loadState = LoadState::MASK_APPLYING;
1297 auto premultiplyOnLoad = textureInfo.preMultiplyOnLoad ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF;
1298 mAsyncLoader->ApplyMask(textureInfo.textureId, pixelBuffer, maskPixelBuffer, textureInfo.scaleFactor, textureInfo.cropToMask, premultiplyOnLoad);
1302 void TextureManager::UploadTextures(std::vector<Devel::PixelBuffer>& pixelBuffers, TextureManager::TextureInfo& textureInfo)
1304 if(!pixelBuffers.empty() && textureInfo.loadState != LoadState::UPLOADED && textureInfo.useAtlas != UseAtlas::USE_ATLAS)
1306 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::General, " TextureManager::UploadTextures() New Texture for textureId:%d\n", textureInfo.textureId);
1308 // Check if this pixelBuffer is premultiplied
1309 textureInfo.preMultiplied = pixelBuffers[0].IsAlphaPreMultiplied();
1311 auto& renderingAddOn = RenderingAddOn::Get();
1312 if(renderingAddOn.IsValid())
1314 renderingAddOn.CreateGeometry(textureInfo.textureId, pixelBuffers[0]);
1317 // Remove previous textures and insert new textures
1318 textureInfo.textures.clear();
1320 for(auto&& pixelBuffer : pixelBuffers)
1322 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, pixelBuffer.GetPixelFormat(), pixelBuffer.GetWidth(), pixelBuffer.GetHeight());
1323 PixelData pixelData = Devel::PixelBuffer::Convert(pixelBuffer);
1324 texture.Upload(pixelData);
1325 textureInfo.textures.push_back(texture);
1329 // Update the load state.
1330 // Note: This is regardless of success as we care about whether a
1331 // load attempt is in progress or not. If unsuccessful, a broken
1332 // image is still loaded.
1333 textureInfo.loadState = LoadState::UPLOADED;
1336 void TextureManager::NotifyObservers(TextureManager::TextureInfo& textureInfo, const bool& success)
1338 TextureId textureId = textureInfo.textureId;
1340 // If there is an observer: Notify the load is complete, whether successful or not,
1341 // and erase it from the list
1342 TextureInfo* info = &textureInfo;
1344 if(info->animatedImageLoading)
1346 // If loading failed, we don't need to get frameCount and frameInterval.
1349 info->frameCount = info->animatedImageLoading.GetImageCount();
1350 info->frameInterval = info->animatedImageLoading.GetFrameInterval(info->frameIndex);
1352 info->animatedImageLoading.Reset();
1355 mLoadingQueueTextureId = textureId;
1357 // Reverse observer list that we can pop_back the observer.
1358 std::reverse(info->observerList.Begin(), info->observerList.End());
1360 while(info->observerList.Count())
1362 TextureUploadObserver* observer = *(info->observerList.End() - 1u);
1364 // During LoadComplete() a Control ResourceReady() signal is emitted.
1365 // During that signal the app may add remove /add Textures (e.g. via
1367 // It is possible for observers to be removed from the observer list,
1368 // and it is also possible for the mTextureInfoContainer to be modified,
1369 // invalidating the reference to the textureInfo struct.
1370 // Texture load requests for the same URL are deferred until the end of this
1372 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Concise, "TextureManager::NotifyObservers() observer:%p textureId:%d url:%s loadState:%s\n", observer, textureId, info->url.GetUrl().c_str(), GET_LOAD_STATE_STRING(info->loadState));
1373 // It is possible for the observer to be deleted.
1374 // Disconnect and remove the observer first.
1375 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, " Disconnect DestructionSignal to observer:%p\n", observer);
1376 observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1378 info->observerList.Erase(info->observerList.End() - 1u);
1380 EmitLoadComplete(observer, *info, success);
1382 // Get the textureInfo from the container again as it may have been invalidated.
1383 TextureCacheIndex textureInfoIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1384 if(textureInfoIndex == INVALID_CACHE_INDEX)
1386 break; // texture has been removed - can stop.
1388 info = &mTextureCacheManager[textureInfoIndex];
1391 mLoadingQueueTextureId = INVALID_TEXTURE_ID;
1394 if(info->storageType == StorageType::RETURN_PIXEL_BUFFER && info->observerList.Count() == 0)
1396 RequestRemove(info->textureId, nullptr);
1400 void TextureManager::ObserverDestroyed(TextureUploadObserver* observer)
1402 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, "TextureManager::ObserverDestroyed() observer:%p\n", observer);
1404 const std::size_t size = mTextureCacheManager.size();
1405 for(TextureCacheIndex cacheIndex = TextureCacheIndex(TextureManagerType::TEXTURE_CACHE_INDEX_TYPE_LOCAL, 0u); cacheIndex.GetIndex() < size; ++cacheIndex.detailValue.index)
1407 TextureInfo& textureInfo(mTextureCacheManager[cacheIndex]);
1408 for(TextureInfo::ObserverListType::Iterator j = textureInfo.observerList.Begin();
1409 j != textureInfo.observerList.End();)
1413 j = textureInfo.observerList.Erase(j);
1422 // Remove element from the LoadQueue
1423 for(auto&& element : mLoadQueue)
1425 if(element.mObserver == observer)
1427 element.mTextureId = INVALID_TEXTURE_ID;
1428 element.mObserver = nullptr;
1433 Dali::Geometry TextureManager::GetRenderGeometry(const TextureManager::TextureId& textureId, std::uint32_t& frontElements, std::uint32_t& backElements)
1435 return RenderingAddOn::Get().IsValid() ? RenderingAddOn::Get().GetGeometry(textureId, frontElements, backElements) : Geometry();
1438 void TextureManager::EmitLoadComplete(TextureUploadObserver* observer, TextureManager::TextureInfo& textureInfo, const bool& success)
1440 if(textureInfo.storageType == StorageType::RETURN_PIXEL_BUFFER)
1442 observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::PIXEL_BUFFER, textureInfo.pixelBuffer, textureInfo.url.GetUrl(), textureInfo.preMultiplied));
1446 TextureSet textureSet = GetTextureSet(textureInfo);
1447 if(textureInfo.isAnimatedImageFormat)
1449 observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::ANIMATED_IMAGE_TEXTURE, textureInfo.textureId, textureSet, textureInfo.frameCount, textureInfo.frameInterval));
1453 observer->LoadComplete(success, TextureUploadObserver::TextureInformation(TextureUploadObserver::ReturnType::TEXTURE, textureInfo.textureId, textureSet, (textureInfo.useAtlas == UseAtlas::USE_ATLAS) ? true : false, textureInfo.atlasRect, textureInfo.preMultiplied));
1458 TextureSet TextureManager::GetTextureSet(const TextureManager::TextureId& textureId)
1460 TextureSet textureSet;
1461 TextureManager::LoadState loadState = mTextureCacheManager.GetTextureStateInternal(textureId);
1462 if(loadState == TextureManager::LoadState::UPLOADED)
1464 // LoadComplete has already been called - keep the same texture set
1465 TextureCacheIndex textureCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureId);
1466 if(textureCacheIndex != INVALID_CACHE_INDEX)
1468 TextureInfo& textureInfo(mTextureCacheManager[textureCacheIndex]);
1469 textureSet = GetTextureSet(textureInfo);
1474 DALI_LOG_ERROR("GetTextureSet is failed. texture is not uploaded \n");
1479 TextureSet TextureManager::GetTextureSet(const TextureManager::TextureInfo& textureInfo)
1481 TextureSet textureSet;
1483 // LoadComplete has already been called - keep the same texture set
1484 textureSet = TextureSet::New();
1485 if(!textureInfo.textures.empty())
1487 if(textureInfo.textures.size() > 1) // For YUV case
1489 uint32_t index = 0u;
1490 for(auto&& texture : textureInfo.textures)
1492 textureSet.SetTexture(index++, texture);
1497 textureSet.SetTexture(TEXTURE_INDEX, textureInfo.textures[0]);
1498 TextureCacheIndex maskCacheIndex = mTextureCacheManager.GetCacheIndexFromId(textureInfo.maskTextureId);
1499 if(maskCacheIndex != INVALID_CACHE_INDEX)
1501 TextureInfo& maskTextureInfo(mTextureCacheManager[maskCacheIndex]);
1502 if(maskTextureInfo.storageType == StorageType::UPLOAD_TO_TEXTURE || maskTextureInfo.storageType == StorageType::KEEP_TEXTURE)
1504 if(!maskTextureInfo.textures.empty())
1506 textureSet.SetTexture(MASK_TEXTURE_INDEX, maskTextureInfo.textures[0]);
1515 void TextureManager::RemoveTextureObserver(TextureManager::TextureInfo& textureInfo, TextureUploadObserver* observer)
1517 // Remove its observer
1520 const auto iterEnd = textureInfo.observerList.End();
1521 const auto iter = std::find(textureInfo.observerList.Begin(), iterEnd, observer);
1524 // Disconnect and remove the observer.
1525 DALI_LOG_INFO(gTextureManagerLogFilter, Debug::Verbose, " Disconnect DestructionSignal to observer:%p\n", observer);
1526 observer->DestructionSignal().Disconnect(this, &TextureManager::ObserverDestroyed);
1527 textureInfo.observerList.Erase(iter);
1532 } // namespace Internal
1534 } // namespace Toolkit