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 "animated-image-visual.h"
22 #include <dali/devel-api/adaptor-framework/image-loading.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/public-api/rendering/decorated-visual-renderer.h>
28 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
29 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
30 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
31 #include <dali-toolkit/internal/visuals/animated-image/fixed-image-cache.h>
32 #include <dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h>
33 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
34 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
35 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
37 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
40 #include <dali-toolkit/public-api/visuals/visual-properties.h>
50 const int CUSTOM_PROPERTY_COUNT(5); // ltr, wrap, pixel area, crop to mask, mask texture ratio
53 DALI_ENUM_TO_STRING_TABLE_BEGIN(STOP_BEHAVIOR)
54 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME)
55 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME)
56 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME)
57 DALI_ENUM_TO_STRING_TABLE_END(STOP_BEHAVIOR)
60 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
61 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
62 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
63 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
64 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
65 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
68 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOAD_POLICY)
69 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE)
70 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED)
71 DALI_ENUM_TO_STRING_TABLE_END(LOAD_POLICY)
74 DALI_ENUM_TO_STRING_TABLE_BEGIN(RELEASE_POLICY)
75 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED)
76 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED)
77 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER)
78 DALI_ENUM_TO_STRING_TABLE_END(RELEASE_POLICY)
80 static constexpr uint32_t SINGLE_IMAGE_COUNT = 1u;
81 static constexpr uint32_t FIRST_FRAME_INDEX = 0u;
82 static constexpr uint16_t MINIMUM_CACHESIZE = 1;
83 static constexpr Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
84 static constexpr auto LOOP_FOREVER = -1;
85 static constexpr auto FIRST_LOOP = 0u;
87 constexpr uint32_t TEXTURE_COUNT_FOR_GPU_ALPHA_MASK = 2u;
89 #if defined(DEBUG_ENABLED)
90 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
95 * Multi-image Flow of execution
100 * | CreateImageCache()
103 * | PrepareTextureSet()
104 * | cache->FirstFrame()
106 * | FrameReady(textureSet)
108 * | actor.AddRenderer
110 * | mRenderer.SetTextures(textureSet)
113 * | DisplayNextFrame()
114 * | if front frame is ready,
115 * | mRenderer.SetTextures( front frame's texture )
117 * | Waiting for frame ready.
119 * | FrameReady(textureSet)
120 * | mRenderer.SetTextures(textureSet)
125 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
127 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
128 visual->InitializeAnimatedImage(imageUrl);
129 visual->SetProperties(properties);
131 visual->Initialize();
136 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties)
138 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
139 visual->mImageUrls = new ImageCache::UrlList();
140 visual->mImageUrls->reserve(imageUrls.Count());
142 for(unsigned int i = 0; i < imageUrls.Count(); ++i)
144 ImageCache::UrlStore urlStore;
145 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
146 urlStore.mUrl = imageUrls[i].Get<std::string>();
147 visual->mImageUrls->push_back(urlStore);
149 visual->mFrameCount = imageUrls.Count();
150 visual->SetProperties(properties);
152 visual->Initialize();
157 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
159 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
160 visual->InitializeAnimatedImage(imageUrl);
162 visual->Initialize();
167 void AnimatedImageVisual::InitializeAnimatedImage(const VisualUrl& imageUrl)
169 mImageUrl = imageUrl;
170 mAnimatedImageLoading = AnimatedImageLoading::New(imageUrl.GetUrl(), imageUrl.IsLocalResource());
173 void AnimatedImageVisual::CreateImageCache()
175 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::CreateImageCache() batchSize:%d cacheSize:%d\n", mBatchSize, mCacheSize);
177 TextureManager& textureManager = mFactoryCache.GetTextureManager();
179 if(mAnimatedImageLoading)
181 mImageCache = new RollingAnimatedImageCache(textureManager, mAnimatedImageLoading, mMaskingData, *this, mCacheSize, mBatchSize, IsSynchronousLoadingRequired(), mFactoryCache.GetPreMultiplyOnLoad());
185 // Ensure the batch size and cache size are no bigger than the number of URLs,
186 // and that the cache is at least as big as the batch size.
187 uint16_t numUrls = mImageUrls->size();
188 uint16_t batchSize = std::max(std::min(mBatchSize, numUrls), MINIMUM_CACHESIZE);
189 uint16_t cacheSize = std::max(std::min(std::max(batchSize, mCacheSize), numUrls), MINIMUM_CACHESIZE);
190 if(cacheSize < numUrls)
192 mImageCache = new RollingImageCache(textureManager, *mImageUrls, mMaskingData, *this, cacheSize, batchSize, mFrameDelay);
196 mImageCache = new FixedImageCache(textureManager, *mImageUrls, mMaskingData, *this, batchSize, mFrameDelay);
202 DALI_LOG_ERROR("mImageCache is null\n");
206 AnimatedImageVisual::AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory)
207 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::ANIMATED_IMAGE),
210 mImageVisualShaderFactory(shaderFactory),
211 mPixelArea(FULL_TEXTURE_RECT),
213 mAnimatedImageLoading(),
214 mFrameIndexForJumpTo(0),
215 mCurrentFrameIndex(FIRST_FRAME_INDEX),
221 mLoopCount(LOOP_FOREVER),
222 mCurrentLoopIndex(FIRST_LOOP),
223 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
224 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
228 mActionStatus(DevelAnimatedImageVisual::Action::PLAY),
229 mWrapModeU(WrapMode::DEFAULT),
230 mWrapModeV(WrapMode::DEFAULT),
231 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
232 mStartFirstFrame(false),
235 EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
238 AnimatedImageVisual::~AnimatedImageVisual()
240 // AnimatedImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
241 // If this is animated image, clear cache. Else if this is single frame image, this is affected be release policy.
242 if(mFrameCount > SINGLE_IMAGE_COUNT || mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER)
244 mImageCache->ClearCache();
250 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
252 if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
254 if(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid() &&
255 mMaskingData->mCropToMask)
257 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
258 if(dimensions != ImageDimensions(0, 0))
260 mImageSize = dimensions;
261 naturalSize.x = dimensions.GetWidth();
262 naturalSize.y = dimensions.GetHeight();
267 if(mImageUrl.IsValid())
269 mImageSize = mAnimatedImageLoading.GetImageSize();
271 else if(mImageUrls && mImageUrls->size() > 0)
273 mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl.GetUrl());
277 naturalSize.width = mImageSize.GetWidth();
278 naturalSize.height = mImageSize.GetHeight();
281 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
285 bool sync = IsSynchronousLoadingRequired();
286 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
288 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
290 if(mImageUrl.IsValid())
292 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
294 if(mImageUrls != NULL && !mImageUrls->empty())
296 Property::Array urls;
297 for(unsigned int i = 0; i < mImageUrls->size(); ++i)
299 urls.Add((*mImageUrls)[i].mUrl.GetUrl());
301 Property::Value value(const_cast<Property::Array&>(urls));
302 map.Insert(Toolkit::ImageVisual::Property::URL, value);
305 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
306 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
307 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
309 map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
310 map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
311 map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
312 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
313 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
314 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>((mAnimatedImageLoading) ? mAnimatedImageLoading.GetImageCount() : mImageCache->GetTotalFrameCount()) : -1);
316 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
318 if(mMaskingData != nullptr)
320 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
321 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
322 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
323 map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
326 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
327 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
330 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
335 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
337 // Make not set any action when the resource status is already failed.
338 if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
343 // Check if action is valid for this visual type and perform action if possible
346 case DevelAnimatedImageVisual::Action::PAUSE:
348 // Pause will be executed on next timer tick
349 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
352 case DevelAnimatedImageVisual::Action::PLAY:
354 if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
356 mFrameDelayTimer.Start();
358 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
361 case DevelAnimatedImageVisual::Action::STOP:
363 // STOP reset functionality will actually be done in a future change
364 // Stop will be executed on next timer tick
365 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
366 mCurrentLoopIndex = FIRST_LOOP;
373 case DevelAnimatedImageVisual::Action::JUMP_TO:
376 if(attributes.Get(frameNumber))
378 if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
380 DALI_LOG_ERROR("Invalid frame index used.\n");
385 mFrameIndexForJumpTo = frameNumber;
397 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
399 // url[s] already passed in from constructor
400 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
402 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
403 if(keyValue.first.type == Property::Key::INDEX)
405 DoSetProperty(keyValue.first.indexKey, keyValue.second);
409 if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
411 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
413 else if(keyValue.first == IMAGE_WRAP_MODE_U)
415 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
417 else if(keyValue.first == IMAGE_WRAP_MODE_V)
419 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
421 else if(keyValue.first == BATCH_SIZE_NAME)
423 DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
425 else if(keyValue.first == CACHE_SIZE_NAME)
427 DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
429 else if(keyValue.first == FRAME_DELAY_NAME)
431 DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
433 else if(keyValue.first == LOOP_COUNT_NAME)
435 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
437 else if(keyValue.first == STOP_BEHAVIOR_NAME)
439 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
441 else if(keyValue.first == ALPHA_MASK_URL)
443 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
445 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
447 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
449 else if(keyValue.first == CROP_TO_MASK_NAME)
451 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
453 else if(keyValue.first == MASKING_TYPE_NAME)
455 DoSetProperty(Toolkit::DevelImageVisual::Property::MASKING_TYPE, keyValue.second);
457 else if(keyValue.first == LOAD_POLICY_NAME)
459 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
461 else if(keyValue.first == RELEASE_POLICY_NAME)
463 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
465 else if(keyValue.first == SYNCHRONOUS_LOADING)
467 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
471 // Load image immediately if LOAD_POLICY requires it
472 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
478 void AnimatedImageVisual::DoSetProperty(Property::Index index,
479 const Property::Value& value)
483 case Toolkit::ImageVisual::Property::PIXEL_AREA:
485 value.Get(mPixelArea);
488 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
491 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
493 mWrapModeU = Dali::WrapMode::Type(wrapMode);
497 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
501 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
504 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
506 mWrapModeV = Dali::WrapMode::Type(wrapMode);
510 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
515 case Toolkit::ImageVisual::Property::BATCH_SIZE:
518 if(value.Get(batchSize))
522 DALI_LOG_ERROR("The minimum value of batch size is 2.");
526 mBatchSize = batchSize;
532 case Toolkit::ImageVisual::Property::CACHE_SIZE:
535 if(value.Get(cacheSize))
539 DALI_LOG_ERROR("The minimum value of cache size is 2.");
543 mCacheSize = cacheSize;
549 case Toolkit::ImageVisual::Property::FRAME_DELAY:
552 if(value.Get(frameDelay))
554 mFrameDelay = frameDelay;
557 mImageCache->SetInterval(static_cast<uint32_t>(mFrameDelay));
563 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
566 if(value.Get(loopCount))
568 mLoopCount = loopCount;
573 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
575 int32_t stopBehavior = mStopBehavior;
576 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
578 mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
583 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
589 mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
593 mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
598 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
600 std::string alphaUrl = "";
601 if(value.Get(alphaUrl))
604 mMaskingData->mAlphaMaskUrl = alphaUrl;
609 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
615 mMaskingData->mContentScaleFactor = scale;
620 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
626 mMaskingData->mCropToMask = crop;
631 case Toolkit::DevelImageVisual::Property::MASKING_TYPE:
634 if(value.Get(maskingType))
637 mMaskingData->mPreappliedMasking = Toolkit::DevelImageVisual::MaskingType::Type(maskingType) == Toolkit::DevelImageVisual::MaskingType::MASKING_ON_LOADING ? true : false;
642 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
644 int releasePolicy = 0;
645 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
646 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
650 case Toolkit::ImageVisual::Property::LOAD_POLICY:
653 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
654 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
660 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
662 mStartFirstFrame = true;
663 mPlacementActor = actor;
667 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
669 DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
673 mFrameDelayTimer.Stop();
674 mFrameDelayTimer.Reset();
677 actor.RemoveRenderer(mImpl->mRenderer);
678 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
680 mImageCache->ClearCache(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
681 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
683 TextureSet textureSet = TextureSet::New();
684 mImpl->mRenderer.SetTextures(textureSet);
687 mPlacementActor.Reset();
688 mStartFirstFrame = false;
689 mCurrentFrameIndex = FIRST_FRAME_INDEX;
690 mCurrentLoopIndex = FIRST_LOOP;
693 void AnimatedImageVisual::OnSetTransform()
697 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
701 void AnimatedImageVisual::UpdateShader()
705 Shader shader = GenerateShader();
706 mImpl->mRenderer.SetShader(shader);
710 Shader AnimatedImageVisual::GenerateShader() const
712 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
713 bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
715 shader = mImageVisualShaderFactory.GetShader(
717 ImageVisualShaderFeature::FeatureBuilder()
718 .ApplyDefaultTextureWrapMode(defaultWrapMode)
719 .EnableRoundedCorner(IsRoundedCornerRequired())
720 .EnableBorderline(IsBorderlineRequired())
721 .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering));
725 void AnimatedImageVisual::OnInitialize()
729 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
730 Shader shader = GenerateShader();
732 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
734 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
735 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
737 // Register transform properties
738 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
740 if(!defaultWrapMode) // custom wrap mode
742 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
743 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
744 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
747 if(mPixelArea != FULL_TEXTURE_RECT)
749 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
754 mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
757 // Enable PreMultipliedAlpha if it need premultiplied
758 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
759 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
760 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
761 EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
764 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval)
766 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
768 mStartFirstFrame = false;
771 mImpl->mRenderer.SetTextures(textureSet);
774 Actor actor = mPlacementActor.GetHandle();
777 actor.AddRenderer(mImpl->mRenderer);
778 mPlacementActor.Reset();
782 if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
784 if(mFrameCount > SINGLE_IMAGE_COUNT)
786 mFrameDelayTimer = Timer::New(firstInterval);
787 mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
788 mFrameDelayTimer.Start();
791 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
792 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
795 mCurrentFrameIndex = FIRST_FRAME_INDEX;
798 void AnimatedImageVisual::PrepareTextureSet()
800 TextureSet textureSet;
803 textureSet = mImageCache->FirstFrame();
806 // Check whether synchronous loading is true or false for the first frame.
809 SetImageSize(textureSet);
813 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
817 Texture texture = textureSet.GetTexture(0);
820 mImageSize.SetWidth(texture.GetWidth());
821 mImageSize.SetHeight(texture.GetHeight());
824 if(textureSet.GetTextureCount() > 1u && mMaskingData && mMaskingData->mCropToMask)
826 Texture maskTexture = textureSet.GetTexture(1);
829 mImageSize.SetWidth(std::min(static_cast<uint32_t>(mImageSize.GetWidth() * mMaskingData->mContentScaleFactor), maskTexture.GetWidth()));
830 mImageSize.SetHeight(std::min(static_cast<uint32_t>(mImageSize.GetHeight() * mMaskingData->mContentScaleFactor), maskTexture.GetHeight()));
832 float textureWidth = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
833 float textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
834 Vector2 textureRatio(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
835 std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
836 mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, textureRatio);
842 void AnimatedImageVisual::FrameReady(TextureSet textureSet, uint32_t interval)
844 // When image visual requested to load new frame to mImageCache and it is failed.
845 if(!mImageCache || !textureSet)
847 textureSet = SetLoadingFailed();
849 SetImageSize(textureSet);
853 mFrameCount = mImageCache->GetTotalFrameCount();
854 StartFirstFrame(textureSet, interval);
860 if(mFrameDelayTimer && interval > 0u)
862 mFrameDelayTimer.SetInterval(interval);
864 mImpl->mRenderer.SetTextures(textureSet);
870 bool AnimatedImageVisual::DisplayNextFrame()
872 TextureSet textureSet;
873 bool continueTimer = false;
877 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
882 frameIndex = mFrameIndexForJumpTo;
884 else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
888 else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
890 mCurrentLoopIndex = FIRST_LOOP;
891 if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
893 frameIndex = FIRST_FRAME_INDEX;
895 else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
897 frameIndex = mFrameCount - 1;
901 return false; // Do not draw already rendered scene twice.
906 if(mFrameCount > SINGLE_IMAGE_COUNT)
909 if(frameIndex >= mFrameCount)
911 frameIndex = FIRST_FRAME_INDEX;
915 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
917 // This will stop timer
918 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
919 return DisplayNextFrame();
924 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
926 textureSet = mImageCache->Frame(frameIndex);
930 SetImageSize(textureSet);
933 mImpl->mRenderer.SetTextures(textureSet);
936 mFrameDelayTimer.SetInterval(mImageCache->GetFrameInterval(frameIndex));
939 mCurrentFrameIndex = frameIndex;
940 continueTimer = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY && textureSet) ? true : false;
943 return continueTimer;
946 TextureSet AnimatedImageVisual::SetLoadingFailed()
948 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
949 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
951 Actor actor = mPlacementActor.GetHandle();
952 Vector2 imageSize = Vector2::ZERO;
955 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
957 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
958 TextureSet textureSet = mImpl->mRenderer.GetTextures();
962 mFrameDelayTimer.Stop();
963 mFrameDelayTimer.Reset();
966 SetImageSize(textureSet);
971 void AnimatedImageVisual::AllocateMaskData()
975 mMaskingData.reset(new TextureManager::MaskingData());
979 void AnimatedImageVisual::CheckMaskTexture()
981 if(mMaskingData && !mMaskingData->mPreappliedMasking)
983 bool maskLoadFailed = true;
984 TextureSet textures = mImpl->mRenderer.GetTextures();
985 if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
987 maskLoadFailed = false;
989 if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
991 mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
997 } // namespace Internal
999 } // namespace Toolkit