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/devel-api/adaptor-framework/file-loader.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/integration-api/trace.h>
25 #include <dali/public-api/math/math-utils.h>
26 #include <dali/public-api/object/property-array.h>
29 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
30 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
31 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
45 constexpr auto LOOP_FOREVER = -1;
46 constexpr auto MICROSECONDS_PER_SECOND(1e+6);
48 #if defined(DEBUG_ENABLED)
49 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VECTOR_ANIMATION");
52 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_IMAGE_PERFORMANCE_MARKER, false);
54 } // unnamed namespace
56 VectorAnimationTask::VectorAnimationTask(VisualFactoryCache& factoryCache)
57 : AsyncTask(MakeCallback(this, &VectorAnimationTask::TaskCompleted), AsyncTask::PriorityType::HIGH, AsyncTask::ThreadType::WORKER_THREAD),
59 mEncodedImageBuffer(),
60 mVectorRenderer(VectorAnimationRenderer::New()),
62 mVectorAnimationThread(factoryCache.GetVectorAnimationManager().GetVectorAnimationThread()),
64 mResourceReadySignal(),
65 mLoadCompletedCallback(MakeCallback(this, &VectorAnimationTask::OnLoadCompleted)),
68 mPlayState(PlayState::STOPPED),
69 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
70 mLoopingMode(DevelImageVisual::LoopingMode::RESTART),
71 mNextFrameStartTime(),
72 mFrameDurationMicroSeconds(MICROSECONDS_PER_SECOND / 60.0f),
81 mAnimationDataIndex(0),
82 mLoopCount(LOOP_FOREVER),
85 mUpdateFrameNumber(false),
86 mNeedAnimationFinishedTrigger(true),
87 mAnimationDataUpdated(false),
92 mKeepAnimation(false),
93 mLayerInfoCached(false),
94 mMarkerInfoCached(false)
96 mVectorRenderer.UploadCompletedSignal().Connect(this, &VectorAnimationTask::OnUploadCompleted);
99 VectorAnimationTask::~VectorAnimationTask()
101 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this);
104 void VectorAnimationTask::Process()
106 mRasterized = Rasterize();
109 bool VectorAnimationTask::IsReady()
114 void VectorAnimationTask::Finalize()
116 ConditionalWait::ScopedLock lock(mConditionalWait);
118 // Release some objects in the main thread
119 if(mAnimationFinishedCallback)
121 mVectorAnimationThread.RemoveEventTriggerCallback(mAnimationFinishedCallback.get());
122 mAnimationFinishedCallback.reset();
124 if(mLoadCompletedCallback)
126 mVectorAnimationThread.RemoveEventTriggerCallback(mLoadCompletedCallback.get());
127 mLoadCompletedCallback.reset();
130 mVectorRenderer.Finalize();
135 void VectorAnimationTask::TaskCompleted(VectorAnimationTaskPtr task)
137 mVectorAnimationThread.OnTaskCompleted(task, task->IsRasterized(), task->IsAnimating());
140 bool VectorAnimationTask::IsRasterized()
145 bool VectorAnimationTask::IsAnimating()
147 return mKeepAnimation;
150 bool VectorAnimationTask::Load(bool synchronousLoading)
153 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
155 std::ostringstream oss;
156 oss << "[url:" << mImageUrl.GetUrl() << "]";
157 // DALI_TRACE_BEGIN(gTraceFilter, "DALI_LOTTIE_LOADING_TASK"); ///< TODO : Open it if we can control trace log level
158 DALI_LOG_RELEASE_INFO("BEGIN: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
162 if(mEncodedImageBuffer)
164 if(!mVectorRenderer.Load(mEncodedImageBuffer.GetRawBuffer()))
169 // We don't need to hold image buffer anymore.
170 mEncodedImageBuffer.Reset();
172 else if(mImageUrl.IsLocalResource())
174 if(!mVectorRenderer.Load(mImageUrl.GetUrl()))
181 Dali::Vector<uint8_t> remoteData;
182 if(!Dali::FileLoader::DownloadFileSynchronously(mImageUrl.GetUrl(), remoteData) || // Failed if we fail to download json file,
183 !mVectorRenderer.Load(remoteData)) // or download data is not valid vector animation file.
191 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mImageUrl.GetUrl().c_str());
192 mLoadRequest = false;
193 if(!synchronousLoading && mLoadCompletedCallback)
195 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
198 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
200 std::ostringstream oss;
201 oss << "[url:" << mImageUrl.GetUrl() << "]";
202 // DALI_TRACE_END(gTraceFilter, "DALI_LOTTIE_LOADING_TASK"); ///< TODO : Open it if we can control trace log level
203 DALI_LOG_RELEASE_INFO("END: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
209 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
211 mEndFrame = mTotalFrame - 1;
213 mFrameRate = mVectorRenderer.GetFrameRate();
214 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
216 mLoadRequest = false;
217 if(!synchronousLoading && mLoadCompletedCallback)
219 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
222 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mImageUrl.GetUrl().c_str(), mTotalFrame, mFrameRate, this);
225 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
227 std::ostringstream oss;
228 oss << "[url:" << mImageUrl.GetUrl() << "]";
229 // DALI_TRACE_END(gTraceFilter, "DALI_LOTTIE_LOADING_TASK"); ///< TODO : Open it if we can control trace log level
230 DALI_LOG_RELEASE_INFO("END: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
237 void VectorAnimationTask::SetRenderer(Renderer renderer)
239 ConditionalWait::ScopedLock lock(mConditionalWait);
241 mVectorRenderer.SetRenderer(renderer);
243 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
246 void VectorAnimationTask::RequestLoad(const VisualUrl& url, EncodedImageBuffer encodedImageBuffer, bool synchronousLoading)
249 mEncodedImageBuffer = encodedImageBuffer;
251 if(!synchronousLoading)
255 mVectorAnimationThread.AddTask(this);
265 bool VectorAnimationTask::IsLoadRequested() const
270 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
272 ConditionalWait::ScopedLock lock(mConditionalWait);
274 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
276 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
278 mAnimationData[index].push_back(data);
279 mAnimationDataUpdated = true;
281 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
283 // The size should be changed in the main thread.
284 SetSize(data.width, data.height);
287 mVectorAnimationThread.AddTask(this);
290 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
292 if(mWidth != width || mHeight != height)
294 mVectorRenderer.SetSize(width, height);
299 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
303 void VectorAnimationTask::PlayAnimation()
305 if(mPlayState != PlayState::PLAYING)
307 mNeedAnimationFinishedTrigger = true;
308 mUpdateFrameNumber = false;
309 mPlayState = PlayState::PLAYING;
311 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
315 void VectorAnimationTask::StopAnimation()
317 if(mPlayState != PlayState::STOPPING)
319 mNeedAnimationFinishedTrigger = false;
320 mPlayState = PlayState::STOPPING;
322 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
326 void VectorAnimationTask::PauseAnimation()
328 if(mPlayState == PlayState::PLAYING)
330 mPlayState = PlayState::PAUSED;
332 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
336 void VectorAnimationTask::SetAnimationFinishedCallback(CallbackBase* callback)
338 ConditionalWait::ScopedLock lock(mConditionalWait);
339 mAnimationFinishedCallback = std::unique_ptr<CallbackBase>(callback);
342 void VectorAnimationTask::SetLoopCount(int32_t count)
344 if(mLoopCount != count)
349 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
353 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
356 uint32_t startFrame = 0, endFrame = 0;
357 size_t count = playRange.Count();
361 int32_t start = 0, end = 0;
362 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
364 startFrame = static_cast<uint32_t>(start);
365 endFrame = static_cast<uint32_t>(end);
370 std::string startMarker, endMarker;
371 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
375 uint32_t frame; // We don't use this later
376 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
387 if(playRange.GetElementAt(0).Get(marker))
389 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
398 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
402 // Make sure the range specified is between 0 and the total frame number
403 startFrame = std::min(startFrame, mTotalFrame - 1);
404 endFrame = std::min(endFrame, mTotalFrame - 1);
406 // If the range is not in order swap values
407 if(startFrame > endFrame)
409 uint32_t temp = startFrame;
410 startFrame = endFrame;
414 if(startFrame != mStartFrame || endFrame != mEndFrame)
416 mStartFrame = startFrame;
417 mEndFrame = endFrame;
419 // If the current frame is out of the range, change the current frame also.
420 if(mStartFrame > mCurrentFrame)
422 mCurrentFrame = mStartFrame;
424 else if(mEndFrame < mCurrentFrame)
426 mCurrentFrame = mEndFrame;
429 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mImageUrl.GetUrl().c_str(), this);
433 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
435 startFrame = mStartFrame;
436 endFrame = mEndFrame;
439 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
441 if(mCurrentFrame == frameNumber)
443 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
447 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
449 mCurrentFrame = frameNumber;
450 mUpdateFrameNumber = false;
452 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
456 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
460 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
462 return mCurrentFrame;
465 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
470 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
472 mVectorRenderer.GetDefaultSize(width, height);
475 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
477 mStopBehavior = stopBehavior;
479 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
482 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
484 mLoopingMode = loopingMode;
486 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
489 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
491 // Fast-out if file is loading, or load failed.
492 if(mLoadFailed || IsLoadRequested())
497 if(DALI_UNLIKELY(!mLayerInfoCached))
499 // Update only 1 time.
500 mLayerInfoCached = true;
501 mVectorRenderer.GetLayerInfo(mCachedLayerInfo);
504 map = mCachedLayerInfo;
507 void VectorAnimationTask::GetMarkerInfo(Property::Map& map) const
509 // Fast-out if file is loading, or load failed.
510 if(mLoadFailed || IsLoadRequested())
515 if(DALI_UNLIKELY(!mMarkerInfoCached))
517 // Update only 1 time.
518 mMarkerInfoCached = true;
519 mVectorRenderer.GetMarkerInfo(mCachedMarkerInfo);
522 map = mCachedMarkerInfo;
525 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
527 return mResourceReadySignal;
530 bool VectorAnimationTask::Rasterize()
532 bool stopped = false;
533 uint32_t currentFrame;
534 mKeepAnimation = false;
537 ConditionalWait::ScopedLock lock(mConditionalWait);
540 // The task will be destroyed. We don't need rasterization.
556 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
558 std::ostringstream oss;
559 oss << "[size:" << mWidth << "x" << mHeight << " ";
560 oss << "url:" << mImageUrl.GetUrl() << "]";
561 DALI_TRACE_BEGIN_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
565 ApplyAnimationData();
567 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
569 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
570 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
573 currentFrame = mCurrentFrame;
575 mUpdateFrameNumber = true;
577 if(mPlayState == PlayState::STOPPING)
579 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
580 currentFrame = mCurrentFrame;
583 else if(mPlayState == PlayState::PLAYING)
585 bool animationFinished = false;
587 if(currentFrame >= mEndFrame) // last frame
589 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
595 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
597 mCurrentFrame = mStartFrame;
598 mUpdateFrameNumber = false;
602 animationFinished = true; // end of animation
606 else if(currentFrame == mStartFrame && !mForward) // first frame
608 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
614 animationFinished = true; // end of animation
618 if(animationFinished)
620 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
626 mPlayState = PlayState::STOPPING;
632 bool renderSuccess = false;
635 renderSuccess = mVectorRenderer.Render(currentFrame);
638 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
639 mUpdateFrameNumber = false;
643 if(stopped && renderSuccess)
645 mPlayState = PlayState::STOPPED;
651 // Notify the Renderer that rendering is stopped.
652 mVectorRenderer.RenderStopped();
655 // Animation is finished
657 ConditionalWait::ScopedLock lock(mConditionalWait);
658 if(mNeedAnimationFinishedTrigger && mAnimationFinishedCallback)
660 mVectorAnimationThread.AddEventTriggerCallback(mAnimationFinishedCallback.get());
664 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
667 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
669 mKeepAnimation = true;
673 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
675 std::ostringstream oss;
676 oss << "[size:" << mWidth << "x" << mHeight << " ";
677 oss << "frame:" << mCurrentFrame << " ";
678 oss << "loop:" << mCurrentLoop << " ";
679 oss << "state:" << mPlayState << " ";
680 oss << "url:" << mImageUrl.GetUrl() << "]";
681 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
688 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
690 uint32_t frame = currentFrame;
692 switch(mStopBehavior)
694 case DevelImageVisual::StopBehavior::FIRST_FRAME:
699 case DevelImageVisual::StopBehavior::LAST_FRAME:
701 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
711 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
713 frame = currentFrame;
721 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
723 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
724 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
725 // is casted to use the default duration.
726 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
727 auto current = std::chrono::steady_clock::now();
732 mNextFrameStartTime = current;
734 else if(mNextFrameStartTime < current)
736 uint32_t droppedFrames = 0;
738 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
741 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
744 mNextFrameStartTime = current;
745 mDroppedFrames = droppedFrames;
748 return mNextFrameStartTime;
751 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
753 return mNextFrameStartTime;
756 void VectorAnimationTask::ApplyAnimationData()
761 ConditionalWait::ScopedLock lock(mConditionalWait);
763 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].size() != 0)
765 // Data is not updated or the previous data is not applied yet.
769 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
770 mAnimationDataUpdated = false;
772 index = mAnimationDataIndex;
775 for(const auto& animationData : mAnimationData[index])
777 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
779 SetLoopCount(animationData.loopCount);
782 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
784 SetPlayRange(animationData.playRange);
787 if(animationData.resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
789 SetStopBehavior(animationData.stopBehavior);
792 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
794 SetLoopingMode(animationData.loopingMode);
797 if(animationData.resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
799 SetCurrentFrameNumber(animationData.currentFrame);
802 if(animationData.resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
804 mVectorRenderer.InvalidateBuffer();
807 if(animationData.resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
809 for(auto&& iter : animationData.dynamicProperties)
811 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
815 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
817 if(animationData.playState == DevelImageVisual::PlayState::PLAYING)
821 else if(animationData.playState == DevelImageVisual::PlayState::PAUSED)
825 else if(animationData.playState == DevelImageVisual::PlayState::STOPPED)
833 mAnimationData[index].clear();
836 void VectorAnimationTask::OnUploadCompleted()
838 mResourceReadySignal.Emit(ResourceStatus::READY);
841 void VectorAnimationTask::OnLoadCompleted()
845 mResourceReadySignal.Emit(ResourceStatus::LOADED);
849 mResourceReadySignal.Emit(ResourceStatus::FAILED);
852 } // namespace Internal
854 } // namespace Toolkit