2 * Copyright (c) 2021 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>
50 DALI_ENUM_TO_STRING_TABLE_BEGIN(STOP_BEHAVIOR)
51 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME)
52 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME)
53 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME)
54 DALI_ENUM_TO_STRING_TABLE_END(STOP_BEHAVIOR)
57 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
58 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
59 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
60 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
61 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
62 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
64 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
65 constexpr auto LOOP_FOREVER = -1;
67 #if defined(DEBUG_ENABLED)
68 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
73 * Multi-image Flow of execution
79 * | cache->LoadBatch()
82 * | PrepareTextureSet()
83 * | cache->FirstFrame()
84 * | CreateRenderer() (Doesn't become ready until first frame loads)
87 * | FrameReady(textureSet)
88 * | start first frame:
91 * | mRenderer.SetTextures(textureSet)
94 * | DisplayNextFrame()
95 * | if front frame is ready,
96 * | mRenderer.SetTextures( front frame's texture )
98 * | mWaitingForTexture=true
99 * | cache->LoadBatch()
101 * | FrameReady(textureSet)
102 * | mRenderer.SetTextures(textureSet)
107 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
109 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
110 visual->InitializeAnimatedImage(imageUrl);
111 visual->SetProperties(properties);
113 if(visual->mFrameCount > 0)
115 visual->LoadFirstBatch();
118 visual->Initialize();
123 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties)
125 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
126 visual->mImageUrls = new ImageCache::UrlList();
127 visual->mImageUrls->reserve(imageUrls.Count());
129 for(unsigned int i = 0; i < imageUrls.Count(); ++i)
131 ImageCache::UrlStore urlStore;
132 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
133 urlStore.mUrl = imageUrls[i].Get<std::string>();
134 visual->mImageUrls->push_back(urlStore);
136 visual->mFrameCount = imageUrls.Count();
137 visual->SetProperties(properties);
139 if(visual->mFrameCount > 0)
141 visual->LoadFirstBatch();
144 visual->Initialize();
149 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
151 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
152 visual->InitializeAnimatedImage(imageUrl);
154 if(visual->mFrameCount > 0)
156 visual->LoadFirstBatch();
159 visual->Initialize();
164 void AnimatedImageVisual::InitializeAnimatedImage(const VisualUrl& imageUrl)
166 mImageUrl = imageUrl;
167 mAnimatedImageLoading = AnimatedImageLoading::New(imageUrl.GetUrl(), imageUrl.IsLocalResource());
168 mFrameCount = mAnimatedImageLoading.GetImageCount();
171 AnimatedImageVisual::AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory)
172 : Visual::Base(factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO, Toolkit::Visual::ANIMATED_IMAGE),
175 mImageVisualShaderFactory(shaderFactory),
176 mPixelArea(FULL_TEXTURE_RECT),
178 mAnimatedImageLoading(),
179 mFrameIndexForJumpTo(0),
185 mLoopCount(LOOP_FOREVER),
186 mCurrentLoopIndex(0),
190 mWrapModeU(WrapMode::DEFAULT),
191 mWrapModeV(WrapMode::DEFAULT),
192 mActionStatus(DevelAnimatedImageVisual::Action::PLAY),
193 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
194 mStartFirstFrame(false),
199 AnimatedImageVisual::~AnimatedImageVisual()
205 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
207 if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
209 if(mImageUrl.IsValid())
211 mImageSize = mAnimatedImageLoading.GetImageSize();
213 else if(mImageUrls && mImageUrls->size() > 0)
215 mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl);
219 naturalSize.width = mImageSize.GetWidth();
220 naturalSize.height = mImageSize.GetHeight();
223 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
227 bool sync = IsSynchronousLoadingRequired();
228 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
230 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
232 if(mImageUrl.IsValid())
234 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
236 if(mImageUrls != NULL && !mImageUrls->empty())
238 Property::Array urls;
239 for(unsigned int i = 0; i < mImageUrls->size(); ++i)
241 urls.Add((*mImageUrls)[i].mUrl);
243 Property::Value value(const_cast<Property::Array&>(urls));
244 map.Insert(Toolkit::ImageVisual::Property::URL, value);
247 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
248 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
249 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
251 map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
252 map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
253 map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
254 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
255 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
256 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetTotalFrameCount()) : -1);
258 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
261 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
266 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
268 // Make not set any action when the resource status is already failed.
269 if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
274 // Check if action is valid for this visual type and perform action if possible
277 case DevelAnimatedImageVisual::Action::PAUSE:
279 // Pause will be executed on next timer tick
280 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
283 case DevelAnimatedImageVisual::Action::PLAY:
285 if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
287 mFrameDelayTimer.Start();
289 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
292 case DevelAnimatedImageVisual::Action::STOP:
294 // STOP reset functionality will actually be done in a future change
295 // Stop will be executed on next timer tick
296 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
303 case DevelAnimatedImageVisual::Action::JUMP_TO:
306 if(attributes.Get(frameNumber))
308 if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
310 DALI_LOG_ERROR("Invalid frame index used.\n");
315 mFrameIndexForJumpTo = frameNumber;
327 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
329 // url[s] already passed in from constructor
330 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
332 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
333 if(keyValue.first.type == Property::Key::INDEX)
335 DoSetProperty(keyValue.first.indexKey, keyValue.second);
339 if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
341 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
343 else if(keyValue.first == IMAGE_WRAP_MODE_U)
345 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
347 else if(keyValue.first == IMAGE_WRAP_MODE_V)
349 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
351 else if(keyValue.first == BATCH_SIZE_NAME)
353 DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
355 else if(keyValue.first == CACHE_SIZE_NAME)
357 DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
359 else if(keyValue.first == FRAME_DELAY_NAME)
361 DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
363 else if(keyValue.first == LOOP_COUNT_NAME)
365 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
367 else if(keyValue.first == STOP_BEHAVIOR_NAME)
369 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
375 void AnimatedImageVisual::DoSetProperty(Property::Index index,
376 const Property::Value& value)
380 case Toolkit::ImageVisual::Property::PIXEL_AREA:
382 value.Get(mPixelArea);
385 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
388 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
390 mWrapModeU = Dali::WrapMode::Type(wrapMode);
394 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
398 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
401 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
403 mWrapModeV = Dali::WrapMode::Type(wrapMode);
407 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
412 case Toolkit::ImageVisual::Property::BATCH_SIZE:
415 if(value.Get(batchSize))
419 DALI_LOG_ERROR("The minimum value of batch size is 2.");
423 mBatchSize = batchSize;
429 case Toolkit::ImageVisual::Property::CACHE_SIZE:
432 if(value.Get(cacheSize))
436 DALI_LOG_ERROR("The minimum value of cache size is 2.");
440 mCacheSize = cacheSize;
446 case Toolkit::ImageVisual::Property::FRAME_DELAY:
449 if(value.Get(frameDelay))
451 mFrameDelay = frameDelay;
456 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
459 if(value.Get(loopCount))
461 mLoopCount = loopCount;
466 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
468 int32_t stopBehavior = mStopBehavior;
469 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
471 mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
476 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
482 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
486 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
493 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
495 mPlacementActor = actor;
496 TextureSet textureSet = PrepareTextureSet();
498 // Loading animated image file is failed.
500 (mAnimatedImageLoading && !mAnimatedImageLoading.HasLoadingSucceeded()))
502 textureSet = SetLoadingFailed();
505 if(textureSet) // if the image loading is successful
507 StartFirstFrame(textureSet);
511 mStartFirstFrame = true;
515 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
517 DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
521 mFrameDelayTimer.Stop();
522 mFrameDelayTimer.Reset();
525 actor.RemoveRenderer(mImpl->mRenderer);
526 mPlacementActor.Reset();
527 mStartFirstFrame = false;
530 void AnimatedImageVisual::OnSetTransform()
534 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
538 void AnimatedImageVisual::OnInitialize()
540 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
541 bool atlasing = false;
542 Shader shader = mImageVisualShaderFactory.GetShader(mFactoryCache, atlasing, defaultWrapMode, IsRoundedCornerRequired());
544 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
546 mImpl->mRenderer = Renderer::New(geometry, shader);
548 // Register transform properties
549 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
551 if(!defaultWrapMode) // custom wrap mode
553 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
554 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
555 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
558 if(mPixelArea != FULL_TEXTURE_RECT)
560 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
564 void AnimatedImageVisual::LoadFirstBatch()
566 // Ensure the batch size and cache size are no bigger than the number of URLs,
567 // and that the cache is at least as big as the batch size.
568 uint16_t numUrls = 0;
569 uint16_t batchSize = 1;
570 uint16_t cacheSize = 1;
574 numUrls = mImageUrls->size();
578 numUrls = mFrameCount;
581 batchSize = std::min(mBatchSize, numUrls);
582 cacheSize = std::min(std::max(batchSize, mCacheSize), numUrls);
584 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::LoadFirstBatch() batchSize:%d cacheSize:%d\n", batchSize, cacheSize);
587 TextureManager& textureManager = mFactoryCache.GetTextureManager();
589 if(mAnimatedImageLoading)
591 mImageCache = new RollingAnimatedImageCache(textureManager, mAnimatedImageLoading, mFrameCount, *this, cacheSize, batchSize, IsSynchronousLoadingRequired());
595 if(batchSize > 0 && cacheSize > 0)
597 if(cacheSize < numUrls)
599 mImageCache = new RollingImageCache(textureManager, *mImageUrls, *this, cacheSize, batchSize);
603 mImageCache = new FixedImageCache(textureManager, *mImageUrls, *this, batchSize);
608 mImageCache = new RollingImageCache(textureManager, *mImageUrls, *this, 1, 1);
614 DALI_LOG_ERROR("mImageCache is null\n");
618 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet)
620 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
622 mStartFirstFrame = false;
625 mImpl->mRenderer.SetTextures(textureSet);
627 Actor actor = mPlacementActor.GetHandle();
630 actor.AddRenderer(mImpl->mRenderer);
631 mPlacementActor.Reset();
637 int frameDelay = mImageCache->GetFrameInterval(0);
640 frameDelay = mFrameDelay; // from URL array
642 mFrameDelayTimer = Timer::New(frameDelay);
643 mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
644 mFrameDelayTimer.Start();
647 if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
649 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
650 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
654 TextureSet AnimatedImageVisual::PrepareTextureSet()
656 TextureSet textureSet;
659 textureSet = mImageCache->FirstFrame();
664 SetImageSize(textureSet);
670 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
674 Texture texture = textureSet.GetTexture(0);
677 mImageSize.SetWidth(texture.GetWidth());
678 mImageSize.SetHeight(texture.GetHeight());
683 void AnimatedImageVisual::FrameReady(TextureSet textureSet)
685 // When image visual requested to load new frame to mImageCache and it is failed.
688 textureSet = SetLoadingFailed();
691 SetImageSize(textureSet);
695 StartFirstFrame(textureSet);
701 mImpl->mRenderer.SetTextures(textureSet);
706 bool AnimatedImageVisual::DisplayNextFrame()
708 TextureSet textureSet;
709 bool continueTimer = false;
713 bool nextFrame = false;
714 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
719 frameIndex = mFrameIndexForJumpTo;
721 else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
725 else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
728 if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
732 else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
734 frameIndex = mFrameCount - 1;
738 return false; // Do not draw already rendered scene twice.
747 if(frameIndex >= mFrameCount)
749 frameIndex %= mFrameCount;
753 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
755 // This will stop timer
756 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
757 return DisplayNextFrame();
761 unsigned int delay = mImageCache->GetFrameInterval(frameIndex);
764 if(mFrameDelayTimer.GetInterval() != delay)
766 mFrameDelayTimer.SetInterval(delay);
771 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
775 textureSet = mImageCache->NextFrame();
779 textureSet = mImageCache->Frame(frameIndex);
782 continueTimer = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY) ? true : false;
787 SetImageSize(textureSet);
790 mImpl->mRenderer.SetTextures(textureSet);
794 return continueTimer;
797 TextureSet AnimatedImageVisual::SetLoadingFailed()
799 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
800 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
802 TextureSet textureSet = TextureSet::New();
803 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
804 textureSet.SetTexture(0u, brokenImage);
808 mFrameDelayTimer.Stop();
809 mFrameDelayTimer.Reset();
812 SetImageSize(textureSet);
817 } // namespace Internal
819 } // namespace Toolkit