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());
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),
234 AnimatedImageVisual::~AnimatedImageVisual()
236 // AnimatedImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
237 // If this is animated image, clear cache. Else if this is single frame image, this is affected be release policy.
238 if(mFrameCount > SINGLE_IMAGE_COUNT || mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER)
240 mImageCache->ClearCache();
246 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
248 if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
250 if(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid() &&
251 mMaskingData->mCropToMask)
253 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
254 if(dimensions != ImageDimensions(0, 0))
256 mImageSize = dimensions;
257 naturalSize.x = dimensions.GetWidth();
258 naturalSize.y = dimensions.GetHeight();
263 if(mImageUrl.IsValid())
265 mImageSize = mAnimatedImageLoading.GetImageSize();
267 else if(mImageUrls && mImageUrls->size() > 0)
269 mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl.GetUrl());
273 naturalSize.width = mImageSize.GetWidth();
274 naturalSize.height = mImageSize.GetHeight();
277 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
281 bool sync = IsSynchronousLoadingRequired();
282 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
284 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
286 if(mImageUrl.IsValid())
288 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
290 if(mImageUrls != NULL && !mImageUrls->empty())
292 Property::Array urls;
293 for(unsigned int i = 0; i < mImageUrls->size(); ++i)
295 urls.Add((*mImageUrls)[i].mUrl.GetUrl());
297 Property::Value value(const_cast<Property::Array&>(urls));
298 map.Insert(Toolkit::ImageVisual::Property::URL, value);
301 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
302 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
303 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
305 map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
306 map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
307 map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
308 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
309 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
310 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>((mAnimatedImageLoading) ? mAnimatedImageLoading.GetImageCount() : mImageCache->GetTotalFrameCount()) : -1);
312 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
314 if(mMaskingData != nullptr)
316 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
317 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
318 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
321 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
322 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
325 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
330 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
332 // Make not set any action when the resource status is already failed.
333 if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
338 // Check if action is valid for this visual type and perform action if possible
341 case DevelAnimatedImageVisual::Action::PAUSE:
343 // Pause will be executed on next timer tick
344 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
347 case DevelAnimatedImageVisual::Action::PLAY:
349 if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
351 mFrameDelayTimer.Start();
353 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
356 case DevelAnimatedImageVisual::Action::STOP:
358 // STOP reset functionality will actually be done in a future change
359 // Stop will be executed on next timer tick
360 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
361 mCurrentLoopIndex = FIRST_LOOP;
368 case DevelAnimatedImageVisual::Action::JUMP_TO:
371 if(attributes.Get(frameNumber))
373 if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
375 DALI_LOG_ERROR("Invalid frame index used.\n");
380 mFrameIndexForJumpTo = frameNumber;
392 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
394 // url[s] already passed in from constructor
395 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
397 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
398 if(keyValue.first.type == Property::Key::INDEX)
400 DoSetProperty(keyValue.first.indexKey, keyValue.second);
404 if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
406 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
408 else if(keyValue.first == IMAGE_WRAP_MODE_U)
410 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
412 else if(keyValue.first == IMAGE_WRAP_MODE_V)
414 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
416 else if(keyValue.first == BATCH_SIZE_NAME)
418 DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
420 else if(keyValue.first == CACHE_SIZE_NAME)
422 DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
424 else if(keyValue.first == FRAME_DELAY_NAME)
426 DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
428 else if(keyValue.first == LOOP_COUNT_NAME)
430 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
432 else if(keyValue.first == STOP_BEHAVIOR_NAME)
434 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
436 else if(keyValue.first == ALPHA_MASK_URL)
438 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
440 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
442 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
444 else if(keyValue.first == CROP_TO_MASK_NAME)
446 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
448 else if(keyValue.first == LOAD_POLICY_NAME)
450 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
452 else if(keyValue.first == RELEASE_POLICY_NAME)
454 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
456 else if(keyValue.first == SYNCHRONOUS_LOADING)
458 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
462 // Load image immediately if LOAD_POLICY requires it
463 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
469 void AnimatedImageVisual::DoSetProperty(Property::Index index,
470 const Property::Value& value)
474 case Toolkit::ImageVisual::Property::PIXEL_AREA:
476 value.Get(mPixelArea);
479 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
482 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
484 mWrapModeU = Dali::WrapMode::Type(wrapMode);
488 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
492 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
495 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
497 mWrapModeV = Dali::WrapMode::Type(wrapMode);
501 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
506 case Toolkit::ImageVisual::Property::BATCH_SIZE:
509 if(value.Get(batchSize))
513 DALI_LOG_ERROR("The minimum value of batch size is 2.");
517 mBatchSize = batchSize;
523 case Toolkit::ImageVisual::Property::CACHE_SIZE:
526 if(value.Get(cacheSize))
530 DALI_LOG_ERROR("The minimum value of cache size is 2.");
534 mCacheSize = cacheSize;
540 case Toolkit::ImageVisual::Property::FRAME_DELAY:
543 if(value.Get(frameDelay))
545 mFrameDelay = frameDelay;
548 mImageCache->SetInterval(static_cast<uint32_t>(mFrameDelay));
554 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
557 if(value.Get(loopCount))
559 mLoopCount = loopCount;
564 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
566 int32_t stopBehavior = mStopBehavior;
567 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
569 mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
574 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
580 mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
584 mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
589 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
591 std::string alphaUrl = "";
592 if(value.Get(alphaUrl))
595 mMaskingData->mAlphaMaskUrl = alphaUrl;
600 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
606 mMaskingData->mContentScaleFactor = scale;
611 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
617 mMaskingData->mCropToMask = crop;
622 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
624 int releasePolicy = 0;
625 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
626 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
630 case Toolkit::ImageVisual::Property::LOAD_POLICY:
633 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
634 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
640 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
642 mStartFirstFrame = true;
643 mPlacementActor = actor;
647 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
649 DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
653 mFrameDelayTimer.Stop();
654 mFrameDelayTimer.Reset();
657 actor.RemoveRenderer(mImpl->mRenderer);
658 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
660 mImageCache->ClearCache(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
661 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
663 TextureSet textureSet = TextureSet::New();
664 mImpl->mRenderer.SetTextures(textureSet);
667 mPlacementActor.Reset();
668 mStartFirstFrame = false;
669 mCurrentFrameIndex = FIRST_FRAME_INDEX;
670 mCurrentLoopIndex = FIRST_LOOP;
673 void AnimatedImageVisual::OnSetTransform()
677 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
681 void AnimatedImageVisual::UpdateShader()
685 Shader shader = GenerateShader();
686 mImpl->mRenderer.SetShader(shader);
690 Shader AnimatedImageVisual::GenerateShader() const
692 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
694 shader = mImageVisualShaderFactory.GetShader(
696 ImageVisualShaderFeature::FeatureBuilder()
697 .ApplyDefaultTextureWrapMode(defaultWrapMode)
698 .EnableRoundedCorner(IsRoundedCornerRequired())
699 .EnableBorderline(IsBorderlineRequired()));
703 void AnimatedImageVisual::OnInitialize()
707 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
708 Shader shader = GenerateShader();
710 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
712 mImpl->mRenderer = VisualRenderer::New(geometry, shader);
713 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
715 // Register transform properties
716 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
718 if(!defaultWrapMode) // custom wrap mode
720 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
721 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
722 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
725 if(mPixelArea != FULL_TEXTURE_RECT)
727 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
731 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval)
733 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
735 mStartFirstFrame = false;
738 mImpl->mRenderer.SetTextures(textureSet);
740 Actor actor = mPlacementActor.GetHandle();
743 actor.AddRenderer(mImpl->mRenderer);
744 mPlacementActor.Reset();
748 if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
750 if(mFrameCount > SINGLE_IMAGE_COUNT)
752 mFrameDelayTimer = Timer::New(firstInterval);
753 mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
754 mFrameDelayTimer.Start();
757 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
758 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
761 mCurrentFrameIndex = FIRST_FRAME_INDEX;
764 void AnimatedImageVisual::PrepareTextureSet()
766 TextureSet textureSet;
769 textureSet = mImageCache->FirstFrame();
772 // Check whether synchronous loading is true or false for the first frame.
775 SetImageSize(textureSet);
779 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
783 Texture texture = textureSet.GetTexture(0);
786 mImageSize.SetWidth(texture.GetWidth());
787 mImageSize.SetHeight(texture.GetHeight());
792 void AnimatedImageVisual::FrameReady(TextureSet textureSet, uint32_t interval)
794 // When image visual requested to load new frame to mImageCache and it is failed.
795 if(!mImageCache || !textureSet)
797 textureSet = SetLoadingFailed();
799 SetImageSize(textureSet);
803 mFrameCount = mImageCache->GetTotalFrameCount();
804 StartFirstFrame(textureSet, interval);
810 if(mFrameDelayTimer && interval > 0u)
812 mFrameDelayTimer.SetInterval(interval);
814 mImpl->mRenderer.SetTextures(textureSet);
819 bool AnimatedImageVisual::DisplayNextFrame()
821 TextureSet textureSet;
822 bool continueTimer = false;
826 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
831 frameIndex = mFrameIndexForJumpTo;
833 else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
837 else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
839 mCurrentLoopIndex = FIRST_LOOP;
840 if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
842 frameIndex = FIRST_FRAME_INDEX;
844 else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
846 frameIndex = mFrameCount - 1;
850 return false; // Do not draw already rendered scene twice.
855 if(mFrameCount > SINGLE_IMAGE_COUNT)
858 if(frameIndex >= mFrameCount)
860 frameIndex = FIRST_FRAME_INDEX;
864 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
866 // This will stop timer
867 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
868 return DisplayNextFrame();
873 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
875 textureSet = mImageCache->Frame(frameIndex);
879 SetImageSize(textureSet);
882 mImpl->mRenderer.SetTextures(textureSet);
884 mFrameDelayTimer.SetInterval(mImageCache->GetFrameInterval(frameIndex));
887 mCurrentFrameIndex = frameIndex;
888 continueTimer = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY && textureSet) ? true : false;
891 return continueTimer;
894 TextureSet AnimatedImageVisual::SetLoadingFailed()
896 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
897 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
899 Actor actor = mPlacementActor.GetHandle();
900 Vector2 imageSize = Vector2::ZERO;
903 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
905 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
906 TextureSet textureSet = mImpl->mRenderer.GetTextures();
910 mFrameDelayTimer.Stop();
911 mFrameDelayTimer.Reset();
914 SetImageSize(textureSet);
919 void AnimatedImageVisual::AllocateMaskData()
923 mMaskingData.reset(new TextureManager::MaskingData());
927 } // namespace Internal
929 } // namespace Toolkit