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/devel-api/adaptor-framework/window-devel.h>
25 #include <dali/integration-api/debug.h>
28 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
29 #include <dali-toolkit/public-api/visuals/visual-properties.h>
30 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
31 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-signals-devel.h>
32 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
35 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
49 constexpr auto LOOP_FOREVER = -1;
51 const Dali::Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
53 // Flags for re-sending data to the rasterize thread
56 RESEND_PLAY_RANGE = 1 << 0,
57 RESEND_LOOP_COUNT = 1 << 1,
58 RESEND_STOP_BEHAVIOR = 1 << 2,
59 RESEND_LOOPING_MODE = 1 << 3
63 DALI_ENUM_TO_STRING_TABLE_BEGIN( STOP_BEHAVIOR )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME )
65 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME )
66 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME )
67 DALI_ENUM_TO_STRING_TABLE_END( STOP_BEHAVIOR )
70 DALI_ENUM_TO_STRING_TABLE_BEGIN( LOOPING_MODE )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::LoopingMode, RESTART )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::LoopingMode, AUTO_REVERSE )
73 DALI_ENUM_TO_STRING_TABLE_END( LOOPING_MODE )
75 #if defined(DEBUG_ENABLED)
76 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VECTOR_ANIMATION" );
79 } // unnamed namespace
81 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties )
83 AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
84 visual->SetProperties( properties );
89 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
91 AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
96 AnimatedVectorImageVisual::AnimatedVectorImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
97 : Visual::Base( factoryCache, Visual::FittingMode::FILL ),
99 mVectorAnimationTask( new VectorAnimationTask( factoryCache, imageUrl.GetUrl() ) ),
100 mImageVisualShaderFactory( shaderFactory ),
102 mVisualScale( Vector2::ONE ),
104 mLoopCount( LOOP_FOREVER ),
108 mActionStatus( DevelAnimatedVectorImageVisual::Action::STOP ),
109 mStopBehavior( DevelImageVisual::StopBehavior::CURRENT_FRAME ),
110 mLoopingMode( DevelImageVisual::LoopingMode::RESTART ),
111 mRendererAdded( false )
113 // the rasterized image is with pre-multiplied alpha format
114 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
116 mVectorAnimationTask->UploadCompletedSignal().Connect( this, &AnimatedVectorImageVisual::OnUploadCompleted );
117 mVectorAnimationTask->SetAnimationFinishedCallback( new EventThreadCallback( MakeCallback( this, &AnimatedVectorImageVisual::OnAnimationFinished ) ) );
120 AnimatedVectorImageVisual::~AnimatedVectorImageVisual()
122 // Finalize animation task in the main thread
123 mVectorAnimationTask->Finalize();
126 void AnimatedVectorImageVisual::GetNaturalSize( Vector2& naturalSize )
128 if( mVisualSize != Vector2::ZERO )
130 naturalSize = mVisualSize;
134 uint32_t width, height;
135 mVectorAnimationTask->GetDefaultSize( width, height );
136 naturalSize.x = width;
137 naturalSize.y = height;
140 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::GetNaturalSize: w = %f, h = %f [%p]\n", naturalSize.width, naturalSize.height, this );
143 void AnimatedVectorImageVisual::DoCreatePropertyMap( Property::Map& map ) const
146 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE );
149 map.Insert( Toolkit::ImageVisual::Property::URL, mUrl.GetUrl() );
151 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, mLoopCount );
153 uint32_t startFrame, endFrame;
154 mVectorAnimationTask->GetPlayRange( startFrame, endFrame );
156 Property::Array playRange;
157 playRange.PushBack( static_cast< int32_t >( startFrame ) );
158 playRange.PushBack( static_cast< int32_t >( endFrame ) );
159 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_RANGE, playRange );
161 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast< int32_t >( mVectorAnimationTask->GetPlayState() ) );
162 map.Insert( Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetCurrentFrameNumber() ) );
163 map.Insert( Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetTotalFrameNumber() ) );
165 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
166 map.Insert( Toolkit::DevelImageVisual::Property::LOOPING_MODE, mLoopingMode );
168 Property::Map layerInfo;
169 mVectorAnimationTask->GetLayerInfo( layerInfo );
170 map.Insert( Toolkit::DevelImageVisual::Property::CONTENT_INFO, layerInfo );
173 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
178 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
180 // url already passed in from constructor
181 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
183 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
184 if( keyValue.first.type == Property::Key::INDEX )
186 DoSetProperty( keyValue.first.indexKey, keyValue.second );
190 if( keyValue.first == LOOP_COUNT_NAME )
192 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
194 else if( keyValue.first == PLAY_RANGE_NAME )
196 DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
198 else if( keyValue.first == STOP_BEHAVIOR_NAME )
200 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
202 else if( keyValue.first == LOOPING_MODE_NAME )
204 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second );
210 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
214 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
217 if( value.Get( loopCount ) )
219 mLoopCount = loopCount;
220 mResendFlag |= RESEND_LOOP_COUNT;
224 case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
226 Property::Array* array = value.GetArray();
229 size_t count = array->Count();
232 int startFrame, endFrame;
233 int totalFrame = mVectorAnimationTask->GetTotalFrameNumber();
234 array->GetElementAt( 0 ).Get( startFrame );
235 array->GetElementAt( 1 ).Get( endFrame );
237 if( startFrame >= 0 && startFrame < totalFrame && endFrame >= 0 && endFrame < totalFrame )
239 mStartFrame = startFrame;
240 mEndFrame = endFrame;
241 mResendFlag |= RESEND_PLAY_RANGE;
245 DALI_LOG_ERROR( "Invalid play range [%d, %d / %d]\n", startFrame, endFrame, totalFrame );
251 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
253 int32_t stopBehavior = mStopBehavior;
254 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
256 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
257 mResendFlag |= RESEND_STOP_BEHAVIOR;
261 case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
263 int32_t loopingMode = mLoopingMode;
264 if( Scripting::GetEnumerationProperty( value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode ) )
266 mLoopingMode = DevelImageVisual::LoopingMode::Type( loopingMode );
267 mResendFlag |= RESEND_LOOPING_MODE;
274 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
278 if( mImpl->mCustomShader )
280 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
281 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
282 mImpl->mCustomShader->mHints );
284 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
288 shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
291 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
293 mImpl->mRenderer = Renderer::New( geometry, shader );
295 TextureSet textureSet = TextureSet::New();
296 mImpl->mRenderer.SetTextures( textureSet );
298 // Register transform properties
299 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
301 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
303 // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
304 mPlacementActor = actor;
306 mVectorAnimationTask->SetRenderer( mImpl->mRenderer );
308 // Add property notification for scaling & size
309 mScaleNotification = actor.AddPropertyNotification( Actor::Property::WORLD_SCALE, StepCondition( 0.1f, 1.0f ) );
310 mScaleNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnScaleNotification );
312 mSizeNotification = actor.AddPropertyNotification( Actor::Property::SIZE, StepCondition( 3.0f ) );
313 mSizeNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnSizeNotification );
315 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnControlVisibilityChanged );
317 Window window = DevelWindow::Get( actor );
320 DevelWindow::VisibilityChangedSignal( window ).Connect( this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged );
323 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOnStage [%p]\n", this );
326 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
330 if( mImpl->mRenderer )
332 actor.RemoveRenderer( mImpl->mRenderer );
333 mImpl->mRenderer.Reset();
335 mRendererAdded = false;
338 // Remove property notification
339 actor.RemovePropertyNotification( mScaleNotification );
340 actor.RemovePropertyNotification( mSizeNotification );
342 DevelActor::VisibilityChangedSignal( actor ).Disconnect( this, &AnimatedVectorImageVisual::OnControlVisibilityChanged );
344 Window window = DevelWindow::Get( actor );
347 DevelWindow::VisibilityChangedSignal( window ).Disconnect( this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged );
350 mPlacementActor.Reset();
352 // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
353 mVisualSize = Vector2::ZERO;
354 mVisualScale = Vector2::ONE;
356 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOffStage [%p]\n", this );
359 void AnimatedVectorImageVisual::OnSetTransform()
361 Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
363 if( IsOnStage() && visualSize != mVisualSize )
365 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f [%p]\n", visualSize.width, visualSize.height, this );
367 mVisualSize = visualSize;
369 SetVectorImageSize();
373 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
375 mVectorAnimationTask->PlayAnimation();
377 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
382 mVectorAnimationTask->RenderFrame();
387 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
389 // Check if action is valid for this visual type and perform action if possible
392 case DevelAnimatedVectorImageVisual::Action::PLAY:
394 if( IsOnStage() && mVisualSize != Vector2::ZERO )
396 mVectorAnimationTask->PlayAnimation();
398 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
400 mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
403 case DevelAnimatedVectorImageVisual::Action::PAUSE:
405 mVectorAnimationTask->PauseAnimation();
407 if( mImpl->mRenderer )
409 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
412 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
415 case DevelAnimatedVectorImageVisual::Action::STOP:
417 if( mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::STOPPED )
419 mVectorAnimationTask->StopAnimation();
422 if( mImpl->mRenderer )
424 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
427 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
430 case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
433 if( attributes.Get( frameNumber ) )
435 mVectorAnimationTask->SetCurrentFrameNumber( frameNumber );
437 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
439 mVectorAnimationTask->RenderFrame();
440 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
445 case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
447 Property::Map* map = attributes.GetMap();
450 DoSetProperties( *map );
459 void AnimatedVectorImageVisual::OnUploadCompleted()
461 // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
462 Actor actor = mPlacementActor.GetHandle();
463 if( actor && !mRendererAdded )
465 actor.AddRenderer( mImpl->mRenderer );
466 mRendererAdded = true;
468 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
470 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnUploadCompleted: Renderer is added [%p]\n", this );
474 void AnimatedVectorImageVisual::OnAnimationFinished()
476 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnAnimationFinished: action state = %d [%p]\n", mActionStatus, this );
478 if( mActionStatus != DevelAnimatedVectorImageVisual::Action::STOP )
480 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
482 if( mImpl->mEventObserver )
484 mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
488 if( mImpl->mRenderer )
490 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
494 void AnimatedVectorImageVisual::SendAnimationData()
498 bool isPlaying = false;
499 if( mVectorAnimationTask->GetPlayState() == DevelImageVisual::PlayState::PLAYING )
501 mVectorAnimationTask->PauseAnimation();
505 if( mResendFlag & RESEND_LOOP_COUNT )
507 mVectorAnimationTask->SetLoopCount( mLoopCount );
510 if( mResendFlag & RESEND_PLAY_RANGE )
512 mVectorAnimationTask->SetPlayRange( mStartFrame, mEndFrame );
515 if( mResendFlag & RESEND_STOP_BEHAVIOR )
517 mVectorAnimationTask->SetStopBehavior( mStopBehavior );
520 if( mResendFlag & RESEND_LOOPING_MODE )
522 mVectorAnimationTask->SetLoopingMode( mLoopingMode );
529 mVectorAnimationTask->PlayAnimation();
533 mVectorAnimationTask->RenderFrame();
534 Stage::GetCurrent().KeepRendering( 0.0f );
542 void AnimatedVectorImageVisual::SetVectorImageSize()
544 uint32_t width = static_cast< uint32_t >( mVisualSize.width * mVisualScale.width );
545 uint32_t height = static_cast< uint32_t >( mVisualSize.height * mVisualScale.height );
547 mVectorAnimationTask->SetSize( width, height );
549 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
551 mVectorAnimationTask->RenderFrame();
552 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
556 void AnimatedVectorImageVisual::PauseAnimation()
558 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
560 mVectorAnimationTask->PauseAnimation();
562 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
564 if( mImpl->mRenderer )
566 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
571 void AnimatedVectorImageVisual::OnScaleNotification( PropertyNotification& source )
573 Actor actor = mPlacementActor.GetHandle();
576 Vector3 scale = actor.GetProperty< Vector3 >( Actor::Property::WORLD_SCALE );
577 mVisualScale.width = scale.width;
578 mVisualScale.height = scale.height;
580 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnScaleNotification: scale = %f, %f [%p]\n", mVisualScale.width, mVisualScale.height, this );
582 SetVectorImageSize();
586 void AnimatedVectorImageVisual::OnSizeNotification( PropertyNotification& source )
588 Actor actor = mPlacementActor.GetHandle();
591 Vector3 size = actor.GetCurrentSize();
592 mVisualSize.width = size.width;
593 mVisualSize.height = size.height;
595 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSizeNotification: size = %f, %f [%p]\n", mVisualSize.width, mVisualSize.height, this );
597 SetVectorImageSize();
601 void AnimatedVectorImageVisual::OnControlVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type )
607 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnControlVisibilityChanged: invisibile. Pause animation [%p]\n", this );
611 void AnimatedVectorImageVisual::OnWindowVisibilityChanged( Window window, bool visible )
617 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnWindowVisibilityChanged: invisibile. Pause animation [%p]\n", this );
621 } // namespace Internal
623 } // namespace Toolkit