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)
147 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
149 std::ostringstream oss;
150 oss << "[url:" << mImageUrl.GetUrl() << "]";
151 DALI_TRACE_BEGIN_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_LOADING_TASK", oss.str().c_str());
155 if(!mVectorRenderer.Load(mImageUrl.GetUrl()))
157 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mImageUrl.GetUrl().c_str());
163 mLoadRequest = false;
164 if(!synchronousLoading && mLoadCompletedCallback)
166 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
169 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
171 std::ostringstream oss;
172 oss << "[url:" << mImageUrl.GetUrl() << "]";
173 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_LOADING_TASK", oss.str().c_str());
179 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
181 mEndFrame = mTotalFrame - 1;
183 mFrameRate = mVectorRenderer.GetFrameRate();
184 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
186 mLoadRequest = false;
187 if(!synchronousLoading && mLoadCompletedCallback)
189 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
192 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mImageUrl.GetUrl().c_str(), mTotalFrame, mFrameRate, this);
195 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
197 std::ostringstream oss;
198 oss << "[url:" << mImageUrl.GetUrl() << "]";
199 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_LOADING_TASK", oss.str().c_str());
206 void VectorAnimationTask::SetRenderer(Renderer renderer)
208 ConditionalWait::ScopedLock lock(mConditionalWait);
210 mVectorRenderer.SetRenderer(renderer);
212 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
215 void VectorAnimationTask::RequestLoad(const VisualUrl& url, bool synchronousLoading)
219 if(!synchronousLoading)
223 mVectorAnimationThread.AddTask(this);
233 bool VectorAnimationTask::IsLoadRequested() const
238 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
240 ConditionalWait::ScopedLock lock(mConditionalWait);
242 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
244 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
246 mAnimationData[index].push_back(data);
247 mAnimationDataUpdated = true;
249 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
251 // The size should be changed in the main thread.
252 SetSize(data.width, data.height);
255 mVectorAnimationThread.AddTask(this);
258 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
260 if(mWidth != width || mHeight != height)
262 mVectorRenderer.SetSize(width, height);
267 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
271 void VectorAnimationTask::PlayAnimation()
273 if(mPlayState != PlayState::PLAYING)
275 mNeedAnimationFinishedTrigger = true;
276 mUpdateFrameNumber = false;
277 mPlayState = PlayState::PLAYING;
279 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
283 void VectorAnimationTask::StopAnimation()
285 if(mPlayState != PlayState::STOPPING)
287 mNeedAnimationFinishedTrigger = false;
288 mPlayState = PlayState::STOPPING;
290 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
294 void VectorAnimationTask::PauseAnimation()
296 if(mPlayState == PlayState::PLAYING)
298 mPlayState = PlayState::PAUSED;
300 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
304 void VectorAnimationTask::SetAnimationFinishedCallback(CallbackBase* callback)
306 ConditionalWait::ScopedLock lock(mConditionalWait);
307 mAnimationFinishedCallback = std::unique_ptr<CallbackBase>(callback);
310 void VectorAnimationTask::SetLoopCount(int32_t count)
312 if(mLoopCount != count)
317 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
321 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
324 uint32_t startFrame = 0, endFrame = 0;
325 size_t count = playRange.Count();
329 int32_t start = 0, end = 0;
330 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
332 startFrame = static_cast<uint32_t>(start);
333 endFrame = static_cast<uint32_t>(end);
338 std::string startMarker, endMarker;
339 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
343 uint32_t frame; // We don't use this later
344 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
355 if(playRange.GetElementAt(0).Get(marker))
357 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
366 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
370 // Make sure the range specified is between 0 and the total frame number
371 startFrame = std::min(startFrame, mTotalFrame - 1);
372 endFrame = std::min(endFrame, mTotalFrame - 1);
374 // If the range is not in order swap values
375 if(startFrame > endFrame)
377 uint32_t temp = startFrame;
378 startFrame = endFrame;
382 if(startFrame != mStartFrame || endFrame != mEndFrame)
384 mStartFrame = startFrame;
385 mEndFrame = endFrame;
387 // If the current frame is out of the range, change the current frame also.
388 if(mStartFrame > mCurrentFrame)
390 mCurrentFrame = mStartFrame;
392 else if(mEndFrame < mCurrentFrame)
394 mCurrentFrame = mEndFrame;
397 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mImageUrl.GetUrl().c_str(), this);
401 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
403 startFrame = mStartFrame;
404 endFrame = mEndFrame;
407 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
409 if(mCurrentFrame == frameNumber)
411 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
415 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
417 mCurrentFrame = frameNumber;
418 mUpdateFrameNumber = false;
420 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
424 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
428 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
430 return mCurrentFrame;
433 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
438 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
440 mVectorRenderer.GetDefaultSize(width, height);
443 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
445 mStopBehavior = stopBehavior;
447 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
450 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
452 mLoopingMode = loopingMode;
454 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
457 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
459 mVectorRenderer.GetLayerInfo(map);
462 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
464 return mResourceReadySignal;
467 bool VectorAnimationTask::Rasterize()
469 bool stopped = false;
470 uint32_t currentFrame;
471 mKeepAnimation = false;
474 ConditionalWait::ScopedLock lock(mConditionalWait);
477 // The task will be destroyed. We don't need rasterization.
493 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
495 std::ostringstream oss;
496 oss << "[size:" << mWidth << "x" << mHeight << " ";
497 oss << "url:" << mImageUrl.GetUrl() << "]";
498 DALI_TRACE_BEGIN_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
502 ApplyAnimationData();
504 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
506 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
507 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
510 currentFrame = mCurrentFrame;
512 mUpdateFrameNumber = true;
514 if(mPlayState == PlayState::STOPPING)
516 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
517 currentFrame = mCurrentFrame;
520 else if(mPlayState == PlayState::PLAYING)
522 bool animationFinished = false;
524 if(currentFrame >= mEndFrame) // last frame
526 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
532 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
534 mCurrentFrame = mStartFrame;
535 mUpdateFrameNumber = false;
539 animationFinished = true; // end of animation
543 else if(currentFrame == mStartFrame && !mForward) // first frame
545 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
551 animationFinished = true; // end of animation
555 if(animationFinished)
557 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
563 mPlayState = PlayState::STOPPING;
569 bool renderSuccess = false;
572 renderSuccess = mVectorRenderer.Render(currentFrame);
575 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
576 mUpdateFrameNumber = false;
580 if(stopped && renderSuccess)
582 mPlayState = PlayState::STOPPED;
588 // Notify the Renderer that rendering is stopped.
589 mVectorRenderer.RenderStopped();
592 // Animation is finished
594 ConditionalWait::ScopedLock lock(mConditionalWait);
595 if(mNeedAnimationFinishedTrigger && mAnimationFinishedCallback)
597 mVectorAnimationThread.AddEventTriggerCallback(mAnimationFinishedCallback.get());
601 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
604 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
606 mKeepAnimation = true;
610 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
612 std::ostringstream oss;
613 oss << "[size:" << mWidth << "x" << mHeight << " ";
614 oss << "frame:" << mCurrentFrame << " ";
615 oss << "loop:" << mCurrentLoop << " ";
616 oss << "state:" << mPlayState << " ";
617 oss << "url:" << mImageUrl.GetUrl() << "]";
618 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
625 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
627 uint32_t frame = currentFrame;
629 switch(mStopBehavior)
631 case DevelImageVisual::StopBehavior::FIRST_FRAME:
636 case DevelImageVisual::StopBehavior::LAST_FRAME:
638 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
648 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
650 frame = currentFrame;
658 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
660 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
661 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
662 // is casted to use the default duration.
663 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
664 auto current = std::chrono::steady_clock::now();
669 mNextFrameStartTime = current;
671 else if(mNextFrameStartTime < current)
673 uint32_t droppedFrames = 0;
675 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
678 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
681 mNextFrameStartTime = current;
682 mDroppedFrames = droppedFrames;
685 return mNextFrameStartTime;
688 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
690 return mNextFrameStartTime;
693 void VectorAnimationTask::ApplyAnimationData()
698 ConditionalWait::ScopedLock lock(mConditionalWait);
700 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].size() != 0)
702 // Data is not updated or the previous data is not applied yet.
706 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
707 mAnimationDataUpdated = false;
709 index = mAnimationDataIndex;
712 for(const auto& animationData : mAnimationData[index])
714 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
716 SetLoopCount(animationData.loopCount);
719 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
721 SetPlayRange(animationData.playRange);
724 if(animationData.resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
726 SetStopBehavior(animationData.stopBehavior);
729 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
731 SetLoopingMode(animationData.loopingMode);
734 if(animationData.resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
736 SetCurrentFrameNumber(animationData.currentFrame);
739 if(animationData.resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
741 mVectorRenderer.InvalidateBuffer();
744 if(animationData.resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
746 for(auto&& iter : animationData.dynamicProperties)
748 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
752 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
754 if(animationData.playState == DevelImageVisual::PlayState::PLAYING)
758 else if(animationData.playState == DevelImageVisual::PlayState::PAUSED)
762 else if(animationData.playState == DevelImageVisual::PlayState::STOPPED)
770 mAnimationData[index].clear();
773 void VectorAnimationTask::OnUploadCompleted()
775 mResourceReadySignal.Emit(ResourceStatus::READY);
778 void VectorAnimationTask::OnLoadCompleted()
782 mResourceReadySignal.Emit(ResourceStatus::LOADED);
786 mResourceReadySignal.Emit(ResourceStatus::FAILED);
789 } // namespace Internal
791 } // namespace Toolkit