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 );
166 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
171 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
173 // url already passed in from constructor
174 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
176 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
177 if( keyValue.first.type == Property::Key::INDEX )
179 DoSetProperty( keyValue.first.indexKey, keyValue.second );
183 if( keyValue.first == LOOP_COUNT_NAME )
185 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
187 else if( keyValue.first == PLAY_RANGE_NAME )
189 DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
191 else if( keyValue.first == STOP_BEHAVIOR_NAME )
193 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
195 else if( keyValue.first == LOOPING_MODE_NAME )
197 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second );
203 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
207 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
210 if( value.Get( loopCount ) )
212 mLoopCount = loopCount;
213 mResendFlag |= RESEND_LOOP_COUNT;
217 case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
219 Property::Array* array = value.GetArray();
222 size_t count = array->Count();
225 int startFrame, endFrame;
226 int totalFrame = mVectorAnimationTask->GetTotalFrameNumber();
227 array->GetElementAt( 0 ).Get( startFrame );
228 array->GetElementAt( 1 ).Get( endFrame );
230 if( startFrame >= 0 && startFrame < totalFrame && endFrame >= 0 && endFrame < totalFrame )
232 mStartFrame = startFrame;
233 mEndFrame = endFrame;
234 mResendFlag |= RESEND_PLAY_RANGE;
238 DALI_LOG_ERROR( "Invalid play range [%d, %d / %d]\n", startFrame, endFrame, totalFrame );
244 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
246 int32_t stopBehavior = mStopBehavior;
247 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
249 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
250 mResendFlag |= RESEND_STOP_BEHAVIOR;
254 case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
256 int32_t loopingMode = mLoopingMode;
257 if( Scripting::GetEnumerationProperty( value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode ) )
259 mLoopingMode = DevelImageVisual::LoopingMode::Type( loopingMode );
260 mResendFlag |= RESEND_LOOPING_MODE;
267 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
271 if( mImpl->mCustomShader )
273 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
274 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
275 mImpl->mCustomShader->mHints );
277 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
281 shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
284 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
286 mImpl->mRenderer = Renderer::New( geometry, shader );
288 TextureSet textureSet = TextureSet::New();
289 mImpl->mRenderer.SetTextures( textureSet );
291 // Register transform properties
292 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
294 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
296 // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
297 mPlacementActor = actor;
299 mVectorAnimationTask->SetRenderer( mImpl->mRenderer );
301 // Add property notification for scaling & size
302 mScaleNotification = actor.AddPropertyNotification( Actor::Property::WORLD_SCALE, StepCondition( 0.1f, 1.0f ) );
303 mScaleNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnScaleNotification );
305 mSizeNotification = actor.AddPropertyNotification( Actor::Property::SIZE, StepCondition( 3.0f ) );
306 mSizeNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnSizeNotification );
308 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnVisibilityChanged );
310 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOnStage [%p]\n", this );
313 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
315 mVectorAnimationTask->PauseAnimation();
317 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
319 if( mImpl->mRenderer )
321 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
323 actor.RemoveRenderer( mImpl->mRenderer );
324 mImpl->mRenderer.Reset();
326 mRendererAdded = false;
329 // Remove property notification
330 actor.RemovePropertyNotification( mScaleNotification );
331 actor.RemovePropertyNotification( mSizeNotification );
333 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnVisibilityChanged );
335 mPlacementActor.Reset();
337 // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
338 mVisualSize = Vector2::ZERO;
339 mVisualScale = Vector2::ONE;
341 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOffStage [%p]\n", this );
344 void AnimatedVectorImageVisual::OnSetTransform()
346 Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
348 if( IsOnStage() && visualSize != mVisualSize )
350 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f [%p]\n", visualSize.width, visualSize.height, this );
352 mVisualSize = visualSize;
354 SetVectorImageSize();
358 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
360 mVectorAnimationTask->PlayAnimation();
362 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
367 mVectorAnimationTask->RenderFrame();
372 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
374 // Check if action is valid for this visual type and perform action if possible
377 case DevelAnimatedVectorImageVisual::Action::PLAY:
379 if( IsOnStage() && mVisualSize != Vector2::ZERO )
381 mVectorAnimationTask->PlayAnimation();
383 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
385 mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
388 case DevelAnimatedVectorImageVisual::Action::PAUSE:
390 mVectorAnimationTask->PauseAnimation();
392 if( mImpl->mRenderer )
394 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
397 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
400 case DevelAnimatedVectorImageVisual::Action::STOP:
402 if( mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::STOPPED )
404 mVectorAnimationTask->StopAnimation();
407 if( mImpl->mRenderer )
409 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
412 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
415 case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
418 if( attributes.Get( frameNumber ) )
420 mVectorAnimationTask->SetCurrentFrameNumber( frameNumber );
422 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
424 mVectorAnimationTask->RenderFrame();
425 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
430 case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
432 Property::Map* map = attributes.GetMap();
435 DoSetProperties( *map );
444 void AnimatedVectorImageVisual::OnUploadCompleted()
446 // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
447 Actor actor = mPlacementActor.GetHandle();
448 if( actor && !mRendererAdded )
450 actor.AddRenderer( mImpl->mRenderer );
451 mRendererAdded = true;
454 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
456 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnUploadCompleted: Renderer is added [%p]\n", this );
459 void AnimatedVectorImageVisual::OnAnimationFinished()
461 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnAnimationFinished: action state = %d [%p]\n", mActionStatus, this );
463 if( mActionStatus != DevelAnimatedVectorImageVisual::Action::STOP )
465 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
467 if( mImpl->mEventObserver )
469 mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
473 if( mImpl->mRenderer )
475 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
479 void AnimatedVectorImageVisual::SendAnimationData()
483 bool isPlaying = false;
484 if( mVectorAnimationTask->GetPlayState() == DevelImageVisual::PlayState::PLAYING )
486 mVectorAnimationTask->PauseAnimation();
490 if( mResendFlag & RESEND_LOOP_COUNT )
492 mVectorAnimationTask->SetLoopCount( mLoopCount );
495 if( mResendFlag & RESEND_PLAY_RANGE )
497 mVectorAnimationTask->SetPlayRange( mStartFrame, mEndFrame );
500 if( mResendFlag & RESEND_STOP_BEHAVIOR )
502 mVectorAnimationTask->SetStopBehavior( mStopBehavior );
505 if( mResendFlag & RESEND_LOOPING_MODE )
507 mVectorAnimationTask->SetLoopingMode( mLoopingMode );
514 mVectorAnimationTask->PlayAnimation();
518 mVectorAnimationTask->RenderFrame();
519 Stage::GetCurrent().KeepRendering( 0.0f );
527 void AnimatedVectorImageVisual::SetVectorImageSize()
529 uint32_t width = static_cast< uint32_t >( mVisualSize.width * mVisualScale.width );
530 uint32_t height = static_cast< uint32_t >( mVisualSize.height * mVisualScale.height );
532 mVectorAnimationTask->SetSize( width, height );
534 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
536 mVectorAnimationTask->RenderFrame();
537 Stage::GetCurrent().KeepRendering( 0.0f ); // Trigger rendering
541 void AnimatedVectorImageVisual::OnScaleNotification( PropertyNotification& source )
543 Actor actor = mPlacementActor.GetHandle();
546 Vector3 scale = actor.GetProperty< Vector3 >( Actor::Property::WORLD_SCALE );
547 mVisualScale.width = scale.width;
548 mVisualScale.height = scale.height;
550 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnScaleNotification: scale = %f, %f [%p]\n", mVisualScale.width, mVisualScale.height, this );
552 SetVectorImageSize();
556 void AnimatedVectorImageVisual::OnSizeNotification( PropertyNotification& source )
558 Actor actor = mPlacementActor.GetHandle();
561 Vector3 size = actor.GetCurrentSize();
562 mVisualSize.width = size.width;
563 mVisualSize.height = size.height;
565 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSizeNotification: size = %f, %f [%p]\n", mVisualSize.width, mVisualSize.height, this );
567 SetVectorImageSize();
571 void AnimatedVectorImageVisual::OnVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type )
575 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
577 mVectorAnimationTask->PauseAnimation();
579 if( mImpl->mRenderer )
581 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
584 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
586 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnVisibilityChanged: invisibile. Pause animation [%p]\n", this );
591 } // namespace Internal
593 } // namespace Toolkit