2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "animated-image-visual.h"
22 #include <dali/devel-api/adaptor-framework/image-loading.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/public-api/rendering/decorated-visual-renderer.h>
28 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
29 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
30 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
31 #include <dali-toolkit/internal/visuals/animated-image/fixed-image-cache.h>
32 #include <dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h>
33 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
34 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
35 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
37 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
40 #include <dali-toolkit/public-api/visuals/visual-properties.h>
50 const int CUSTOM_PROPERTY_COUNT(5); // ltr, wrap, pixel area, crop to mask, mask texture ratio
53 DALI_ENUM_TO_STRING_TABLE_BEGIN(FITTING_MODE)
54 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SHRINK_TO_FIT)
55 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SCALE_TO_FILL)
56 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_WIDTH)
57 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_HEIGHT)
58 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, DEFAULT)
59 DALI_ENUM_TO_STRING_TABLE_END(FITTING_MODE)
62 DALI_ENUM_TO_STRING_TABLE_BEGIN(SAMPLING_MODE)
63 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX)
64 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NEAREST)
65 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, LINEAR)
66 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_NEAREST)
67 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_LINEAR)
68 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NO_FILTER)
69 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, DONT_CARE)
70 DALI_ENUM_TO_STRING_TABLE_END(SAMPLING_MODE)
73 DALI_ENUM_TO_STRING_TABLE_BEGIN(STOP_BEHAVIOR)
74 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME)
75 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME)
76 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME)
77 DALI_ENUM_TO_STRING_TABLE_END(STOP_BEHAVIOR)
80 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
81 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
82 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
83 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
84 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
85 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
88 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOAD_POLICY)
89 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE)
90 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED)
91 DALI_ENUM_TO_STRING_TABLE_END(LOAD_POLICY)
94 DALI_ENUM_TO_STRING_TABLE_BEGIN(RELEASE_POLICY)
95 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED)
96 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED)
97 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER)
98 DALI_ENUM_TO_STRING_TABLE_END(RELEASE_POLICY)
100 static constexpr uint32_t SINGLE_IMAGE_COUNT = 1u;
101 static constexpr uint32_t FIRST_FRAME_INDEX = 0u;
102 static constexpr uint16_t MINIMUM_CACHESIZE = 1;
103 static constexpr Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
104 static constexpr auto LOOP_FOREVER = -1;
105 static constexpr auto FIRST_LOOP = 0u;
107 constexpr uint32_t TEXTURE_COUNT_FOR_GPU_ALPHA_MASK = 2u;
109 #if defined(DEBUG_ENABLED)
110 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
115 * Multi-image Flow of execution
118 * | DoSetProperties()
120 * | CreateImageCache()
123 * | PrepareTextureSet()
124 * | cache->FirstFrame()
126 * | FrameReady(textureSet)
128 * | actor.AddRenderer
130 * | mRenderer.SetTextures(textureSet)
133 * | DisplayNextFrame()
134 * | if front frame is ready,
135 * | mRenderer.SetTextures( front frame's texture )
137 * | Waiting for frame ready.
139 * | FrameReady(textureSet)
140 * | mRenderer.SetTextures(textureSet)
145 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
147 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory, ImageDimensions()));
148 visual->InitializeAnimatedImage(imageUrl);
149 visual->SetProperties(properties);
151 visual->Initialize();
156 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties)
158 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory, ImageDimensions()));
159 visual->mImageUrls = new ImageCache::UrlList();
160 visual->mImageUrls->reserve(imageUrls.Count());
162 for(unsigned int i = 0; i < imageUrls.Count(); ++i)
164 ImageCache::UrlStore urlStore;
165 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
166 urlStore.mUrl = imageUrls[i].Get<std::string>();
167 visual->mImageUrls->push_back(urlStore);
169 visual->mFrameCount = imageUrls.Count();
170 visual->SetProperties(properties);
172 visual->Initialize();
177 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
179 AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory, size));
180 visual->InitializeAnimatedImage(imageUrl);
182 visual->Initialize();
187 void AnimatedImageVisual::InitializeAnimatedImage(const VisualUrl& imageUrl)
189 mImageUrl = imageUrl;
190 mAnimatedImageLoading = AnimatedImageLoading::New(imageUrl.GetUrl(), imageUrl.IsLocalResource());
193 void AnimatedImageVisual::CreateImageCache()
195 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::CreateImageCache() batchSize:%d cacheSize:%d\n", mBatchSize, mCacheSize);
197 TextureManager& textureManager = mFactoryCache.GetTextureManager();
199 if(mAnimatedImageLoading)
201 mImageCache = new RollingAnimatedImageCache(textureManager, mDesiredSize, mFittingMode, mSamplingMode, mAnimatedImageLoading, mMaskingData, *this, mCacheSize, mBatchSize, mWrapModeU, mWrapModeV, IsSynchronousLoadingRequired(), IsPreMultipliedAlphaEnabled());
205 // Ensure the batch size and cache size are no bigger than the number of URLs,
206 // and that the cache is at least as big as the batch size.
207 uint16_t numUrls = mImageUrls->size();
208 uint16_t batchSize = std::max(std::min(mBatchSize, numUrls), MINIMUM_CACHESIZE);
209 uint16_t cacheSize = std::max(std::min(std::max(batchSize, mCacheSize), numUrls), MINIMUM_CACHESIZE);
210 if(cacheSize < numUrls)
212 mImageCache = new RollingImageCache(textureManager, mDesiredSize, mFittingMode, mSamplingMode, *mImageUrls, mMaskingData, *this, cacheSize, batchSize, mFrameDelay, IsPreMultipliedAlphaEnabled());
216 mImageCache = new FixedImageCache(textureManager, mDesiredSize, mFittingMode, mSamplingMode, *mImageUrls, mMaskingData, *this, batchSize, mFrameDelay, IsPreMultipliedAlphaEnabled());
222 DALI_LOG_ERROR("mImageCache is null\n");
226 AnimatedImageVisual::AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, ImageDimensions desiredSize)
227 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::ANIMATED_IMAGE),
230 mImageVisualShaderFactory(shaderFactory),
231 mPixelArea(FULL_TEXTURE_RECT),
233 mAnimatedImageLoading(),
234 mFrameIndexForJumpTo(0),
235 mCurrentFrameIndex(FIRST_FRAME_INDEX),
241 mLoopCount(LOOP_FOREVER),
242 mCurrentLoopIndex(FIRST_LOOP),
243 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
244 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
246 mDesiredSize(desiredSize),
249 mActionStatus(DevelAnimatedImageVisual::Action::PLAY),
250 mWrapModeU(WrapMode::DEFAULT),
251 mWrapModeV(WrapMode::DEFAULT),
252 mFittingMode(FittingMode::SCALE_TO_FILL),
253 mSamplingMode(SamplingMode::BOX_THEN_LINEAR),
254 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
255 mStartFirstFrame(false),
258 EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
261 AnimatedImageVisual::~AnimatedImageVisual()
263 // AnimatedImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
264 // If this is animated image, clear cache. Else if this is single frame image, this is affected be release policy.
265 if(mFrameCount > SINGLE_IMAGE_COUNT || mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER)
267 mImageCache->ClearCache();
273 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
275 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
277 naturalSize.x = mDesiredSize.GetWidth();
278 naturalSize.y = mDesiredSize.GetHeight();
282 naturalSize = Vector2::ZERO;
283 if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
285 if(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid() &&
286 mMaskingData->mCropToMask)
288 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
289 if(dimensions != ImageDimensions(0, 0))
291 mImageSize = dimensions;
292 naturalSize.x = dimensions.GetWidth();
293 naturalSize.y = dimensions.GetHeight();
298 if(mImageUrl.IsValid())
300 mImageSize = mAnimatedImageLoading.GetImageSize();
302 else if(mImageUrls && mImageUrls->size() > 0)
304 mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl.GetUrl());
308 naturalSize.width = mImageSize.GetWidth();
309 naturalSize.height = mImageSize.GetHeight();
312 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
316 bool sync = IsSynchronousLoadingRequired();
317 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
319 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
321 if(mImageUrl.IsValid())
323 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
325 if(mImageUrls != NULL && !mImageUrls->empty())
327 Property::Array urls;
328 for(unsigned int i = 0; i < mImageUrls->size(); ++i)
330 urls.Add((*mImageUrls)[i].mUrl.GetUrl());
332 Property::Value value(const_cast<Property::Array&>(urls));
333 map.Insert(Toolkit::ImageVisual::Property::URL, value);
336 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
337 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
338 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
340 map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
341 map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
342 map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
343 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
344 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
345 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>((mAnimatedImageLoading) ? mAnimatedImageLoading.GetImageCount() : mImageCache->GetTotalFrameCount()) : -1);
347 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
349 if(mMaskingData != nullptr)
351 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
352 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
353 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
354 map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
357 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
358 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
359 map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
360 map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
361 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
362 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
365 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
368 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
369 if(mImageUrl.IsValid())
371 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
372 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
376 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
378 // Make not set any action when the resource status is already failed.
379 if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
384 // Check if action is valid for this visual type and perform action if possible
387 case DevelAnimatedImageVisual::Action::PAUSE:
389 // Pause will be executed on next timer tick
390 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
393 case DevelAnimatedImageVisual::Action::PLAY:
395 if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
397 mFrameDelayTimer.Start();
399 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
402 case DevelAnimatedImageVisual::Action::STOP:
404 // STOP reset functionality will actually be done in a future change
405 // Stop will be executed on next timer tick
406 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
407 mCurrentLoopIndex = FIRST_LOOP;
414 case DevelAnimatedImageVisual::Action::JUMP_TO:
417 if(attributes.Get(frameNumber))
419 if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
421 DALI_LOG_ERROR("Invalid frame index used.\n");
426 mFrameIndexForJumpTo = frameNumber;
438 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
440 // url[s] already passed in from constructor
441 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
443 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
444 if(keyValue.first.type == Property::Key::INDEX)
446 DoSetProperty(keyValue.first.indexKey, keyValue.second);
450 if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
452 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
454 else if(keyValue.first == IMAGE_WRAP_MODE_U)
456 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
458 else if(keyValue.first == IMAGE_WRAP_MODE_V)
460 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
462 else if(keyValue.first == BATCH_SIZE_NAME)
464 DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
466 else if(keyValue.first == CACHE_SIZE_NAME)
468 DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
470 else if(keyValue.first == FRAME_DELAY_NAME)
472 DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
474 else if(keyValue.first == LOOP_COUNT_NAME)
476 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
478 else if(keyValue.first == STOP_BEHAVIOR_NAME)
480 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
482 else if(keyValue.first == ALPHA_MASK_URL)
484 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
486 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
488 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
490 else if(keyValue.first == CROP_TO_MASK_NAME)
492 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
494 else if(keyValue.first == MASKING_TYPE_NAME)
496 DoSetProperty(Toolkit::DevelImageVisual::Property::MASKING_TYPE, keyValue.second);
498 else if(keyValue.first == LOAD_POLICY_NAME)
500 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
502 else if(keyValue.first == RELEASE_POLICY_NAME)
504 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
506 else if(keyValue.first == SYNCHRONOUS_LOADING)
508 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
510 else if(keyValue.first == IMAGE_FITTING_MODE)
512 DoSetProperty(Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second);
514 else if(keyValue.first == IMAGE_SAMPLING_MODE)
516 DoSetProperty(Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second);
518 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
520 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
522 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
524 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
528 // Load image immediately if LOAD_POLICY requires it
529 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
535 void AnimatedImageVisual::DoSetProperty(Property::Index index,
536 const Property::Value& value)
540 case Toolkit::ImageVisual::Property::PIXEL_AREA:
542 value.Get(mPixelArea);
545 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
548 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
550 mWrapModeU = Dali::WrapMode::Type(wrapMode);
554 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
558 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
561 if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
563 mWrapModeV = Dali::WrapMode::Type(wrapMode);
567 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
572 case Toolkit::ImageVisual::Property::BATCH_SIZE:
575 if(value.Get(batchSize))
579 DALI_LOG_ERROR("The minimum value of batch size is 2.");
583 mBatchSize = batchSize;
589 case Toolkit::ImageVisual::Property::CACHE_SIZE:
592 if(value.Get(cacheSize))
596 DALI_LOG_ERROR("The minimum value of cache size is 2.");
600 mCacheSize = cacheSize;
606 case Toolkit::ImageVisual::Property::FRAME_DELAY:
609 if(value.Get(frameDelay))
611 mFrameDelay = frameDelay;
614 mImageCache->SetInterval(static_cast<uint32_t>(mFrameDelay));
620 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
623 if(value.Get(loopCount))
625 mLoopCount = loopCount;
630 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
632 int32_t stopBehavior = mStopBehavior;
633 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
635 mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
640 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
646 mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
650 mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
655 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
657 std::string alphaUrl = "";
658 if(value.Get(alphaUrl))
661 mMaskingData->mAlphaMaskUrl = alphaUrl;
666 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
672 mMaskingData->mContentScaleFactor = scale;
677 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
683 mMaskingData->mCropToMask = crop;
688 case Toolkit::DevelImageVisual::Property::MASKING_TYPE:
691 if(value.Get(maskingType))
694 mMaskingData->mPreappliedMasking = Toolkit::DevelImageVisual::MaskingType::Type(maskingType) == Toolkit::DevelImageVisual::MaskingType::MASKING_ON_LOADING ? true : false;
699 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
701 int releasePolicy = 0;
702 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
703 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
707 case Toolkit::ImageVisual::Property::LOAD_POLICY:
710 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
711 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
715 case Toolkit::ImageVisual::Property::FITTING_MODE:
718 Scripting::GetEnumerationProperty(value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode);
719 mFittingMode = Dali::FittingMode::Type(fittingMode);
723 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
725 int samplingMode = 0;
726 Scripting::GetEnumerationProperty(value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode);
727 mSamplingMode = Dali::SamplingMode::Type(samplingMode);
731 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
733 float desiredWidth = 0.0f;
734 if(value.Get(desiredWidth))
736 mDesiredSize.SetWidth(desiredWidth);
740 DALI_LOG_ERROR("AnimatedImageVisual: desiredWidth property has incorrect type\n");
745 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
747 float desiredHeight = 0.0f;
748 if(value.Get(desiredHeight))
750 mDesiredSize.SetHeight(desiredHeight);
754 DALI_LOG_ERROR("AnimatedImageVisual: desiredHeight property has incorrect type\n");
761 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
763 mStartFirstFrame = true;
764 mPlacementActor = actor;
768 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
770 DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
774 mFrameDelayTimer.Stop();
775 mFrameDelayTimer.Reset();
778 actor.RemoveRenderer(mImpl->mRenderer);
779 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
781 mImageCache->ClearCache(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
782 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
784 TextureSet textureSet = TextureSet::New();
785 mImpl->mRenderer.SetTextures(textureSet);
788 mPlacementActor.Reset();
789 mStartFirstFrame = false;
790 mCurrentFrameIndex = FIRST_FRAME_INDEX;
791 mCurrentLoopIndex = FIRST_LOOP;
794 void AnimatedImageVisual::OnSetTransform()
798 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
802 void AnimatedImageVisual::UpdateShader()
806 Shader shader = GenerateShader();
807 mImpl->mRenderer.SetShader(shader);
811 Shader AnimatedImageVisual::GenerateShader() const
813 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
814 bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
816 shader = mImageVisualShaderFactory.GetShader(
818 ImageVisualShaderFeature::FeatureBuilder()
819 .ApplyDefaultTextureWrapMode(defaultWrapMode)
820 .EnableRoundedCorner(IsRoundedCornerRequired())
821 .EnableBorderline(IsBorderlineRequired())
822 .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering));
826 void AnimatedImageVisual::OnInitialize()
830 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
831 Shader shader = GenerateShader();
833 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
835 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
836 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
838 // Register transform properties
839 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
841 if(!defaultWrapMode) // custom wrap mode
843 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
844 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
845 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
848 if(mPixelArea != FULL_TEXTURE_RECT)
850 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
855 mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
858 // Enable PreMultipliedAlpha if it need premultiplied
859 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
860 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
861 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
862 EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
865 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval)
867 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
869 mStartFirstFrame = false;
872 mImpl->mRenderer.SetTextures(textureSet);
875 Actor actor = mPlacementActor.GetHandle();
878 actor.AddRenderer(mImpl->mRenderer);
879 mPlacementActor.Reset();
883 if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
885 if(mFrameCount > SINGLE_IMAGE_COUNT)
887 mFrameDelayTimer = Timer::New(firstInterval);
888 mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
889 mFrameDelayTimer.Start();
892 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
893 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
896 mCurrentFrameIndex = FIRST_FRAME_INDEX;
899 void AnimatedImageVisual::PrepareTextureSet()
901 TextureSet textureSet;
904 textureSet = mImageCache->FirstFrame();
907 // Check whether synchronous loading is true or false for the first frame.
910 SetImageSize(textureSet);
914 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
918 Texture texture = textureSet.GetTexture(0);
921 mImageSize.SetWidth(texture.GetWidth());
922 mImageSize.SetHeight(texture.GetHeight());
925 if(textureSet.GetTextureCount() > 1u && mMaskingData && mMaskingData->mCropToMask)
927 Texture maskTexture = textureSet.GetTexture(1);
930 mImageSize.SetWidth(std::min(static_cast<uint32_t>(mImageSize.GetWidth() * mMaskingData->mContentScaleFactor), maskTexture.GetWidth()));
931 mImageSize.SetHeight(std::min(static_cast<uint32_t>(mImageSize.GetHeight() * mMaskingData->mContentScaleFactor), maskTexture.GetHeight()));
933 float textureWidth = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
934 float textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
935 Vector2 textureRatio(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
936 std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
937 mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, textureRatio);
943 void AnimatedImageVisual::FrameReady(TextureSet textureSet, uint32_t interval, bool preMultiplied)
945 EnablePreMultipliedAlpha(preMultiplied);
947 // When image visual requested to load new frame to mImageCache and it is failed.
948 if(!mImageCache || !textureSet)
950 textureSet = SetLoadingFailed();
952 SetImageSize(textureSet);
956 mFrameCount = mImageCache->GetTotalFrameCount();
957 StartFirstFrame(textureSet, interval);
963 if(mFrameDelayTimer && interval > 0u)
965 mFrameDelayTimer.SetInterval(interval);
967 mImpl->mRenderer.SetTextures(textureSet);
973 bool AnimatedImageVisual::DisplayNextFrame()
975 TextureSet textureSet;
976 bool continueTimer = false;
980 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
985 frameIndex = mFrameIndexForJumpTo;
987 else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
991 else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
993 mCurrentLoopIndex = FIRST_LOOP;
994 if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
996 frameIndex = FIRST_FRAME_INDEX;
998 else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
1000 frameIndex = mFrameCount - 1;
1004 return false; // Do not draw already rendered scene twice.
1009 if(mFrameCount > SINGLE_IMAGE_COUNT)
1012 if(frameIndex >= mFrameCount)
1014 frameIndex = FIRST_FRAME_INDEX;
1015 ++mCurrentLoopIndex;
1018 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
1020 // This will stop timer
1021 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
1022 return DisplayNextFrame();
1027 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
1029 textureSet = mImageCache->Frame(frameIndex);
1033 SetImageSize(textureSet);
1034 if(mImpl->mRenderer)
1036 mImpl->mRenderer.SetTextures(textureSet);
1039 mFrameDelayTimer.SetInterval(mImageCache->GetFrameInterval(frameIndex));
1042 mCurrentFrameIndex = frameIndex;
1043 continueTimer = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY && textureSet) ? true : false;
1046 return continueTimer;
1049 TextureSet AnimatedImageVisual::SetLoadingFailed()
1051 DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
1052 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
1054 Actor actor = mPlacementActor.GetHandle();
1055 Vector2 imageSize = Vector2::ZERO;
1058 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
1060 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
1061 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1063 if(mFrameDelayTimer)
1065 mFrameDelayTimer.Stop();
1066 mFrameDelayTimer.Reset();
1069 SetImageSize(textureSet);
1074 void AnimatedImageVisual::AllocateMaskData()
1078 mMaskingData.reset(new TextureManager::MaskingData());
1082 void AnimatedImageVisual::CheckMaskTexture()
1084 if(mMaskingData && !mMaskingData->mPreappliedMasking)
1086 bool maskLoadFailed = true;
1087 TextureSet textures = mImpl->mRenderer.GetTextures();
1088 if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
1090 maskLoadFailed = false;
1092 if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
1094 mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
1100 } // namespace Internal
1102 } // namespace Toolkit