1 #ifndef DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H
2 #define DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H
5 * Copyright (c) 2022 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/conditional-wait.h>
24 #include <dali/public-api/object/property-array.h>
29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
37 class VisualFactoryCache;
38 class VectorAnimationThread;
39 class VectorAnimationTask;
40 typedef IntrusivePtr<VectorAnimationTask> VectorAnimationTaskPtr;
43 * The task of the vector animation.
45 class VectorAnimationTask : public RefObject, public ConnectionTracker
48 using ResourceReadySignalType = Signal<void(bool)>;
50 using TimePoint = std::chrono::time_point<std::chrono::steady_clock>;
53 * Flags for re-sending data to the vector animation thread
57 RESEND_PLAY_RANGE = 1 << 0,
58 RESEND_LOOP_COUNT = 1 << 1,
59 RESEND_STOP_BEHAVIOR = 1 << 2,
60 RESEND_LOOPING_MODE = 1 << 3,
61 RESEND_CURRENT_FRAME = 1 << 4,
63 RESEND_PLAY_STATE = 1 << 6,
64 RESEND_NEED_RESOURCE_READY = 1 << 7
68 * @brief Structure used to pass parameters to the vector animation task
76 stopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
77 loopingMode(DevelImageVisual::LoopingMode::RESTART),
85 AnimationData& operator=(const AnimationData& rhs)
87 resendFlag |= rhs.resendFlag; // OR resend flag
88 playRange = rhs.playRange;
89 playState = rhs.playState;
90 stopBehavior = rhs.stopBehavior;
91 loopingMode = rhs.loopingMode;
92 currentFrame = rhs.currentFrame;
95 loopCount = rhs.loopCount;
100 Property::Array playRange;
101 DevelImageVisual::PlayState::Type playState;
102 DevelImageVisual::StopBehavior::Type stopBehavior;
103 DevelImageVisual::LoopingMode::Type loopingMode;
104 uint32_t currentFrame;
111 * @brief Constructor.
113 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
115 VectorAnimationTask(VisualFactoryCache& factoryCache);
120 ~VectorAnimationTask() override;
123 * @brief Finalizes the task.
128 * @brief Sets the renderer used to display the result image.
130 * @param[in] renderer The renderer used to display the result image
132 void SetRenderer(Renderer renderer);
135 * @brief Request to load the animation file.
137 * @param[in] url The url of the vector animation file
139 void RequestLoad(const std::string& url);
142 * @brief Sets data to specify animation playback.
143 * @param[in] data The animation data
145 void SetAnimationData(const AnimationData& data);
148 * @brief This callback is called after the animation is finished.
149 * @param[in] callback The animation finished callback
151 void SetAnimationFinishedCallback(EventThreadCallback* callback);
154 * @brief Gets the playing range in frame number.
155 * @param[out] startFrame The frame number to specify minimum progress.
156 * @param[out] endFrame The frame number to specify maximum progress.
158 void GetPlayRange(uint32_t& startFrame, uint32_t& endFrame);
161 * @brief Retrieves the current frame number of the animation.
162 * @return The current frame number
164 uint32_t GetCurrentFrameNumber() const;
167 * @brief Retrieves the total frame number of the animation.
168 * @return The total frame number
170 uint32_t GetTotalFrameNumber() const;
173 * @brief Gets the default size of the file,.
174 * @return The default size of the file
176 void GetDefaultSize(uint32_t& width, uint32_t& height) const;
179 * @brief Gets the layer information of all the child layers.
180 * @param[out] map The layer information
182 void GetLayerInfo(Property::Map& map) const;
185 * @brief Connect to this signal to be notified when the resource is ready.
186 * @return The signal to connect to.
188 ResourceReadySignalType& ResourceReadySignal();
191 * @brief Rasterizes the current frame.
192 * @param[out] keepAnimation true if the animation is running, false otherwise.
193 * @return true if the rasterization succeeded, false otherwise.
195 bool Rasterize(bool& keepAnimation);
198 * @brief Calculates the time for the next frame rasterization.
199 * @return The time for the next frame rasterization.
201 TimePoint CalculateNextFrameTime(bool renderNow);
204 * @brief Gets the time for the next frame rasterization.
205 * @return The time for the next frame rasterization.
207 TimePoint GetNextFrameTime();
211 * @brief Loads the animation file.
213 * @return True if loading succeeded, false otherwise.
218 * @brief Play the vector animation.
220 void PlayAnimation();
223 * @brief Stop the vector animation.
225 void StopAnimation();
228 * @brief Pause the vector animation.
230 void PauseAnimation();
233 * @brief Sets the target image size.
235 * @param[in] width The target image width
236 * @param[in] height The target image height
238 void SetSize(uint32_t width, uint32_t height);
241 * @brief Enable looping for 'count' repeats. -1 means to repeat forever.
242 * @param[in] count The number of times to loop
244 void SetLoopCount(int32_t count);
247 * @brief Set the playing range in frame number.
248 * @param[in] playRange The array to specify minimum and maximum progress.
249 * The animation will play between those values.
251 void SetPlayRange(const Property::Array& playRange);
254 * @brief Sets the current frame number of the animation.
255 * @param[in] frameNumber The new frame number between [0, the maximum frame number] or between the play range if specified.
257 void SetCurrentFrameNumber(uint32_t frameNumber);
260 * @brief Sets the stop behavior of the animation. This is performed when the animation is stopped.
261 * @param[in] stopBehavior The stop behavior
263 void SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior);
266 * @brief Sets the looping mode.
267 * Animation plays forwards and then restarts from the beginning or runs backwards again.
268 * @param[in] loopingMode The looping mode
270 void SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode);
273 * @brief Gets the frame number when the animation is stopped according to the stop behavior.
275 uint32_t GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame);
278 * @brief Applies the animation data set by the main thread.
280 void ApplyAnimationData();
283 * @brief Called when the texture upload is completed.
285 void OnUploadCompleted();
288 * @brief Event callback from rasterize thread. This is called when the file loading is completed.
290 void OnLoadCompleted();
293 VectorAnimationTask(const VectorAnimationTask& task) = delete;
296 VectorAnimationTask& operator=(const VectorAnimationTask& task) = delete;
301 STOPPING, ///< The animation is stopping
302 STOPPED, ///< The animation has stopped
303 PLAYING, ///< The animation is playing
304 PAUSED ///< The animation is paused
308 VectorAnimationRenderer mVectorRenderer;
309 AnimationData mAnimationData[2];
310 VectorAnimationThread& mVectorAnimationThread;
311 ConditionalWait mConditionalWait;
312 ResourceReadySignalType mResourceReadySignal;
313 std::unique_ptr<EventThreadCallback> mAnimationFinishedTrigger;
314 std::unique_ptr<EventThreadCallback> mLoadCompletedTrigger;
315 PlayState mPlayState;
316 DevelImageVisual::StopBehavior::Type mStopBehavior;
317 DevelImageVisual::LoopingMode::Type mLoopingMode;
318 TimePoint mNextFrameStartTime;
319 int64_t mFrameDurationMicroSeconds;
321 uint32_t mCurrentFrame;
322 uint32_t mTotalFrame;
323 uint32_t mStartFrame;
325 uint32_t mDroppedFrames;
328 uint32_t mAnimationDataIndex;
330 int32_t mCurrentLoop;
332 bool mUpdateFrameNumber;
333 bool mNeedAnimationFinishedTrigger;
334 bool mAnimationDataUpdated;
340 } // namespace Internal
342 } // namespace Toolkit
346 #endif // DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H