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/integration-api/trace.h>
24 #include <dali/public-api/math/math-utils.h>
25 #include <dali/public-api/object/property-array.h>
28 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
29 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
30 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
44 constexpr auto LOOP_FOREVER = -1;
45 constexpr auto MICROSECONDS_PER_SECOND(1e+6);
47 #if defined(DEBUG_ENABLED)
48 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VECTOR_ANIMATION");
51 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_IMAGE_PERFORMANCE_MARKER, false);
53 } // unnamed namespace
55 VectorAnimationTask::VectorAnimationTask(VisualFactoryCache& factoryCache)
56 : AsyncTask(MakeCallback(this, &VectorAnimationTask::TaskCompleted), AsyncTask::PriorityType::HIGH, AsyncTask::ThreadType::WORKER_THREAD),
58 mVectorRenderer(VectorAnimationRenderer::New()),
60 mVectorAnimationThread(factoryCache.GetVectorAnimationManager().GetVectorAnimationThread()),
62 mResourceReadySignal(),
63 mLoadCompletedCallback(MakeCallback(this, &VectorAnimationTask::OnLoadCompleted)),
64 mPlayState(PlayState::STOPPED),
65 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
66 mLoopingMode(DevelImageVisual::LoopingMode::RESTART),
67 mNextFrameStartTime(),
68 mFrameDurationMicroSeconds(MICROSECONDS_PER_SECOND / 60.0f),
77 mAnimationDataIndex(0),
78 mLoopCount(LOOP_FOREVER),
81 mUpdateFrameNumber(false),
82 mNeedAnimationFinishedTrigger(true),
83 mAnimationDataUpdated(false),
90 mVectorRenderer.UploadCompletedSignal().Connect(this, &VectorAnimationTask::OnUploadCompleted);
93 VectorAnimationTask::~VectorAnimationTask()
95 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this);
98 void VectorAnimationTask::Process()
100 mRasterized = Rasterize();
103 bool VectorAnimationTask::IsReady()
108 void VectorAnimationTask::Finalize()
110 ConditionalWait::ScopedLock lock(mConditionalWait);
112 // Release some objects in the main thread
113 if(mAnimationFinishedCallback)
115 mVectorAnimationThread.RemoveEventTriggerCallback(mAnimationFinishedCallback.get());
116 mAnimationFinishedCallback.reset();
118 if(mLoadCompletedCallback)
120 mVectorAnimationThread.RemoveEventTriggerCallback(mLoadCompletedCallback.get());
121 mLoadCompletedCallback.reset();
124 mVectorRenderer.Finalize();
129 void VectorAnimationTask::TaskCompleted(VectorAnimationTaskPtr task)
131 mVectorAnimationThread.OnTaskCompleted(task, task->IsRasterized(), task->IsAnimating());
134 bool VectorAnimationTask::IsRasterized()
139 bool VectorAnimationTask::IsAnimating()
141 return mKeepAnimation;
144 bool VectorAnimationTask::Load(bool synchronousLoading)
146 DALI_TRACE_SCOPE(gTraceFilter, "DALI_LOTTIE_LOADING_TASK");
148 if(!mVectorRenderer.Load(mUrl))
150 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mUrl.c_str());
151 mLoadRequest = false;
153 if(!synchronousLoading && mLoadCompletedCallback)
155 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
160 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
162 mEndFrame = mTotalFrame - 1;
164 mFrameRate = mVectorRenderer.GetFrameRate();
165 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
167 mLoadRequest = false;
168 if(!synchronousLoading && mLoadCompletedCallback)
170 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
173 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mUrl.c_str(), mTotalFrame, mFrameRate, this);
178 void VectorAnimationTask::SetRenderer(Renderer renderer)
180 ConditionalWait::ScopedLock lock(mConditionalWait);
182 mVectorRenderer.SetRenderer(renderer);
184 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
187 void VectorAnimationTask::RequestLoad(const std::string& url, bool synchronousLoading)
191 if(!synchronousLoading)
195 mVectorAnimationThread.AddTask(this);
205 bool VectorAnimationTask::IsLoadRequested() const
210 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
212 ConditionalWait::ScopedLock lock(mConditionalWait);
214 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
216 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
218 mAnimationData[index].push_back(data);
219 mAnimationDataUpdated = true;
221 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
223 // The size should be changed in the main thread.
224 SetSize(data.width, data.height);
227 mVectorAnimationThread.AddTask(this);
230 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
232 if(mWidth != width || mHeight != height)
234 mVectorRenderer.SetSize(width, height);
239 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
243 void VectorAnimationTask::PlayAnimation()
245 if(mPlayState != PlayState::PLAYING)
247 mNeedAnimationFinishedTrigger = true;
248 mUpdateFrameNumber = false;
249 mPlayState = PlayState::PLAYING;
251 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
255 void VectorAnimationTask::StopAnimation()
257 if(mPlayState != PlayState::STOPPING)
259 mNeedAnimationFinishedTrigger = false;
260 mPlayState = PlayState::STOPPING;
262 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
266 void VectorAnimationTask::PauseAnimation()
268 if(mPlayState == PlayState::PLAYING)
270 mPlayState = PlayState::PAUSED;
272 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
276 void VectorAnimationTask::SetAnimationFinishedCallback(CallbackBase* callback)
278 ConditionalWait::ScopedLock lock(mConditionalWait);
279 mAnimationFinishedCallback = std::unique_ptr<CallbackBase>(callback);
282 void VectorAnimationTask::SetLoopCount(int32_t count)
284 if(mLoopCount != count)
289 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
293 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
296 uint32_t startFrame = 0, endFrame = 0;
297 size_t count = playRange.Count();
301 int32_t start = 0, end = 0;
302 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
304 startFrame = static_cast<uint32_t>(start);
305 endFrame = static_cast<uint32_t>(end);
310 std::string startMarker, endMarker;
311 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
315 uint32_t frame; // We don't use this later
316 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
327 if(playRange.GetElementAt(0).Get(marker))
329 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
338 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
342 // Make sure the range specified is between 0 and the total frame number
343 startFrame = std::min(startFrame, mTotalFrame - 1);
344 endFrame = std::min(endFrame, mTotalFrame - 1);
346 // If the range is not in order swap values
347 if(startFrame > endFrame)
349 uint32_t temp = startFrame;
350 startFrame = endFrame;
354 if(startFrame != mStartFrame || endFrame != mEndFrame)
356 mStartFrame = startFrame;
357 mEndFrame = endFrame;
359 // If the current frame is out of the range, change the current frame also.
360 if(mStartFrame > mCurrentFrame)
362 mCurrentFrame = mStartFrame;
364 else if(mEndFrame < mCurrentFrame)
366 mCurrentFrame = mEndFrame;
369 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mUrl.c_str(), this);
373 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
375 startFrame = mStartFrame;
376 endFrame = mEndFrame;
379 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
381 if(mCurrentFrame == frameNumber)
383 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
387 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
389 mCurrentFrame = frameNumber;
390 mUpdateFrameNumber = false;
392 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
396 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
400 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
402 return mCurrentFrame;
405 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
410 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
412 mVectorRenderer.GetDefaultSize(width, height);
415 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
417 mStopBehavior = stopBehavior;
419 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
422 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
424 mLoopingMode = loopingMode;
426 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
429 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
431 mVectorRenderer.GetLayerInfo(map);
434 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
436 return mResourceReadySignal;
439 bool VectorAnimationTask::Rasterize()
441 bool stopped = false;
442 uint32_t currentFrame;
443 mKeepAnimation = false;
446 ConditionalWait::ScopedLock lock(mConditionalWait);
449 // The task will be destroyed. We don't need rasterization.
464 DALI_TRACE_BEGIN(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK");
466 ApplyAnimationData();
468 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
470 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
471 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
474 currentFrame = mCurrentFrame;
476 mUpdateFrameNumber = true;
478 if(mPlayState == PlayState::STOPPING)
480 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
481 currentFrame = mCurrentFrame;
484 else if(mPlayState == PlayState::PLAYING)
486 bool animationFinished = false;
488 if(currentFrame >= mEndFrame) // last frame
490 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
496 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
498 mCurrentFrame = mStartFrame;
499 mUpdateFrameNumber = false;
503 animationFinished = true; // end of animation
507 else if(currentFrame == mStartFrame && !mForward) // first frame
509 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
515 animationFinished = true; // end of animation
519 if(animationFinished)
521 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
527 mPlayState = PlayState::STOPPING;
533 bool renderSuccess = false;
536 renderSuccess = mVectorRenderer.Render(currentFrame);
539 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
540 mUpdateFrameNumber = false;
544 if(stopped && renderSuccess)
546 mPlayState = PlayState::STOPPED;
552 // Notify the Renderer that rendering is stopped.
553 mVectorRenderer.RenderStopped();
556 // Animation is finished
558 ConditionalWait::ScopedLock lock(mConditionalWait);
559 if(mNeedAnimationFinishedTrigger && mAnimationFinishedCallback)
561 mVectorAnimationThread.AddEventTriggerCallback(mAnimationFinishedCallback.get());
565 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
568 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
570 mKeepAnimation = true;
574 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
576 std::ostringstream oss;
577 oss << "[size: " << mWidth << " x " << mHeight << ", ";
578 oss << "frame: " << mCurrentFrame << ", ";
579 oss << "loop: " << mCurrentLoop << ", ";
580 oss << "state : " << mPlayState << "]";
581 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
588 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
590 uint32_t frame = currentFrame;
592 switch(mStopBehavior)
594 case DevelImageVisual::StopBehavior::FIRST_FRAME:
599 case DevelImageVisual::StopBehavior::LAST_FRAME:
601 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
611 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
613 frame = currentFrame;
621 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
623 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
624 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
625 // is casted to use the default duration.
626 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
627 auto current = std::chrono::steady_clock::now();
632 mNextFrameStartTime = current;
634 else if(mNextFrameStartTime < current)
636 uint32_t droppedFrames = 0;
638 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
641 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
644 mNextFrameStartTime = current;
645 mDroppedFrames = droppedFrames;
648 return mNextFrameStartTime;
651 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
653 return mNextFrameStartTime;
656 void VectorAnimationTask::ApplyAnimationData()
661 ConditionalWait::ScopedLock lock(mConditionalWait);
663 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].size() != 0)
665 // Data is not updated or the previous data is not applied yet.
669 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
670 mAnimationDataUpdated = false;
672 index = mAnimationDataIndex;
675 for(const auto& animationData : mAnimationData[index])
677 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
679 SetLoopCount(animationData.loopCount);
682 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
684 SetPlayRange(animationData.playRange);
687 if(animationData.resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
689 SetStopBehavior(animationData.stopBehavior);
692 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
694 SetLoopingMode(animationData.loopingMode);
697 if(animationData.resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
699 SetCurrentFrameNumber(animationData.currentFrame);
702 if(animationData.resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
704 mVectorRenderer.InvalidateBuffer();
707 if(animationData.resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
709 for(auto&& iter : animationData.dynamicProperties)
711 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
715 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
717 if(animationData.playState == DevelImageVisual::PlayState::PLAYING)
721 else if(animationData.playState == DevelImageVisual::PlayState::PAUSED)
725 else if(animationData.playState == DevelImageVisual::PlayState::STOPPED)
733 mAnimationData[index].clear();
736 void VectorAnimationTask::OnUploadCompleted()
738 mResourceReadySignal.Emit(ResourceStatus::READY);
741 void VectorAnimationTask::OnLoadCompleted()
745 mResourceReadySignal.Emit(ResourceStatus::LOADED);
749 mResourceReadySignal.Emit(ResourceStatus::FAILED);
752 } // namespace Internal
754 } // namespace Toolkit