dali-toolkit/internal/visuals/animated-vector-image/vector-rasterize-thread.h

   1 #ifndef DALI_TOOLKIT_VECTOR_IMAGE_RASTERIZE_THREAD_H
   2 #define DALI_TOOLKIT_VECTOR_IMAGE_RASTERIZE_THREAD_H
   3
   4 /*
   5  * Copyright (c) 2018 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/devel-api/threading/mutex.h>
  25 #include <dali/devel-api/threading/thread.h>
  26 #include <dali/integration-api/adaptors/log-factory-interface.h>
  27 #include <string>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal
  39 {
  40
  41 /**
  42  * The worker thread for vector image rasterization.
  43  */
  44 class VectorRasterizeThread : public Thread
  45 {
  46 public:
  47
  48   /**
  49    * @brief Constructor.
  50    *
  51    * @param[in] url The url of the vector animation file
  52    */
  53   VectorRasterizeThread( const std::string& url );
  54
  55   /**
  56    * @brief Destructor.
  57    */
  58   virtual ~VectorRasterizeThread();
  59
  60   /**
  61    * @brief Sets the renderer used to display the result image.
  62    *
  63    * @param[in] renderer The renderer used to display the result image
  64    */
  65   void SetRenderer( Renderer renderer );
  66
  67   /**
  68    * @brief Sets the target image size.
  69    *
  70    * @param[in] width The target image width
  71    * @param[in] height The target image height
  72    */
  73   void SetSize( uint32_t width, uint32_t height );
  74
  75   /**
  76    * @brief Play the vector animation.
  77    */
  78   void PlayAnimation();
  79
  80   /**
  81    * @brief Stop the vector animation.
  82    */
  83   void StopAnimation();
  84
  85   /**
  86    * @brief Pause the vector animation.
  87    */
  88   void PauseAnimation();
  89
  90   /**
  91    * @brief Render one frame. The current frame number will be increased.
  92    */
  93   void RenderFrame();
  94
  95   /**
  96    * @brief This callback is called after the first frame is ready.
  97    * @param[in] callback The resource ready callback
  98    */
  99   void SetResourceReadyCallback( EventThreadCallback* callback );
 100
 101   /**
 102    * @brief This callback is called after the animation is finished.
 103    * @param[in] callback The animation finished callback
 104    */
 105   void SetAnimationFinishedCallback( EventThreadCallback* callback );
 106
 107   /**
 108    * @brief Enable looping for 'count' repeats. -1 means to repeat forever.
 109    * @param[in] count The number of times to loop
 110    */
 111   void SetLoopCount( int32_t count );
 112
 113   /**
 114    * @brief Gets the loop count. -1 means to repeat forever.
 115    * @return The number of times to loop
 116    */
 117   int32_t GetLoopCount() const;
 118
 119   /**
 120    * @brief Set the playing range.
 121    * @param[in] range Two values between [0,1] to specify minimum and maximum progress.
 122    * The animation will play between those values.
 123    */
 124   void SetPlayRange( Vector2 range );
 125
 126   /**
 127    * @brief Gets the playing range.
 128    * @return The play range defined for the animation
 129    */
 130   Vector2 GetPlayRange() const;
 131
 132   /**
 133    * @brief Get the play state
 134    * @return The play state
 135    */
 136   DevelImageVisual::PlayState GetPlayState() const;
 137
 138   /**
 139    * @brief Queries whether the resource is ready.
 140    * @return true if ready, false otherwise
 141    */
 142   bool IsResourceReady() const;
 143
 144 protected:
 145
 146   /**
 147    * @brief The entry function of the worker thread.
 148    *        It rasterizes the vector image.
 149    */
 150   void Run() override;
 151
 152 private:
 153
 154   /**
 155    * @brief Called by the rasterize thread which ensures a wait if required.
 156    * @return false if the thread should stop.
 157    */
 158   bool IsThreadReady();
 159
 160   /**
 161    * @brief Start rendering
 162    */
 163   bool StartRender();
 164
 165   /**
 166    * @brief Rasterize the current frame.
 167    */
 168   void Rasterize();
 169
 170   // Undefined
 171   VectorRasterizeThread( const VectorRasterizeThread& thread ) = delete;
 172
 173   // Undefined
 174   VectorRasterizeThread& operator=( const VectorRasterizeThread& thread ) = delete;
 175
 176 private:
 177
 178   std::string                 mUrl;
 179   VectorAnimationRenderer     mVectorRenderer;
 180   ConditionalWait             mConditionalWait;
 181   Dali::Mutex                 mMutex;
 182   EventThreadCallback*        mResourceReadyTrigger;
 183   EventThreadCallback*        mAnimationFinishedTrigger;
 184   Vector2                     mPlayRange;
 185   DevelImageVisual::PlayState mPlayState;
 186   float                       mProgress;
 187   uint32_t                    mCurrentFrame;
 188   uint32_t                    mTotalFrame;
 189   uint32_t                    mStartFrame;
 190   uint32_t                    mEndFrame;
 191   uint32_t                    mWidth;
 192   uint32_t                    mHeight;
 193   int32_t                     mLoopCount;
 194   int32_t                     mCurrentLoop;
 195   bool                        mNeedRender;
 196   bool                        mDestroyThread;  ///< Whether the thread be destroyed
 197   bool                        mResourceReady;
 198   const Dali::LogFactoryInterface& mLogFactory; ///< The log factory
 199
 200 };
 201
 202 } // namespace Internal
 203
 204 } // namespace Toolkit
 205
 206 } // namespace Dali
 207
 208 #endif // DALI_TOOLKIT_VECTOR_IMAGE_RASTERIZE_THREAD_H