dali-toolkit/internal/visuals/animated-vector-image/vector-animation-task.h

   1 #ifndef DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H
   2 #define DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  */
  19
  20 // EXTERNAL INCLUDES
  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>
  25 #include <chrono>
  26 #include <memory>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
  30
  31 namespace Dali
  32 {
  33 namespace Toolkit
  34 {
  35 namespace Internal
  36 {
  37 class VisualFactoryCache;
  38 class VectorAnimationThread;
  39 class VectorAnimationTask;
  40 typedef IntrusivePtr<VectorAnimationTask> VectorAnimationTaskPtr;
  41
  42 /**
  43  * The task of the vector animation.
  44  */
  45 class VectorAnimationTask : public RefObject, public ConnectionTracker
  46 {
  47 public:
  48   enum class ResourceStatus
  49   {
  50     LOADED, /// Resource is loaded
  51     READY,  /// Resource is ready
  52     FAILED  /// Resource is fail to load
  53   };
  54
  55   using ResourceReadySignalType = Signal<void(ResourceStatus)>;
  56
  57   using TimePoint = std::chrono::time_point<std::chrono::steady_clock>;
  58
  59   /**
  60    * Flags for re-sending data to the vector animation thread
  61    */
  62   enum ResendFlags
  63   {
  64     RESEND_PLAY_RANGE          = 1 << 0,
  65     RESEND_LOOP_COUNT          = 1 << 1,
  66     RESEND_STOP_BEHAVIOR       = 1 << 2,
  67     RESEND_LOOPING_MODE        = 1 << 3,
  68     RESEND_CURRENT_FRAME       = 1 << 4,
  69     RESEND_SIZE                = 1 << 5,
  70     RESEND_PLAY_STATE          = 1 << 6,
  71     RESEND_NEED_RESOURCE_READY = 1 << 7
  72   };
  73
  74   /**
  75    * @brief Structure used to pass parameters to the vector animation task
  76    */
  77   struct AnimationData
  78   {
  79     AnimationData()
  80     : resendFlag(0),
  81       playRange(),
  82       playState(),
  83       stopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
  84       loopingMode(DevelImageVisual::LoopingMode::RESTART),
  85       currentFrame(0),
  86       width(0),
  87       height(0),
  88       loopCount(-1)
  89     {
  90     }
  91
  92     AnimationData& operator=(const AnimationData& rhs)
  93     {
  94       resendFlag |= rhs.resendFlag; // OR resend flag
  95       playRange    = rhs.playRange;
  96       playState    = rhs.playState;
  97       stopBehavior = rhs.stopBehavior;
  98       loopingMode  = rhs.loopingMode;
  99       currentFrame = rhs.currentFrame;
 100       width        = rhs.width;
 101       height       = rhs.height;
 102       loopCount    = rhs.loopCount;
 103       return *this;
 104     }
 105
 106     uint32_t                             resendFlag;
 107     Property::Array                      playRange;
 108     DevelImageVisual::PlayState::Type    playState;
 109     DevelImageVisual::StopBehavior::Type stopBehavior;
 110     DevelImageVisual::LoopingMode::Type  loopingMode;
 111     uint32_t                             currentFrame;
 112     uint32_t                             width;
 113     uint32_t                             height;
 114     int32_t                              loopCount;
 115   };
 116
 117   /**
 118    * @brief Constructor.
 119    *
 120    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 121    */
 122   VectorAnimationTask(VisualFactoryCache& factoryCache);
 123
 124   /**
 125    * @brief Destructor.
 126    */
 127   ~VectorAnimationTask() override;
 128
 129   /**
 130    * @brief Finalizes the task.
 131    */
 132   void Finalize();
 133
 134   /**
 135    * @brief Sets the renderer used to display the result image.
 136    *
 137    * @param[in] renderer The renderer used to display the result image
 138    */
 139   void SetRenderer(Renderer renderer);
 140
 141   /**
 142    * @brief Request to load the animation file.
 143    *
 144    * @param[in] url The url of the vector animation file
 145    */
 146   void RequestLoad(const std::string& url);
 147
 148   /**
 149    * @brief Sets data to specify animation playback.
 150    * @param[in] data The animation data
 151    */
 152   void SetAnimationData(const AnimationData& data);
 153
 154   /**
 155    * @brief This callback is called after the animation is finished.
 156    * @param[in] callback The animation finished callback
 157    */
 158   void SetAnimationFinishedCallback(EventThreadCallback* callback);
 159
 160   /**
 161    * @brief Gets the playing range in frame number.
 162    * @param[out] startFrame The frame number to specify minimum progress.
 163    * @param[out] endFrame The frame number to specify maximum progress.
 164    */
 165   void GetPlayRange(uint32_t& startFrame, uint32_t& endFrame);
 166
 167   /**
 168    * @brief Retrieves the current frame number of the animation.
 169    * @return The current frame number
 170    */
 171   uint32_t GetCurrentFrameNumber() const;
 172
 173   /**
 174    * @brief Retrieves the total frame number of the animation.
 175    * @return The total frame number
 176    */
 177   uint32_t GetTotalFrameNumber() const;
 178
 179   /**
 180    * @brief Gets the default size of the file,.
 181    * @return The default size of the file
 182    */
 183   void GetDefaultSize(uint32_t& width, uint32_t& height) const;
 184
 185   /**
 186    * @brief Gets the layer information of all the child layers.
 187    * @param[out] map The layer information
 188    */
 189   void GetLayerInfo(Property::Map& map) const;
 190
 191   /**
 192    * @brief Connect to this signal to be notified when the resource is ready.
 193    * @return The signal to connect to.
 194    */
 195   ResourceReadySignalType& ResourceReadySignal();
 196
 197   /**
 198    * @brief Rasterizes the current frame.
 199    * @param[out] keepAnimation true if the animation is running, false otherwise.
 200    * @return true if the rasterization succeeded, false otherwise.
 201    */
 202   bool Rasterize(bool& keepAnimation);
 203
 204   /**
 205    * @brief Calculates the time for the next frame rasterization.
 206    * @return The time for the next frame rasterization.
 207    */
 208   TimePoint CalculateNextFrameTime(bool renderNow);
 209
 210   /**
 211    * @brief Gets the time for the next frame rasterization.
 212    * @return The time for the next frame rasterization.
 213    */
 214   TimePoint GetNextFrameTime();
 215
 216 private:
 217   /**
 218    * @brief Loads the animation file.
 219    *
 220    * @return True if loading succeeded, false otherwise.
 221    */
 222   bool Load();
 223
 224   /**
 225    * @brief Play the vector animation.
 226    */
 227   void PlayAnimation();
 228
 229   /**
 230    * @brief Stop the vector animation.
 231    */
 232   void StopAnimation();
 233
 234   /**
 235    * @brief Pause the vector animation.
 236    */
 237   void PauseAnimation();
 238
 239   /**
 240    * @brief Sets the target image size.
 241    *
 242    * @param[in] width The target image width
 243    * @param[in] height The target image height
 244    */
 245   void SetSize(uint32_t width, uint32_t height);
 246
 247   /**
 248    * @brief Enable looping for 'count' repeats. -1 means to repeat forever.
 249    * @param[in] count The number of times to loop
 250    */
 251   void SetLoopCount(int32_t count);
 252
 253   /**
 254    * @brief Set the playing range in frame number.
 255    * @param[in] playRange The array to specify minimum and maximum progress.
 256    * The animation will play between those values.
 257    */
 258   void SetPlayRange(const Property::Array& playRange);
 259
 260   /**
 261    * @brief Sets the current frame number of the animation.
 262    * @param[in] frameNumber The new frame number between [0, the maximum frame number] or between the play range if specified.
 263    */
 264   void SetCurrentFrameNumber(uint32_t frameNumber);
 265
 266   /**
 267    * @brief Sets the stop behavior of the animation. This is performed when the animation is stopped.
 268    * @param[in] stopBehavior The stop behavior
 269    */
 270   void SetStopBehavior(DevelImageVisual::StopBehavior::Type stopBehavior);
 271
 272   /**
 273    * @brief Sets the looping mode.
 274    * Animation plays forwards and then restarts from the beginning or runs backwards again.
 275    * @param[in] loopingMode The looping mode
 276    */
 277   void SetLoopingMode(DevelImageVisual::LoopingMode::Type loopingMode);
 278
 279   /**
 280    * @brief Gets the frame number when the animation is stopped according to the stop behavior.
 281    */
 282   uint32_t GetStoppedFrame(uint32_t startFrame, uint32_t endFrame, uint32_t currentFrame);
 283
 284   /**
 285    * @brief Applies the animation data set by the main thread.
 286    */
 287   void ApplyAnimationData();
 288
 289   /**
 290    * @brief Called when the texture upload is completed.
 291    */
 292   void OnUploadCompleted();
 293
 294   /**
 295    * @brief Event callback from rasterize thread. This is called when the file loading is completed.
 296    */
 297   void OnLoadCompleted();
 298
 299   // Undefined
 300   VectorAnimationTask(const VectorAnimationTask& task) = delete;
 301
 302   // Undefined
 303   VectorAnimationTask& operator=(const VectorAnimationTask& task) = delete;
 304
 305 private:
 306   enum class PlayState
 307   {
 308     STOPPING, ///< The animation is stopping
 309     STOPPED,  ///< The animation has stopped
 310     PLAYING,  ///< The animation is playing
 311     PAUSED    ///< The animation is paused
 312   };
 313
 314   std::string                          mUrl;
 315   VectorAnimationRenderer              mVectorRenderer;
 316   AnimationData                        mAnimationData[2];
 317   VectorAnimationThread&               mVectorAnimationThread;
 318   ConditionalWait                      mConditionalWait;
 319   ResourceReadySignalType              mResourceReadySignal;
 320   std::unique_ptr<EventThreadCallback> mAnimationFinishedTrigger;
 321   std::unique_ptr<EventThreadCallback> mLoadCompletedTrigger;
 322   PlayState                            mPlayState;
 323   DevelImageVisual::StopBehavior::Type mStopBehavior;
 324   DevelImageVisual::LoopingMode::Type  mLoopingMode;
 325   TimePoint                            mNextFrameStartTime;
 326   int64_t                              mFrameDurationMicroSeconds;
 327   float                                mFrameRate;
 328   uint32_t                             mCurrentFrame;
 329   uint32_t                             mTotalFrame;
 330   uint32_t                             mStartFrame;
 331   uint32_t                             mEndFrame;
 332   uint32_t                             mDroppedFrames;
 333   uint32_t                             mWidth;
 334   uint32_t                             mHeight;
 335   uint32_t                             mAnimationDataIndex;
 336   int32_t                              mLoopCount;
 337   int32_t                              mCurrentLoop;
 338   bool                                 mForward;
 339   bool                                 mUpdateFrameNumber;
 340   bool                                 mNeedAnimationFinishedTrigger;
 341   bool                                 mAnimationDataUpdated;
 342   bool                                 mDestroyTask;
 343   bool                                 mLoadRequest;
 344   bool                                 mLoadFailed;
 345 };
 346
 347 } // namespace Internal
 348
 349 } // namespace Toolkit
 350
 351 } // namespace Dali
 352
 353 #endif // DALI_TOOLKIT_VECTOR_ANIMATION_TASK_H