2 * Copyright (c) 2022 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/public-api/math/math-utils.h>
24 #include <dali/public-api/object/property-array.h>
27 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
28 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
29 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
39 constexpr auto LOOP_FOREVER = -1;
40 constexpr auto MICROSECONDS_PER_SECOND(1e+6);
42 #if defined(DEBUG_ENABLED)
43 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VECTOR_ANIMATION");
46 } // unnamed namespace
48 VectorAnimationTask::VectorAnimationTask(VisualFactoryCache& factoryCache)
50 mVectorRenderer(VectorAnimationRenderer::New()),
52 mVectorAnimationThread(factoryCache.GetVectorAnimationManager().GetVectorAnimationThread()),
54 mResourceReadySignal(),
55 mAnimationFinishedTrigger(),
56 mLoadCompletedTrigger(new EventThreadCallback(MakeCallback(this, &VectorAnimationTask::OnLoadCompleted))),
57 mPlayState(PlayState::STOPPED),
58 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
59 mLoopingMode(DevelImageVisual::LoopingMode::RESTART),
60 mNextFrameStartTime(),
61 mFrameDurationMicroSeconds(MICROSECONDS_PER_SECOND / 60.0f),
70 mAnimationDataIndex(0),
71 mLoopCount(LOOP_FOREVER),
74 mUpdateFrameNumber(false),
75 mNeedAnimationFinishedTrigger(true),
76 mAnimationDataUpdated(false),
81 mVectorRenderer.UploadCompletedSignal().Connect(this, &VectorAnimationTask::OnUploadCompleted);
84 VectorAnimationTask::~VectorAnimationTask()
86 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this);
89 void VectorAnimationTask::Finalize()
91 ConditionalWait::ScopedLock lock(mConditionalWait);
93 // Release some objects in the main thread
94 if(mAnimationFinishedTrigger)
96 mAnimationFinishedTrigger.reset();
98 if(mLoadCompletedTrigger)
100 mLoadCompletedTrigger.reset();
103 mVectorRenderer.Finalize();
108 bool VectorAnimationTask::Load(bool synchronousLoading)
110 if(!mVectorRenderer.Load(mUrl))
112 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mUrl.c_str());
113 mLoadRequest = false;
115 if(!synchronousLoading)
117 mLoadCompletedTrigger->Trigger();
122 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
124 mEndFrame = mTotalFrame - 1;
126 mFrameRate = mVectorRenderer.GetFrameRate();
127 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
129 mLoadRequest = false;
130 if(!synchronousLoading)
132 mLoadCompletedTrigger->Trigger();
135 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mUrl.c_str(), mTotalFrame, mFrameRate, this);
140 void VectorAnimationTask::SetRenderer(Renderer renderer)
142 ConditionalWait::ScopedLock lock(mConditionalWait);
144 mVectorRenderer.SetRenderer(renderer);
146 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
149 void VectorAnimationTask::RequestLoad(const std::string& url, bool synchronousLoading)
153 if(!synchronousLoading)
157 mVectorAnimationThread.AddTask(this);
167 bool VectorAnimationTask::IsLoadRequested() const
172 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
174 ConditionalWait::ScopedLock lock(mConditionalWait);
176 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
178 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
180 mAnimationData[index] = data;
181 mAnimationDataUpdated = true;
183 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
185 // The size should be changed in the main thread.
186 SetSize(data.width, data.height);
189 mVectorAnimationThread.AddTask(this);
192 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
194 if(mWidth != width || mHeight != height)
196 mVectorRenderer.SetSize(width, height);
201 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
205 void VectorAnimationTask::PlayAnimation()
207 if(mPlayState != PlayState::PLAYING)
209 mNeedAnimationFinishedTrigger = true;
210 mUpdateFrameNumber = false;
211 mPlayState = PlayState::PLAYING;
213 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
217 void VectorAnimationTask::StopAnimation()
219 if(mPlayState != PlayState::STOPPING)
221 mNeedAnimationFinishedTrigger = false;
222 mPlayState = PlayState::STOPPING;
224 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
228 void VectorAnimationTask::PauseAnimation()
230 if(mPlayState == PlayState::PLAYING)
232 mPlayState = PlayState::PAUSED;
234 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
238 void VectorAnimationTask::SetAnimationFinishedCallback(EventThreadCallback* callback)
240 ConditionalWait::ScopedLock lock(mConditionalWait);
243 mAnimationFinishedTrigger = std::unique_ptr<EventThreadCallback>(callback);
247 void VectorAnimationTask::SetLoopCount(int32_t count)
249 if(mLoopCount != count)
254 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
258 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
261 uint32_t startFrame = 0, endFrame = 0;
262 size_t count = playRange.Count();
266 int32_t start = 0, end = 0;
267 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
269 startFrame = static_cast<uint32_t>(start);
270 endFrame = static_cast<uint32_t>(end);
275 std::string startMarker, endMarker;
276 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
280 uint32_t frame; // We don't use this later
281 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
292 if(playRange.GetElementAt(0).Get(marker))
294 if(mVectorRenderer && mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame))
303 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
307 // Make sure the range specified is between 0 and the total frame number
308 startFrame = std::min(startFrame, mTotalFrame - 1);
309 endFrame = std::min(endFrame, mTotalFrame - 1);
311 // If the range is not in order swap values
312 if(startFrame > endFrame)
314 uint32_t temp = startFrame;
315 startFrame = endFrame;
319 if(startFrame != mStartFrame || endFrame != mEndFrame)
321 mStartFrame = startFrame;
322 mEndFrame = endFrame;
324 // If the current frame is out of the range, change the current frame also.
325 if(mStartFrame > mCurrentFrame)
327 mCurrentFrame = mStartFrame;
329 else if(mEndFrame < mCurrentFrame)
331 mCurrentFrame = mEndFrame;
334 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%s] [%p]\n", mStartFrame, mEndFrame, mUrl.c_str(), this);
338 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
340 startFrame = mStartFrame;
341 endFrame = mEndFrame;
344 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
346 if(mCurrentFrame == frameNumber)
348 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
352 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
354 mCurrentFrame = frameNumber;
355 mUpdateFrameNumber = false;
357 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
361 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)] [%p]\n", frameNumber, mStartFrame, mEndFrame, this);
365 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
367 return mCurrentFrame;
370 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
375 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
377 mVectorRenderer.GetDefaultSize(width, height);
380 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
382 mStopBehavior = stopBehavior;
384 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
387 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
389 mLoopingMode = loopingMode;
391 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
394 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
396 mVectorRenderer.GetLayerInfo(map);
399 VectorAnimationTask::ResourceReadySignalType& VectorAnimationTask::ResourceReadySignal()
401 return mResourceReadySignal;
404 bool VectorAnimationTask::Rasterize(bool& keepAnimation)
406 bool stopped = false;
407 uint32_t currentFrame;
408 keepAnimation = false;
411 ConditionalWait::ScopedLock lock(mConditionalWait);
414 // The task will be destroyed. We don't need rasterization.
429 ApplyAnimationData();
431 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
433 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : (mCurrentFrame > mDroppedFrames ? mCurrentFrame - mDroppedFrames - 1 : 0);
434 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
437 currentFrame = mCurrentFrame;
439 mUpdateFrameNumber = true;
441 if(mPlayState == PlayState::STOPPING)
443 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
444 currentFrame = mCurrentFrame;
447 else if(mPlayState == PlayState::PLAYING)
449 bool animationFinished = false;
451 if(currentFrame >= mEndFrame) // last frame
453 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
459 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
461 mCurrentFrame = mStartFrame;
462 mUpdateFrameNumber = false;
466 animationFinished = true; // end of animation
470 else if(currentFrame == mStartFrame && !mForward) // first frame
472 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
478 animationFinished = true; // end of animation
482 if(animationFinished)
484 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
490 mPlayState = PlayState::STOPPING;
496 bool renderSuccess = false;
499 renderSuccess = mVectorRenderer.Render(currentFrame);
502 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
503 mUpdateFrameNumber = false;
507 if(stopped && renderSuccess)
509 mPlayState = PlayState::STOPPED;
513 // Animation is finished
515 ConditionalWait::ScopedLock lock(mConditionalWait);
516 if(mNeedAnimationFinishedTrigger && mAnimationFinishedTrigger)
518 mAnimationFinishedTrigger->Trigger();
522 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
525 if(mPlayState != PlayState::PAUSED && mPlayState != PlayState::STOPPED)
527 keepAnimation = true;
533 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
535 uint32_t frame = currentFrame;
537 switch(mStopBehavior)
539 case DevelImageVisual::StopBehavior::FIRST_FRAME:
544 case DevelImageVisual::StopBehavior::LAST_FRAME:
546 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
556 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
558 frame = currentFrame;
566 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
568 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::steady_clock supported
569 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
570 // is casted to use the default duration.
571 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
572 auto current = std::chrono::steady_clock::now();
577 mNextFrameStartTime = current;
579 else if(mNextFrameStartTime < current)
581 uint32_t droppedFrames = 0;
583 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)) && droppedFrames < mTotalFrame)
586 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
589 mNextFrameStartTime = current;
590 mDroppedFrames = droppedFrames;
593 return mNextFrameStartTime;
596 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
598 return mNextFrameStartTime;
601 void VectorAnimationTask::ApplyAnimationData()
606 ConditionalWait::ScopedLock lock(mConditionalWait);
608 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].resendFlag != 0)
610 // Data is not updated or the previous data is not applied yet.
614 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
615 mAnimationDataUpdated = false;
617 index = mAnimationDataIndex;
620 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
622 SetLoopCount(mAnimationData[index].loopCount);
625 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
627 SetPlayRange(mAnimationData[index].playRange);
630 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
632 SetStopBehavior(mAnimationData[index].stopBehavior);
635 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
637 SetLoopingMode(mAnimationData[index].loopingMode);
640 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
642 SetCurrentFrameNumber(mAnimationData[index].currentFrame);
645 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_NEED_RESOURCE_READY)
647 mVectorRenderer.InvalidateBuffer();
650 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_DYNAMIC_PROPERTY)
652 for(auto&& iter : mAnimationData[index].dynamicProperties)
654 mVectorRenderer.AddPropertyValueCallback(iter.keyPath, static_cast<VectorAnimationRenderer::VectorProperty>(iter.property), iter.callback, iter.id);
658 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
660 if(mAnimationData[index].playState == DevelImageVisual::PlayState::PLAYING)
664 else if(mAnimationData[index].playState == DevelImageVisual::PlayState::PAUSED)
668 else if(mAnimationData[index].playState == DevelImageVisual::PlayState::STOPPED)
675 mAnimationData[index].dynamicProperties.clear();
676 mAnimationData[index].resendFlag = 0;
679 void VectorAnimationTask::OnUploadCompleted()
681 mResourceReadySignal.Emit(ResourceStatus::READY);
684 void VectorAnimationTask::OnLoadCompleted()
688 mResourceReadySignal.Emit(ResourceStatus::LOADED);
692 mResourceReadySignal.Emit(ResourceStatus::FAILED);
695 } // namespace Internal
697 } // namespace Toolkit