2 * Copyright (c) 2019 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 <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
22 #include <dali/public-api/common/stage.h>
23 #include <dali/devel-api/rendering/renderer-devel.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/devel-api/visuals/image-visual-properties-devel.h>
30 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-signals-devel.h>
31 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
32 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
33 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
48 constexpr auto LOOP_FOREVER = -1;
50 const Dali::Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
52 // Flags for re-sending data to the rasterize thread
55 RESEND_PLAY_RANGE = 1 << 0,
56 RESEND_LOOP_COUNT = 1 << 1,
57 RESEND_STOP_BEHAVIOR = 1 << 2,
58 RESEND_LOOPING_MODE = 1 << 3
62 DALI_ENUM_TO_STRING_TABLE_BEGIN( STOP_BEHAVIOR )
63 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME )
65 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME )
66 DALI_ENUM_TO_STRING_TABLE_END( STOP_BEHAVIOR )
69 DALI_ENUM_TO_STRING_TABLE_BEGIN( LOOPING_MODE )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::LoopingMode, RESTART )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::LoopingMode, AUTO_REVERSE )
72 DALI_ENUM_TO_STRING_TABLE_END( LOOPING_MODE )
74 #if defined(DEBUG_ENABLED)
75 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VECTOR_ANIMATION" );
78 } // unnamed namespace
80 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties )
82 AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
83 visual->SetProperties( properties );
88 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
90 AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
95 AnimatedVectorImageVisual::AnimatedVectorImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
96 : Visual::Base( factoryCache, Visual::FittingMode::FILL ),
98 mVectorAnimationTask( new VectorAnimationTask( factoryCache, imageUrl.GetUrl() ) ),
99 mImageVisualShaderFactory( shaderFactory ),
101 mVisualScale( Vector2::ONE ),
103 mLoopCount( LOOP_FOREVER ),
107 mActionStatus( DevelAnimatedVectorImageVisual::Action::STOP ),
108 mStopBehavior( DevelImageVisual::StopBehavior::CURRENT_FRAME ),
109 mLoopingMode( DevelImageVisual::LoopingMode::RESTART ),
110 mRendererAdded( false )
112 // the rasterized image is with pre-multiplied alpha format
113 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
115 mVectorAnimationTask->UploadCompletedSignal().Connect( this, &AnimatedVectorImageVisual::OnUploadCompleted );
116 mVectorAnimationTask->SetAnimationFinishedCallback( new EventThreadCallback( MakeCallback( this, &AnimatedVectorImageVisual::OnAnimationFinished ) ) );
119 AnimatedVectorImageVisual::~AnimatedVectorImageVisual()
123 void AnimatedVectorImageVisual::GetNaturalSize( Vector2& naturalSize )
125 if( mVisualSize != Vector2::ZERO )
127 naturalSize = mVisualSize;
131 uint32_t width, height;
132 mVectorAnimationTask->GetDefaultSize( width, height );
133 naturalSize.x = width;
134 naturalSize.y = height;
137 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::GetNaturalSize: w = %f, h = %f [%p]\n", naturalSize.width, naturalSize.height, this );
140 void AnimatedVectorImageVisual::DoCreatePropertyMap( Property::Map& map ) const
143 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE );
146 map.Insert( Toolkit::ImageVisual::Property::URL, mUrl.GetUrl() );
148 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, mLoopCount );
150 uint32_t startFrame, endFrame;
151 mVectorAnimationTask->GetPlayRange( startFrame, endFrame );
153 Property::Array playRange;
154 playRange.PushBack( static_cast< int32_t >( startFrame ) );
155 playRange.PushBack( static_cast< int32_t >( endFrame ) );
156 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_RANGE, playRange );
158 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast< int32_t >( mVectorAnimationTask->GetPlayState() ) );
159 map.Insert( Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetCurrentFrameNumber() ) );
160 map.Insert( Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetTotalFrameNumber() ) );
162 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
163 map.Insert( Toolkit::DevelImageVisual::Property::LOOPING_MODE, mLoopingMode );
165 Property::Map layerInfo;
166 mVectorAnimationTask->GetLayerInfo( layerInfo );
167 map.Insert( Toolkit::DevelImageVisual::Property::CONTENT_INFO, layerInfo );
170 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
175 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
177 // url already passed in from constructor
178 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
180 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
181 if( keyValue.first.type == Property::Key::INDEX )
183 DoSetProperty( keyValue.first.indexKey, keyValue.second );
187 if( keyValue.first == LOOP_COUNT_NAME )
189 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
191 else if( keyValue.first == PLAY_RANGE_NAME )
193 DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
195 else if( keyValue.first == STOP_BEHAVIOR_NAME )
197 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
199 else if( keyValue.first == LOOPING_MODE_NAME )
201 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second );
207 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
211 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
214 if( value.Get( loopCount ) )
216 mLoopCount = loopCount;
217 mResendFlag |= RESEND_LOOP_COUNT;
221 case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
223 Property::Array* array = value.GetArray();
226 size_t count = array->Count();
229 int startFrame, endFrame;
230 int totalFrame = mVectorAnimationTask->GetTotalFrameNumber();
231 array->GetElementAt( 0 ).Get( startFrame );
232 array->GetElementAt( 1 ).Get( endFrame );
234 if( startFrame >= 0 && startFrame < totalFrame && endFrame >= 0 && endFrame < totalFrame )
236 mStartFrame = startFrame;
237 mEndFrame = endFrame;
238 mResendFlag |= RESEND_PLAY_RANGE;
242 DALI_LOG_ERROR( "Invalid play range [%d, %d / %d]\n", startFrame, endFrame, totalFrame );
248 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
250 int32_t stopBehavior = mStopBehavior;
251 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
253 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
254 mResendFlag |= RESEND_STOP_BEHAVIOR;
258 case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
260 int32_t loopingMode = mLoopingMode;
261 if( Scripting::GetEnumerationProperty( value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode ) )
263 mLoopingMode = DevelImageVisual::LoopingMode::Type( loopingMode );
264 mResendFlag |= RESEND_LOOPING_MODE;
271 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
275 if( mImpl->mCustomShader )
277 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
278 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
279 mImpl->mCustomShader->mHints );
281 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
285 shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
288 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
290 mImpl->mRenderer = Renderer::New( geometry, shader );
292 TextureSet textureSet = TextureSet::New();
293 mImpl->mRenderer.SetTextures( textureSet );
295 // Register transform properties
296 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
298 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
300 // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
301 mPlacementActor = actor;
303 mVectorAnimationTask->SetRenderer( mImpl->mRenderer );
305 // Add property notification for scaling & size
306 mScaleNotification = actor.AddPropertyNotification( Actor::Property::WORLD_SCALE, StepCondition( 0.1f, 1.0f ) );
307 mScaleNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnScaleNotification );
309 mSizeNotification = actor.AddPropertyNotification( Actor::Property::SIZE, StepCondition( 3.0f ) );
310 mSizeNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnSizeNotification );
312 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnVisibilityChanged );
314 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOnStage [%p]\n", this );
317 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
319 mVectorAnimationTask->PauseAnimation();
321 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
323 if( mImpl->mRenderer )
325 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
327 actor.RemoveRenderer( mImpl->mRenderer );
328 mImpl->mRenderer.Reset();
330 mRendererAdded = false;
333 // Remove property notification
334 actor.RemovePropertyNotification( mScaleNotification );
335 actor.RemovePropertyNotification( mSizeNotification );
337 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnVisibilityChanged );
339 mPlacementActor.Reset();
341 // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
342 mVisualSize = Vector2::ZERO;
343 mVisualScale = Vector2::ONE;
345 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOffStage [%p]\n", this );
348 void AnimatedVectorImageVisual::OnSetTransform()
350 Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
352 if( IsOnStage() && visualSize != mVisualSize )
354 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f [%p]\n", visualSize.width, visualSize.height, this );
356 mVisualSize = visualSize;
358 SetVectorImageSize();
362 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
364 mVectorAnimationTask->PlayAnimation();
366 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
371 mVectorAnimationTask->RenderFrame();
376 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
378 // Check if action is valid for this visual type and perform action if possible
381 case DevelAnimatedVectorImageVisual::Action::PLAY:
383 if( IsOnStage() && mVisualSize != Vector2::ZERO )
385 mVectorAnimationTask->PlayAnimation();
387 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
389 mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
392 case DevelAnimatedVectorImageVisual::Action::PAUSE:
394 mVectorAnimationTask->PauseAnimation();
396 if( mImpl->mRenderer )
398 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
401 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
404 case DevelAnimatedVectorImageVisual::Action::STOP:
406 if( mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::STOPPED )
408 mVectorAnimationTask->StopAnimation();
411 if( mImpl->mRenderer )
413 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
416 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
419 case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
422 if( attributes.Get( frameNumber ) )
424 mVectorAnimationTask->SetCurrentFrameNumber( frameNumber );
426 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
428 mVectorAnimationTask->RenderFrame();
429 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
434 case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
436 Property::Map* map = attributes.GetMap();
439 DoSetProperties( *map );
448 void AnimatedVectorImageVisual::OnUploadCompleted()
450 // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
451 Actor actor = mPlacementActor.GetHandle();
452 if( actor && !mRendererAdded )
454 actor.AddRenderer( mImpl->mRenderer );
455 mRendererAdded = true;
458 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
460 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnUploadCompleted: Renderer is added [%p]\n", this );
463 void AnimatedVectorImageVisual::OnAnimationFinished()
465 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnAnimationFinished: action state = %d [%p]\n", mActionStatus, this );
467 if( mActionStatus != DevelAnimatedVectorImageVisual::Action::STOP )
469 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
471 if( mImpl->mEventObserver )
473 mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
477 if( mImpl->mRenderer )
479 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
483 void AnimatedVectorImageVisual::SendAnimationData()
487 bool isPlaying = false;
488 if( mVectorAnimationTask->GetPlayState() == DevelImageVisual::PlayState::PLAYING )
490 mVectorAnimationTask->PauseAnimation();
494 if( mResendFlag & RESEND_LOOP_COUNT )
496 mVectorAnimationTask->SetLoopCount( mLoopCount );
499 if( mResendFlag & RESEND_PLAY_RANGE )
501 mVectorAnimationTask->SetPlayRange( mStartFrame, mEndFrame );
504 if( mResendFlag & RESEND_STOP_BEHAVIOR )
506 mVectorAnimationTask->SetStopBehavior( mStopBehavior );
509 if( mResendFlag & RESEND_LOOPING_MODE )
511 mVectorAnimationTask->SetLoopingMode( mLoopingMode );
518 mVectorAnimationTask->PlayAnimation();
522 mVectorAnimationTask->RenderFrame();
523 Stage::GetCurrent().KeepRendering( 0.0f );
531 void AnimatedVectorImageVisual::SetVectorImageSize()
533 uint32_t width = static_cast< uint32_t >( mVisualSize.width * mVisualScale.width );
534 uint32_t height = static_cast< uint32_t >( mVisualSize.height * mVisualScale.height );
536 mVectorAnimationTask->SetSize( width, height );
538 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
540 mVectorAnimationTask->RenderFrame();
541 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
545 void AnimatedVectorImageVisual::OnScaleNotification( PropertyNotification& source )
547 Actor actor = mPlacementActor.GetHandle();
550 Vector3 scale = actor.GetProperty< Vector3 >( Actor::Property::WORLD_SCALE );
551 mVisualScale.width = scale.width;
552 mVisualScale.height = scale.height;
554 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnScaleNotification: scale = %f, %f [%p]\n", mVisualScale.width, mVisualScale.height, this );
556 SetVectorImageSize();
560 void AnimatedVectorImageVisual::OnSizeNotification( PropertyNotification& source )
562 Actor actor = mPlacementActor.GetHandle();
565 Vector3 size = actor.GetCurrentSize();
566 mVisualSize.width = size.width;
567 mVisualSize.height = size.height;
569 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSizeNotification: size = %f, %f [%p]\n", mVisualSize.width, mVisualSize.height, this );
571 SetVectorImageSize();
575 void AnimatedVectorImageVisual::OnVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type )
579 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
581 mVectorAnimationTask->PauseAnimation();
583 if( mImpl->mRenderer )
585 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
588 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
590 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnVisibilityChanged: invisibile. Pause animation [%p]\n", this );
595 } // namespace Internal
597 } // namespace Toolkit