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)),
66 mPlayState(PlayState::STOPPED),
67 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
68 mLoopingMode(DevelImageVisual::LoopingMode::RESTART),
69 mNextFrameStartTime(),
70 mFrameDurationMicroSeconds(MICROSECONDS_PER_SECOND / 60.0f),
79 mAnimationDataIndex(0),
80 mLoopCount(LOOP_FOREVER),
83 mUpdateFrameNumber(false),
84 mNeedAnimationFinishedTrigger(true),
85 mAnimationDataUpdated(false),
92 mVectorRenderer.UploadCompletedSignal().Connect(this, &VectorAnimationTask::OnUploadCompleted);
95 VectorAnimationTask::~VectorAnimationTask()
97 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this);
100 void VectorAnimationTask::Process()
102 mRasterized = Rasterize();
105 bool VectorAnimationTask::IsReady()
110 void VectorAnimationTask::Finalize()
112 ConditionalWait::ScopedLock lock(mConditionalWait);
114 // Release some objects in the main thread
115 if(mAnimationFinishedCallback)
117 mVectorAnimationThread.RemoveEventTriggerCallback(mAnimationFinishedCallback.get());
118 mAnimationFinishedCallback.reset();
120 if(mLoadCompletedCallback)
122 mVectorAnimationThread.RemoveEventTriggerCallback(mLoadCompletedCallback.get());
123 mLoadCompletedCallback.reset();
126 mVectorRenderer.Finalize();
131 void VectorAnimationTask::TaskCompleted(VectorAnimationTaskPtr task)
133 mVectorAnimationThread.OnTaskCompleted(task, task->IsRasterized(), task->IsAnimating());
136 bool VectorAnimationTask::IsRasterized()
141 bool VectorAnimationTask::IsAnimating()
143 return mKeepAnimation;
146 bool VectorAnimationTask::Load(bool synchronousLoading)
149 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
151 std::ostringstream oss;
152 oss << "[url:" << mImageUrl.GetUrl() << "]";
153 // DALI_TRACE_BEGIN(gTraceFilter, "DALI_LOTTIE_LOADING_TASK"); ///< TODO : Open it if we can control trace log level
154 DALI_LOG_RELEASE_INFO("BEGIN: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
158 if(mEncodedImageBuffer)
160 if(!mVectorRenderer.Load(mEncodedImageBuffer.GetRawBuffer()))
165 // We don't need to hold image buffer anymore.
166 mEncodedImageBuffer.Reset();
168 else if(mImageUrl.IsLocalResource())
170 if(!mVectorRenderer.Load(mImageUrl.GetUrl()))
177 Dali::Vector<uint8_t> remoteData;
178 if(!Dali::FileLoader::DownloadFileSynchronously(mImageUrl.GetUrl(), remoteData) || // Failed if we fail to download json file,
179 !mVectorRenderer.Load(remoteData)) // or download data is not valid vector animation file.
187 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mImageUrl.GetUrl().c_str());
188 mLoadRequest = false;
189 if(!synchronousLoading && mLoadCompletedCallback)
191 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
194 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
196 std::ostringstream oss;
197 oss << "[url:" << mImageUrl.GetUrl() << "]";
198 // DALI_TRACE_END(gTraceFilter, "DALI_LOTTIE_LOADING_TASK"); ///< TODO : Open it if we can control trace log level
199 DALI_LOG_RELEASE_INFO("END: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
205 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
207 mEndFrame = mTotalFrame - 1;
209 mFrameRate = mVectorRenderer.GetFrameRate();
210 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
212 mLoadRequest = false;
213 if(!synchronousLoading && mLoadCompletedCallback)
215 mVectorAnimationThread.AddEventTriggerCallback(mLoadCompletedCallback.get());
218 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mImageUrl.GetUrl().c_str(), mTotalFrame, mFrameRate, this);
221 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
223 std::ostringstream oss;
224 oss << "[url:" << mImageUrl.GetUrl() << "]";
225 // DALI_TRACE_END(gTraceFilter, "DALI_LOTTIE_LOADING_TASK"); ///< TODO : Open it if we can control trace log level
226 DALI_LOG_RELEASE_INFO("END: DALI_LOTTIE_LOADING_TASK %s", oss.str().c_str());
233 void VectorAnimationTask::SetRenderer(Renderer renderer)
235 ConditionalWait::ScopedLock lock(mConditionalWait);
237 mVectorRenderer.SetRenderer(renderer);
239 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
242 void VectorAnimationTask::RequestLoad(const VisualUrl& url, EncodedImageBuffer encodedImageBuffer, bool synchronousLoading)
245 mEncodedImageBuffer = encodedImageBuffer;
247 if(!synchronousLoading)
251 mVectorAnimationThread.AddTask(this);
261 bool VectorAnimationTask::IsLoadRequested() const
266 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
268 ConditionalWait::ScopedLock lock(mConditionalWait);
270 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
272 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
274 mAnimationData[index].push_back(data);
275 mAnimationDataUpdated = true;
277 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
279 // The size should be changed in the main thread.
280 SetSize(data.width, data.height);
283 mVectorAnimationThread.AddTask(this);
286 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
288 if(mWidth != width || mHeight != height)
290 mVectorRenderer.SetSize(width, height);
295 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
299 void VectorAnimationTask::PlayAnimation()
301 if(mPlayState != PlayState::PLAYING)
303 mNeedAnimationFinishedTrigger = true;
304 mUpdateFrameNumber = false;
305 mPlayState = PlayState::PLAYING;
307 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
311 void VectorAnimationTask::StopAnimation()
313 if(mPlayState != PlayState::STOPPING)
315 mNeedAnimationFinishedTrigger = false;
316 mPlayState = PlayState::STOPPING;
318 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
322 void VectorAnimationTask::PauseAnimation()
324 if(mPlayState == PlayState::PLAYING)
326 mPlayState = PlayState::PAUSED;
328 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
332 void VectorAnimationTask::SetAnimationFinishedCallback(CallbackBase* callback)
334 ConditionalWait::ScopedLock lock(mConditionalWait);
335 mAnimationFinishedCallback = std::unique_ptr<CallbackBase>(callback);
338 void VectorAnimationTask::SetLoopCount(int32_t count)
340 if(mLoopCount != count)
345 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
349 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
352 uint32_t startFrame = 0, endFrame = 0;
353 size_t count = playRange.Count();
357 int32_t start = 0, end = 0;
358 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
360 startFrame = static_cast<uint32_t>(start);
361 endFrame = static_cast<uint32_t>(end);
366 std::string startMarker, endMarker;
367 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
371 uint32_t frame; // We don't use this later
372 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
383 if(playRange.GetElementAt(0).Get(marker))
385 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
394 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
398 // Make sure the range specified is between 0 and the total frame number
399 startFrame = std::min(startFrame, mTotalFrame - 1);
400 endFrame = std::min(endFrame, mTotalFrame - 1);
402 // If the range is not in order swap values
403 if(startFrame > endFrame)
405 uint32_t temp = startFrame;
406 startFrame = endFrame;
410 if(startFrame != mStartFrame || endFrame != mEndFrame)
412 mStartFrame = startFrame;
413 mEndFrame = endFrame;
415 // If the current frame is out of the range, change the current frame also.
416 if(mStartFrame > mCurrentFrame)
418 mCurrentFrame = mStartFrame;
420 else if(mEndFrame < mCurrentFrame)
422 mCurrentFrame = mEndFrame;
425 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mImageUrl.GetUrl().c_str(), this);
429 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
431 startFrame = mStartFrame;
432 endFrame = mEndFrame;
435 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
437 if(mCurrentFrame == frameNumber)
439 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
443 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
445 mCurrentFrame = frameNumber;
446 mUpdateFrameNumber = false;
448 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
452 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
456 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
458 return mCurrentFrame;
461 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
466 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
468 mVectorRenderer.GetDefaultSize(width, height);
471 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
473 mStopBehavior = stopBehavior;
475 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
478 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
480 mLoopingMode = loopingMode;
482 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
485 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
487 mVectorRenderer.GetLayerInfo(map);
490 void VectorAnimationTask::GetMarkerInfo(Property::Map& map) const
492 mVectorRenderer.GetMarkerInfo(map);
495 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
497 return mResourceReadySignal;
500 bool VectorAnimationTask::Rasterize()
502 bool stopped = false;
503 uint32_t currentFrame;
504 mKeepAnimation = false;
507 ConditionalWait::ScopedLock lock(mConditionalWait);
510 // The task will be destroyed. We don't need rasterization.
526 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
528 std::ostringstream oss;
529 oss << "[size:" << mWidth << "x" << mHeight << " ";
530 oss << "url:" << mImageUrl.GetUrl() << "]";
531 DALI_TRACE_BEGIN_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
535 ApplyAnimationData();
537 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
539 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
540 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
543 currentFrame = mCurrentFrame;
545 mUpdateFrameNumber = true;
547 if(mPlayState == PlayState::STOPPING)
549 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
550 currentFrame = mCurrentFrame;
553 else if(mPlayState == PlayState::PLAYING)
555 bool animationFinished = false;
557 if(currentFrame >= mEndFrame) // last frame
559 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
565 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
567 mCurrentFrame = mStartFrame;
568 mUpdateFrameNumber = false;
572 animationFinished = true; // end of animation
576 else if(currentFrame == mStartFrame && !mForward) // first frame
578 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
584 animationFinished = true; // end of animation
588 if(animationFinished)
590 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
596 mPlayState = PlayState::STOPPING;
602 bool renderSuccess = false;
605 renderSuccess = mVectorRenderer.Render(currentFrame);
608 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
609 mUpdateFrameNumber = false;
613 if(stopped && renderSuccess)
615 mPlayState = PlayState::STOPPED;
621 // Notify the Renderer that rendering is stopped.
622 mVectorRenderer.RenderStopped();
625 // Animation is finished
627 ConditionalWait::ScopedLock lock(mConditionalWait);
628 if(mNeedAnimationFinishedTrigger && mAnimationFinishedCallback)
630 mVectorAnimationThread.AddEventTriggerCallback(mAnimationFinishedCallback.get());
634 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
637 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
639 mKeepAnimation = true;
643 if(gTraceFilter && gTraceFilter->IsTraceEnabled())
645 std::ostringstream oss;
646 oss << "[size:" << mWidth << "x" << mHeight << " ";
647 oss << "frame:" << mCurrentFrame << " ";
648 oss << "loop:" << mCurrentLoop << " ";
649 oss << "state:" << mPlayState << " ";
650 oss << "url:" << mImageUrl.GetUrl() << "]";
651 DALI_TRACE_END_WITH_MESSAGE(gTraceFilter, "DALI_LOTTIE_RASTERIZE_TASK", oss.str().c_str());
658 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
660 uint32_t frame = currentFrame;
662 switch(mStopBehavior)
664 case DevelImageVisual::StopBehavior::FIRST_FRAME:
669 case DevelImageVisual::StopBehavior::LAST_FRAME:
671 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
681 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
683 frame = currentFrame;
691 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
693 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
694 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
695 // is casted to use the default duration.
696 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
697 auto current = std::chrono::steady_clock::now();
702 mNextFrameStartTime = current;
704 else if(mNextFrameStartTime < current)
706 uint32_t droppedFrames = 0;
708 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
711 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
714 mNextFrameStartTime = current;
715 mDroppedFrames = droppedFrames;
718 return mNextFrameStartTime;
721 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
723 return mNextFrameStartTime;
726 void VectorAnimationTask::ApplyAnimationData()
731 ConditionalWait::ScopedLock lock(mConditionalWait);
733 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].size() != 0)
735 // Data is not updated or the previous data is not applied yet.
739 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
740 mAnimationDataUpdated = false;
742 index = mAnimationDataIndex;
745 for(const auto& animationData : mAnimationData[index])
747 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
749 SetLoopCount(animationData.loopCount);
752 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
754 SetPlayRange(animationData.playRange);
757 if(animationData.resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
759 SetStopBehavior(animationData.stopBehavior);
762 if(animationData.resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
764 SetLoopingMode(animationData.loopingMode);
767 if(animationData.resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
769 SetCurrentFrameNumber(animationData.currentFrame);
772 if(animationData.resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
774 mVectorRenderer.InvalidateBuffer();
777 if(animationData.resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
779 for(auto&& iter : animationData.dynamicProperties)
781 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
785 if(animationData.resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
787 if(animationData.playState == DevelImageVisual::PlayState::PLAYING)
791 else if(animationData.playState == DevelImageVisual::PlayState::PAUSED)
795 else if(animationData.playState == DevelImageVisual::PlayState::STOPPED)
803 mAnimationData[index].clear();
806 void VectorAnimationTask::OnUploadCompleted()
808 mResourceReadySignal.Emit(ResourceStatus::READY);
811 void VectorAnimationTask::OnLoadCompleted()
815 mResourceReadySignal.Emit(ResourceStatus::LOADED);
819 mResourceReadySignal.Emit(ResourceStatus::FAILED);
822 } // namespace Internal
824 } // namespace Toolkit