2 * Copyright (c) 2020 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/vector-animation-task.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/object/property-array.h>
24 #include <dali/public-api/math/math-utils.h>
27 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
28 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
42 constexpr auto LOOP_FOREVER = -1;
43 constexpr auto NANOSECONDS_PER_SECOND( 1e+9 );
45 #if defined(DEBUG_ENABLED)
46 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VECTOR_ANIMATION" );
49 } // unnamed namespace
51 VectorAnimationTask::VectorAnimationTask( VisualFactoryCache& factoryCache, const std::string& url )
55 mVectorAnimationThread( factoryCache.GetVectorAnimationThread() ),
57 mAnimationFinishedTrigger(),
58 mPlayState( PlayState::STOPPED ),
59 mStopBehavior( DevelImageVisual::StopBehavior::CURRENT_FRAME ),
60 mLoopingMode( DevelImageVisual::LoopingMode::RESTART ),
61 mNextFrameStartTime(),
62 mFrameDurationNanoSeconds( 0 ),
70 mAnimationDataIndex( 0 ),
71 mLoopCount( LOOP_FOREVER ),
73 mResourceReady( false ),
75 mUpdateFrameNumber( false ),
76 mNeedAnimationFinishedTrigger( true ),
77 mAnimationDataUpdated( false ),
83 VectorAnimationTask::~VectorAnimationTask()
85 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this );
88 void VectorAnimationTask::Finalize()
90 ConditionalWait::ScopedLock lock( mConditionalWait );
92 // Release some objects in the main thread
93 if( mAnimationFinishedTrigger )
95 mAnimationFinishedTrigger.reset();
98 mVectorRenderer.Finalize();
103 void VectorAnimationTask::SetRenderer( Renderer renderer )
105 ConditionalWait::ScopedLock lock( mConditionalWait );
107 mVectorRenderer.SetRenderer( renderer );
109 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this );
112 void VectorAnimationTask::SetAnimationData( const AnimationData& data )
114 ConditionalWait::ScopedLock lock( mConditionalWait );
116 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this );
118 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
120 mAnimationData[index] = data;
121 mAnimationDataUpdated = true;
123 if( data.resendFlag & VectorAnimationTask::RESEND_SIZE )
125 // The size should be changed in the main thread.
126 SetSize( data.width, data.height );
129 mVectorAnimationThread.AddTask( this );
132 void VectorAnimationTask::SetSize( uint32_t width, uint32_t height )
134 if( mWidth != width || mHeight != height )
136 mVectorRenderer.SetSize( width, height );
141 mResourceReady = false;
143 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this );
147 void VectorAnimationTask::PlayAnimation()
149 if( mPlayState != PlayState::PLAYING )
151 mUpdateFrameNumber = false;
152 mPlayState = PlayState::PLAYING;
154 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this );
158 void VectorAnimationTask::StopAnimation()
160 if( mPlayState != PlayState::STOPPING )
162 mNeedAnimationFinishedTrigger = false;
163 mPlayState = PlayState::STOPPING;
165 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this );
169 void VectorAnimationTask::PauseAnimation()
171 if( mPlayState == PlayState::PLAYING )
173 mPlayState = PlayState::PAUSED;
175 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this );
179 void VectorAnimationTask::SetAnimationFinishedCallback( EventThreadCallback* callback )
181 ConditionalWait::ScopedLock lock( mConditionalWait );
184 mAnimationFinishedTrigger = std::unique_ptr< EventThreadCallback >( callback );
188 void VectorAnimationTask::SetLoopCount( int32_t count )
190 if( mLoopCount != count )
195 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this );
199 void VectorAnimationTask::SetPlayRange( const Property::Array& playRange )
202 uint32_t startFrame = 0, endFrame = 0;
203 size_t count = playRange.Count();
207 int32_t start = 0, end = 0;
208 if( playRange.GetElementAt( 0 ).Get( start ) && playRange.GetElementAt( 1 ).Get( end ) )
210 startFrame = static_cast< uint32_t >( start );
211 endFrame = static_cast< uint32_t >( end );
216 std::string startMarker, endMarker;
217 if( playRange.GetElementAt( 0 ).Get( startMarker ) && playRange.GetElementAt( 1 ).Get( endMarker ) )
219 if( mVectorRenderer )
221 uint32_t frame; // We don't use this later
222 if( mVectorRenderer.GetMarkerInfo( startMarker, startFrame, frame ) && mVectorRenderer.GetMarkerInfo( endMarker, frame, endFrame ) )
230 else if( count == 1 )
233 if( playRange.GetElementAt( 0 ).Get( marker ) )
235 if( mVectorRenderer )
237 mVectorRenderer.GetMarkerInfo( marker, startFrame, endFrame );
245 DALI_LOG_ERROR( "VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this );
249 // Make sure the range specified is between 0 and the total frame number
250 if( startFrame < mTotalFrame && endFrame < mTotalFrame )
252 // If the range is not in order swap values
253 if( startFrame > endFrame )
255 uint32_t temp = startFrame;
256 startFrame = endFrame;
260 if( startFrame != mStartFrame || endFrame != mEndFrame )
262 mStartFrame = startFrame;
263 mEndFrame = endFrame;
265 // If the current frame is out of the range, change the current frame also.
266 if( mStartFrame > mCurrentFrame )
268 mCurrentFrame = mStartFrame;
269 mResourceReady = false;
271 else if( mEndFrame < mCurrentFrame )
273 mCurrentFrame = mEndFrame;
274 mResourceReady = false;
277 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%p]\n", mStartFrame, mEndFrame, this );
282 DALI_LOG_ERROR( "VectorAnimationTask::SetPlayRange: Invalid range (%d, %d) [%p]\n", startFrame, endFrame, this );
287 void VectorAnimationTask::GetPlayRange( uint32_t& startFrame, uint32_t& endFrame )
289 startFrame = mStartFrame;
290 endFrame = mEndFrame;
293 void VectorAnimationTask::SetCurrentFrameNumber( uint32_t frameNumber )
295 if( mCurrentFrame == frameNumber )
297 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this );
301 if( frameNumber >= mStartFrame && frameNumber <= mEndFrame )
303 mCurrentFrame = frameNumber;
304 mUpdateFrameNumber = false;
305 mResourceReady = false;
307 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this );
311 DALI_LOG_ERROR( "Invalid frame number [%d (%d, %d)]\n", frameNumber, mStartFrame, mEndFrame );
315 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
317 return mCurrentFrame;
320 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
325 void VectorAnimationTask::GetDefaultSize( uint32_t& width, uint32_t& height ) const
327 mVectorRenderer.GetDefaultSize( width, height );
330 void VectorAnimationTask::SetStopBehavior( DevelImageVisual::StopBehavior::Type stopBehavior )
332 mStopBehavior = stopBehavior;
334 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this );
337 void VectorAnimationTask::SetLoopingMode( DevelImageVisual::LoopingMode::Type loopingMode )
339 mLoopingMode = loopingMode;
341 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this );
344 void VectorAnimationTask::GetLayerInfo( Property::Map& map ) const
346 mVectorRenderer.GetLayerInfo( map );
349 VectorAnimationTask::UploadCompletedSignalType& VectorAnimationTask::UploadCompletedSignal()
351 return mVectorRenderer.UploadCompletedSignal();
354 void VectorAnimationTask::Initialize()
356 mVectorRenderer = VectorAnimationRenderer::New( mUrl );
358 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
360 mEndFrame = mTotalFrame - 1;
362 mFrameRate = mVectorRenderer.GetFrameRate();
363 mFrameDurationNanoSeconds = NANOSECONDS_PER_SECOND / mFrameRate;
365 uint32_t width, height;
366 mVectorRenderer.GetDefaultSize( width, height );
368 SetSize( width, height );
370 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Initialize: file = %s [%d frames, %f fps] [%p]\n", mUrl.c_str(), mTotalFrame, mFrameRate, this );
373 bool VectorAnimationTask::Rasterize()
375 bool stopped = false;
376 uint32_t currentFrame;
379 ConditionalWait::ScopedLock lock( mConditionalWait );
382 // The task will be destroyed. We don't need rasterization.
387 ApplyAnimationData();
389 if( mPlayState == PlayState::PLAYING && mUpdateFrameNumber )
391 mCurrentFrame = mForward ? mCurrentFrame + 1 : mCurrentFrame - 1;
392 Dali::ClampInPlace( mCurrentFrame, mStartFrame, mEndFrame );
395 currentFrame = mCurrentFrame;
398 mResourceReady = true;
399 mUpdateFrameNumber = true;
400 mNeedAnimationFinishedTrigger = true;
402 if( mPlayState == PlayState::STOPPING )
404 mCurrentFrame = GetStoppedFrame( mStartFrame, mEndFrame, mCurrentFrame );
405 currentFrame = mCurrentFrame;
408 else if( mPlayState == PlayState::PLAYING )
410 bool animationFinished = false;
412 if( currentFrame >= mEndFrame ) // last frame
414 if( mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE )
420 if( mLoopCount < 0 || ++mCurrentLoop < mLoopCount ) // repeat forever or before the last loop
422 mCurrentFrame = mStartFrame;
423 mUpdateFrameNumber = false;
427 animationFinished = true; // end of animation
431 else if( currentFrame == mStartFrame && !mForward ) // first frame
433 if( mLoopCount < 0 || ++mCurrentLoop < mLoopCount ) // repeat forever or before the last loop
439 animationFinished = true; // end of animation
443 if( animationFinished )
445 if( mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME )
451 mPlayState = PlayState::STOPPING;
457 bool renderSuccess = false;
458 if( mVectorRenderer )
460 renderSuccess = mVectorRenderer.Render( currentFrame );
463 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this );
464 mUpdateFrameNumber = false;
466 if( !mResourceReady )
468 mResourceReady = false;
473 if( stopped && renderSuccess )
475 mPlayState = PlayState::STOPPED;
479 // Animation is finished
481 ConditionalWait::ScopedLock lock( mConditionalWait );
482 if( mNeedAnimationFinishedTrigger && mAnimationFinishedTrigger )
484 mAnimationFinishedTrigger->Trigger();
488 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this );
491 bool keepAnimation = true;
492 if( mPlayState == PlayState::PAUSED || mPlayState == PlayState::STOPPED )
494 keepAnimation = false;
497 return keepAnimation;
500 uint32_t VectorAnimationTask::GetStoppedFrame( uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame )
502 uint32_t frame = currentFrame;
504 switch( mStopBehavior )
506 case DevelImageVisual::StopBehavior::FIRST_FRAME:
511 case DevelImageVisual::StopBehavior::LAST_FRAME:
513 if( mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE )
523 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
525 frame = currentFrame;
533 std::chrono::time_point< std::chrono::system_clock > VectorAnimationTask::CalculateNextFrameTime( bool renderNow )
535 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::system_clock supported
536 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
537 // is casted to use the default duration.
538 mNextFrameStartTime = std::chrono::time_point_cast< std::chrono::time_point< std::chrono::system_clock >::duration >(
539 mNextFrameStartTime + std::chrono::nanoseconds( mFrameDurationNanoSeconds ) );
540 auto current = std::chrono::system_clock::now();
541 if( renderNow || mNextFrameStartTime < current )
543 mNextFrameStartTime = current;
545 return mNextFrameStartTime;
548 std::chrono::time_point< std::chrono::system_clock > VectorAnimationTask::GetNextFrameTime()
550 return mNextFrameStartTime;
553 void VectorAnimationTask::ApplyAnimationData()
558 ConditionalWait::ScopedLock lock( mConditionalWait );
560 if( !mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].resendFlag != 0 )
562 // Data is not updated or the previous data is not applied yet.
566 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
567 mAnimationDataUpdated = false;
569 index = mAnimationDataIndex;
572 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT )
574 SetLoopCount( mAnimationData[index].loopCount );
577 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE )
579 SetPlayRange( mAnimationData[index].playRange );
582 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR )
584 SetStopBehavior( mAnimationData[index].stopBehavior );
587 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE )
589 SetLoopingMode( mAnimationData[index].loopingMode );
592 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME )
594 SetCurrentFrameNumber( mAnimationData[index].currentFrame );
597 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_STATE )
599 if( mAnimationData[index].playState == DevelImageVisual::PlayState::PLAYING )
603 else if( mAnimationData[index].playState == DevelImageVisual::PlayState::PAUSED )
607 else if( mAnimationData[index].playState == DevelImageVisual::PlayState::STOPPED )
613 mAnimationData[index].resendFlag = 0;
616 } // namespace Internal
618 } // namespace Toolkit