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(10); // ltr, wrap, pixel area, crop to mask, mask texture ratio + border/corner
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 constexpr uint32_t TEXTURE_COUNT_FOR_GPU_ALPHA_MASK = 2u;
88 #if defined(DEBUG_ENABLED)
89 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
94 * Multi-image Flow of execution
99 * | CreateImageCache()
102 * | PrepareTextureSet()
103 * | cache->FirstFrame()
105 * | FrameReady(textureSet)
107 * | actor.AddRenderer
109 * | mRenderer.SetTextures(textureSet)
112 * | DisplayNextFrame()
113 * | if front frame is ready,
114 * | mRenderer.SetTextures( front frame's texture )
116 * | Waiting for frame ready.
118 * | FrameReady(textureSet)
119 * | mRenderer.SetTextures(textureSet)
124 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
126 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
127 visual->InitializeAnimatedImage(imageUrl);
128 visual->SetProperties(properties);
130 visual->Initialize();
135 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties)
137 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
138 visual->mImageUrls = new ImageCache::UrlList();
139 visual->mImageUrls->reserve(imageUrls.Count());
141 for(unsigned int i = 0; i < imageUrls.Count(); ++i)
143 ImageCache::UrlStore urlStore;
144 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
145 urlStore.mUrl = imageUrls[i].Get<std::string>();
146 visual->mImageUrls->push_back(urlStore);
148 visual->mFrameCount = imageUrls.Count();
149 visual->SetProperties(properties);
151 visual->Initialize();
156 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
158 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory));
159 visual->InitializeAnimatedImage(imageUrl);
161 visual->Initialize();
166 void AnimatedImageVisual::InitializeAnimatedImage(const VisualUrl& imageUrl)
168 mImageUrl = imageUrl;
169 mAnimatedImageLoading = AnimatedImageLoading::New(imageUrl.GetUrl(), imageUrl.IsLocalResource());
172 void AnimatedImageVisual::CreateImageCache()
174 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::CreateImageCache() batchSize:%d cacheSize:%d\n", mBatchSize, mCacheSize);
176 TextureManager& textureManager = mFactoryCache.GetTextureManager();
178 if(mAnimatedImageLoading)
180 mImageCache = new RollingAnimatedImageCache(textureManager, mAnimatedImageLoading, mMaskingData, *this, mCacheSize, mBatchSize, IsSynchronousLoadingRequired(),mFactoryCache.GetPreMultiplyOnLoad());
184 // Ensure the batch size and cache size are no bigger than the number of URLs,
185 // and that the cache is at least as big as the batch size.
186 uint16_t numUrls = mImageUrls->size();
187 uint16_t batchSize = std::max(std::min(mBatchSize, numUrls), MINIMUM_CACHESIZE);
188 uint16_t cacheSize = std::max(std::min(std::max(batchSize, mCacheSize), numUrls), MINIMUM_CACHESIZE);
189 if(cacheSize < numUrls)
191 mImageCache = new RollingImageCache(textureManager, *mImageUrls, mMaskingData, *this, cacheSize, batchSize, mFrameDelay);
195 mImageCache = new FixedImageCache(textureManager, *mImageUrls, mMaskingData, *this, batchSize, mFrameDelay);
201 DALI_LOG_ERROR("mImageCache is null\n");
205 AnimatedImageVisual::AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory)
206 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::ANIMATED_IMAGE),
209 mImageVisualShaderFactory(shaderFactory),
210 mPixelArea(FULL_TEXTURE_RECT),
212 mAnimatedImageLoading(),
213 mFrameIndexForJumpTo(0),
214 mCurrentFrameIndex(FIRST_FRAME_INDEX),
220 mLoopCount(LOOP_FOREVER),
221 mCurrentLoopIndex(FIRST_LOOP),
222 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
223 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
227 mActionStatus(DevelAnimatedImageVisual::Action::PLAY),
228 mWrapModeU(WrapMode::DEFAULT),
229 mWrapModeV(WrapMode::DEFAULT),
230 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
231 mStartFirstFrame(false),
234 EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
237 AnimatedImageVisual::~AnimatedImageVisual()
239 // AnimatedImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
240 // If this is animated image, clear cache. Else if this is single frame image, this is affected be release policy.
241 if(mFrameCount > SINGLE_IMAGE_COUNT || mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER)
243 mImageCache->ClearCache();
249 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
251 if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
253 if(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid() &&
254 mMaskingData->mCropToMask)
256 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
257 if(dimensions != ImageDimensions(0, 0))
259 mImageSize = dimensions;
260 naturalSize.x = dimensions.GetWidth();
261 naturalSize.y = dimensions.GetHeight();
266 if(mImageUrl.IsValid())
268 mImageSize = mAnimatedImageLoading.GetImageSize();
270 else if(mImageUrls && mImageUrls->size() > 0)
272 mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl.GetUrl());
276 naturalSize.width = mImageSize.GetWidth();
277 naturalSize.height = mImageSize.GetHeight();
280 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
284 bool sync = IsSynchronousLoadingRequired();
285 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
287 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
289 if(mImageUrl.IsValid())
291 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
293 if(mImageUrls != NULL && !mImageUrls->empty())
295 Property::Array urls;
296 for(unsigned int i = 0; i < mImageUrls->size(); ++i)
298 urls.Add((*mImageUrls)[i].mUrl.GetUrl());
300 Property::Value value(const_cast<Property::Array&>(urls));
301 map.Insert(Toolkit::ImageVisual::Property::URL, value);
304 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
305 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
306 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
308 map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
309 map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
310 map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
311 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
312 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
313 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>((mAnimatedImageLoading) ? mAnimatedImageLoading.GetImageCount() : mImageCache->GetTotalFrameCount()) : -1);
315 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
317 if(mMaskingData != nullptr)
319 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
320 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
321 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
322 map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
325 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
326 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
329 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
334 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
336 // Make not set any action when the resource status is already failed.
337 if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
342 // Check if action is valid for this visual type and perform action if possible
345 case DevelAnimatedImageVisual::Action::PAUSE:
347 // Pause will be executed on next timer tick
348 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
351 case DevelAnimatedImageVisual::Action::PLAY:
353 if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
355 mFrameDelayTimer.Start();
357 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
360 case DevelAnimatedImageVisual::Action::STOP:
362 // STOP reset functionality will actually be done in a future change
363 // Stop will be executed on next timer tick
364 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
365 mCurrentLoopIndex = FIRST_LOOP;
372 case DevelAnimatedImageVisual::Action::JUMP_TO:
375 if(attributes.Get(frameNumber))
377 if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
379 DALI_LOG_ERROR("Invalid frame index used.\n");
384 mFrameIndexForJumpTo = frameNumber;
396 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
398 // url[s] already passed in from constructor
399 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
401 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
402 if(keyValue.first.type == Property::Key::INDEX)
404 DoSetProperty(keyValue.first.indexKey, keyValue.second);
408 if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
410 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
412 else if(keyValue.first == IMAGE_WRAP_MODE_U)
414 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
416 else if(keyValue.first == IMAGE_WRAP_MODE_V)
418 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
420 else if(keyValue.first == BATCH_SIZE_NAME)
422 DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
424 else if(keyValue.first == CACHE_SIZE_NAME)
426 DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
428 else if(keyValue.first == FRAME_DELAY_NAME)
430 DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
432 else if(keyValue.first == LOOP_COUNT_NAME)
434 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
436 else if(keyValue.first == STOP_BEHAVIOR_NAME)
438 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
440 else if(keyValue.first == ALPHA_MASK_URL)
442 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
444 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
446 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
448 else if(keyValue.first == CROP_TO_MASK_NAME)
450 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
452 else if(keyValue.first == MASKING_TYPE_NAME)
454 DoSetProperty(Toolkit::DevelImageVisual::Property::MASKING_TYPE, keyValue.second);
456 else if(keyValue.first == LOAD_POLICY_NAME)
458 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
460 else if(keyValue.first == RELEASE_POLICY_NAME)
462 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
464 else if(keyValue.first == SYNCHRONOUS_LOADING)
466 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
470 // Load image immediately if LOAD_POLICY requires it
471 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
477 void AnimatedImageVisual::DoSetProperty(Property::Index index,
478 const Property::Value& value)
482 case Toolkit::ImageVisual::Property::PIXEL_AREA:
484 value.Get(mPixelArea);
487 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
490 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
492 mWrapModeU = Dali::WrapMode::Type(wrapMode);
496 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
500 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
503 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
505 mWrapModeV = Dali::WrapMode::Type(wrapMode);
509 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
514 case Toolkit::ImageVisual::Property::BATCH_SIZE:
517 if(value.Get(batchSize))
521 DALI_LOG_ERROR("The minimum value of batch size is 2.");
525 mBatchSize = batchSize;
531 case Toolkit::ImageVisual::Property::CACHE_SIZE:
534 if(value.Get(cacheSize))
538 DALI_LOG_ERROR("The minimum value of cache size is 2.");
542 mCacheSize = cacheSize;
548 case Toolkit::ImageVisual::Property::FRAME_DELAY:
551 if(value.Get(frameDelay))
553 mFrameDelay = frameDelay;
556 mImageCache->SetInterval(static_cast<uint32_t>(mFrameDelay));
562 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
565 if(value.Get(loopCount))
567 mLoopCount = loopCount;
572 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
574 int32_t stopBehavior = mStopBehavior;
575 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
577 mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
582 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
588 mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
592 mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
597 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
599 std::string alphaUrl = "";
600 if(value.Get(alphaUrl))
603 mMaskingData->mAlphaMaskUrl = alphaUrl;
608 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
614 mMaskingData->mContentScaleFactor = scale;
619 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
625 mMaskingData->mCropToMask = crop;
630 case Toolkit::DevelImageVisual::Property::MASKING_TYPE:
633 if(value.Get(maskingType))
636 mMaskingData->mPreappliedMasking = Toolkit::DevelImageVisual::MaskingType::Type(maskingType) == Toolkit::DevelImageVisual::MaskingType::MASKING_ON_LOADING ? true : false;
641 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
643 int releasePolicy = 0;
644 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
645 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
649 case Toolkit::ImageVisual::Property::LOAD_POLICY:
652 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
653 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
659 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
661 mStartFirstFrame = true;
662 mPlacementActor = actor;
666 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
668 DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
672 mFrameDelayTimer.Stop();
673 mFrameDelayTimer.Reset();
676 actor.RemoveRenderer(mImpl->mRenderer);
677 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
679 mImageCache->ClearCache(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
680 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
682 TextureSet textureSet = TextureSet::New();
683 mImpl->mRenderer.SetTextures(textureSet);
686 mPlacementActor.Reset();
687 mStartFirstFrame = false;
688 mCurrentFrameIndex = FIRST_FRAME_INDEX;
689 mCurrentLoopIndex = FIRST_LOOP;
692 void AnimatedImageVisual::OnSetTransform()
696 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
700 void AnimatedImageVisual::UpdateShader()
704 Shader shader = GenerateShader();
705 mImpl->mRenderer.SetShader(shader);
709 Shader AnimatedImageVisual::GenerateShader() const
711 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
712 bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
714 shader = mImageVisualShaderFactory.GetShader(
716 ImageVisualShaderFeature::FeatureBuilder()
717 .ApplyDefaultTextureWrapMode(defaultWrapMode)
718 .EnableRoundedCorner(IsRoundedCornerRequired())
719 .EnableBorderline(IsBorderlineRequired())
720 .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering));
724 void AnimatedImageVisual::OnInitialize()
728 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
729 Shader shader = GenerateShader();
731 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
733 mImpl->mRenderer = VisualRenderer::New(geometry, shader);
734 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
736 // Register transform properties
737 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
739 if(!defaultWrapMode) // custom wrap mode
741 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
742 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
743 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
746 if(mPixelArea != FULL_TEXTURE_RECT)
748 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
753 mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
756 // Enable PreMultipliedAlpha if it need premultiplied
757 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
758 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
759 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
760 EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
763 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval)
765 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
767 mStartFirstFrame = false;
770 mImpl->mRenderer.SetTextures(textureSet);
773 Actor actor = mPlacementActor.GetHandle();
776 actor.AddRenderer(mImpl->mRenderer);
777 mPlacementActor.Reset();
781 if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
783 if(mFrameCount > SINGLE_IMAGE_COUNT)
785 mFrameDelayTimer = Timer::New(firstInterval);
786 mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
787 mFrameDelayTimer.Start();
790 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
791 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
794 mCurrentFrameIndex = FIRST_FRAME_INDEX;
797 void AnimatedImageVisual::PrepareTextureSet()
799 TextureSet textureSet;
802 textureSet = mImageCache->FirstFrame();
805 // Check whether synchronous loading is true or false for the first frame.
808 SetImageSize(textureSet);
812 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
816 Texture texture = textureSet.GetTexture(0);
819 mImageSize.SetWidth(texture.GetWidth());
820 mImageSize.SetHeight(texture.GetHeight());
823 if(textureSet.GetTextureCount() > 1u && mMaskingData && mMaskingData->mCropToMask)
825 Texture maskTexture = textureSet.GetTexture(1);
828 mImageSize.SetWidth(std::min(static_cast<uint32_t>(mImageSize.GetWidth() * mMaskingData->mContentScaleFactor), maskTexture.GetWidth()));
829 mImageSize.SetHeight(std::min(static_cast<uint32_t>(mImageSize.GetHeight() * mMaskingData->mContentScaleFactor), maskTexture.GetHeight()));
831 float textureWidth = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
832 float textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
833 Vector2 textureRatio(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
834 std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
835 mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, textureRatio);
841 void AnimatedImageVisual::FrameReady(TextureSet textureSet, uint32_t interval)
843 // When image visual requested to load new frame to mImageCache and it is failed.
844 if(!mImageCache || !textureSet)
846 textureSet = SetLoadingFailed();
848 SetImageSize(textureSet);
852 mFrameCount = mImageCache->GetTotalFrameCount();
853 StartFirstFrame(textureSet, interval);
859 if(mFrameDelayTimer && interval > 0u)
861 mFrameDelayTimer.SetInterval(interval);
863 mImpl->mRenderer.SetTextures(textureSet);
869 bool AnimatedImageVisual::DisplayNextFrame()
871 TextureSet textureSet;
872 bool continueTimer = false;
876 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
881 frameIndex = mFrameIndexForJumpTo;
883 else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
887 else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
889 mCurrentLoopIndex = FIRST_LOOP;
890 if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
892 frameIndex = FIRST_FRAME_INDEX;
894 else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
896 frameIndex = mFrameCount - 1;
900 return false; // Do not draw already rendered scene twice.
905 if(mFrameCount > SINGLE_IMAGE_COUNT)
908 if(frameIndex >= mFrameCount)
910 frameIndex = FIRST_FRAME_INDEX;
914 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
916 // This will stop timer
917 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
918 return DisplayNextFrame();
923 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
925 textureSet = mImageCache->Frame(frameIndex);
929 SetImageSize(textureSet);
932 mImpl->mRenderer.SetTextures(textureSet);
935 mFrameDelayTimer.SetInterval(mImageCache->GetFrameInterval(frameIndex));
938 mCurrentFrameIndex = frameIndex;
939 continueTimer = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY && textureSet) ? true : false;
942 return continueTimer;
945 TextureSet AnimatedImageVisual::SetLoadingFailed()
947 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
948 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
950 Actor actor = mPlacementActor.GetHandle();
951 Vector2 imageSize = Vector2::ZERO;
954 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
956 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
957 TextureSet textureSet = mImpl->mRenderer.GetTextures();
961 mFrameDelayTimer.Stop();
962 mFrameDelayTimer.Reset();
965 SetImageSize(textureSet);
970 void AnimatedImageVisual::AllocateMaskData()
974 mMaskingData.reset(new TextureManager::MaskingData());
978 void AnimatedImageVisual::CheckMaskTexture()
980 if(mMaskingData && !mMaskingData->mPreappliedMasking)
982 bool maskLoadFailed = true;
983 TextureSet textures = mImpl->mRenderer.GetTextures();
984 if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
986 maskLoadFailed = false;
988 if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
990 mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
996 } // namespace Internal
998 } // namespace Toolkit