1 #ifndef DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H
2 #define DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H
5 * Copyright (c) 2024 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/devel-api/adaptor-framework/event-thread-callback.h>
22 #include <dali/devel-api/adaptor-framework/vector-animation-renderer.h>
23 #include <dali/devel-api/threading/mutex.h>
24 #include <dali/public-api/adaptor-framework/async-task-manager.h>
25 #include <dali/public-api/adaptor-framework/encoded-image-buffer.h>
26 #include <dali/public-api/common/vector-wrapper.h>
27 #include <dali/public-api/object/property-array.h>
32 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-actions-devel.h>
33 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
34 #include <dali-toolkit/internal/visuals/visual-url.h>
42 class VisualFactoryCache;
43 class VectorAnimationThread;
44 class VectorAnimationTask;
45 typedef IntrusivePtr<VectorAnimationTask> VectorAnimationTaskPtr;
48 * The task of the vector animation.
50 class VectorAnimationTask : public AsyncTask, public ConnectionTracker
53 enum class ResourceStatus
55 LOADED, /// Resource is loaded
56 READY, /// Resource is ready
57 FAILED /// Resource is fail to load
60 using ResourceReadySignalType = Signal<void(ResourceStatus)>;
62 using TimePoint = std::chrono::time_point<std::chrono::steady_clock>;
63 using DynamicPropertyType = std::vector<DevelAnimatedVectorImageVisual::DynamicPropertyInfo>;
66 * Flags for re-sending data to the vector animation thread
70 RESEND_PLAY_RANGE = 1 << 0,
71 RESEND_LOOP_COUNT = 1 << 1,
72 RESEND_STOP_BEHAVIOR = 1 << 2,
73 RESEND_LOOPING_MODE = 1 << 3,
74 RESEND_CURRENT_FRAME = 1 << 4,
76 RESEND_PLAY_STATE = 1 << 6,
77 RESEND_NEED_RESOURCE_READY = 1 << 7,
78 RESEND_DYNAMIC_PROPERTY = 1 << 8
82 * @brief Structure used to pass parameters to the vector animation task
91 stopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
92 loopingMode(DevelImageVisual::LoopingMode::RESTART),
101 AnimationData& operator=(const AnimationData& rhs)
103 resendFlag |= rhs.resendFlag; // OR resend flag
104 playRange = rhs.playRange;
105 playState = rhs.playState;
106 stopBehavior = rhs.stopBehavior;
107 loopingMode = rhs.loopingMode;
108 currentFrame = rhs.currentFrame;
111 loopCount = rhs.loopCount;
112 playStateId = rhs.playStateId;
113 dynamicProperties.insert(dynamicProperties.end(), rhs.dynamicProperties.begin(), rhs.dynamicProperties.end());
118 Property::Array playRange;
119 DynamicPropertyType dynamicProperties;
120 DevelImageVisual::PlayState::Type playState;
121 DevelImageVisual::StopBehavior::Type stopBehavior;
122 DevelImageVisual::LoopingMode::Type loopingMode;
123 uint32_t currentFrame;
127 uint32_t playStateId;
131 * @brief Constructor.
133 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
135 VectorAnimationTask(VisualFactoryCache& factoryCache);
140 ~VectorAnimationTask() override;
143 * @brief Finalizes the task.
148 * @brief Sets the renderer used to display the result image.
150 * @param[in] renderer The renderer used to display the result image
152 void SetRenderer(Renderer renderer);
155 * @brief Requests to load the animation file.
157 * @param[in] url The url of the vector animation file
158 * @param[in] encodedImageBuffer The resource buffer if required.
159 * @param[in] synchronousLoading True if the url should be loaded synchronously
161 void RequestLoad(const VisualUrl& url, EncodedImageBuffer encodedImageBuffer, bool synchronousLoading);
164 * @brief Queries whether loading is requested.
165 * @return True if loading is requested.
167 bool IsLoadRequested() const;
170 * @brief Sets data to specify animation playback.
171 * @param[in] data The animation data
173 void SetAnimationData(const AnimationData& data);
176 * @brief This callback is called after the animation is finished.
177 * @param[in] callback The animation finished callback
179 void SetAnimationFinishedCallback(CallbackBase* callback);
182 * @brief Gets the playing range in frame number.
183 * @param[out] startFrame The frame number to specify minimum progress.
184 * @param[out] endFrame The frame number to specify maximum progress.
186 void GetPlayRange(uint32_t& startFrame, uint32_t& endFrame);
189 * @brief Retrieves the current frame number of the animation.
190 * @return The current frame number
192 uint32_t GetCurrentFrameNumber() const;
195 * @brief Retrieves the total frame number of the animation.
196 * @return The total frame number
198 uint32_t GetTotalFrameNumber() const;
201 * @brief Gets the default size of the file,.
202 * @return The default size of the file
204 void GetDefaultSize(uint32_t& width, uint32_t& height) const;
207 * @brief Gets the layer information of all the child layers.
208 * @param[out] map The layer information
210 void GetLayerInfo(Property::Map& map) const;
213 * @brief Gets the all marker information.
214 * @param[out] map The marker information
216 void GetMarkerInfo(Property::Map& map) const;
219 * @brief Connect to this signal to be notified when the resource is ready.
220 * @return The signal to connect to.
222 ResourceReadySignalType& ResourceReadySignal();
225 * @brief Rasterizes the current frame.
226 * @return true if the rasterization succeeded, false otherwise.
231 * @brief Calculates the time for the next frame rasterization.
232 * @return The time for the next frame rasterization.
234 TimePoint CalculateNextFrameTime(bool renderNow);
237 * @brief Gets the time for the next frame rasterization.
238 * @return The time for the next frame rasterization.
240 TimePoint GetNextFrameTime();
243 * @brief Called when the rasterization is completed from the asyncTaskManager
244 * @param[in] task The completed task
246 void TaskCompleted(VectorAnimationTaskPtr task);
249 * @brief Check the rasterization succeeded
250 * @return true if the rasterization succeeded, false otherwise.
255 * @brief Check the animation is running
256 * @return true if the animation is running, false otherwise.
260 public: // Implementation of AsyncTask
262 * @copydoc Dali::AsyncTask::Process()
264 void Process() override;
267 * @copydoc Dali::AsyncTask::IsReady()
269 bool IsReady() override;
272 * @copydoc Dali::AsyncTask::GetTaskName()
274 std::string_view GetTaskName() const override
276 return "VectorAnimationTask";
279 void KeepRasterizedBuffer(bool enableFrameCache)
281 mEnableFrameCache = enableFrameCache;
284 bool IsKeptRasterizedBuffer()
286 return mEnableFrameCache;
291 * @brief Loads the animation file.
293 * @param[in] synchronousLoading True if loading is requested synchronously
294 * @return True if loading succeeded, false otherwise.
296 bool Load(bool synchronousLoading);
299 * @brief Play the vector animation.
301 void PlayAnimation();
304 * @brief Stop the vector animation.
306 void StopAnimation();
309 * @brief Pause the vector animation.
311 void PauseAnimation();
314 * @brief Sets the target image size.
316 * @param[in] width The target image width
317 * @param[in] height The target image height
319 void SetSize(uint32_t width, uint32_t height);
322 * @brief Enable looping for 'count' repeats. -1 means to repeat forever.
323 * @param[in] count The number of times to loop
325 void SetLoopCount(int32_t count);
328 * @brief Set the playing range in frame number.
329 * @param[in] playRange The array to specify minimum and maximum progress.
330 * The animation will play between those values.
332 void SetPlayRange(const Property::Array& playRange);
335 * @brief Sets the current frame number of the animation.
336 * @param[in] frameNumber The new frame number between [0, the maximum frame number] or between the play range if specified.
338 void SetCurrentFrameNumber(uint32_t frameNumber);
341 * @brief Sets the stop behavior of the animation. This is performed when the animation is stopped.
342 * @param[in] stopBehavior The stop behavior
344 void SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior);
347 * @brief Sets the looping mode.
348 * Animation plays forwards and then restarts from the beginning or runs backwards again.
349 * @param[in] loopingMode The looping mode
351 void SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode);
354 * @brief Gets the frame number when the animation is stopped according to the stop behavior.
356 uint32_t GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame);
359 * @brief Applies the animation data set by the main thread.
361 void ApplyAnimationData();
364 * @brief Called when the texture upload is completed.
366 void OnUploadCompleted();
369 * @brief Event callback from rasterize thread. This is called when the file loading is completed.
371 void OnLoadCompleted(uint32_t argument);
374 VectorAnimationTask(const VectorAnimationTask& task) = delete;
377 VectorAnimationTask& operator=(const VectorAnimationTask& task) = delete;
382 STOPPING, ///< The animation is stopping
383 STOPPED, ///< The animation has stopped
384 PLAYING, ///< The animation is playing
385 PAUSED ///< The animation is paused
389 EncodedImageBuffer mEncodedImageBuffer;
390 VectorAnimationRenderer mVectorRenderer;
391 std::vector<AnimationData> mAnimationData[2];
392 VectorAnimationThread& mVectorAnimationThread;
394 ResourceReadySignalType mResourceReadySignal;
395 std::unique_ptr<CallbackBase> mAnimationFinishedCallback{};
396 std::unique_ptr<CallbackBase> mLoadCompletedCallback{};
397 mutable Property::Map mCachedLayerInfo;
398 mutable Property::Map mCachedMarkerInfo;
399 PlayState mPlayState;
400 DevelImageVisual::StopBehavior::Type mStopBehavior;
401 DevelImageVisual::LoopingMode::Type mLoopingMode;
402 TimePoint mNextFrameStartTime;
403 int64_t mFrameDurationMicroSeconds;
405 uint32_t mCurrentFrame;
406 uint32_t mTotalFrame;
407 uint32_t mStartFrame;
409 uint32_t mDroppedFrames;
412 uint32_t mAnimationDataIndex;
413 uint32_t mAppliedPlayStateId;
415 int32_t mCurrentLoop;
417 bool mUpdateFrameNumber : 1;
418 bool mNeedAnimationFinishedTrigger : 1;
419 bool mAnimationDataUpdated : 1;
420 bool mDestroyTask : 1;
421 bool mLoadRequest : 1;
422 bool mLoadFailed : 1;
423 bool mRasterized : 1;
424 bool mKeepAnimation : 1;
425 mutable bool mLayerInfoCached : 1;
426 mutable bool mMarkerInfoCached : 1;
427 bool mEnableFrameCache : 1;
428 bool mSizeUpdated : 1;
431 } // namespace Internal
433 } // namespace Toolkit
437 #endif // DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H