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-thread.h>
22 #include <dali/devel-api/adaptor-framework/environment-variable.h>
23 #include <dali/devel-api/adaptor-framework/thread-settings.h>
24 #include <dali/integration-api/adaptor-framework/adaptor.h>
25 #include <dali/integration-api/debug.h>
36 #if defined(DEBUG_ENABLED)
37 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VECTOR_ANIMATION");
40 } // unnamed namespace
42 VectorAnimationThread::VectorAnimationThread()
46 mSleepThread(MakeCallback(this, &VectorAnimationThread::OnAwakeFromSleep)),
49 mDestroyThread(false),
50 mLogFactory(Dali::Adaptor::Get().GetLogFactory())
52 mAsyncTaskManager = Dali::AsyncTaskManager::Get();
55 mEventTrigger = std::unique_ptr<EventThreadCallback>(new EventThreadCallback(MakeCallback(this, &VectorAnimationThread::OnEventCallbackTriggered)));
58 VectorAnimationThread::~VectorAnimationThread()
62 ConditionalWait::ScopedLock lock(mConditionalWait);
63 mDestroyThread = true;
65 mConditionalWait.Notify(lock);
68 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationThread::~VectorAnimationThread: Join [%p]\n", this);
73 void VectorAnimationThread::AddTask(VectorAnimationTaskPtr task)
75 ConditionalWait::ScopedLock lock(mConditionalWait);
77 // Find if the task is already in the list except loading task
78 auto iter = std::find_if(mAnimationTasks.begin(), mAnimationTasks.end(), [task](VectorAnimationTaskPtr& element) { return (element == task && !element->IsLoadRequested()); });
79 if(iter == mAnimationTasks.end())
81 auto currentTime = task->CalculateNextFrameTime(true); // Rasterize as soon as possible
83 bool inserted = false;
84 for(auto iter = mAnimationTasks.begin(); iter != mAnimationTasks.end(); ++iter)
86 auto nextTime = (*iter)->GetNextFrameTime();
87 if(nextTime > currentTime)
89 mAnimationTasks.insert(iter, task);
97 mAnimationTasks.push_back(task);
100 mNeedToSleep = false;
101 // wake up the animation thread
102 mConditionalWait.Notify(lock);
106 void VectorAnimationThread::OnTaskCompleted(VectorAnimationTaskPtr task, bool success, bool keepAnimation)
110 ConditionalWait::ScopedLock lock(mConditionalWait);
111 bool needRasterize = false;
113 auto workingTask = std::find(mWorkingTasks.begin(), mWorkingTasks.end(), task);
114 if(workingTask != mWorkingTasks.end())
116 mWorkingTasks.erase(workingTask);
119 // Check pending task
120 if(mAnimationTasks.end() != std::find(mAnimationTasks.begin(), mAnimationTasks.end(), task))
122 needRasterize = true;
125 if(keepAnimation && success)
127 if(mCompletedTasks.end() == std::find(mCompletedTasks.begin(), mCompletedTasks.end(), task))
129 mCompletedTasks.push_back(task);
130 needRasterize = true;
136 mNeedToSleep = false;
137 // wake up the animation thread
138 mConditionalWait.Notify(lock);
143 void VectorAnimationThread::OnAwakeFromSleep()
147 mNeedToSleep = false;
148 // wake up the animation thread
149 mConditionalWait.Notify();
153 void VectorAnimationThread::AddEventTriggerCallback(CallbackBase* callback)
155 ConditionalWait::ScopedLock lock(mConditionalWait);
156 mTriggerEventCallbacks.push_back(callback);
160 mEventTrigger->Trigger();
161 mEventTriggered = true;
165 void VectorAnimationThread::RemoveEventTriggerCallback(CallbackBase* callback)
167 ConditionalWait::ScopedLock lock(mConditionalWait);
168 auto iter = std::find(mTriggerEventCallbacks.begin(), mTriggerEventCallbacks.end(), callback);
169 if(iter != mTriggerEventCallbacks.end())
171 mTriggerEventCallbacks.erase(iter);
175 void VectorAnimationThread::Run()
177 SetThreadName("VectorAnimationThread");
178 mLogFactory.InstallLogFunction();
180 while(!mDestroyThread)
186 void VectorAnimationThread::Rasterize()
188 // Lock while popping task out from the queue
189 ConditionalWait::ScopedLock lock(mConditionalWait);
194 mConditionalWait.Wait(lock);
199 // Process completed tasks
200 for(auto&& task : mCompletedTasks)
202 if(mAnimationTasks.end() == std::find(mAnimationTasks.begin(), mAnimationTasks.end(), task))
204 // Should use the frame rate of the animation file
205 auto nextFrameTime = task->CalculateNextFrameTime(false);
207 bool inserted = false;
208 for(auto iter = mAnimationTasks.begin(); iter != mAnimationTasks.end(); ++iter)
210 auto time = (*iter)->GetNextFrameTime();
211 if(time > nextFrameTime)
213 mAnimationTasks.insert(iter, task);
221 mAnimationTasks.push_back(task);
225 mCompletedTasks.clear();
227 // pop out the next task from the queue
228 for(auto it = mAnimationTasks.begin(); it != mAnimationTasks.end();)
230 VectorAnimationTaskPtr nextTask = *it;
232 auto currentTime = std::chrono::steady_clock::now();
233 auto nextFrameTime = nextTask->GetNextFrameTime();
235 #if defined(DEBUG_ENABLED)
236 // auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(nextFrameTime - currentTime);
238 // DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationThread::Rasterize: [next time = %lld]\n", duration.count());
240 if(nextFrameTime <= currentTime)
242 // If the task is not in the working list
243 if(std::find(mWorkingTasks.begin(), mWorkingTasks.end(), nextTask) == mWorkingTasks.end())
245 it = mAnimationTasks.erase(it);
247 // Add it to the working list
248 mWorkingTasks.push_back(nextTask);
249 mAsyncTaskManager.AddTask(nextTask);
258 mSleepThread.SleepUntil(nextFrameTime);
264 void VectorAnimationThread::OnEventCallbackTriggered()
266 ConditionalWait::ScopedLock lock(mConditionalWait);
268 for(auto&& iter : mTriggerEventCallbacks)
270 CallbackBase::Execute(*iter);
273 mTriggerEventCallbacks.clear();
274 mEventTriggered = false;
277 VectorAnimationThread::SleepThread::SleepThread(CallbackBase* callback)
278 : mConditionalWait(),
279 mAwakeCallback(std::unique_ptr<CallbackBase>(callback)),
281 mLogFactory(Dali::Adaptor::Get().GetLogFactory()),
283 mDestroyThread(false)
287 VectorAnimationThread::SleepThread::~SleepThread()
291 ConditionalWait::ScopedLock lock(mConditionalWait);
292 mDestroyThread = true;
293 mConditionalWait.Notify(lock);
299 void VectorAnimationThread::SleepThread::SleepUntil(std::chrono::time_point<std::chrono::steady_clock> timeToSleepUntil)
301 ConditionalWait::ScopedLock lock(mConditionalWait);
302 mSleepTimePoint = timeToSleepUntil;
304 mConditionalWait.Notify(lock);
307 void VectorAnimationThread::SleepThread::Run()
309 SetThreadName("VectorSleepThread");
310 mLogFactory.InstallLogFunction();
312 while(!mDestroyThread)
315 std::chrono::time_point<std::chrono::steady_clock> sleepTimePoint;
318 ConditionalWait::ScopedLock lock(mConditionalWait);
320 needToSleep = mNeedToSleep;
321 sleepTimePoint = mSleepTimePoint;
323 mNeedToSleep = false;
328 #if defined(DEBUG_ENABLED)
329 // auto sleepDuration = std::chrono::duration_cast<std::chrono::milliseconds>(mSleepTimePoint - std::chrono::steady_clock::now());
331 // DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "VectorAnimationThread::SleepThread::Run: [sleep duration = %lld]\n", sleepDuration.count());
334 std::this_thread::sleep_until(sleepTimePoint);
338 CallbackBase::Execute(*mAwakeCallback);
343 ConditionalWait::ScopedLock lock(mConditionalWait);
344 if(!mDestroyThread && !mNeedToSleep)
346 mConditionalWait.Wait(lock);
352 } // namespace Internal
354 } // namespace Toolkit