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()
124 void AnimatedVectorImageVisual::GetNaturalSize( Vector2& naturalSize )
126 if( mVisualSize != Vector2::ZERO )
128 naturalSize = mVisualSize;
132 uint32_t width, height;
133 mVectorAnimationTask->GetDefaultSize( width, height );
134 naturalSize.x = width;
135 naturalSize.y = height;
138 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::GetNaturalSize: w = %f, h = %f [%p]\n", naturalSize.width, naturalSize.height, this );
141 void AnimatedVectorImageVisual::DoCreatePropertyMap( Property::Map& map ) const
144 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE );
147 map.Insert( Toolkit::ImageVisual::Property::URL, mUrl.GetUrl() );
149 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, mLoopCount );
151 uint32_t startFrame, endFrame;
152 mVectorAnimationTask->GetPlayRange( startFrame, endFrame );
154 Property::Array playRange;
155 playRange.PushBack( static_cast< int32_t >( startFrame ) );
156 playRange.PushBack( static_cast< int32_t >( endFrame ) );
157 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_RANGE, playRange );
159 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast< int32_t >( mVectorAnimationTask->GetPlayState() ) );
160 map.Insert( Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetCurrentFrameNumber() ) );
161 map.Insert( Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetTotalFrameNumber() ) );
163 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
164 map.Insert( Toolkit::DevelImageVisual::Property::LOOPING_MODE, mLoopingMode );
166 Property::Map layerInfo;
167 mVectorAnimationTask->GetLayerInfo( layerInfo );
168 map.Insert( Toolkit::DevelImageVisual::Property::CONTENT_INFO, layerInfo );
171 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
176 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
178 // url already passed in from constructor
179 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
181 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
182 if( keyValue.first.type == Property::Key::INDEX )
184 DoSetProperty( keyValue.first.indexKey, keyValue.second );
188 if( keyValue.first == LOOP_COUNT_NAME )
190 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
192 else if( keyValue.first == PLAY_RANGE_NAME )
194 DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
196 else if( keyValue.first == STOP_BEHAVIOR_NAME )
198 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
200 else if( keyValue.first == LOOPING_MODE_NAME )
202 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second );
208 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
212 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
215 if( value.Get( loopCount ) )
217 mLoopCount = loopCount;
218 mResendFlag |= RESEND_LOOP_COUNT;
222 case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
224 Property::Array* array = value.GetArray();
227 size_t count = array->Count();
230 int startFrame, endFrame;
231 int totalFrame = mVectorAnimationTask->GetTotalFrameNumber();
232 array->GetElementAt( 0 ).Get( startFrame );
233 array->GetElementAt( 1 ).Get( endFrame );
235 if( startFrame >= 0 && startFrame < totalFrame && endFrame >= 0 && endFrame < totalFrame )
237 mStartFrame = startFrame;
238 mEndFrame = endFrame;
239 mResendFlag |= RESEND_PLAY_RANGE;
243 DALI_LOG_ERROR( "Invalid play range [%d, %d / %d]\n", startFrame, endFrame, totalFrame );
249 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
251 int32_t stopBehavior = mStopBehavior;
252 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
254 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
255 mResendFlag |= RESEND_STOP_BEHAVIOR;
259 case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
261 int32_t loopingMode = mLoopingMode;
262 if( Scripting::GetEnumerationProperty( value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode ) )
264 mLoopingMode = DevelImageVisual::LoopingMode::Type( loopingMode );
265 mResendFlag |= RESEND_LOOPING_MODE;
272 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
276 if( mImpl->mCustomShader )
278 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
279 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
280 mImpl->mCustomShader->mHints );
282 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
286 shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
289 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
291 mImpl->mRenderer = Renderer::New( geometry, shader );
293 TextureSet textureSet = TextureSet::New();
294 mImpl->mRenderer.SetTextures( textureSet );
296 // Register transform properties
297 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
299 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
301 // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
302 mPlacementActor = actor;
304 mVectorAnimationTask->SetRenderer( mImpl->mRenderer );
306 // Add property notification for scaling & size
307 mScaleNotification = actor.AddPropertyNotification( Actor::Property::WORLD_SCALE, StepCondition( 0.1f, 1.0f ) );
308 mScaleNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnScaleNotification );
310 mSizeNotification = actor.AddPropertyNotification( Actor::Property::SIZE, StepCondition( 3.0f ) );
311 mSizeNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnSizeNotification );
313 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnControlVisibilityChanged );
315 Window window = DevelWindow::Get( actor );
318 DevelWindow::VisibilityChangedSignal( window ).Connect( this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged );
321 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOnStage [%p]\n", this );
324 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
328 if( mImpl->mRenderer )
330 actor.RemoveRenderer( mImpl->mRenderer );
331 mImpl->mRenderer.Reset();
333 mRendererAdded = false;
336 // Remove property notification
337 actor.RemovePropertyNotification( mScaleNotification );
338 actor.RemovePropertyNotification( mSizeNotification );
340 DevelActor::VisibilityChangedSignal( actor ).Disconnect( this, &AnimatedVectorImageVisual::OnControlVisibilityChanged );
342 Window window = DevelWindow::Get( actor );
345 DevelWindow::VisibilityChangedSignal( window ).Disconnect( this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged );
348 mPlacementActor.Reset();
350 // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
351 mVisualSize = Vector2::ZERO;
352 mVisualScale = Vector2::ONE;
354 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOffStage [%p]\n", this );
357 void AnimatedVectorImageVisual::OnSetTransform()
359 Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
361 if( IsOnStage() && visualSize != mVisualSize )
363 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f [%p]\n", visualSize.width, visualSize.height, this );
365 mVisualSize = visualSize;
367 SetVectorImageSize();
371 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
373 mVectorAnimationTask->PlayAnimation();
375 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
380 mVectorAnimationTask->RenderFrame();
385 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
387 // Check if action is valid for this visual type and perform action if possible
390 case DevelAnimatedVectorImageVisual::Action::PLAY:
392 if( IsOnStage() && mVisualSize != Vector2::ZERO )
394 mVectorAnimationTask->PlayAnimation();
396 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
398 mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
401 case DevelAnimatedVectorImageVisual::Action::PAUSE:
403 mVectorAnimationTask->PauseAnimation();
405 if( mImpl->mRenderer )
407 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
410 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
413 case DevelAnimatedVectorImageVisual::Action::STOP:
415 if( mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::STOPPED )
417 mVectorAnimationTask->StopAnimation();
420 if( mImpl->mRenderer )
422 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
425 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
428 case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
431 if( attributes.Get( frameNumber ) )
433 mVectorAnimationTask->SetCurrentFrameNumber( frameNumber );
435 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
437 mVectorAnimationTask->RenderFrame();
438 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
443 case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
445 Property::Map* map = attributes.GetMap();
448 DoSetProperties( *map );
457 void AnimatedVectorImageVisual::OnUploadCompleted()
459 // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
460 Actor actor = mPlacementActor.GetHandle();
461 if( actor && !mRendererAdded )
463 actor.AddRenderer( mImpl->mRenderer );
464 mRendererAdded = true;
467 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
469 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnUploadCompleted: Renderer is added [%p]\n", this );
472 void AnimatedVectorImageVisual::OnAnimationFinished()
474 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnAnimationFinished: action state = %d [%p]\n", mActionStatus, this );
476 if( mActionStatus != DevelAnimatedVectorImageVisual::Action::STOP )
478 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
480 if( mImpl->mEventObserver )
482 mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
486 if( mImpl->mRenderer )
488 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
492 void AnimatedVectorImageVisual::SendAnimationData()
496 bool isPlaying = false;
497 if( mVectorAnimationTask->GetPlayState() == DevelImageVisual::PlayState::PLAYING )
499 mVectorAnimationTask->PauseAnimation();
503 if( mResendFlag & RESEND_LOOP_COUNT )
505 mVectorAnimationTask->SetLoopCount( mLoopCount );
508 if( mResendFlag & RESEND_PLAY_RANGE )
510 mVectorAnimationTask->SetPlayRange( mStartFrame, mEndFrame );
513 if( mResendFlag & RESEND_STOP_BEHAVIOR )
515 mVectorAnimationTask->SetStopBehavior( mStopBehavior );
518 if( mResendFlag & RESEND_LOOPING_MODE )
520 mVectorAnimationTask->SetLoopingMode( mLoopingMode );
527 mVectorAnimationTask->PlayAnimation();
531 mVectorAnimationTask->RenderFrame();
532 Stage::GetCurrent().KeepRendering( 0.0f );
540 void AnimatedVectorImageVisual::SetVectorImageSize()
542 uint32_t width = static_cast< uint32_t >( mVisualSize.width * mVisualScale.width );
543 uint32_t height = static_cast< uint32_t >( mVisualSize.height * mVisualScale.height );
545 mVectorAnimationTask->SetSize( width, height );
547 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
549 mVectorAnimationTask->RenderFrame();
550 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
554 void AnimatedVectorImageVisual::PauseAnimation()
556 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
558 mVectorAnimationTask->PauseAnimation();
560 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
562 if( mImpl->mRenderer )
564 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
569 void AnimatedVectorImageVisual::OnScaleNotification( PropertyNotification& source )
571 Actor actor = mPlacementActor.GetHandle();
574 Vector3 scale = actor.GetProperty< Vector3 >( Actor::Property::WORLD_SCALE );
575 mVisualScale.width = scale.width;
576 mVisualScale.height = scale.height;
578 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnScaleNotification: scale = %f, %f [%p]\n", mVisualScale.width, mVisualScale.height, this );
580 SetVectorImageSize();
584 void AnimatedVectorImageVisual::OnSizeNotification( PropertyNotification& source )
586 Actor actor = mPlacementActor.GetHandle();
589 Vector3 size = actor.GetCurrentSize();
590 mVisualSize.width = size.width;
591 mVisualSize.height = size.height;
593 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSizeNotification: size = %f, %f [%p]\n", mVisualSize.width, mVisualSize.height, this );
595 SetVectorImageSize();
599 void AnimatedVectorImageVisual::OnControlVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type )
605 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnControlVisibilityChanged: invisibile. Pause animation [%p]\n", this );
609 void AnimatedVectorImageVisual::OnWindowVisibilityChanged( Window window, bool visible )
615 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnWindowVisibilityChanged: invisibile. Pause animation [%p]\n", this );
619 } // namespace Internal
621 } // namespace Toolkit