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(gTraceFilter, "DALI_LOTTIE_LOADING_TASK");
152 DALI_LOG_RELEASE_INFO("BEGIN: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
156 if(!mVectorRenderer.Load(mImageUrl.GetUrl()))
158 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mImageUrl.GetUrl().c_str());
164 mLoadRequest = false;
165 if(!synchronousLoading && mLoadCompletedCallback)
167 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
170 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
172 std::ostringstream oss;
173 oss << "[url:" << mImageUrl.GetUrl() << "]";
174 DALI_TRACE_END(gTraceFilter, "DALI_LOTTIE_LOADING_TASK");
175 DALI_LOG_RELEASE_INFO("END: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
181 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
183 mEndFrame = mTotalFrame - 1;
185 mFrameRate = mVectorRenderer.GetFrameRate();
186 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
188 mLoadRequest = false;
189 if(!synchronousLoading && mLoadCompletedCallback)
191 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
194 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mImageUrl.GetUrl().c_str(), mTotalFrame, mFrameRate, this);
197 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
199 std::ostringstream oss;
200 oss << "[url:" << mImageUrl.GetUrl() << "]";
201 DALI_TRACE_END(gTraceFilter, "DALI_LOTTIE_LOADING_TASK");
202 DALI_LOG_RELEASE_INFO("END: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
209 void VectorAnimationTask::SetRenderer(Renderer renderer)
211 ConditionalWait::ScopedLock lock(mConditionalWait);
213 mVectorRenderer.SetRenderer(renderer);
215 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
218 void VectorAnimationTask::RequestLoad(const VisualUrl& url, bool synchronousLoading)
222 if(!synchronousLoading)
226 mVectorAnimationThread.AddTask(this);
236 bool VectorAnimationTask::IsLoadRequested() const
241 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
243 ConditionalWait::ScopedLock lock(mConditionalWait);
245 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
247 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
249 mAnimationData[index].push_back(data);
250 mAnimationDataUpdated = true;
252 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
254 // The size should be changed in the main thread.
255 SetSize(data.width, data.height);
258 mVectorAnimationThread.AddTask(this);
261 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
263 if(mWidth != width || mHeight != height)
265 mVectorRenderer.SetSize(width, height);
270 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
274 void VectorAnimationTask::PlayAnimation()
276 if(mPlayState != PlayState::PLAYING)
278 mNeedAnimationFinishedTrigger = true;
279 mUpdateFrameNumber = false;
280 mPlayState = PlayState::PLAYING;
282 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
286 void VectorAnimationTask::StopAnimation()
288 if(mPlayState != PlayState::STOPPING)
290 mNeedAnimationFinishedTrigger = false;
291 mPlayState = PlayState::STOPPING;
293 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
297 void VectorAnimationTask::PauseAnimation()
299 if(mPlayState == PlayState::PLAYING)
301 mPlayState = PlayState::PAUSED;
303 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
307 void VectorAnimationTask::SetAnimationFinishedCallback(CallbackBase* callback)
309 ConditionalWait::ScopedLock lock(mConditionalWait);
310 mAnimationFinishedCallback = std::unique_ptr<CallbackBase>(callback);
313 void VectorAnimationTask::SetLoopCount(int32_t count)
315 if(mLoopCount != count)
320 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
324 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
327 uint32_t startFrame = 0, endFrame = 0;
328 size_t count = playRange.Count();
332 int32_t start = 0, end = 0;
333 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
335 startFrame = static_cast<uint32_t>(start);
336 endFrame = static_cast<uint32_t>(end);
341 std::string startMarker, endMarker;
342 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
346 uint32_t frame; // We don't use this later
347 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
358 if(playRange.GetElementAt(0).Get(marker))
360 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
369 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
373 // Make sure the range specified is between 0 and the total frame number
374 startFrame = std::min(startFrame, mTotalFrame - 1);
375 endFrame = std::min(endFrame, mTotalFrame - 1);
377 // If the range is not in order swap values
378 if(startFrame > endFrame)
380 uint32_t temp = startFrame;
381 startFrame = endFrame;
385 if(startFrame != mStartFrame || endFrame != mEndFrame)
387 mStartFrame = startFrame;
388 mEndFrame = endFrame;
390 // If the current frame is out of the range, change the current frame also.
391 if(mStartFrame > mCurrentFrame)
393 mCurrentFrame = mStartFrame;
395 else if(mEndFrame < mCurrentFrame)
397 mCurrentFrame = mEndFrame;
400 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mImageUrl.GetUrl().c_str(), this);
404 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
406 startFrame = mStartFrame;
407 endFrame = mEndFrame;
410 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
412 if(mCurrentFrame == frameNumber)
414 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
418 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
420 mCurrentFrame = frameNumber;
421 mUpdateFrameNumber = false;
423 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
427 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
431 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
433 return mCurrentFrame;
436 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
441 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
443 mVectorRenderer.GetDefaultSize(width, height);
446 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
448 mStopBehavior = stopBehavior;
450 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
453 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
455 mLoopingMode = loopingMode;
457 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
460 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
462 mVectorRenderer.GetLayerInfo(map);
465 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
467 return mResourceReadySignal;
470 bool VectorAnimationTask::Rasterize()
472 bool stopped = false;
473 uint32_t currentFrame;
474 mKeepAnimation = false;
477 ConditionalWait::ScopedLock lock(mConditionalWait);
480 // The task will be destroyed. We don't need rasterization.
496 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
498 std::ostringstream oss;
499 oss << "[size:" << mWidth << "x" << mHeight << " ";
500 oss << "url:" << mImageUrl.GetUrl() << "]";
501 DALI_TRACE_BEGIN_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
505 ApplyAnimationData();
507 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
509 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
510 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
513 currentFrame = mCurrentFrame;
515 mUpdateFrameNumber = true;
517 if(mPlayState == PlayState::STOPPING)
519 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
520 currentFrame = mCurrentFrame;
523 else if(mPlayState == PlayState::PLAYING)
525 bool animationFinished = false;
527 if(currentFrame >= mEndFrame) // last frame
529 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
535 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
537 mCurrentFrame = mStartFrame;
538 mUpdateFrameNumber = false;
542 animationFinished = true; // end of animation
546 else if(currentFrame == mStartFrame && !mForward) // first frame
548 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
554 animationFinished = true; // end of animation
558 if(animationFinished)
560 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
566 mPlayState = PlayState::STOPPING;
572 bool renderSuccess = false;
575 renderSuccess = mVectorRenderer.Render(currentFrame);
578 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
579 mUpdateFrameNumber = false;
583 if(stopped && renderSuccess)
585 mPlayState = PlayState::STOPPED;
591 // Notify the Renderer that rendering is stopped.
592 mVectorRenderer.RenderStopped();
595 // Animation is finished
597 ConditionalWait::ScopedLock lock(mConditionalWait);
598 if(mNeedAnimationFinishedTrigger && mAnimationFinishedCallback)
600 mVectorAnimationThread.AddEventTriggerCallback(mAnimationFinishedCallback.get());
604 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
607 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
609 mKeepAnimation = true;
613 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
615 std::ostringstream oss;
616 oss << "[size:" << mWidth << "x" << mHeight << " ";
617 oss << "frame:" << mCurrentFrame << " ";
618 oss << "loop:" << mCurrentLoop << " ";
619 oss << "state:" << mPlayState << " ";
620 oss << "url:" << mImageUrl.GetUrl() << "]";
621 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
628 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
630 uint32_t frame = currentFrame;
632 switch(mStopBehavior)
634 case DevelImageVisual::StopBehavior::FIRST_FRAME:
639 case DevelImageVisual::StopBehavior::LAST_FRAME:
641 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
651 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
653 frame = currentFrame;
661 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
663 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
664 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
665 // is casted to use the default duration.
666 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
667 auto current = std::chrono::steady_clock::now();
672 mNextFrameStartTime = current;
674 else if(mNextFrameStartTime < current)
676 uint32_t droppedFrames = 0;
678 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
681 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
684 mNextFrameStartTime = current;
685 mDroppedFrames = droppedFrames;
688 return mNextFrameStartTime;
691 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
693 return mNextFrameStartTime;
696 void VectorAnimationTask::ApplyAnimationData()
701 ConditionalWait::ScopedLock lock(mConditionalWait);
703 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].size() != 0)
705 // Data is not updated or the previous data is not applied yet.
709 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
710 mAnimationDataUpdated = false;
712 index = mAnimationDataIndex;
715 for(const auto& animationData : mAnimationData[index])
717 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
719 SetLoopCount(animationData.loopCount);
722 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
724 SetPlayRange(animationData.playRange);
727 if(animationData.resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
729 SetStopBehavior(animationData.stopBehavior);
732 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
734 SetLoopingMode(animationData.loopingMode);
737 if(animationData.resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
739 SetCurrentFrameNumber(animationData.currentFrame);
742 if(animationData.resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
744 mVectorRenderer.InvalidateBuffer();
747 if(animationData.resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
749 for(auto&& iter : animationData.dynamicProperties)
751 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
755 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
757 if(animationData.playState == DevelImageVisual::PlayState::PLAYING)
761 else if(animationData.playState == DevelImageVisual::PlayState::PAUSED)
765 else if(animationData.playState == DevelImageVisual::PlayState::STOPPED)
773 mAnimationData[index].clear();
776 void VectorAnimationTask::OnUploadCompleted()
778 mResourceReadySignal.Emit(ResourceStatus::READY);
781 void VectorAnimationTask::OnLoadCompleted()
785 mResourceReadySignal.Emit(ResourceStatus::LOADED);
789 mResourceReadySignal.Emit(ResourceStatus::FAILED);
792 } // namespace Internal
794 } // namespace Toolkit