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 ),
74 mUpdateFrameNumber( false ),
75 mNeedAnimationFinishedTrigger( true ),
76 mAnimationDataUpdated( false ),
82 VectorAnimationTask::~VectorAnimationTask()
84 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this );
87 void VectorAnimationTask::Finalize()
89 ConditionalWait::ScopedLock lock( mConditionalWait );
91 // Release some objects in the main thread
92 if( mAnimationFinishedTrigger )
94 mAnimationFinishedTrigger.reset();
97 mVectorRenderer.Finalize();
102 void VectorAnimationTask::SetRenderer( Renderer renderer )
104 ConditionalWait::ScopedLock lock( mConditionalWait );
106 mVectorRenderer.SetRenderer( renderer );
108 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this );
111 void VectorAnimationTask::SetAnimationData( const AnimationData& data )
113 ConditionalWait::ScopedLock lock( mConditionalWait );
115 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this );
117 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
119 mAnimationData[index] = data;
120 mAnimationDataUpdated = true;
122 if( data.resendFlag & VectorAnimationTask::RESEND_SIZE )
124 // The size should be changed in the main thread.
125 SetSize( data.width, data.height );
128 mVectorAnimationThread.AddTask( this );
131 void VectorAnimationTask::SetSize( uint32_t width, uint32_t height )
133 if( mWidth != width || mHeight != height )
135 mVectorRenderer.SetSize( width, height );
140 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this );
144 void VectorAnimationTask::PlayAnimation()
146 if( mPlayState != PlayState::PLAYING )
148 mNeedAnimationFinishedTrigger = true;
149 mUpdateFrameNumber = false;
150 mPlayState = PlayState::PLAYING;
152 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this );
156 void VectorAnimationTask::StopAnimation()
158 if( mPlayState != PlayState::STOPPING )
160 mNeedAnimationFinishedTrigger = false;
161 mPlayState = PlayState::STOPPING;
163 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this );
167 void VectorAnimationTask::PauseAnimation()
169 if( mPlayState == PlayState::PLAYING )
171 mPlayState = PlayState::PAUSED;
173 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this );
177 void VectorAnimationTask::SetAnimationFinishedCallback( EventThreadCallback* callback )
179 ConditionalWait::ScopedLock lock( mConditionalWait );
182 mAnimationFinishedTrigger = std::unique_ptr< EventThreadCallback >( callback );
186 void VectorAnimationTask::SetLoopCount( int32_t count )
188 if( mLoopCount != count )
193 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this );
197 void VectorAnimationTask::SetPlayRange( const Property::Array& playRange )
200 uint32_t startFrame = 0, endFrame = 0;
201 size_t count = playRange.Count();
205 int32_t start = 0, end = 0;
206 if( playRange.GetElementAt( 0 ).Get( start ) && playRange.GetElementAt( 1 ).Get( end ) )
208 startFrame = static_cast< uint32_t >( start );
209 endFrame = static_cast< uint32_t >( end );
214 std::string startMarker, endMarker;
215 if( playRange.GetElementAt( 0 ).Get( startMarker ) && playRange.GetElementAt( 1 ).Get( endMarker ) )
217 if( mVectorRenderer )
219 uint32_t frame; // We don't use this later
220 if( mVectorRenderer.GetMarkerInfo( startMarker, startFrame, frame ) && mVectorRenderer.GetMarkerInfo( endMarker, frame, endFrame ) )
228 else if( count == 1 )
231 if( playRange.GetElementAt( 0 ).Get( marker ) )
233 if( mVectorRenderer )
235 mVectorRenderer.GetMarkerInfo( marker, startFrame, endFrame );
243 DALI_LOG_ERROR( "VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this );
247 // Make sure the range specified is between 0 and the total frame number
248 if( startFrame < mTotalFrame && endFrame < mTotalFrame )
250 // If the range is not in order swap values
251 if( startFrame > endFrame )
253 uint32_t temp = startFrame;
254 startFrame = endFrame;
258 if( startFrame != mStartFrame || endFrame != mEndFrame )
260 mStartFrame = startFrame;
261 mEndFrame = endFrame;
263 // If the current frame is out of the range, change the current frame also.
264 if( mStartFrame > mCurrentFrame )
266 mCurrentFrame = mStartFrame;
268 else if( mEndFrame < mCurrentFrame )
270 mCurrentFrame = mEndFrame;
273 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%p]\n", mStartFrame, mEndFrame, this );
278 DALI_LOG_ERROR( "VectorAnimationTask::SetPlayRange: Invalid range (%d, %d) [%p]\n", startFrame, endFrame, this );
283 void VectorAnimationTask::GetPlayRange( uint32_t& startFrame, uint32_t& endFrame )
285 startFrame = mStartFrame;
286 endFrame = mEndFrame;
289 void VectorAnimationTask::SetCurrentFrameNumber( uint32_t frameNumber )
291 if( mCurrentFrame == frameNumber )
293 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this );
297 if( frameNumber >= mStartFrame && frameNumber <= mEndFrame )
299 mCurrentFrame = frameNumber;
300 mUpdateFrameNumber = false;
302 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this );
306 DALI_LOG_ERROR( "Invalid frame number [%d (%d, %d)]\n", frameNumber, mStartFrame, mEndFrame );
310 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
312 return mCurrentFrame;
315 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
320 void VectorAnimationTask::GetDefaultSize( uint32_t& width, uint32_t& height ) const
322 mVectorRenderer.GetDefaultSize( width, height );
325 void VectorAnimationTask::SetStopBehavior( DevelImageVisual::StopBehavior::Type stopBehavior )
327 mStopBehavior = stopBehavior;
329 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this );
332 void VectorAnimationTask::SetLoopingMode( DevelImageVisual::LoopingMode::Type loopingMode )
334 mLoopingMode = loopingMode;
336 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this );
339 void VectorAnimationTask::GetLayerInfo( Property::Map& map ) const
341 mVectorRenderer.GetLayerInfo( map );
344 VectorAnimationTask::UploadCompletedSignalType& VectorAnimationTask::UploadCompletedSignal()
346 return mVectorRenderer.UploadCompletedSignal();
349 void VectorAnimationTask::Initialize()
351 mVectorRenderer = VectorAnimationRenderer::New( mUrl );
353 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
355 mEndFrame = mTotalFrame - 1;
357 mFrameRate = mVectorRenderer.GetFrameRate();
358 mFrameDurationNanoSeconds = NANOSECONDS_PER_SECOND / mFrameRate;
360 uint32_t width, height;
361 mVectorRenderer.GetDefaultSize( width, height );
363 SetSize( width, height );
365 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Initialize: file = %s [%d frames, %f fps] [%p]\n", mUrl.c_str(), mTotalFrame, mFrameRate, this );
368 bool VectorAnimationTask::Rasterize()
370 bool stopped = false;
371 uint32_t currentFrame;
374 ConditionalWait::ScopedLock lock( mConditionalWait );
377 // The task will be destroyed. We don't need rasterization.
382 ApplyAnimationData();
384 if( mPlayState == PlayState::PLAYING && mUpdateFrameNumber )
386 mCurrentFrame = mForward ? mCurrentFrame + 1 : mCurrentFrame - 1;
387 Dali::ClampInPlace( mCurrentFrame, mStartFrame, mEndFrame );
390 currentFrame = mCurrentFrame;
392 mUpdateFrameNumber = true;
394 if( mPlayState == PlayState::STOPPING )
396 mCurrentFrame = GetStoppedFrame( mStartFrame, mEndFrame, mCurrentFrame );
397 currentFrame = mCurrentFrame;
400 else if( mPlayState == PlayState::PLAYING )
402 bool animationFinished = false;
404 if( currentFrame >= mEndFrame ) // last frame
406 if( mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE )
412 if( mLoopCount < 0 || ++mCurrentLoop < mLoopCount ) // repeat forever or before the last loop
414 mCurrentFrame = mStartFrame;
415 mUpdateFrameNumber = false;
419 animationFinished = true; // end of animation
423 else if( currentFrame == mStartFrame && !mForward ) // first frame
425 if( mLoopCount < 0 || ++mCurrentLoop < mLoopCount ) // repeat forever or before the last loop
431 animationFinished = true; // end of animation
435 if( animationFinished )
437 if( mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME )
443 mPlayState = PlayState::STOPPING;
449 bool renderSuccess = false;
450 if( mVectorRenderer )
452 renderSuccess = mVectorRenderer.Render( currentFrame );
455 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this );
456 mUpdateFrameNumber = false;
460 if( stopped && renderSuccess )
462 mPlayState = PlayState::STOPPED;
466 // Animation is finished
468 ConditionalWait::ScopedLock lock( mConditionalWait );
469 if( mNeedAnimationFinishedTrigger && mAnimationFinishedTrigger )
471 mAnimationFinishedTrigger->Trigger();
475 DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this );
478 bool keepAnimation = true;
479 if( mPlayState == PlayState::PAUSED || mPlayState == PlayState::STOPPED )
481 keepAnimation = false;
484 return keepAnimation;
487 uint32_t VectorAnimationTask::GetStoppedFrame( uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame )
489 uint32_t frame = currentFrame;
491 switch( mStopBehavior )
493 case DevelImageVisual::StopBehavior::FIRST_FRAME:
498 case DevelImageVisual::StopBehavior::LAST_FRAME:
500 if( mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE )
510 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
512 frame = currentFrame;
520 std::chrono::time_point< std::chrono::system_clock > VectorAnimationTask::CalculateNextFrameTime( bool renderNow )
522 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::system_clock supported
523 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
524 // is casted to use the default duration.
525 mNextFrameStartTime = std::chrono::time_point_cast< std::chrono::time_point< std::chrono::system_clock >::duration >(
526 mNextFrameStartTime + std::chrono::nanoseconds( mFrameDurationNanoSeconds ) );
527 auto current = std::chrono::system_clock::now();
528 if( renderNow || mNextFrameStartTime < current )
530 mNextFrameStartTime = current;
532 return mNextFrameStartTime;
535 std::chrono::time_point< std::chrono::system_clock > VectorAnimationTask::GetNextFrameTime()
537 return mNextFrameStartTime;
540 void VectorAnimationTask::ApplyAnimationData()
545 ConditionalWait::ScopedLock lock( mConditionalWait );
547 if( !mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].resendFlag != 0 )
549 // Data is not updated or the previous data is not applied yet.
553 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
554 mAnimationDataUpdated = false;
556 index = mAnimationDataIndex;
559 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT )
561 SetLoopCount( mAnimationData[index].loopCount );
564 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE )
566 SetPlayRange( mAnimationData[index].playRange );
569 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR )
571 SetStopBehavior( mAnimationData[index].stopBehavior );
574 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE )
576 SetLoopingMode( mAnimationData[index].loopingMode );
579 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME )
581 SetCurrentFrameNumber( mAnimationData[index].currentFrame );
584 if( mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_STATE )
586 if( mAnimationData[index].playState == DevelImageVisual::PlayState::PLAYING )
590 else if( mAnimationData[index].playState == DevelImageVisual::PlayState::PAUSED )
594 else if( mAnimationData[index].playState == DevelImageVisual::PlayState::STOPPED )
600 mAnimationData[index].resendFlag = 0;
603 } // namespace Internal
605 } // namespace Toolkit