2 * Copyright (c) 2023 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/math/math-utils.h>
24 #include <dali/public-api/object/property-array.h>
27 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
28 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
29 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
39 constexpr auto LOOP_FOREVER = -1;
40 constexpr auto MICROSECONDS_PER_SECOND(1e+6);
42 #if defined(DEBUG_ENABLED)
43 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VECTOR_ANIMATION");
46 } // unnamed namespace
48 VectorAnimationTask::VectorAnimationTask(VisualFactoryCache& factoryCache)
49 : AsyncTask(MakeCallback(this, &VectorAnimationTask::TaskCompleted), AsyncTask::PriorityType::HIGH, AsyncTask::ThreadType::WORKER_THREAD),
51 mVectorRenderer(VectorAnimationRenderer::New()),
53 mVectorAnimationThread(factoryCache.GetVectorAnimationManager().GetVectorAnimationThread()),
55 mResourceReadySignal(),
56 mLoadCompletedCallback(MakeCallback(this, &VectorAnimationTask::OnLoadCompleted)),
57 mPlayState(PlayState::STOPPED),
58 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
59 mLoopingMode(DevelImageVisual::LoopingMode::RESTART),
60 mNextFrameStartTime(),
61 mFrameDurationMicroSeconds(MICROSECONDS_PER_SECOND / 60.0f),
70 mAnimationDataIndex(0),
71 mLoopCount(LOOP_FOREVER),
74 mUpdateFrameNumber(false),
75 mNeedAnimationFinishedTrigger(true),
76 mAnimationDataUpdated(false),
83 mVectorRenderer.UploadCompletedSignal().Connect(this, &VectorAnimationTask::OnUploadCompleted);
86 VectorAnimationTask::~VectorAnimationTask()
88 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this);
91 void VectorAnimationTask::Process()
93 mRasterized = Rasterize();
96 bool VectorAnimationTask::IsReady()
101 void VectorAnimationTask::Finalize()
103 ConditionalWait::ScopedLock lock(mConditionalWait);
105 // Release some objects in the main thread
106 if(mAnimationFinishedCallback)
108 mVectorAnimationThread.RemoveEventTriggerCallback(mAnimationFinishedCallback.get());
109 mAnimationFinishedCallback.reset();
111 if(mLoadCompletedCallback)
113 mVectorAnimationThread.RemoveEventTriggerCallback(mLoadCompletedCallback.get());
114 mLoadCompletedCallback.reset();
117 mVectorRenderer.Finalize();
122 void VectorAnimationTask::TaskCompleted(VectorAnimationTaskPtr task)
124 mVectorAnimationThread.OnTaskCompleted(task, task->IsRasterized(), task->IsAnimating());
127 bool VectorAnimationTask::IsRasterized()
132 bool VectorAnimationTask::IsAnimating()
134 return mKeepAnimation;
137 bool VectorAnimationTask::Load(bool synchronousLoading)
139 if(!mVectorRenderer.Load(mUrl))
141 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mUrl.c_str());
142 mLoadRequest = false;
144 if(!synchronousLoading && mLoadCompletedCallback)
146 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
151 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
153 mEndFrame = mTotalFrame - 1;
155 mFrameRate = mVectorRenderer.GetFrameRate();
156 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
158 mLoadRequest = false;
159 if(!synchronousLoading && mLoadCompletedCallback)
161 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
164 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mUrl.c_str(), mTotalFrame, mFrameRate, this);
169 void VectorAnimationTask::SetRenderer(Renderer renderer)
171 ConditionalWait::ScopedLock lock(mConditionalWait);
173 mVectorRenderer.SetRenderer(renderer);
175 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
178 void VectorAnimationTask::RequestLoad(const std::string& url, bool synchronousLoading)
182 if(!synchronousLoading)
186 mVectorAnimationThread.AddTask(this);
196 bool VectorAnimationTask::IsLoadRequested() const
201 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
203 ConditionalWait::ScopedLock lock(mConditionalWait);
205 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
207 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
209 mAnimationData[index] = data;
210 mAnimationDataUpdated = true;
212 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
214 // The size should be changed in the main thread.
215 SetSize(data.width, data.height);
218 mVectorAnimationThread.AddTask(this);
221 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
223 if(mWidth != width || mHeight != height)
225 mVectorRenderer.SetSize(width, height);
230 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
234 void VectorAnimationTask::PlayAnimation()
236 if(mPlayState != PlayState::PLAYING)
238 mNeedAnimationFinishedTrigger = true;
239 mUpdateFrameNumber = false;
240 mPlayState = PlayState::PLAYING;
242 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
246 void VectorAnimationTask::StopAnimation()
248 if(mPlayState != PlayState::STOPPING)
250 mNeedAnimationFinishedTrigger = false;
251 mPlayState = PlayState::STOPPING;
253 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
257 void VectorAnimationTask::PauseAnimation()
259 if(mPlayState == PlayState::PLAYING)
261 mPlayState = PlayState::PAUSED;
263 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
267 void VectorAnimationTask::SetAnimationFinishedCallback(CallbackBase* callback)
269 ConditionalWait::ScopedLock lock(mConditionalWait);
270 mAnimationFinishedCallback = std::unique_ptr<CallbackBase>(callback);
273 void VectorAnimationTask::SetLoopCount(int32_t count)
275 if(mLoopCount != count)
280 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
284 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
287 uint32_t startFrame = 0, endFrame = 0;
288 size_t count = playRange.Count();
292 int32_t start = 0, end = 0;
293 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
295 startFrame = static_cast<uint32_t>(start);
296 endFrame = static_cast<uint32_t>(end);
301 std::string startMarker, endMarker;
302 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
306 uint32_t frame; // We don't use this later
307 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
318 if(playRange.GetElementAt(0).Get(marker))
320 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
329 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
333 // Make sure the range specified is between 0 and the total frame number
334 startFrame = std::min(startFrame, mTotalFrame - 1);
335 endFrame = std::min(endFrame, mTotalFrame - 1);
337 // If the range is not in order swap values
338 if(startFrame > endFrame)
340 uint32_t temp = startFrame;
341 startFrame = endFrame;
345 if(startFrame != mStartFrame || endFrame != mEndFrame)
347 mStartFrame = startFrame;
348 mEndFrame = endFrame;
350 // If the current frame is out of the range, change the current frame also.
351 if(mStartFrame > mCurrentFrame)
353 mCurrentFrame = mStartFrame;
355 else if(mEndFrame < mCurrentFrame)
357 mCurrentFrame = mEndFrame;
360 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mUrl.c_str(), this);
364 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
366 startFrame = mStartFrame;
367 endFrame = mEndFrame;
370 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
372 if(mCurrentFrame == frameNumber)
374 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
378 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
380 mCurrentFrame = frameNumber;
381 mUpdateFrameNumber = false;
383 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
387 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
391 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
393 return mCurrentFrame;
396 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
401 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
403 mVectorRenderer.GetDefaultSize(width, height);
406 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
408 mStopBehavior = stopBehavior;
410 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
413 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
415 mLoopingMode = loopingMode;
417 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
420 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
422 mVectorRenderer.GetLayerInfo(map);
425 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
427 return mResourceReadySignal;
430 bool VectorAnimationTask::Rasterize()
432 bool stopped = false;
433 uint32_t currentFrame;
434 mKeepAnimation = false;
437 ConditionalWait::ScopedLock lock(mConditionalWait);
440 // The task will be destroyed. We don't need rasterization.
455 ApplyAnimationData();
457 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
459 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
460 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
463 currentFrame = mCurrentFrame;
465 mUpdateFrameNumber = true;
467 if(mPlayState == PlayState::STOPPING)
469 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
470 currentFrame = mCurrentFrame;
473 else if(mPlayState == PlayState::PLAYING)
475 bool animationFinished = false;
477 if(currentFrame >= mEndFrame) // last frame
479 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
485 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
487 mCurrentFrame = mStartFrame;
488 mUpdateFrameNumber = false;
492 animationFinished = true; // end of animation
496 else if(currentFrame == mStartFrame && !mForward) // first frame
498 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
504 animationFinished = true; // end of animation
508 if(animationFinished)
510 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
516 mPlayState = PlayState::STOPPING;
522 bool renderSuccess = false;
525 renderSuccess = mVectorRenderer.Render(currentFrame);
528 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
529 mUpdateFrameNumber = false;
533 if(stopped && renderSuccess)
535 mPlayState = PlayState::STOPPED;
541 // Notify the Renderer that rendering is stopped.
542 mVectorRenderer.RenderStopped();
545 // Animation is finished
547 ConditionalWait::ScopedLock lock(mConditionalWait);
548 if(mNeedAnimationFinishedTrigger && mAnimationFinishedCallback)
550 mVectorAnimationThread.AddEventTriggerCallback(mAnimationFinishedCallback.get());
554 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
557 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
559 mKeepAnimation = true;
565 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
567 uint32_t frame = currentFrame;
569 switch(mStopBehavior)
571 case DevelImageVisual::StopBehavior::FIRST_FRAME:
576 case DevelImageVisual::StopBehavior::LAST_FRAME:
578 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
588 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
590 frame = currentFrame;
598 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
600 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
601 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
602 // is casted to use the default duration.
603 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
604 auto current = std::chrono::steady_clock::now();
609 mNextFrameStartTime = current;
611 else if(mNextFrameStartTime < current)
613 uint32_t droppedFrames = 0;
615 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
618 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
621 mNextFrameStartTime = current;
622 mDroppedFrames = droppedFrames;
625 return mNextFrameStartTime;
628 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
630 return mNextFrameStartTime;
633 void VectorAnimationTask::ApplyAnimationData()
638 ConditionalWait::ScopedLock lock(mConditionalWait);
640 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].resendFlag != 0)
642 // Data is not updated or the previous data is not applied yet.
646 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
647 mAnimationDataUpdated = false;
649 index = mAnimationDataIndex;
652 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
654 SetLoopCount(mAnimationData[index].loopCount);
657 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
659 SetPlayRange(mAnimationData[index].playRange);
662 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
664 SetStopBehavior(mAnimationData[index].stopBehavior);
667 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
669 SetLoopingMode(mAnimationData[index].loopingMode);
672 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
674 SetCurrentFrameNumber(mAnimationData[index].currentFrame);
677 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
679 mVectorRenderer.InvalidateBuffer();
682 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
684 for(auto&& iter : mAnimationData[index].dynamicProperties)
686 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
690 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
692 if(mAnimationData[index].playState == DevelImageVisual::PlayState::PLAYING)
696 else if(mAnimationData[index].playState == DevelImageVisual::PlayState::PAUSED)
700 else if(mAnimationData[index].playState == DevelImageVisual::PlayState::STOPPED)
707 mAnimationData[index].dynamicProperties.clear();
708 mAnimationData[index].resendFlag = 0;
711 void VectorAnimationTask::OnUploadCompleted()
713 mResourceReadySignal.Emit(ResourceStatus::READY);
716 void VectorAnimationTask::OnLoadCompleted()
720 mResourceReadySignal.Emit(ResourceStatus::LOADED);
724 mResourceReadySignal.Emit(ResourceStatus::FAILED);
727 } // namespace Internal
729 } // namespace Toolkit