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-gif-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->InitializeGif( 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->InitializeGif( imageUrl );
154 if( visual->mFrameCount > 0 )
156 visual->LoadFirstBatch();
162 void AnimatedImageVisual::InitializeGif( const VisualUrl& imageUrl )
164 mImageUrl = imageUrl;
165 mGifLoading = GifLoading::New( imageUrl.GetUrl(), imageUrl.IsLocalResource() );
166 mFrameCount = mGifLoading->GetImageCount();
167 mGifLoading->LoadFrameDelays( mFrameDelayContainer );
170 AnimatedImageVisual::AnimatedImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory )
171 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO, Toolkit::Visual::ANIMATED_IMAGE ),
174 mImageVisualShaderFactory( shaderFactory ),
175 mPixelArea( FULL_TEXTURE_RECT ),
177 mGifLoading( nullptr ),
178 mCurrentFrameIndex( 0 ),
184 mLoopCount( LOOP_FOREVER ),
185 mCurrentLoopIndex( 0 ),
189 mWrapModeU( WrapMode::DEFAULT ),
190 mWrapModeV( WrapMode::DEFAULT ),
191 mActionStatus( DevelAnimatedImageVisual::Action::PLAY ),
192 mStopBehavior( DevelImageVisual::StopBehavior::CURRENT_FRAME ),
193 mStartFirstFrame(false),
197 AnimatedImageVisual::~AnimatedImageVisual()
203 void AnimatedImageVisual::GetNaturalSize( Vector2& naturalSize )
205 if( mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
207 if( mImageUrl.IsValid() )
209 mImageSize = mGifLoading->GetImageSize();
211 else if( mImageUrls && mImageUrls->size() > 0 )
213 mImageSize = Dali::GetClosestImageSize( (*mImageUrls)[0].mUrl );
217 naturalSize.width = mImageSize.GetWidth();
218 naturalSize.height = mImageSize.GetHeight();
221 void AnimatedImageVisual::DoCreatePropertyMap( Property::Map& map ) const
225 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE );
227 if( mImageUrl.IsValid() )
229 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
231 if( mImageUrls != NULL && ! mImageUrls->empty() )
233 Property::Array urls;
234 for( unsigned int i=0; i<mImageUrls->size(); ++i)
236 urls.Add( (*mImageUrls)[i].mUrl );
238 Property::Value value( const_cast<Property::Array&>(urls) );
239 map.Insert( Toolkit::ImageVisual::Property::URL, value );
242 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
243 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
244 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
246 map.Insert( Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize) );
247 map.Insert( Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize) );
248 map.Insert( Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay) );
249 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount) );
251 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
254 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
259 void AnimatedImageVisual::OnDoAction( const Dali::Property::Index actionId, const Dali::Property::Value& attributes )
261 // Check if action is valid for this visual type and perform action if possible
265 case DevelAnimatedImageVisual::Action::PAUSE:
267 // Pause will be executed on next timer tick
268 mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
271 case DevelAnimatedImageVisual::Action::PLAY:
273 if( IsOnStage() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY )
275 mFrameDelayTimer.Start();
277 mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
280 case DevelAnimatedImageVisual::Action::STOP:
282 // STOP reset functionality will actually be done in a future change
283 // Stop will be executed on next timer tick
284 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
291 case DevelAnimatedImageVisual::Action::JUMP_TO:
294 if( attributes.Get( frameNumber ) )
296 if( frameNumber < 0 || frameNumber >= static_cast<int32_t>( mFrameCount ) )
298 DALI_LOG_ERROR( "Invalid frame index used.\n" );
303 mCurrentFrameIndex = frameNumber;
315 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
317 // url[s] already passed in from constructor
319 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
321 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
322 if( keyValue.first.type == Property::Key::INDEX )
324 DoSetProperty( keyValue.first.indexKey, keyValue.second );
328 if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
330 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
332 else if( keyValue.first == IMAGE_WRAP_MODE_U )
334 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
336 else if( keyValue.first == IMAGE_WRAP_MODE_V )
338 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
340 else if( keyValue.first == BATCH_SIZE_NAME )
342 DoSetProperty( Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second );
344 else if( keyValue.first == CACHE_SIZE_NAME )
346 DoSetProperty( Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second );
348 else if( keyValue.first == FRAME_DELAY_NAME )
350 DoSetProperty( Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second );
352 else if( keyValue.first == LOOP_COUNT_NAME )
354 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
356 else if( keyValue.first == STOP_BEHAVIOR_NAME )
358 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
364 void AnimatedImageVisual::DoSetProperty( Property::Index index,
365 const Property::Value& value )
369 case Toolkit::ImageVisual::Property::PIXEL_AREA:
371 value.Get( mPixelArea );
374 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
377 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
379 mWrapModeU = Dali::WrapMode::Type(wrapMode);
383 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
387 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
390 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
392 mWrapModeV = Dali::WrapMode::Type(wrapMode);
396 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
401 case Toolkit::ImageVisual::Property::BATCH_SIZE:
404 if( value.Get( batchSize ) )
406 mBatchSize = batchSize;
411 case Toolkit::ImageVisual::Property::CACHE_SIZE:
414 if( value.Get( cacheSize ) )
416 mCacheSize = cacheSize;
421 case Toolkit::ImageVisual::Property::FRAME_DELAY:
424 if( value.Get( frameDelay ) )
426 mFrameDelay = frameDelay;
431 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
434 if( value.Get( loopCount ) )
436 mLoopCount = loopCount;
441 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
443 int32_t stopBehavior = mStopBehavior;
444 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
446 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
453 void AnimatedImageVisual::DoSetOnStage( Actor& actor )
455 mPlacementActor = actor;
456 TextureSet textureSet = PrepareTextureSet();
457 CreateRenderer(); // Always create a renderer when on stage
459 if( textureSet ) // if the image loading is successful
461 StartFirstFrame( textureSet );
465 mStartFirstFrame = true;
469 void AnimatedImageVisual::DoSetOffStage( Actor& actor )
471 DALI_ASSERT_DEBUG( (bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
473 if( mFrameDelayTimer )
475 mFrameDelayTimer.Stop();
476 mFrameDelayTimer.Reset();
479 actor.RemoveRenderer( mImpl->mRenderer );
480 mImpl->mRenderer.Reset();
481 mPlacementActor.Reset();
484 void AnimatedImageVisual::OnSetTransform()
486 if( mImpl->mRenderer )
488 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
492 void AnimatedImageVisual::CreateRenderer()
494 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
495 bool atlasing = false;
496 Shader shader = mImageVisualShaderFactory.GetShader( mFactoryCache, atlasing, defaultWrapMode, IsRoundedCornerRequired() );
498 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
500 mImpl->mRenderer = Renderer::New( geometry, shader );
502 // Register transform properties
503 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
505 if( !defaultWrapMode ) // custom wrap mode
507 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
508 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
509 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
512 if( mPixelArea != FULL_TEXTURE_RECT )
514 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
517 mCurrentFrameIndex = 0;
520 void AnimatedImageVisual::LoadFirstBatch()
522 // Ensure the batch size and cache size are no bigger than the number of URLs,
523 // and that the cache is at least as big as the batch size.
524 uint16_t numUrls = 0;
525 uint16_t batchSize = 1;
526 uint16_t cacheSize = 1;
530 numUrls = mImageUrls->size();
534 numUrls = mFrameCount;
537 batchSize = std::min( mBatchSize, numUrls );
538 cacheSize = std::min( std::max( batchSize, mCacheSize ), numUrls );
540 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::LoadFirstBatch() batchSize:%d cacheSize:%d\n", batchSize, cacheSize);
543 TextureManager& textureManager = mFactoryCache.GetTextureManager();
545 if( mGifLoading != nullptr )
547 mImageCache = new RollingGifImageCache( textureManager, *mGifLoading, mFrameCount, *this, cacheSize, batchSize );
549 else if( mImageUrls )
551 if( batchSize > 0 && cacheSize > 0 )
553 if( cacheSize < numUrls )
555 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, cacheSize, batchSize );
559 mImageCache = new FixedImageCache( textureManager, *mImageUrls, *this, batchSize );
564 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, 1, 1 );
570 DALI_LOG_ERROR("mImageCache is null\n");
574 void AnimatedImageVisual::StartFirstFrame( TextureSet& textureSet )
576 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::StartFirstFrame()\n");
578 mStartFirstFrame = false;
581 mImpl->mRenderer.SetTextures( textureSet );
583 Actor actor = mPlacementActor.GetHandle();
586 actor.AddRenderer( mImpl->mRenderer );
587 mPlacementActor.Reset();
590 mCurrentFrameIndex = 0;
592 if( mFrameCount > 1 )
594 int frameDelay = mFrameDelay; // from URL array
595 if( mFrameDelayContainer.Count() > 0 ) // from GIF
597 frameDelay = mFrameDelayContainer[0];
600 mFrameDelayTimer = Timer::New( frameDelay );
601 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
602 mFrameDelayTimer.Start();
604 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::READY)\n");
605 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
608 TextureSet AnimatedImageVisual::PrepareTextureSet()
610 TextureSet textureSet;
612 textureSet = mImageCache->FirstFrame();
615 SetImageSize( textureSet );
619 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::FAILED)\n");
620 ResourceReady( Toolkit::Visual::ResourceStatus::FAILED );
626 void AnimatedImageVisual::SetImageSize( TextureSet& textureSet )
630 Texture texture = textureSet.GetTexture( 0 );
633 mImageSize.SetWidth( texture.GetWidth() );
634 mImageSize.SetHeight( texture.GetHeight() );
639 void AnimatedImageVisual::FrameReady( TextureSet textureSet )
641 SetImageSize( textureSet );
643 if( mStartFirstFrame )
645 StartFirstFrame( textureSet );
651 mImpl->mRenderer.SetTextures( textureSet );
656 bool AnimatedImageVisual::DisplayNextFrame()
662 else if( mActionStatus == DevelAnimatedImageVisual::Action::PAUSE )
666 else if( mActionStatus == DevelAnimatedImageVisual::Action::STOP )
668 mCurrentLoopIndex = 0;
669 if( mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME )
671 mCurrentFrameIndex = 0;
673 else if( mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME )
675 mCurrentFrameIndex = mFrameCount - 1;
679 return false; // Do not draw already rendered scene twice.
684 if( mFrameCount > 1 )
686 // Wrap the frame index
687 bool finished = false;
688 ++mCurrentFrameIndex;
689 if( mCurrentFrameIndex >= mFrameCount )
695 if( mLoopCount < 0 || mCurrentLoopIndex < mLoopCount)
699 mCurrentFrameIndex = 0; // Back to the first frame
704 // This will stop timer
705 mActionStatus = DevelAnimatedImageVisual::Action::STOP;
706 return DisplayNextFrame();
710 if( mFrameDelayContainer.Count() > 0 )
712 unsigned int delay = mFrameDelayContainer[mCurrentFrameIndex];
714 if( mFrameDelayTimer.GetInterval() != delay )
716 mFrameDelayTimer.SetInterval( delay );
721 DALI_LOG_INFO( gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, mCurrentFrameIndex);
723 TextureSet textureSet;
726 textureSet = mImageCache->Frame( mCurrentFrameIndex );
729 SetImageSize( textureSet );
730 mImpl->mRenderer.SetTextures( textureSet );
734 return ( mActionStatus == DevelAnimatedImageVisual::Action::PLAY ) ? true : false;
738 } // namespace Internal
740 } // namespace Toolkit