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 and disconnect the signal in the main thread
123 mVectorAnimationTask->UploadCompletedSignal().Disconnect( this, &AnimatedVectorImageVisual::OnUploadCompleted );
124 mVectorAnimationTask->Finalize();
127 void AnimatedVectorImageVisual::GetNaturalSize( Vector2& naturalSize )
129 if( mVisualSize != Vector2::ZERO )
131 naturalSize = mVisualSize;
135 uint32_t width, height;
136 mVectorAnimationTask->GetDefaultSize( width, height );
137 naturalSize.x = width;
138 naturalSize.y = height;
141 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::GetNaturalSize: w = %f, h = %f [%p]\n", naturalSize.width, naturalSize.height, this );
144 void AnimatedVectorImageVisual::DoCreatePropertyMap( Property::Map& map ) const
147 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE );
150 map.Insert( Toolkit::ImageVisual::Property::URL, mUrl.GetUrl() );
152 map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, mLoopCount );
154 uint32_t startFrame, endFrame;
155 mVectorAnimationTask->GetPlayRange( startFrame, endFrame );
157 Property::Array playRange;
158 playRange.PushBack( static_cast< int32_t >( startFrame ) );
159 playRange.PushBack( static_cast< int32_t >( endFrame ) );
160 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_RANGE, playRange );
162 map.Insert( Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast< int32_t >( mVectorAnimationTask->GetPlayState() ) );
163 map.Insert( Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetCurrentFrameNumber() ) );
164 map.Insert( Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, static_cast< int32_t >( mVectorAnimationTask->GetTotalFrameNumber() ) );
166 map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
167 map.Insert( Toolkit::DevelImageVisual::Property::LOOPING_MODE, mLoopingMode );
169 Property::Map layerInfo;
170 mVectorAnimationTask->GetLayerInfo( layerInfo );
171 map.Insert( Toolkit::DevelImageVisual::Property::CONTENT_INFO, layerInfo );
174 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
179 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
181 // url already passed in from constructor
182 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
184 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
185 if( keyValue.first.type == Property::Key::INDEX )
187 DoSetProperty( keyValue.first.indexKey, keyValue.second );
191 if( keyValue.first == LOOP_COUNT_NAME )
193 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
195 else if( keyValue.first == PLAY_RANGE_NAME )
197 DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
199 else if( keyValue.first == STOP_BEHAVIOR_NAME )
201 DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
203 else if( keyValue.first == LOOPING_MODE_NAME )
205 DoSetProperty( Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second );
211 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
215 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
218 if( value.Get( loopCount ) )
220 mLoopCount = loopCount;
221 mResendFlag |= RESEND_LOOP_COUNT;
225 case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
227 Property::Array* array = value.GetArray();
230 size_t count = array->Count();
233 int startFrame, endFrame;
234 int totalFrame = mVectorAnimationTask->GetTotalFrameNumber();
235 array->GetElementAt( 0 ).Get( startFrame );
236 array->GetElementAt( 1 ).Get( endFrame );
238 if( startFrame >= 0 && startFrame < totalFrame && endFrame >= 0 && endFrame < totalFrame )
240 mStartFrame = startFrame;
241 mEndFrame = endFrame;
242 mResendFlag |= RESEND_PLAY_RANGE;
246 DALI_LOG_ERROR( "Invalid play range [%d, %d / %d]\n", startFrame, endFrame, totalFrame );
252 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
254 int32_t stopBehavior = mStopBehavior;
255 if( Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior ) )
257 mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
258 mResendFlag |= RESEND_STOP_BEHAVIOR;
262 case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
264 int32_t loopingMode = mLoopingMode;
265 if( Scripting::GetEnumerationProperty( value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode ) )
267 mLoopingMode = DevelImageVisual::LoopingMode::Type( loopingMode );
268 mResendFlag |= RESEND_LOOPING_MODE;
275 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
279 if( mImpl->mCustomShader )
281 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
282 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
283 mImpl->mCustomShader->mHints );
285 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
289 shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
292 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
294 mImpl->mRenderer = Renderer::New( geometry, shader );
296 TextureSet textureSet = TextureSet::New();
297 mImpl->mRenderer.SetTextures( textureSet );
299 // Register transform properties
300 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
302 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
304 // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
305 mPlacementActor = actor;
307 mVectorAnimationTask->SetRenderer( mImpl->mRenderer );
309 // Add property notification for scaling & size
310 mScaleNotification = actor.AddPropertyNotification( Actor::Property::WORLD_SCALE, StepCondition( 0.1f, 1.0f ) );
311 mScaleNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnScaleNotification );
313 mSizeNotification = actor.AddPropertyNotification( Actor::Property::SIZE, StepCondition( 3.0f ) );
314 mSizeNotification.NotifySignal().Connect( this, &AnimatedVectorImageVisual::OnSizeNotification );
316 DevelActor::VisibilityChangedSignal( actor ).Connect( this, &AnimatedVectorImageVisual::OnControlVisibilityChanged );
318 Window window = DevelWindow::Get( actor );
321 DevelWindow::VisibilityChangedSignal( window ).Connect( this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged );
324 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOnStage [%p]\n", this );
327 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
331 if( mImpl->mRenderer )
333 actor.RemoveRenderer( mImpl->mRenderer );
334 mImpl->mRenderer.Reset();
336 mRendererAdded = false;
339 // Remove property notification
340 actor.RemovePropertyNotification( mScaleNotification );
341 actor.RemovePropertyNotification( mSizeNotification );
343 DevelActor::VisibilityChangedSignal( actor ).Disconnect( this, &AnimatedVectorImageVisual::OnControlVisibilityChanged );
345 Window window = DevelWindow::Get( actor );
348 DevelWindow::VisibilityChangedSignal( window ).Disconnect( this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged );
351 mPlacementActor.Reset();
353 // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
354 mVisualSize = Vector2::ZERO;
355 mVisualScale = Vector2::ONE;
357 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOffStage [%p]\n", this );
360 void AnimatedVectorImageVisual::OnSetTransform()
362 Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
364 if( IsOnStage() && visualSize != mVisualSize )
366 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f [%p]\n", visualSize.width, visualSize.height, this );
368 mVisualSize = visualSize;
370 SetVectorImageSize();
374 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
376 mVectorAnimationTask->PlayAnimation();
378 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
383 mVectorAnimationTask->RenderFrame();
388 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
390 // Check if action is valid for this visual type and perform action if possible
393 case DevelAnimatedVectorImageVisual::Action::PLAY:
395 if( IsOnStage() && mVisualSize != Vector2::ZERO )
397 mVectorAnimationTask->PlayAnimation();
399 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
401 mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
404 case DevelAnimatedVectorImageVisual::Action::PAUSE:
406 mVectorAnimationTask->PauseAnimation();
408 if( mImpl->mRenderer )
410 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
413 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
416 case DevelAnimatedVectorImageVisual::Action::STOP:
418 if( mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::STOPPED )
420 mVectorAnimationTask->StopAnimation();
423 if( mImpl->mRenderer )
425 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
428 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
431 case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
434 if( attributes.Get( frameNumber ) )
436 mVectorAnimationTask->SetCurrentFrameNumber( frameNumber );
438 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
440 mVectorAnimationTask->RenderFrame();
441 Stage::GetCurrent().KeepRendering( 1.0f ); // Trigger rendering
446 case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
448 Property::Map* map = attributes.GetMap();
451 DoSetProperties( *map );
460 void AnimatedVectorImageVisual::OnUploadCompleted()
462 // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
463 Actor actor = mPlacementActor.GetHandle();
464 if( actor && !mRendererAdded )
466 actor.AddRenderer( mImpl->mRenderer );
467 mRendererAdded = true;
469 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
471 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnUploadCompleted: Renderer is added [%p]\n", this );
475 void AnimatedVectorImageVisual::OnAnimationFinished()
477 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnAnimationFinished: action state = %d [%p]\n", mActionStatus, this );
479 if( mActionStatus != DevelAnimatedVectorImageVisual::Action::STOP )
481 mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
483 if( mImpl->mEventObserver )
485 mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
489 if( mImpl->mRenderer )
491 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
495 void AnimatedVectorImageVisual::SendAnimationData()
499 bool isPlaying = false;
500 if( mVectorAnimationTask->GetPlayState() == DevelImageVisual::PlayState::PLAYING )
502 mVectorAnimationTask->PauseAnimation();
506 if( mResendFlag & RESEND_LOOP_COUNT )
508 mVectorAnimationTask->SetLoopCount( mLoopCount );
511 if( mResendFlag & RESEND_PLAY_RANGE )
513 mVectorAnimationTask->SetPlayRange( mStartFrame, mEndFrame );
516 if( mResendFlag & RESEND_STOP_BEHAVIOR )
518 mVectorAnimationTask->SetStopBehavior( mStopBehavior );
521 if( mResendFlag & RESEND_LOOPING_MODE )
523 mVectorAnimationTask->SetLoopingMode( mLoopingMode );
530 mVectorAnimationTask->PlayAnimation();
534 mVectorAnimationTask->RenderFrame();
535 Stage::GetCurrent().KeepRendering( 1.0f );
543 void AnimatedVectorImageVisual::SetVectorImageSize()
545 uint32_t width = static_cast< uint32_t >( mVisualSize.width * mVisualScale.width );
546 uint32_t height = static_cast< uint32_t >( mVisualSize.height * mVisualScale.height );
548 mVectorAnimationTask->SetSize( width, height );
550 if( IsOnStage() && mVectorAnimationTask->GetPlayState() != DevelImageVisual::PlayState::PLAYING )
552 mVectorAnimationTask->RenderFrame();
553 Stage::GetCurrent().KeepRendering( 1.0f ); // Trigger rendering
557 void AnimatedVectorImageVisual::PauseAnimation()
559 if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
561 mVectorAnimationTask->PauseAnimation();
563 mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
565 if( mImpl->mRenderer )
567 mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
572 void AnimatedVectorImageVisual::OnScaleNotification( PropertyNotification& source )
574 Actor actor = mPlacementActor.GetHandle();
577 Vector3 scale = actor.GetProperty< Vector3 >( Actor::Property::WORLD_SCALE );
578 mVisualScale.width = scale.width;
579 mVisualScale.height = scale.height;
581 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnScaleNotification: scale = %f, %f [%p]\n", mVisualScale.width, mVisualScale.height, this );
583 SetVectorImageSize();
587 void AnimatedVectorImageVisual::OnSizeNotification( PropertyNotification& source )
589 Actor actor = mPlacementActor.GetHandle();
592 Vector3 size = actor.GetCurrentSize();
593 mVisualSize.width = size.width;
594 mVisualSize.height = size.height;
596 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSizeNotification: size = %f, %f [%p]\n", mVisualSize.width, mVisualSize.height, this );
598 SetVectorImageSize();
602 void AnimatedVectorImageVisual::OnControlVisibilityChanged( Actor actor, bool visible, DevelActor::VisibilityChange::Type type )
608 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnControlVisibilityChanged: invisibile. Pause animation [%p]\n", this );
612 void AnimatedVectorImageVisual::OnWindowVisibilityChanged( Window window, bool visible )
618 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnWindowVisibilityChanged: invisibile. Pause animation [%p]\n", this );
622 } // namespace Internal
624 } // namespace Toolkit