2 * Copyright (c) 2017 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);
61 #if defined(DEBUG_ENABLED)
62 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
68 * Multi-image Flow of execution
74 * | cache->LoadBatch()
77 * | PrepareTextureSet()
78 * | cache->FirstFrame()
79 * | CreateRenderer() (Doesn't become ready until first frame loads)
82 * | FrameReady(textureSet)
83 * | start first frame:
86 * | mRenderer.SetTextures(textureSet)
89 * | DisplayNextFrame()
90 * | if front frame is ready,
91 * | mRenderer.SetTextures( front frame's texture )
93 * | mWaitingForTexture=true
94 * | cache->LoadBatch()
96 * | FrameReady(textureSet)
97 * | mRenderer.SetTextures(textureSet)
102 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties )
104 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache ) );
105 visual->InitializeGif( imageUrl );
106 visual->SetProperties( properties );
108 if( visual->mFrameCount > 0 )
110 visual->LoadFirstBatch();
116 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const Property::Array& imageUrls, const Property::Map& properties )
118 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache ) );
119 visual->mImageUrls = new ImageCache::UrlList();
120 visual->mImageUrls->reserve( imageUrls.Count() );
122 for( unsigned int i=0; i < imageUrls.Count(); ++i)
124 ImageCache::UrlStore urlStore;
125 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
126 urlStore.mUrl = imageUrls[i].Get<std::string>();
127 visual->mImageUrls->push_back( urlStore );
129 visual->mFrameCount = imageUrls.Count();
130 visual->SetProperties( properties );
132 if( visual->mFrameCount > 0 )
134 visual->LoadFirstBatch();
140 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl )
142 AnimatedImageVisualPtr visual( new AnimatedImageVisual( factoryCache ) );
143 visual->InitializeGif( imageUrl );
145 if( visual->mFrameCount > 0 )
147 visual->LoadFirstBatch();
153 void AnimatedImageVisual::InitializeGif( const VisualUrl& imageUrl )
155 mImageUrl = imageUrl;
156 mGifLoading = GifLoading::New( imageUrl.GetUrl() );
157 mFrameCount = mGifLoading->GetImageCount();
158 mGifLoading->LoadFrameDelays( mFrameDelayContainer );
161 AnimatedImageVisual::AnimatedImageVisual( VisualFactoryCache& factoryCache )
162 : Visual::Base( factoryCache ),
165 mPixelArea( FULL_TEXTURE_RECT ),
167 mGifLoading( nullptr ),
168 mCurrentFrameIndex( 0 ),
177 mWrapModeU( WrapMode::DEFAULT ),
178 mWrapModeV( WrapMode::DEFAULT ),
179 mStartFirstFrame(false)
182 AnimatedImageVisual::~AnimatedImageVisual()
188 void AnimatedImageVisual::GetNaturalSize( Vector2& naturalSize )
190 if( mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
192 if( mImageUrl.IsValid() )
194 mImageSize = mGifLoading->GetImageSize();
196 else if( mImageUrls && mImageUrls->size() > 0 )
198 mImageSize = Dali::GetClosestImageSize( (*mImageUrls)[0].mUrl );
202 naturalSize.width = mImageSize.GetWidth();
203 naturalSize.height = mImageSize.GetHeight();
206 void AnimatedImageVisual::DoCreatePropertyMap( Property::Map& map ) const
210 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE );
212 if( mImageUrl.IsValid() )
214 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
216 if( mImageUrls != NULL && ! mImageUrls->empty() )
218 Property::Array urls;
219 for( unsigned int i=0; i<mImageUrls->size(); ++i)
221 urls.Add( (*mImageUrls)[i].mUrl );
223 Property::Value value( const_cast<Property::Array&>(urls) );
224 map.Insert( Toolkit::ImageVisual::Property::URL, value );
227 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
228 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
229 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
231 map.Insert( Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize) );
232 map.Insert( Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize) );
233 map.Insert( Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay) );
236 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
241 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
243 // url[s] already passed in from constructor
245 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
247 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
248 if( keyValue.first.type == Property::Key::INDEX )
250 DoSetProperty( keyValue.first.indexKey, keyValue.second );
254 if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
256 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
258 else if( keyValue.first == IMAGE_WRAP_MODE_U )
260 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
262 else if( keyValue.first == IMAGE_WRAP_MODE_V )
264 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
266 else if( keyValue.first == BATCH_SIZE_NAME )
268 DoSetProperty( Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second );
270 else if( keyValue.first == CACHE_SIZE_NAME )
272 DoSetProperty( Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second );
274 else if( keyValue.first == FRAME_DELAY_NAME )
276 DoSetProperty( Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second );
282 void AnimatedImageVisual::DoSetProperty( Property::Index index,
283 const Property::Value& value )
287 case Toolkit::ImageVisual::Property::PIXEL_AREA:
289 value.Get( mPixelArea );
292 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
295 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
297 mWrapModeU = Dali::WrapMode::Type(wrapMode);
301 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
305 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
308 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
310 mWrapModeV = Dali::WrapMode::Type(wrapMode);
314 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
319 case Toolkit::ImageVisual::Property::BATCH_SIZE:
322 if( value.Get( batchSize ) )
324 mBatchSize = batchSize;
329 case Toolkit::ImageVisual::Property::CACHE_SIZE:
332 if( value.Get( cacheSize ) )
334 mCacheSize = cacheSize;
339 case Toolkit::ImageVisual::Property::FRAME_DELAY:
342 if( value.Get( frameDelay ) )
344 mFrameDelay = frameDelay;
351 void AnimatedImageVisual::DoSetOnStage( Actor& actor )
353 mPlacementActor = actor;
354 TextureSet textureSet = PrepareTextureSet();
355 CreateRenderer(); // Always create a renderer when on stage
357 if( textureSet ) // if the image loading is successful
359 StartFirstFrame( textureSet );
363 mStartFirstFrame = true;
367 void AnimatedImageVisual::DoSetOffStage( Actor& actor )
369 DALI_ASSERT_DEBUG( (bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
371 if( mFrameDelayTimer )
373 mFrameDelayTimer.Stop();
374 mFrameDelayTimer.Reset();
377 actor.RemoveRenderer( mImpl->mRenderer );
378 mImpl->mRenderer.Reset();
379 mPlacementActor.Reset();
382 void AnimatedImageVisual::OnSetTransform()
384 if( mImpl->mRenderer )
386 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
390 void AnimatedImageVisual::CreateRenderer()
392 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
393 bool atlasing = false;
394 Shader shader = ImageVisual::GetImageShader( mFactoryCache, atlasing, defaultWrapMode );
396 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
398 mImpl->mRenderer = Renderer::New( geometry, shader );
400 // Register transform properties
401 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
403 if( !defaultWrapMode ) // custom wrap mode
405 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
406 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
407 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
410 if( mPixelArea != FULL_TEXTURE_RECT )
412 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
415 mCurrentFrameIndex = 0;
418 void AnimatedImageVisual::LoadFirstBatch()
420 // Ensure the batch size and cache size are no bigger than the number of URLs,
421 // and that the cache is at least as big as the batch size.
422 uint16_t numUrls = 0;
423 uint16_t batchSize = 1;
424 uint16_t cacheSize = 1;
428 numUrls = mImageUrls->size();
432 numUrls = mFrameCount;
435 batchSize = std::min( mBatchSize, numUrls );
436 cacheSize = std::min( std::max( batchSize, mCacheSize ), numUrls );
438 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::LoadFirstBatch() batchSize:%d cacheSize:%d\n", batchSize, cacheSize);
441 TextureManager& textureManager = mFactoryCache.GetTextureManager();
443 if( mGifLoading != nullptr )
445 mImageCache = new RollingGifImageCache( textureManager, *mGifLoading, mFrameCount, *this, cacheSize, batchSize );
447 else if( batchSize > 0 && cacheSize > 0 )
449 if( cacheSize < numUrls )
451 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, cacheSize, batchSize );
455 mImageCache = new FixedImageCache( textureManager, *mImageUrls, *this, batchSize );
460 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, 1, 1 );
464 DALI_LOG_ERROR("mImageCache is null");
468 void AnimatedImageVisual::StartFirstFrame( TextureSet& textureSet )
470 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::StartFirstFrame()\n");
472 mStartFirstFrame = false;
473 mImpl->mRenderer.SetTextures( textureSet );
474 Actor actor = mPlacementActor.GetHandle();
477 actor.AddRenderer( mImpl->mRenderer );
478 mPlacementActor.Reset();
481 mCurrentFrameIndex = 0;
483 if( mFrameCount > 1 )
485 int frameDelay = mFrameDelay; // from URL array
486 if( mFrameDelayContainer.Count() > 0 ) // from GIF
488 frameDelay = mFrameDelayContainer[0];
491 mFrameDelayTimer = Timer::New( frameDelay );
492 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
493 mFrameDelayTimer.Start();
495 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::READY)\n");
496 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
499 TextureSet AnimatedImageVisual::PrepareTextureSet()
501 TextureSet textureSet;
503 textureSet = mImageCache->FirstFrame();
506 SetImageSize( textureSet );
510 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady(ResourceStatus::FAILED)\n");
511 ResourceReady( Toolkit::Visual::ResourceStatus::FAILED );
517 void AnimatedImageVisual::SetImageSize( TextureSet& textureSet )
521 Texture texture = textureSet.GetTexture( 0 );
524 mImageSize.SetWidth( texture.GetWidth() );
525 mImageSize.SetHeight( texture.GetHeight() );
530 void AnimatedImageVisual::FrameReady( TextureSet textureSet )
532 SetImageSize( textureSet );
534 if( mStartFirstFrame )
536 StartFirstFrame( textureSet );
540 mImpl->mRenderer.SetTextures( textureSet );
544 bool AnimatedImageVisual::DisplayNextFrame()
546 if( mFrameCount > 1 )
548 // Wrap the frame index
549 ++mCurrentFrameIndex;
550 mCurrentFrameIndex %= mFrameCount;
552 DALI_LOG_INFO( gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::DisplayNextFrame(this:%p) FrameCount:%d\n", this, mCurrentFrameIndex);
554 if( mFrameDelayContainer.Count() > 0 )
556 unsigned int delay = mFrameDelayContainer[mCurrentFrameIndex];
558 if( mFrameDelayTimer.GetInterval() != delay )
560 mFrameDelayTimer.SetInterval( delay );
564 TextureSet textureSet;
566 textureSet = mImageCache->NextFrame();
569 SetImageSize( textureSet );
570 mImpl->mRenderer.SetTextures( textureSet );
573 // Keep timer ticking
578 } // namespace Internal
580 } // namespace Toolkit