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>
27 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
28 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
30 #include <dali-toolkit/internal/visuals/animated-image/fixed-image-cache.h>
31 #include <dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h>
32 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
33 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
35 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
37 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
38 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
39 #include <dali-toolkit/public-api/visuals/visual-properties.h>
49 const int CUSTOM_PROPERTY_COUNT(3); // ltr, wrap, pixel area,
52 DALI_ENUM_TO_STRING_TABLE_BEGIN(STOP_BEHAVIOR)
53 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME)
54 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME)
55 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME)
56 DALI_ENUM_TO_STRING_TABLE_END(STOP_BEHAVIOR)
59 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
60 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
61 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
62 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
63 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
64 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
67 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOAD_POLICY)
68 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE)
69 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED)
70 DALI_ENUM_TO_STRING_TABLE_END(LOAD_POLICY)
73 DALI_ENUM_TO_STRING_TABLE_BEGIN(RELEASE_POLICY)
74 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED)
75 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED)
76 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER)
77 DALI_ENUM_TO_STRING_TABLE_END(RELEASE_POLICY)
79 static constexpr uint32_t SINGLE_IMAGE_COUNT = 1u;
80 static constexpr uint32_t FIRST_FRAME_INDEX = 0u;
81 static constexpr uint16_t MINIMUM_CACHESIZE = 1;
82 static constexpr Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
83 static constexpr auto LOOP_FOREVER = -1;
84 static constexpr auto FIRST_LOOP = 0u;
86 #if defined(DEBUG_ENABLED)
87 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
92 * Multi-image Flow of execution
97 * | CreateImageCache()
100 * | PrepareTextureSet()
101 * | cache->FirstFrame()
103 * | FrameReady(textureSet)
105 * | actor.AddRenderer
107 * | mRenderer.SetTextures(textureSet)
110 * | DisplayNextFrame()
111 * | if front frame is ready,
112 * | mRenderer.SetTextures( front frame's texture )
114 * | Waiting for frame ready.
116 * | FrameReady(textureSet)
117 * | mRenderer.SetTextures(textureSet)
122 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
124 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
125 visual->InitializeAnimatedImage(imageUrl);
126 visual->SetProperties(properties);
128 visual->Initialize();
133 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties)
135 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
136 visual->mImageUrls = new ImageCache::UrlList();
137 visual->mImageUrls->reserve(imageUrls.Count());
139 for(unsigned int i = 0; i < imageUrls.Count(); ++i)
141 ImageCache::UrlStore urlStore;
142 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
143 urlStore.mUrl = imageUrls[i].Get<std::string>();
144 visual->mImageUrls->push_back(urlStore);
146 visual->mFrameCount = imageUrls.Count();
147 visual->SetProperties(properties);
149 visual->Initialize();
154 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
156 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
157 visual->InitializeAnimatedImage(imageUrl);
159 visual->Initialize();
164 void AnimatedImageVisual::InitializeAnimatedImage(const VisualUrl& imageUrl)
166 mImageUrl = imageUrl;
167 mAnimatedImageLoading = AnimatedImageLoading::New(imageUrl.GetUrl(), imageUrl.IsLocalResource());
170 void AnimatedImageVisual::CreateImageCache()
172 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::CreateImageCache() batchSize:%d cacheSize:%d\n", mBatchSize, mCacheSize);
174 TextureManager& textureManager = mFactoryCache.GetTextureManager();
176 if(mAnimatedImageLoading)
178 mImageCache = new RollingAnimatedImageCache(textureManager, mAnimatedImageLoading, mMaskingData, *this, mCacheSize, mBatchSize, IsSynchronousLoadingRequired(),mFactoryCache.GetPreMultiplyOnLoad());
182 // Ensure the batch size and cache size are no bigger than the number of URLs,
183 // and that the cache is at least as big as the batch size.
184 uint16_t numUrls = mImageUrls->size();
185 uint16_t batchSize = std::max(std::min(mBatchSize, numUrls), MINIMUM_CACHESIZE);
186 uint16_t cacheSize = std::max(std::min(std::max(batchSize, mCacheSize), numUrls), MINIMUM_CACHESIZE);
187 if(cacheSize < numUrls)
189 mImageCache = new RollingImageCache(textureManager, *mImageUrls, mMaskingData, *this, cacheSize, batchSize, mFrameDelay);
193 mImageCache = new FixedImageCache(textureManager, *mImageUrls, mMaskingData, *this, batchSize, mFrameDelay);
199 DALI_LOG_ERROR("mImageCache is null\n");
203 AnimatedImageVisual::AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory)
204 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::ANIMATED_IMAGE),
207 mImageVisualShaderFactory(shaderFactory),
208 mPixelArea(FULL_TEXTURE_RECT),
210 mAnimatedImageLoading(),
211 mFrameIndexForJumpTo(0),
212 mCurrentFrameIndex(FIRST_FRAME_INDEX),
218 mLoopCount(LOOP_FOREVER),
219 mCurrentLoopIndex(FIRST_LOOP),
220 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
221 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
225 mActionStatus(DevelAnimatedImageVisual::Action::PLAY),
226 mWrapModeU(WrapMode::DEFAULT),
227 mWrapModeV(WrapMode::DEFAULT),
228 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
229 mStartFirstFrame(false),
232 EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
235 AnimatedImageVisual::~AnimatedImageVisual()
237 // AnimatedImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
238 // If this is animated image, clear cache. Else if this is single frame image, this is affected be release policy.
239 if(mFrameCount > SINGLE_IMAGE_COUNT || mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER)
241 mImageCache->ClearCache();
247 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
249 if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
251 if(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid() &&
252 mMaskingData->mCropToMask)
254 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
255 if(dimensions != ImageDimensions(0, 0))
257 mImageSize = dimensions;
258 naturalSize.x = dimensions.GetWidth();
259 naturalSize.y = dimensions.GetHeight();
264 if(mImageUrl.IsValid())
266 mImageSize = mAnimatedImageLoading.GetImageSize();
268 else if(mImageUrls && mImageUrls->size() > 0)
270 mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl.GetUrl());
274 naturalSize.width = mImageSize.GetWidth();
275 naturalSize.height = mImageSize.GetHeight();
278 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
282 bool sync = IsSynchronousLoadingRequired();
283 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
285 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
287 if(mImageUrl.IsValid())
289 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
291 if(mImageUrls != NULL && !mImageUrls->empty())
293 Property::Array urls;
294 for(unsigned int i = 0; i < mImageUrls->size(); ++i)
296 urls.Add((*mImageUrls)[i].mUrl.GetUrl());
298 Property::Value value(const_cast<Property::Array&>(urls));
299 map.Insert(Toolkit::ImageVisual::Property::URL, value);
302 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
303 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
304 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
306 map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
307 map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
308 map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
309 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
310 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
311 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>((mAnimatedImageLoading) ? mAnimatedImageLoading.GetImageCount() : mImageCache->GetTotalFrameCount()) : -1);
313 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
315 if(mMaskingData != nullptr)
317 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
318 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
319 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
322 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
323 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
326 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
331 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
333 // Make not set any action when the resource status is already failed.
334 if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
339 // Check if action is valid for this visual type and perform action if possible
342 case DevelAnimatedImageVisual::Action::PAUSE:
344 // Pause will be executed on next timer tick
345 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
348 case DevelAnimatedImageVisual::Action::PLAY:
350 if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
352 mFrameDelayTimer.Start();
354 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
357 case DevelAnimatedImageVisual::Action::STOP:
359 // STOP reset functionality will actually be done in a future change
360 // Stop will be executed on next timer tick
361 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
362 mCurrentLoopIndex = FIRST_LOOP;
369 case DevelAnimatedImageVisual::Action::JUMP_TO:
372 if(attributes.Get(frameNumber))
374 if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
376 DALI_LOG_ERROR("Invalid frame index used.\n");
381 mFrameIndexForJumpTo = frameNumber;
393 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
395 // url[s] already passed in from constructor
396 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
398 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
399 if(keyValue.first.type == Property::Key::INDEX)
401 DoSetProperty(keyValue.first.indexKey, keyValue.second);
405 if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
407 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
409 else if(keyValue.first == IMAGE_WRAP_MODE_U)
411 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
413 else if(keyValue.first == IMAGE_WRAP_MODE_V)
415 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
417 else if(keyValue.first == BATCH_SIZE_NAME)
419 DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
421 else if(keyValue.first == CACHE_SIZE_NAME)
423 DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
425 else if(keyValue.first == FRAME_DELAY_NAME)
427 DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
429 else if(keyValue.first == LOOP_COUNT_NAME)
431 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
433 else if(keyValue.first == STOP_BEHAVIOR_NAME)
435 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
437 else if(keyValue.first == ALPHA_MASK_URL)
439 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
441 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
443 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
445 else if(keyValue.first == CROP_TO_MASK_NAME)
447 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
449 else if(keyValue.first == LOAD_POLICY_NAME)
451 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
453 else if(keyValue.first == RELEASE_POLICY_NAME)
455 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
457 else if(keyValue.first == SYNCHRONOUS_LOADING)
459 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
463 // Load image immediately if LOAD_POLICY requires it
464 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
470 void AnimatedImageVisual::DoSetProperty(Property::Index index,
471 const Property::Value& value)
475 case Toolkit::ImageVisual::Property::PIXEL_AREA:
477 value.Get(mPixelArea);
480 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
483 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
485 mWrapModeU = Dali::WrapMode::Type(wrapMode);
489 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
493 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
496 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
498 mWrapModeV = Dali::WrapMode::Type(wrapMode);
502 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
507 case Toolkit::ImageVisual::Property::BATCH_SIZE:
510 if(value.Get(batchSize))
514 DALI_LOG_ERROR("The minimum value of batch size is 2.");
518 mBatchSize = batchSize;
524 case Toolkit::ImageVisual::Property::CACHE_SIZE:
527 if(value.Get(cacheSize))
531 DALI_LOG_ERROR("The minimum value of cache size is 2.");
535 mCacheSize = cacheSize;
541 case Toolkit::ImageVisual::Property::FRAME_DELAY:
544 if(value.Get(frameDelay))
546 mFrameDelay = frameDelay;
549 mImageCache->SetInterval(static_cast<uint32_t>(mFrameDelay));
555 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
558 if(value.Get(loopCount))
560 mLoopCount = loopCount;
565 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
567 int32_t stopBehavior = mStopBehavior;
568 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
570 mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
575 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
581 mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
585 mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
590 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
592 std::string alphaUrl = "";
593 if(value.Get(alphaUrl))
596 mMaskingData->mAlphaMaskUrl = alphaUrl;
601 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
607 mMaskingData->mContentScaleFactor = scale;
612 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
618 mMaskingData->mCropToMask = crop;
623 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
625 int releasePolicy = 0;
626 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
627 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
631 case Toolkit::ImageVisual::Property::LOAD_POLICY:
634 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
635 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
641 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
643 mStartFirstFrame = true;
644 mPlacementActor = actor;
648 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
650 DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
654 mFrameDelayTimer.Stop();
655 mFrameDelayTimer.Reset();
658 actor.RemoveRenderer(mImpl->mRenderer);
659 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
661 mImageCache->ClearCache(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
662 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
664 TextureSet textureSet = TextureSet::New();
665 mImpl->mRenderer.SetTextures(textureSet);
668 mPlacementActor.Reset();
669 mStartFirstFrame = false;
670 mCurrentFrameIndex = FIRST_FRAME_INDEX;
671 mCurrentLoopIndex = FIRST_LOOP;
674 void AnimatedImageVisual::OnSetTransform()
678 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
682 void AnimatedImageVisual::UpdateShader()
686 Shader shader = GenerateShader();
687 mImpl->mRenderer.SetShader(shader);
691 Shader AnimatedImageVisual::GenerateShader() const
693 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
695 shader = mImageVisualShaderFactory.GetShader(
697 ImageVisualShaderFeature::FeatureBuilder()
698 .ApplyDefaultTextureWrapMode(defaultWrapMode)
699 .EnableRoundedCorner(IsRoundedCornerRequired())
700 .EnableBorderline(IsBorderlineRequired()));
704 void AnimatedImageVisual::OnInitialize()
708 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
709 Shader shader = GenerateShader();
711 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
713 mImpl->mRenderer = VisualRenderer::New(geometry, shader);
714 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
716 // Register transform properties
717 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
719 if(!defaultWrapMode) // custom wrap mode
721 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
722 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
723 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
726 if(mPixelArea != FULL_TEXTURE_RECT)
728 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
731 // Enable PreMultipliedAlpha if it need premultiplied
732 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
733 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
734 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
735 EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
738 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval)
740 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
742 mStartFirstFrame = false;
745 mImpl->mRenderer.SetTextures(textureSet);
747 Actor actor = mPlacementActor.GetHandle();
750 actor.AddRenderer(mImpl->mRenderer);
751 mPlacementActor.Reset();
755 if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
757 if(mFrameCount > SINGLE_IMAGE_COUNT)
759 mFrameDelayTimer = Timer::New(firstInterval);
760 mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
761 mFrameDelayTimer.Start();
764 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
765 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
768 mCurrentFrameIndex = FIRST_FRAME_INDEX;
771 void AnimatedImageVisual::PrepareTextureSet()
773 TextureSet textureSet;
776 textureSet = mImageCache->FirstFrame();
779 // Check whether synchronous loading is true or false for the first frame.
782 SetImageSize(textureSet);
786 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
790 Texture texture = textureSet.GetTexture(0);
793 mImageSize.SetWidth(texture.GetWidth());
794 mImageSize.SetHeight(texture.GetHeight());
799 void AnimatedImageVisual::FrameReady(TextureSet textureSet, uint32_t interval)
801 // When image visual requested to load new frame to mImageCache and it is failed.
802 if(!mImageCache || !textureSet)
804 textureSet = SetLoadingFailed();
806 SetImageSize(textureSet);
810 mFrameCount = mImageCache->GetTotalFrameCount();
811 StartFirstFrame(textureSet, interval);
817 if(mFrameDelayTimer && interval > 0u)
819 mFrameDelayTimer.SetInterval(interval);
821 mImpl->mRenderer.SetTextures(textureSet);
826 bool AnimatedImageVisual::DisplayNextFrame()
828 TextureSet textureSet;
829 bool continueTimer = false;
833 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
838 frameIndex = mFrameIndexForJumpTo;
840 else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
844 else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
846 mCurrentLoopIndex = FIRST_LOOP;
847 if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
849 frameIndex = FIRST_FRAME_INDEX;
851 else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
853 frameIndex = mFrameCount - 1;
857 return false; // Do not draw already rendered scene twice.
862 if(mFrameCount > SINGLE_IMAGE_COUNT)
865 if(frameIndex >= mFrameCount)
867 frameIndex = FIRST_FRAME_INDEX;
871 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
873 // This will stop timer
874 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
875 return DisplayNextFrame();
880 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
882 textureSet = mImageCache->Frame(frameIndex);
886 SetImageSize(textureSet);
889 mImpl->mRenderer.SetTextures(textureSet);
891 mFrameDelayTimer.SetInterval(mImageCache->GetFrameInterval(frameIndex));
894 mCurrentFrameIndex = frameIndex;
895 continueTimer = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY && textureSet) ? true : false;
898 return continueTimer;
901 TextureSet AnimatedImageVisual::SetLoadingFailed()
903 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
904 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
906 Actor actor = mPlacementActor.GetHandle();
907 Vector2 imageSize = Vector2::ZERO;
910 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
912 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
913 TextureSet textureSet = mImpl->mRenderer.GetTextures();
917 mFrameDelayTimer.Stop();
918 mFrameDelayTimer.Reset();
921 SetImageSize(textureSet);
926 void AnimatedImageVisual::AllocateMaskData()
930 mMaskingData.reset(new TextureManager::MaskingData());
934 } // namespace Internal
936 } // namespace Toolkit