2 * Copyright (c) 2021 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 mAnimationFinishedTrigger(),
55 mPlayState(PlayState::STOPPED),
56 mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
57 mLoopingMode(DevelImageVisual::LoopingMode::RESTART),
58 mNextFrameStartTime(),
59 mFrameDurationMicroSeconds(MICROSECONDS_PER_SECOND / 60.0f),
68 mAnimationDataIndex(0),
69 mLoopCount(LOOP_FOREVER),
72 mUpdateFrameNumber(false),
73 mNeedAnimationFinishedTrigger(true),
74 mAnimationDataUpdated(false),
79 VectorAnimationTask::~VectorAnimationTask()
81 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::~VectorAnimationTask: destructor [%p]\n", this);
84 void VectorAnimationTask::Finalize()
86 ConditionalWait::ScopedLock lock(mConditionalWait);
88 // Release some objects in the main thread
89 if(mAnimationFinishedTrigger)
91 mAnimationFinishedTrigger.reset();
94 mVectorRenderer.Finalize();
99 bool VectorAnimationTask::Load(const std::string& url)
103 if(!mVectorRenderer.Load(mUrl))
105 DALI_LOG_ERROR("VectorAnimationTask::Load: Load failed [%s]\n", mUrl.c_str());
109 mTotalFrame = mVectorRenderer.GetTotalFrameNumber();
111 mEndFrame = mTotalFrame - 1;
113 mFrameRate = mVectorRenderer.GetFrameRate();
114 mFrameDurationMicroSeconds = MICROSECONDS_PER_SECOND / mFrameRate;
116 uint32_t width, height;
117 mVectorRenderer.GetDefaultSize(width, height);
119 SetSize(width, height);
121 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Load: file = %s [%d frames, %f fps] [%p]\n", mUrl.c_str(), mTotalFrame, mFrameRate, this);
126 void VectorAnimationTask::SetRenderer(Renderer renderer)
128 ConditionalWait::ScopedLock lock(mConditionalWait);
130 mVectorRenderer.SetRenderer(renderer);
132 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetRenderer [%p]\n", this);
135 void VectorAnimationTask::SetAnimationData(const AnimationData& data)
137 ConditionalWait::ScopedLock lock(mConditionalWait);
139 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetAnimationData [%p]\n", this);
141 uint32_t index = mAnimationDataIndex == 0 ? 1 : 0; // Use the other buffer
143 mAnimationData[index] = data;
144 mAnimationDataUpdated = true;
146 if(data.resendFlag & VectorAnimationTask::RESEND_SIZE)
148 // The size should be changed in the main thread.
149 SetSize(data.width, data.height);
152 mVectorAnimationThread.AddTask(this);
155 void VectorAnimationTask::SetSize(uint32_t width, uint32_t height)
157 if(mWidth != width || mHeight != height)
159 mVectorRenderer.SetSize(width, height);
164 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetSize: width = %d, height = %d [%p]\n", width, height, this);
168 void VectorAnimationTask::PlayAnimation()
170 if(mPlayState != PlayState::PLAYING)
172 mNeedAnimationFinishedTrigger = true;
173 mUpdateFrameNumber = false;
174 mPlayState = PlayState::PLAYING;
176 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PlayAnimation: Play [%p]\n", this);
180 void VectorAnimationTask::StopAnimation()
182 if(mPlayState != PlayState::STOPPING)
184 mNeedAnimationFinishedTrigger = false;
185 mPlayState = PlayState::STOPPING;
187 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::StopAnimation: Stop [%p]\n", this);
191 void VectorAnimationTask::PauseAnimation()
193 if(mPlayState == PlayState::PLAYING)
195 mPlayState = PlayState::PAUSED;
197 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::PauseAnimation: Pause [%p]\n", this);
201 void VectorAnimationTask::SetAnimationFinishedCallback(EventThreadCallback* callback)
203 ConditionalWait::ScopedLock lock(mConditionalWait);
206 mAnimationFinishedTrigger = std::unique_ptr<EventThreadCallback>(callback);
210 void VectorAnimationTask::SetLoopCount(int32_t count)
212 if(mLoopCount != count)
217 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopCount: [%d] [%p]\n", count, this);
221 void VectorAnimationTask::SetPlayRange(const Property::Array& playRange)
224 uint32_t startFrame = 0, endFrame = 0;
225 size_t count = playRange.Count();
229 int32_t start = 0, end = 0;
230 if(playRange.GetElementAt(0).Get(start) && playRange.GetElementAt(1).Get(end))
232 startFrame = static_cast<uint32_t>(start);
233 endFrame = static_cast<uint32_t>(end);
238 std::string startMarker, endMarker;
239 if(playRange.GetElementAt(0).Get(startMarker) && playRange.GetElementAt(1).Get(endMarker))
243 uint32_t frame; // We don't use this later
244 if(mVectorRenderer.GetMarkerInfo(startMarker, startFrame, frame) && mVectorRenderer.GetMarkerInfo(endMarker, frame, endFrame))
255 if(playRange.GetElementAt(0).Get(marker))
259 mVectorRenderer.GetMarkerInfo(marker, startFrame, endFrame);
267 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range [%p]\n", this);
271 // Make sure the range specified is between 0 and the total frame number
272 if(startFrame < mTotalFrame && endFrame < mTotalFrame)
274 // If the range is not in order swap values
275 if(startFrame > endFrame)
277 uint32_t temp = startFrame;
278 startFrame = endFrame;
282 if(startFrame != mStartFrame || endFrame != mEndFrame)
284 mStartFrame = startFrame;
285 mEndFrame = endFrame;
287 // If the current frame is out of the range, change the current frame also.
288 if(mStartFrame > mCurrentFrame)
290 mCurrentFrame = mStartFrame;
292 else if(mEndFrame < mCurrentFrame)
294 mCurrentFrame = mEndFrame;
297 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetPlayRange: [%d, %d] [%p]\n", mStartFrame, mEndFrame, this);
302 DALI_LOG_ERROR("VectorAnimationTask::SetPlayRange: Invalid range (%d, %d) [%p]\n", startFrame, endFrame, this);
307 void VectorAnimationTask::GetPlayRange(uint32_t& startFrame, uint32_t& endFrame)
309 startFrame = mStartFrame;
310 endFrame = mEndFrame;
313 void VectorAnimationTask::SetCurrentFrameNumber(uint32_t frameNumber)
315 if(mCurrentFrame == frameNumber)
317 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: Set same frame [%d] [%p]\n", frameNumber, this);
321 if(frameNumber >= mStartFrame && frameNumber <= mEndFrame)
323 mCurrentFrame = frameNumber;
324 mUpdateFrameNumber = false;
326 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetCurrentFrameNumber: frame number = %d [%p]\n", mCurrentFrame, this);
330 DALI_LOG_ERROR("Invalid frame number [%d (%d, %d)]\n", frameNumber, mStartFrame, mEndFrame);
334 uint32_t VectorAnimationTask::GetCurrentFrameNumber() const
336 return mCurrentFrame;
339 uint32_t VectorAnimationTask::GetTotalFrameNumber() const
344 void VectorAnimationTask::GetDefaultSize(uint32_t& width, uint32_t& height) const
346 mVectorRenderer.GetDefaultSize(width, height);
349 void VectorAnimationTask::SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior)
351 mStopBehavior = stopBehavior;
353 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetStopBehavior: stop behavor = %d [%p]\n", mStopBehavior, this);
356 void VectorAnimationTask::SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode)
358 mLoopingMode = loopingMode;
360 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::SetLoopingMode: looping mode = %d [%p]\n", mLoopingMode, this);
363 void VectorAnimationTask::GetLayerInfo(Property::Map& map) const
365 mVectorRenderer.GetLayerInfo(map);
368 VectorAnimationTask::UploadCompletedSignalType& VectorAnimationTask::UploadCompletedSignal()
370 return mVectorRenderer.UploadCompletedSignal();
373 bool VectorAnimationTask::Rasterize()
375 bool stopped = false;
376 uint32_t currentFrame;
379 ConditionalWait::ScopedLock lock(mConditionalWait);
382 // The task will be destroyed. We don't need rasterization.
387 ApplyAnimationData();
389 if(mPlayState == PlayState::PLAYING && mUpdateFrameNumber)
391 mCurrentFrame = mForward ? mCurrentFrame + mDroppedFrames + 1 : mCurrentFrame - mDroppedFrames - 1;
392 Dali::ClampInPlace(mCurrentFrame, mStartFrame, mEndFrame);
395 currentFrame = mCurrentFrame;
397 mUpdateFrameNumber = true;
399 if(mPlayState == PlayState::STOPPING)
401 mCurrentFrame = GetStoppedFrame(mStartFrame, mEndFrame, mCurrentFrame);
402 currentFrame = mCurrentFrame;
405 else if(mPlayState == PlayState::PLAYING)
407 bool animationFinished = false;
409 if(currentFrame >= mEndFrame) // last frame
411 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
417 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
419 mCurrentFrame = mStartFrame;
420 mUpdateFrameNumber = false;
424 animationFinished = true; // end of animation
428 else if(currentFrame == mStartFrame && !mForward) // first frame
430 if(mLoopCount < 0 || ++mCurrentLoop < mLoopCount) // repeat forever or before the last loop
436 animationFinished = true; // end of animation
440 if(animationFinished)
442 if(mStopBehavior == DevelImageVisual::StopBehavior::CURRENT_FRAME)
448 mPlayState = PlayState::STOPPING;
454 bool renderSuccess = false;
457 renderSuccess = mVectorRenderer.Render(currentFrame);
460 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Rendering failed. Try again later.[%d] [%p]\n", currentFrame, this);
461 mUpdateFrameNumber = false;
465 if(stopped && renderSuccess)
467 mPlayState = PlayState::STOPPED;
471 // Animation is finished
473 ConditionalWait::ScopedLock lock(mConditionalWait);
474 if(mNeedAnimationFinishedTrigger && mAnimationFinishedTrigger)
476 mAnimationFinishedTrigger->Trigger();
480 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationTask::Rasterize: Animation is finished [current = %d] [%p]\n", currentFrame, this);
483 bool keepAnimation = true;
484 if(mPlayState == PlayState::PAUSED || mPlayState == PlayState::STOPPED)
486 keepAnimation = false;
489 return keepAnimation;
492 uint32_t VectorAnimationTask::GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame)
494 uint32_t frame = currentFrame;
496 switch(mStopBehavior)
498 case DevelImageVisual::StopBehavior::FIRST_FRAME:
503 case DevelImageVisual::StopBehavior::LAST_FRAME:
505 if(mLoopingMode == DevelImageVisual::LoopingMode::AUTO_REVERSE)
515 case DevelImageVisual::StopBehavior::CURRENT_FRAME:
517 frame = currentFrame;
525 VectorAnimationTask::TimePoint VectorAnimationTask::CalculateNextFrameTime(bool renderNow)
527 // std::chrono::time_point template has second parameter duration which defaults to the std::chrono::system_clock supported
528 // duration. In some C++11 implementations it is a milliseconds duration, so it fails to compile unless mNextFrameStartTime
529 // is casted to use the default duration.
530 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
531 auto current = std::chrono::system_clock::now();
534 mNextFrameStartTime = current;
537 else if(mNextFrameStartTime < current)
539 uint32_t droppedFrames = 0;
541 while(current > std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds)))
544 mNextFrameStartTime = std::chrono::time_point_cast<TimePoint::duration>(mNextFrameStartTime + std::chrono::microseconds(mFrameDurationMicroSeconds));
547 mNextFrameStartTime = current;
548 mDroppedFrames = droppedFrames;
551 return mNextFrameStartTime;
554 VectorAnimationTask::TimePoint VectorAnimationTask::GetNextFrameTime()
556 return mNextFrameStartTime;
559 void VectorAnimationTask::ApplyAnimationData()
564 ConditionalWait::ScopedLock lock(mConditionalWait);
566 if(!mAnimationDataUpdated || mAnimationData[mAnimationDataIndex].resendFlag != 0)
568 // Data is not updated or the previous data is not applied yet.
572 mAnimationDataIndex = mAnimationDataIndex == 0 ? 1 : 0; // Swap index
573 mAnimationDataUpdated = false;
575 index = mAnimationDataIndex;
578 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOP_COUNT)
580 SetLoopCount(mAnimationData[index].loopCount);
583 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_RANGE)
585 SetPlayRange(mAnimationData[index].playRange);
588 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_STOP_BEHAVIOR)
590 SetStopBehavior(mAnimationData[index].stopBehavior);
593 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_LOOPING_MODE)
595 SetLoopingMode(mAnimationData[index].loopingMode);
598 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_CURRENT_FRAME)
600 SetCurrentFrameNumber(mAnimationData[index].currentFrame);
603 if(mAnimationData[index].resendFlag & VectorAnimationTask::RESEND_PLAY_STATE)
605 if(mAnimationData[index].playState == DevelImageVisual::PlayState::PLAYING)
609 else if(mAnimationData[index].playState == DevelImageVisual::PlayState::PAUSED)
613 else if(mAnimationData[index].playState == DevelImageVisual::PlayState::STOPPED)
619 mAnimationData[index].resendFlag = 0;
622 } // namespace Internal
624 } // namespace Toolkit