2 * Copyright (c) 2018 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/animated-image/fixed-image-cache.h>
34 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
35 #include <dali-toolkit/internal/visuals/animated-image/rolling-gif-image-cache.h>
36 #include <dali-toolkit/internal/visuals/image/image-visual.h>
37 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
38 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
52 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
53 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
55 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
56 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
57 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
59 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
60 constexpr auto LOOP_FOREVER = -1;
62 #if defined(DEBUG_ENABLED)
63 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
69 * Multi-image Flow of execution
75 * | cache->LoadBatch()
78 * | PrepareTextureSet()
79 * | cache->FirstFrame()
80 * | CreateRenderer() (Doesn't become ready until first frame loads)
83 * | FrameReady(textureSet)
84 * | start first frame:
87 * | mRenderer.SetTextures(textureSet)
90 * | DisplayNextFrame()
91 * | if front frame is ready,
92 * | mRenderer.SetTextures( front frame's texture )
94 * | mWaitingForTexture=true
95 * | cache->LoadBatch()
97 * | FrameReady(textureSet)
98 * | mRenderer.SetTextures(textureSet)
103 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties )
105 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache ) );
106 visual->InitializeGif( imageUrl );
107 visual->SetProperties( properties );
109 if( visual->mFrameCount > 0 )
111 visual->LoadFirstBatch();
117 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const Property::Array& imageUrls, const Property::Map& properties )
119 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache ) );
120 visual->mImageUrls = new ImageCache::UrlList();
121 visual->mImageUrls->reserve( imageUrls.Count() );
123 for( unsigned int i=0; i < imageUrls.Count(); ++i)
125 ImageCache::UrlStore urlStore;
126 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
127 urlStore.mUrl = imageUrls[i].Get<std::string>();
128 visual->mImageUrls->push_back( urlStore );
130 visual->mFrameCount = imageUrls.Count();
131 visual->SetProperties( properties );
133 if( visual->mFrameCount > 0 )
135 visual->LoadFirstBatch();
141 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl )
143 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache ) );
144 visual->InitializeGif( imageUrl );
146 if( visual->mFrameCount > 0 )
148 visual->LoadFirstBatch();
154 void AnimatedImageVisual::InitializeGif( const VisualUrl& imageUrl )
156 mImageUrl = imageUrl;
157 mGifLoading = GifLoading::New( imageUrl.GetUrl() );
158 mFrameCount = mGifLoading->GetImageCount();
159 mGifLoading->LoadFrameDelays( mFrameDelayContainer );
162 AnimatedImageVisual::AnimatedImageVisual( VisualFactoryCache& factoryCache )
163 : Visual::Base( factoryCache ),
166 mPixelArea( FULL_TEXTURE_RECT ),
168 mGifLoading( nullptr ),
169 mCurrentFrameIndex( 0 ),
175 mLoopCount( LOOP_FOREVER ),
176 mCurrentLoopIndex( 0 ),
180 mWrapModeU( WrapMode::DEFAULT ),
181 mWrapModeV( WrapMode::DEFAULT ),
182 mStartFirstFrame(false)
185 AnimatedImageVisual::~AnimatedImageVisual()
191 void AnimatedImageVisual::GetNaturalSize( Vector2& naturalSize )
193 if( mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
195 if( mImageUrl.IsValid() )
197 mImageSize = mGifLoading->GetImageSize();
199 else if( mImageUrls && mImageUrls->size() > 0 )
201 mImageSize = Dali::GetClosestImageSize( (*mImageUrls)[0].mUrl );
205 naturalSize.width = mImageSize.GetWidth();
206 naturalSize.height = mImageSize.GetHeight();
209 void AnimatedImageVisual::DoCreatePropertyMap( Property::Map& map ) const
213 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE );
215 if( mImageUrl.IsValid() )
217 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
219 if( mImageUrls != NULL && ! mImageUrls->empty() )
221 Property::Array urls;
222 for( unsigned int i=0; i<mImageUrls->size(); ++i)
224 urls.Add( (*mImageUrls)[i].mUrl );
226 Property::Value value( const_cast<Property::Array&>(urls) );
227 map.Insert( Toolkit::ImageVisual::Property::URL, value );
230 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
231 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
232 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
234 map.Insert( Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize) );
235 map.Insert( Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize) );
236 map.Insert( Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay) );
237 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount) );
240 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
245 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
247 // url[s] already passed in from constructor
249 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
251 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
252 if( keyValue.first.type == Property::Key::INDEX )
254 DoSetProperty( keyValue.first.indexKey, keyValue.second );
258 if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
260 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
262 else if( keyValue.first == IMAGE_WRAP_MODE_U )
264 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
266 else if( keyValue.first == IMAGE_WRAP_MODE_V )
268 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
270 else if( keyValue.first == BATCH_SIZE_NAME )
272 DoSetProperty( Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second );
274 else if( keyValue.first == CACHE_SIZE_NAME )
276 DoSetProperty( Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second );
278 else if( keyValue.first == FRAME_DELAY_NAME )
280 DoSetProperty( Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second );
282 else if( keyValue.first == LOOP_COUNT_NAME )
284 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
290 void AnimatedImageVisual::DoSetProperty( Property::Index index,
291 const Property::Value& value )
295 case Toolkit::ImageVisual::Property::PIXEL_AREA:
297 value.Get( mPixelArea );
300 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
303 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
305 mWrapModeU = Dali::WrapMode::Type(wrapMode);
309 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
313 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
316 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
318 mWrapModeV = Dali::WrapMode::Type(wrapMode);
322 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
327 case Toolkit::ImageVisual::Property::BATCH_SIZE:
330 if( value.Get( batchSize ) )
332 mBatchSize = batchSize;
337 case Toolkit::ImageVisual::Property::CACHE_SIZE:
340 if( value.Get( cacheSize ) )
342 mCacheSize = cacheSize;
347 case Toolkit::ImageVisual::Property::FRAME_DELAY:
350 if( value.Get( frameDelay ) )
352 mFrameDelay = frameDelay;
357 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
360 if( value.Get( loopCount ) )
362 mLoopCount = loopCount;
369 void AnimatedImageVisual::DoSetOnStage( Actor& actor )
371 mPlacementActor = actor;
372 TextureSet textureSet = PrepareTextureSet();
373 CreateRenderer(); // Always create a renderer when on stage
375 if( textureSet ) // if the image loading is successful
377 StartFirstFrame( textureSet );
381 mStartFirstFrame = true;
385 void AnimatedImageVisual::DoSetOffStage( Actor& actor )
387 DALI_ASSERT_DEBUG( (bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
389 if( mFrameDelayTimer )
391 mFrameDelayTimer.Stop();
392 mFrameDelayTimer.Reset();
395 actor.RemoveRenderer( mImpl->mRenderer );
396 mImpl->mRenderer.Reset();
397 mPlacementActor.Reset();
400 void AnimatedImageVisual::OnSetTransform()
402 if( mImpl->mRenderer )
404 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
408 void AnimatedImageVisual::CreateRenderer()
410 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
411 bool atlasing = false;
412 Shader shader = ImageVisual::GetImageShader( mFactoryCache, atlasing, defaultWrapMode );
414 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
416 mImpl->mRenderer = Renderer::New( geometry, shader );
418 // Register transform properties
419 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
421 if( !defaultWrapMode ) // custom wrap mode
423 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
424 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
425 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
428 if( mPixelArea != FULL_TEXTURE_RECT )
430 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
433 mCurrentFrameIndex = 0;
436 void AnimatedImageVisual::LoadFirstBatch()
438 // Ensure the batch size and cache size are no bigger than the number of URLs,
439 // and that the cache is at least as big as the batch size.
440 uint16_t numUrls = 0;
441 uint16_t batchSize = 1;
442 uint16_t cacheSize = 1;
446 numUrls = mImageUrls->size();
450 numUrls = mFrameCount;
453 batchSize = std::min( mBatchSize, numUrls );
454 cacheSize = std::min( std::max( batchSize, mCacheSize ), numUrls );
456 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::LoadFirstBatch() batchSize:%d cacheSize:%d\n", batchSize, cacheSize);
459 TextureManager& textureManager = mFactoryCache.GetTextureManager();
461 if( mGifLoading != nullptr )
463 mImageCache = new RollingGifImageCache( textureManager, *mGifLoading, mFrameCount, *this, cacheSize, batchSize );
465 else if( batchSize > 0 && cacheSize > 0 )
467 if( cacheSize < numUrls )
469 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, cacheSize, batchSize );
473 mImageCache = new FixedImageCache( textureManager, *mImageUrls, *this, batchSize );
478 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, 1, 1 );
482 DALI_LOG_ERROR("mImageCache is null");
486 void AnimatedImageVisual::StartFirstFrame( TextureSet& textureSet )
488 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::StartFirstFrame()\n");
490 mStartFirstFrame = false;
491 mImpl->mRenderer.SetTextures( textureSet );
492 Actor actor = mPlacementActor.GetHandle();
495 actor.AddRenderer( mImpl->mRenderer );
496 mPlacementActor.Reset();
499 mCurrentFrameIndex = 0;
501 if( mFrameCount > 1 )
503 int frameDelay = mFrameDelay; // from URL array
504 if( mFrameDelayContainer.Count() > 0 ) // from GIF
506 frameDelay = mFrameDelayContainer[0];
509 mFrameDelayTimer = Timer::New( frameDelay );
510 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
511 mFrameDelayTimer.Start();
513 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::READY)\n");
514 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
517 TextureSet AnimatedImageVisual::PrepareTextureSet()
519 TextureSet textureSet;
521 textureSet = mImageCache->FirstFrame();
524 SetImageSize( textureSet );
528 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::FAILED)\n");
529 ResourceReady( Toolkit::Visual::ResourceStatus::FAILED );
535 void AnimatedImageVisual::SetImageSize( TextureSet& textureSet )
539 Texture texture = textureSet.GetTexture( 0 );
542 mImageSize.SetWidth( texture.GetWidth() );
543 mImageSize.SetHeight( texture.GetHeight() );
548 void AnimatedImageVisual::FrameReady( TextureSet textureSet )
550 SetImageSize( textureSet );
552 if( mStartFirstFrame )
554 StartFirstFrame( textureSet );
558 mImpl->mRenderer.SetTextures( textureSet );
562 bool AnimatedImageVisual::DisplayNextFrame()
564 if( mFrameCount > 1 )
566 // Wrap the frame index
567 ++mCurrentFrameIndex;
569 if( mLoopCount < 0 || mCurrentLoopIndex <= mLoopCount)
571 mCurrentFrameIndex %= mFrameCount;
572 if( mCurrentFrameIndex == 0 )
579 // This will stop timer
583 DALI_LOG_INFO( gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::DisplayNextFrame(this:%p) FrameCount:%d\n", this, mCurrentFrameIndex);
585 if( mFrameDelayContainer.Count() > 0 )
587 unsigned int delay = mFrameDelayContainer[mCurrentFrameIndex];
589 if( mFrameDelayTimer.GetInterval() != delay )
591 mFrameDelayTimer.SetInterval( delay );
595 TextureSet textureSet;
597 textureSet = mImageCache->NextFrame();
600 SetImageSize( textureSet );
601 mImpl->mRenderer.SetTextures( textureSet );
604 // Keep timer ticking
609 } // namespace Internal
611 } // namespace Toolkit