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 mCurrentFrameIndex( 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 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE );
226 if( mImageUrl.IsValid() )
228 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
230 if( mImageUrls != NULL && ! mImageUrls->empty() )
232 Property::Array urls;
233 for( unsigned int i=0; i<mImageUrls->size(); ++i)
235 urls.Add( (*mImageUrls)[i].mUrl );
237 Property::Value value( const_cast<Property::Array&>(urls) );
238 map.Insert( Toolkit::ImageVisual::Property::URL, value );
241 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
242 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
243 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
245 map.Insert( Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize) );
246 map.Insert( Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize) );
247 map.Insert( Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay) );
248 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount) );
250 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
253 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
258 void AnimatedImageVisual::OnDoAction( const Dali::Property::Index actionId, const Dali::Property::Value& attributes )
260 // Check if action is valid for this visual type and perform action if possible
264 case DevelAnimatedImageVisual::Action::PAUSE:
266 // Pause will be executed on next timer tick
267 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
270 case DevelAnimatedImageVisual::Action::PLAY:
272 if( mFrameDelayTimer && IsOnStage() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY )
274 mFrameDelayTimer.Start();
276 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
279 case DevelAnimatedImageVisual::Action::STOP:
281 // STOP reset functionality will actually be done in a future change
282 // Stop will be executed on next timer tick
283 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
290 case DevelAnimatedImageVisual::Action::JUMP_TO:
293 if( attributes.Get( frameNumber ) )
295 if( frameNumber < 0 || frameNumber >= static_cast<int32_t>( mFrameCount ) )
297 DALI_LOG_ERROR( "Invalid frame index used.\n" );
302 mCurrentFrameIndex = frameNumber;
314 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
316 // url[s] already passed in from constructor
318 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
320 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
321 if( keyValue.first.type == Property::Key::INDEX )
323 DoSetProperty( keyValue.first.indexKey, keyValue.second );
327 if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
329 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
331 else if( keyValue.first == IMAGE_WRAP_MODE_U )
333 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
335 else if( keyValue.first == IMAGE_WRAP_MODE_V )
337 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
339 else if( keyValue.first == BATCH_SIZE_NAME )
341 DoSetProperty( Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second );
343 else if( keyValue.first == CACHE_SIZE_NAME )
345 DoSetProperty( Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second );
347 else if( keyValue.first == FRAME_DELAY_NAME )
349 DoSetProperty( Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second );
351 else if( keyValue.first == LOOP_COUNT_NAME )
353 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
355 else if( keyValue.first == STOP_BEHAVIOR_NAME )
357 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
363 void AnimatedImageVisual::DoSetProperty( Property::Index index,
364 const Property::Value& value )
368 case Toolkit::ImageVisual::Property::PIXEL_AREA:
370 value.Get( mPixelArea );
373 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
376 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
378 mWrapModeU = Dali::WrapMode::Type(wrapMode);
382 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
386 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
389 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
391 mWrapModeV = Dali::WrapMode::Type(wrapMode);
395 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
400 case Toolkit::ImageVisual::Property::BATCH_SIZE:
403 if( value.Get( batchSize ) )
405 mBatchSize = batchSize;
410 case Toolkit::ImageVisual::Property::CACHE_SIZE:
413 if( value.Get( cacheSize ) )
415 mCacheSize = cacheSize;
420 case Toolkit::ImageVisual::Property::FRAME_DELAY:
423 if( value.Get( frameDelay ) )
425 mFrameDelay = frameDelay;
430 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
433 if( value.Get( loopCount ) )
435 mLoopCount = loopCount;
440 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
442 int32_t stopBehavior = mStopBehavior;
443 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
445 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
452 void AnimatedImageVisual::DoSetOnStage( Actor& actor )
454 mPlacementActor = actor;
455 TextureSet textureSet = PrepareTextureSet();
456 CreateRenderer(); // Always create a renderer when on stage
458 if( textureSet ) // if the image loading is successful
460 StartFirstFrame( textureSet );
464 mStartFirstFrame = true;
468 void AnimatedImageVisual::DoSetOffStage( Actor& actor )
470 DALI_ASSERT_DEBUG( (bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
472 if( mFrameDelayTimer )
474 mFrameDelayTimer.Stop();
475 mFrameDelayTimer.Reset();
478 actor.RemoveRenderer( mImpl->mRenderer );
479 mImpl->mRenderer.Reset();
480 mPlacementActor.Reset();
483 void AnimatedImageVisual::OnSetTransform()
485 if( mImpl->mRenderer )
487 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
491 void AnimatedImageVisual::CreateRenderer()
493 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
494 bool atlasing = false;
495 Shader shader = mImageVisualShaderFactory.GetShader( mFactoryCache, atlasing, defaultWrapMode, IsRoundedCornerRequired() );
497 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
499 mImpl->mRenderer = Renderer::New( geometry, shader );
501 // Register transform properties
502 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
504 if( !defaultWrapMode ) // custom wrap mode
506 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
507 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
508 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
511 if( mPixelArea != FULL_TEXTURE_RECT )
513 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
516 mCurrentFrameIndex = 0;
519 void AnimatedImageVisual::LoadFirstBatch()
521 // Ensure the batch size and cache size are no bigger than the number of URLs,
522 // and that the cache is at least as big as the batch size.
523 uint16_t numUrls = 0;
524 uint16_t batchSize = 1;
525 uint16_t cacheSize = 1;
529 numUrls = mImageUrls->size();
533 numUrls = mFrameCount;
536 batchSize = std::min( mBatchSize, numUrls );
537 cacheSize = std::min( std::max( batchSize, mCacheSize ), numUrls );
539 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::LoadFirstBatch() batchSize:%d cacheSize:%d\n", batchSize, cacheSize);
542 TextureManager& textureManager = mFactoryCache.GetTextureManager();
544 if( mAnimatedImageLoading )
546 mImageCache = new RollingAnimatedImageCache( textureManager, mAnimatedImageLoading, mFrameCount, *this, cacheSize, batchSize );
548 else if( mImageUrls )
550 if( batchSize > 0 && cacheSize > 0 )
552 if( cacheSize < numUrls )
554 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, cacheSize, batchSize );
558 mImageCache = new FixedImageCache( textureManager, *mImageUrls, *this, batchSize );
563 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, 1, 1 );
569 DALI_LOG_ERROR("mImageCache is null\n");
573 void AnimatedImageVisual::StartFirstFrame( TextureSet& textureSet )
575 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::StartFirstFrame()\n");
577 mStartFirstFrame = false;
580 mImpl->mRenderer.SetTextures( textureSet );
582 Actor actor = mPlacementActor.GetHandle();
585 actor.AddRenderer( mImpl->mRenderer );
586 mPlacementActor.Reset();
589 mCurrentFrameIndex = 0;
591 if( mFrameCount > 1 )
593 int frameDelay = mFrameDelay; // from URL array
594 if( mAnimatedImageLoading && mImageCache )
596 frameDelay = mImageCache->GetFrameInterval( 0 );
598 mFrameDelayTimer = Timer::New( frameDelay );
599 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
600 mFrameDelayTimer.Start();
602 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::READY)\n");
603 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
606 TextureSet AnimatedImageVisual::PrepareTextureSet()
608 TextureSet textureSet;
610 textureSet = mImageCache->FirstFrame();
613 SetImageSize( textureSet );
617 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::FAILED)\n");
618 ResourceReady( Toolkit::Visual::ResourceStatus::FAILED );
624 void AnimatedImageVisual::SetImageSize( TextureSet& textureSet )
628 Texture texture = textureSet.GetTexture( 0 );
631 mImageSize.SetWidth( texture.GetWidth() );
632 mImageSize.SetHeight( texture.GetHeight() );
637 void AnimatedImageVisual::FrameReady( TextureSet textureSet )
639 SetImageSize( textureSet );
641 if( mStartFirstFrame )
643 StartFirstFrame( textureSet );
649 mImpl->mRenderer.SetTextures( textureSet );
654 bool AnimatedImageVisual::DisplayNextFrame()
660 else if( mActionStatus == DevelAnimatedImageVisual::Action::PAUSE )
664 else if( mActionStatus == DevelAnimatedImageVisual::Action::STOP )
666 mCurrentLoopIndex = 0;
667 if( mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME )
669 mCurrentFrameIndex = 0;
671 else if( mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME )
673 mCurrentFrameIndex = mFrameCount - 1;
677 return false; // Do not draw already rendered scene twice.
682 if( mFrameCount > 1 )
684 // Wrap the frame index
685 bool finished = false;
686 ++mCurrentFrameIndex;
687 if( mCurrentFrameIndex >= mFrameCount )
693 if( mLoopCount < 0 || mCurrentLoopIndex < mLoopCount)
697 mCurrentFrameIndex = 0; // Back to the first frame
702 // This will stop timer
703 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
704 return DisplayNextFrame();
707 // TODO : newly added one.
708 if( mAnimatedImageLoading && mImageCache )
710 unsigned int delay = mImageCache->GetFrameInterval( mCurrentFrameIndex );
711 if( mFrameDelayTimer.GetInterval() != delay )
713 mFrameDelayTimer.SetInterval( delay );
718 DALI_LOG_INFO( gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, mCurrentFrameIndex);
720 TextureSet textureSet;
723 textureSet = mImageCache->Frame( mCurrentFrameIndex );
726 SetImageSize( textureSet );
727 mImpl->mRenderer.SetTextures( textureSet );
731 return ( mActionStatus == DevelAnimatedImageVisual::Action::PLAY ) ? true : false;
735 } // namespace Internal
737 } // namespace Toolkit