2 * Copyright (c) 2020 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/public-api/visuals/image-visual-properties.h>
28 #include <dali-toolkit/public-api/visuals/visual-properties.h>
29 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
30 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
31 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
32 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
33 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
34 #include <dali-toolkit/internal/visuals/animated-image/fixed-image-cache.h>
35 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
36 #include <dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h>
37 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
38 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
39 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
53 DALI_ENUM_TO_STRING_TABLE_BEGIN( STOP_BEHAVIOR )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME )
55 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME )
56 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME )
57 DALI_ENUM_TO_STRING_TABLE_END( STOP_BEHAVIOR )
60 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
62 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
63 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
65 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
67 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
68 constexpr auto LOOP_FOREVER = -1;
70 #if defined(DEBUG_ENABLED)
71 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
77 * Multi-image Flow of execution
83 * | cache->LoadBatch()
86 * | PrepareTextureSet()
87 * | cache->FirstFrame()
88 * | CreateRenderer() (Doesn't become ready until first frame loads)
91 * | FrameReady(textureSet)
92 * | start first frame:
95 * | mRenderer.SetTextures(textureSet)
98 * | DisplayNextFrame()
99 * | if front frame is ready,
100 * | mRenderer.SetTextures( front frame's texture )
102 * | mWaitingForTexture=true
103 * | cache->LoadBatch()
105 * | FrameReady(textureSet)
106 * | mRenderer.SetTextures(textureSet)
111 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties )
113 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache, shaderFactory ) );
114 visual->InitializeAnimatedImage( imageUrl );
115 visual->SetProperties( properties );
117 if( visual->mFrameCount > 0 )
119 visual->LoadFirstBatch();
125 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties )
127 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache, shaderFactory ) );
128 visual->mImageUrls = new ImageCache::UrlList();
129 visual->mImageUrls->reserve( imageUrls.Count() );
131 for( unsigned int i=0; i < imageUrls.Count(); ++i)
133 ImageCache::UrlStore urlStore;
134 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
135 urlStore.mUrl = imageUrls[i].Get<std::string>();
136 visual->mImageUrls->push_back( urlStore );
138 visual->mFrameCount = imageUrls.Count();
139 visual->SetProperties( properties );
141 if( visual->mFrameCount > 0 )
143 visual->LoadFirstBatch();
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();
162 void AnimatedImageVisual::InitializeAnimatedImage( const VisualUrl& imageUrl )
164 mImageUrl = imageUrl;
165 mAnimatedImageLoading = AnimatedImageLoading::New( imageUrl.GetUrl(), imageUrl.IsLocalResource() );
166 mFrameCount = mAnimatedImageLoading.GetImageCount();
169 AnimatedImageVisual::AnimatedImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory )
170 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO, Toolkit::Visual::ANIMATED_IMAGE ),
173 mImageVisualShaderFactory( shaderFactory ),
174 mPixelArea( FULL_TEXTURE_RECT ),
176 mAnimatedImageLoading(),
177 mFrameIndexForJumpTo( 0 ),
183 mLoopCount( LOOP_FOREVER ),
184 mCurrentLoopIndex( 0 ),
188 mWrapModeU( WrapMode::DEFAULT ),
189 mWrapModeV( WrapMode::DEFAULT ),
190 mActionStatus( DevelAnimatedImageVisual::Action::PLAY ),
191 mStopBehavior( DevelImageVisual::StopBehavior::CURRENT_FRAME ),
192 mStartFirstFrame(false),
196 AnimatedImageVisual::~AnimatedImageVisual()
202 void AnimatedImageVisual::GetNaturalSize( Vector2& naturalSize )
204 if( mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
206 if( mImageUrl.IsValid() )
208 mImageSize = mAnimatedImageLoading.GetImageSize();
210 else if( mImageUrls && mImageUrls->size() > 0 )
212 mImageSize = Dali::GetClosestImageSize( (*mImageUrls)[0].mUrl );
216 naturalSize.width = mImageSize.GetWidth();
217 naturalSize.height = mImageSize.GetHeight();
220 void AnimatedImageVisual::DoCreatePropertyMap( Property::Map& map ) const
224 bool sync = IsSynchronousLoadingRequired();
225 map.Insert( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync );
227 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE );
229 if( mImageUrl.IsValid() )
231 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
233 if( mImageUrls != NULL && ! mImageUrls->empty() )
235 Property::Array urls;
236 for( unsigned int i=0; i<mImageUrls->size(); ++i)
238 urls.Add( (*mImageUrls)[i].mUrl );
240 Property::Value value( const_cast<Property::Array&>(urls) );
241 map.Insert( Toolkit::ImageVisual::Property::URL, value );
244 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
245 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
246 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
248 map.Insert( Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize) );
249 map.Insert( Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize) );
250 map.Insert( Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay) );
251 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount) );
252 map.Insert( Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1 );
253 map.Insert( Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetTotalFrameCount()) : -1 );
255 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
258 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
263 void AnimatedImageVisual::OnDoAction( const Dali::Property::Index actionId, const Dali::Property::Value& attributes )
265 // Check if action is valid for this visual type and perform action if possible
269 case DevelAnimatedImageVisual::Action::PAUSE:
271 // Pause will be executed on next timer tick
272 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
275 case DevelAnimatedImageVisual::Action::PLAY:
277 if( mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY )
279 mFrameDelayTimer.Start();
281 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
284 case DevelAnimatedImageVisual::Action::STOP:
286 // STOP reset functionality will actually be done in a future change
287 // Stop will be executed on next timer tick
288 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
295 case DevelAnimatedImageVisual::Action::JUMP_TO:
298 if( attributes.Get( frameNumber ) )
300 if( frameNumber < 0 || frameNumber >= static_cast<int32_t>( mFrameCount ) )
302 DALI_LOG_ERROR( "Invalid frame index used.\n" );
307 mFrameIndexForJumpTo = frameNumber;
319 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
321 // url[s] already passed in from constructor
323 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
325 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
326 if( keyValue.first.type == Property::Key::INDEX )
328 DoSetProperty( keyValue.first.indexKey, keyValue.second );
332 if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
334 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
336 else if( keyValue.first == IMAGE_WRAP_MODE_U )
338 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
340 else if( keyValue.first == IMAGE_WRAP_MODE_V )
342 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
344 else if( keyValue.first == BATCH_SIZE_NAME )
346 DoSetProperty( Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second );
348 else if( keyValue.first == CACHE_SIZE_NAME )
350 DoSetProperty( Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second );
352 else if( keyValue.first == FRAME_DELAY_NAME )
354 DoSetProperty( Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second );
356 else if( keyValue.first == LOOP_COUNT_NAME )
358 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
360 else if( keyValue.first == STOP_BEHAVIOR_NAME )
362 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
368 void AnimatedImageVisual::DoSetProperty( Property::Index index,
369 const Property::Value& value )
373 case Toolkit::ImageVisual::Property::PIXEL_AREA:
375 value.Get( mPixelArea );
378 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
381 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
383 mWrapModeU = Dali::WrapMode::Type(wrapMode);
387 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
391 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
394 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
396 mWrapModeV = Dali::WrapMode::Type(wrapMode);
400 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
405 case Toolkit::ImageVisual::Property::BATCH_SIZE:
408 if( value.Get( batchSize ) )
412 DALI_LOG_ERROR( "The minimum value of batch size is 2." );
416 mBatchSize = batchSize;
422 case Toolkit::ImageVisual::Property::CACHE_SIZE:
425 if( value.Get( cacheSize ) )
429 DALI_LOG_ERROR( "The minimum value of cache size is 2." );
433 mCacheSize = cacheSize;
439 case Toolkit::ImageVisual::Property::FRAME_DELAY:
442 if( value.Get( frameDelay ) )
444 mFrameDelay = frameDelay;
449 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
452 if( value.Get( loopCount ) )
454 mLoopCount = loopCount;
459 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
461 int32_t stopBehavior = mStopBehavior;
462 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
464 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
469 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
475 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
479 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
486 void AnimatedImageVisual::DoSetOnScene( Actor& actor )
488 mPlacementActor = actor;
489 TextureSet textureSet = PrepareTextureSet();
490 CreateRenderer(); // Always create a renderer when on stage
492 if( textureSet ) // if the image loading is successful
494 StartFirstFrame( textureSet );
498 mStartFirstFrame = true;
502 void AnimatedImageVisual::DoSetOffScene( Actor& actor )
504 DALI_ASSERT_DEBUG( (bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
506 if( mFrameDelayTimer )
508 mFrameDelayTimer.Stop();
509 mFrameDelayTimer.Reset();
512 actor.RemoveRenderer( mImpl->mRenderer );
513 mImpl->mRenderer.Reset();
514 mPlacementActor.Reset();
515 mStartFirstFrame = false;
518 void AnimatedImageVisual::OnSetTransform()
520 if( mImpl->mRenderer )
522 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
526 void AnimatedImageVisual::CreateRenderer()
528 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
529 bool atlasing = false;
530 Shader shader = mImageVisualShaderFactory.GetShader( mFactoryCache, atlasing, defaultWrapMode, IsRoundedCornerRequired() );
532 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
534 mImpl->mRenderer = Renderer::New( geometry, shader );
536 // Register transform properties
537 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
539 if( !defaultWrapMode ) // custom wrap mode
541 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
542 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
543 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
546 if( mPixelArea != FULL_TEXTURE_RECT )
548 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
552 void AnimatedImageVisual::LoadFirstBatch()
554 // Ensure the batch size and cache size are no bigger than the number of URLs,
555 // and that the cache is at least as big as the batch size.
556 uint16_t numUrls = 0;
557 uint16_t batchSize = 1;
558 uint16_t cacheSize = 1;
562 numUrls = mImageUrls->size();
566 numUrls = mFrameCount;
569 batchSize = std::min( mBatchSize, numUrls );
570 cacheSize = std::min( std::max( batchSize, mCacheSize ), numUrls );
572 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::LoadFirstBatch() batchSize:%d cacheSize:%d\n", batchSize, cacheSize);
575 TextureManager& textureManager = mFactoryCache.GetTextureManager();
577 if( mAnimatedImageLoading )
579 mImageCache = new RollingAnimatedImageCache( textureManager, mAnimatedImageLoading, mFrameCount, *this, cacheSize, batchSize, IsSynchronousLoadingRequired() );
581 else if( mImageUrls )
583 if( batchSize > 0 && cacheSize > 0 )
585 if( cacheSize < numUrls )
587 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, cacheSize, batchSize );
591 mImageCache = new FixedImageCache( textureManager, *mImageUrls, *this, batchSize );
596 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, 1, 1 );
602 DALI_LOG_ERROR("mImageCache is null\n");
606 void AnimatedImageVisual::StartFirstFrame( TextureSet& textureSet )
608 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::StartFirstFrame()\n");
610 mStartFirstFrame = false;
613 mImpl->mRenderer.SetTextures( textureSet );
615 Actor actor = mPlacementActor.GetHandle();
618 actor.AddRenderer( mImpl->mRenderer );
619 mPlacementActor.Reset();
623 if( mFrameCount > 1 )
625 int frameDelay = mImageCache->GetFrameInterval( 0 );
626 if( frameDelay == 0u )
628 frameDelay = mFrameDelay; // from URL array
630 mFrameDelayTimer = Timer::New( frameDelay );
631 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
632 mFrameDelayTimer.Start();
634 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::READY)\n");
635 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
638 TextureSet AnimatedImageVisual::PrepareTextureSet()
640 TextureSet textureSet;
643 textureSet = mImageCache->FirstFrame();
648 SetImageSize( textureSet );
654 void AnimatedImageVisual::SetImageSize( TextureSet& textureSet )
658 Texture texture = textureSet.GetTexture( 0 );
661 mImageSize.SetWidth( texture.GetWidth() );
662 mImageSize.SetHeight( texture.GetHeight() );
667 void AnimatedImageVisual::FrameReady( TextureSet textureSet )
671 SetImageSize(textureSet);
675 StartFirstFrame(textureSet);
681 mImpl->mRenderer.SetTextures(textureSet);
687 DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n" );
688 ResourceReady( Toolkit::Visual::ResourceStatus::FAILED );
692 bool AnimatedImageVisual::DisplayNextFrame()
694 bool continueTimer = false;
698 bool nextFrame = false;
699 uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
704 frameIndex = mFrameIndexForJumpTo;
706 else if( mActionStatus == DevelAnimatedImageVisual::Action::PAUSE )
710 else if( mActionStatus == DevelAnimatedImageVisual::Action::STOP )
713 if( mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME )
717 else if( mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME )
719 frameIndex = mFrameCount - 1;
723 return false; // Do not draw already rendered scene twice.
728 if( mFrameCount > 1 )
732 if( frameIndex >= mFrameCount )
734 frameIndex %= mFrameCount;
738 if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
740 // This will stop timer
741 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
742 return DisplayNextFrame();
746 unsigned int delay = mImageCache->GetFrameInterval( frameIndex );
749 if( mFrameDelayTimer.GetInterval() != delay )
751 mFrameDelayTimer.SetInterval( delay );
756 DALI_LOG_INFO( gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
758 TextureSet textureSet;
761 textureSet = mImageCache->NextFrame();
765 textureSet = mImageCache->Frame( frameIndex );
770 SetImageSize( textureSet );
771 if( mImpl->mRenderer )
773 mImpl->mRenderer.SetTextures( textureSet );
777 continueTimer = ( mActionStatus == DevelAnimatedImageVisual::Action::PLAY ) ? true : false;
780 return continueTimer;
784 } // namespace Internal
786 } // namespace Toolkit