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/gif-loading.h>
23 #include <dali/devel-api/adaptor-framework/image-loading.h>
24 #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/image/image-visual.h>
36 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
50 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
51 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
52 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
53 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
55 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
57 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
59 #if defined(DEBUG_ENABLED)
60 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
66 * Multi-image Flow of execution
70 * | cache->LoadBatch()
73 * | CreateRenderer() (Doesn't become ready until first frame loads)
75 * | FrameReady(textureSet)
76 * | start first frame:
79 * | mRenderer.SetTextures(textureSet)
82 * | DisplayNextFrame()
83 * | if front frame is ready,
84 * | mRenderer.SetTextures( front frame's texture )
86 * | mWaitingForTexture=true
87 * | cache->LoadBatch()
89 * | FrameReady(textureSet)
90 * | mRenderer.SetTextures(textureSet)
95 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties )
97 AnimatedImageVisual* visual = new AnimatedImageVisual( factoryCache );
98 visual->mImageUrl = imageUrl;
99 visual->SetProperties( properties );
104 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const Property::Array& imageUrls, const Property::Map& properties )
106 AnimatedImageVisual* visual = new AnimatedImageVisual( factoryCache );
107 visual->mImageUrls = new ImageCache::UrlList();
108 visual->mImageUrls->reserve( imageUrls.Count() );
110 for( unsigned int i=0; i < imageUrls.Count(); ++i)
112 ImageCache::UrlStore urlStore;
113 urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
114 urlStore.mUrl = imageUrls[i].Get<std::string>();
115 visual->mImageUrls->push_back( urlStore );
118 visual->SetProperties( properties );
119 // starts loading immediately
123 AnimatedImageVisualPtr AnimatedImageVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl )
125 AnimatedImageVisual* visual = new AnimatedImageVisual( factoryCache );
126 visual->mImageUrl = imageUrl;
131 AnimatedImageVisual::AnimatedImageVisual( VisualFactoryCache& factoryCache )
132 : Visual::Base( factoryCache ),
135 mPixelArea( FULL_TEXTURE_RECT ),
137 mCurrentFrameIndex( 0 ),
145 mWrapModeU( WrapMode::DEFAULT ),
146 mWrapModeV( WrapMode::DEFAULT ),
147 mStartFirstFrame(false)
150 AnimatedImageVisual::~AnimatedImageVisual()
156 void AnimatedImageVisual::GetNaturalSize( Vector2& naturalSize )
158 if( mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
160 if( mImageUrl.IsValid() )
162 mImageSize = Dali::GetGifImageSize( mImageUrl.GetUrl() );
164 else if( mImageUrls && mImageUrls->size() > 0 )
166 mImageSize = Dali::GetClosestImageSize( (*mImageUrls)[0].mUrl );
170 naturalSize.width = mImageSize.GetWidth();
171 naturalSize.height = mImageSize.GetHeight();
174 void AnimatedImageVisual::DoCreatePropertyMap( Property::Map& map ) const
178 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE );
180 if( mImageUrl.IsValid() )
182 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
184 if( mImageUrls != NULL && ! mImageUrls->empty() )
186 Property::Array urls;
187 for( unsigned int i=0; i<mImageUrls->size(); ++i)
189 urls.Add( (*mImageUrls)[i].mUrl );
191 Property::Value value( const_cast<Property::Array&>(urls) );
192 map.Insert( Toolkit::ImageVisual::Property::URL, value );
195 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
196 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
197 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
199 map.Insert( Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize) );
200 map.Insert( Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize) );
201 map.Insert( Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay) );
204 void AnimatedImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
209 void AnimatedImageVisual::DoSetProperties( const Property::Map& propertyMap )
211 // url[s] already passed in from constructor
213 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
215 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
216 if( keyValue.first.type == Property::Key::INDEX )
218 DoSetProperty( keyValue.first.indexKey, keyValue.second );
222 if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
224 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
226 else if( keyValue.first == IMAGE_WRAP_MODE_U )
228 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
230 else if( keyValue.first == IMAGE_WRAP_MODE_V )
232 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
234 else if( keyValue.first == BATCH_SIZE_NAME )
236 DoSetProperty( Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second );
238 else if( keyValue.first == CACHE_SIZE_NAME )
240 DoSetProperty( Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second );
242 else if( keyValue.first == FRAME_DELAY_NAME )
244 DoSetProperty( Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second );
249 if( mImageUrls && mImageUrls->size() > 0 )
255 void AnimatedImageVisual::DoSetProperty( Property::Index index,
256 const Property::Value& value )
260 case Toolkit::ImageVisual::Property::PIXEL_AREA:
262 value.Get( mPixelArea );
265 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
268 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
270 mWrapModeU = Dali::WrapMode::Type(wrapMode);
274 mWrapModeU = Dali::WrapMode::Type::DEFAULT;
278 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
281 if(Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode ))
283 mWrapModeV = Dali::WrapMode::Type(wrapMode);
287 mWrapModeV = Dali::WrapMode::Type::DEFAULT;
292 case Toolkit::ImageVisual::Property::BATCH_SIZE:
295 if( value.Get( batchSize ) )
297 mBatchSize = batchSize;
302 case Toolkit::ImageVisual::Property::CACHE_SIZE:
305 if( value.Get( cacheSize ) )
307 mCacheSize = cacheSize;
312 case Toolkit::ImageVisual::Property::FRAME_DELAY:
315 if( value.Get( frameDelay ) )
317 mFrameDelay = frameDelay;
324 void AnimatedImageVisual::DoSetOnStage( Actor& actor )
326 mPlacementActor = actor;
327 TextureSet textureSet = PrepareTextureSet();
328 CreateRenderer(); // Always create a renderer when on stage
330 if( textureSet ) // if the image loading is successful
332 StartFirstFrame( textureSet );
336 mStartFirstFrame = true;
340 void AnimatedImageVisual::DoSetOffStage( Actor& actor )
342 DALI_ASSERT_DEBUG( (bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
344 if( mFrameDelayTimer )
346 mFrameDelayTimer.Stop();
347 mFrameDelayTimer.Reset();
350 mTextureRectContainer.Clear();
351 mFrameDelayContainer.Clear();
353 actor.RemoveRenderer( mImpl->mRenderer );
354 mImpl->mRenderer.Reset();
355 mPlacementActor.Reset();
358 void AnimatedImageVisual::OnSetTransform()
360 if( mImpl->mRenderer )
362 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
366 void AnimatedImageVisual::CreateRenderer()
368 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
369 bool atlasing = (mTextureRectContainer.Count() > 0) ;
370 Shader shader = ImageVisual::GetImageShader( mFactoryCache, atlasing, defaultWrapMode );
372 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
374 mImpl->mRenderer = Renderer::New( geometry, shader );
376 // Register transform properties
377 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
379 if( !defaultWrapMode ) // custom wrap mode
381 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
382 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
383 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
386 if( mPixelArea != FULL_TEXTURE_RECT )
388 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
391 mCurrentFrameIndex = 0;
393 if( mTextureRectContainer.Count() > 0 )
395 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mTextureRectContainer[mCurrentFrameIndex] );
399 void AnimatedImageVisual::LoadFirstBatch()
401 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::LoadFirstBatch()\n");
403 // Ensure the batch size and cache size are no bigger than the number of URLs,
404 // and that the cache is at least as big as the batch size.
405 uint16_t numUrls = mImageUrls->size();
406 uint16_t batchSize = std::min( mBatchSize, numUrls );
407 uint16_t cacheSize = std::min( std::max( batchSize, mCacheSize ), numUrls );
410 TextureManager& textureManager = mFactoryCache.GetTextureManager();
412 if( batchSize > 0 && cacheSize > 0 )
414 if( cacheSize < numUrls )
416 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, cacheSize, batchSize );
420 mImageCache = new FixedImageCache( textureManager, *mImageUrls, *this, batchSize );
425 mImageCache = new RollingImageCache( textureManager, *mImageUrls, *this, 1, 1 );
429 void AnimatedImageVisual::StartFirstFrame( TextureSet& textureSet )
431 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::StartFirstFrame()\n");
433 mStartFirstFrame = false;
434 mImpl->mRenderer.SetTextures( textureSet );
435 Actor actor = mPlacementActor.GetHandle();
438 actor.AddRenderer( mImpl->mRenderer );
439 mPlacementActor.Reset();
442 int frameDelay = mFrameDelay;
443 if( mFrameDelayContainer.Count() > 1 )
445 frameDelay = mFrameDelayContainer[0];
447 mFrameDelayTimer = Timer::New( frameDelay );
448 mFrameDelayTimer.TickSignal().Connect( this, &AnimatedImageVisual::DisplayNextFrame );
449 mFrameDelayTimer.Start();
451 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"ResourceReady()\n");
455 TextureSet AnimatedImageVisual::PrepareTextureSet()
457 TextureSet textureSet;
458 if( mImageUrl.IsValid() )
460 textureSet = PrepareAnimatedGifImage();
464 textureSet = mImageCache->FirstFrame();
467 SetImageSize( textureSet );
473 TextureSet AnimatedImageVisual::PrepareAnimatedGifImage()
475 TextureSet textureSet;
477 // load from image file
478 std::vector<Dali::PixelData> pixelDataList;
480 if( mImageUrl.IsLocalResource() )
482 if( Dali::LoadAnimatedGifFromFile( mImageUrl.GetUrl().c_str() , pixelDataList, mFrameDelayContainer ) )
484 mImageSize.SetWidth( pixelDataList[0].GetWidth() );
485 mImageSize.SetHeight( pixelDataList[0].GetHeight() );
487 Texture texture = Toolkit::ImageAtlas::PackToAtlas( pixelDataList, mTextureRectContainer );
488 textureSet = TextureSet::New();
489 textureSet.SetTexture( 0, texture );
496 void AnimatedImageVisual::SetImageSize( TextureSet& textureSet )
500 Texture texture = textureSet.GetTexture( 0 );
503 mImageSize.SetWidth( texture.GetWidth() );
504 mImageSize.SetHeight( texture.GetHeight() );
509 void AnimatedImageVisual::FrameReady( TextureSet textureSet )
511 SetImageSize( textureSet );
513 if( mStartFirstFrame )
515 StartFirstFrame( textureSet );
519 mImpl->mRenderer.SetTextures( textureSet );
523 bool AnimatedImageVisual::DisplayNextFrame()
525 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::DisplayNextFrame() start\n");
527 if( mFrameDelayContainer.Count() > 0 )
529 // Wrap the frame index
530 ++mCurrentFrameIndex;
531 mCurrentFrameIndex %= mFrameDelayContainer.Count();
533 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mTextureRectContainer[mCurrentFrameIndex] );
535 if( mFrameDelayTimer.GetInterval() != mFrameDelayContainer[mCurrentFrameIndex] )
537 mFrameDelayTimer.SetInterval( mFrameDelayContainer[mCurrentFrameIndex] );
540 else if( mImageCache )
542 TextureSet textureSet = mImageCache->NextFrame();
545 SetImageSize( textureSet );
546 mImpl->mRenderer.SetTextures( textureSet );
550 // Keep timer ticking
555 } // namespace Internal
557 } // namespace Toolkit