dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h

   1 #ifndef DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
   2 #define DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
   3
   4 /*
   5  * Copyright (c) 2019 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/threading/conditional-wait.h>
  23 #include <dali/devel-api/threading/mutex.h>
  24 #include <dali/devel-api/threading/thread.h>
  25 #include <dali/public-api/images/buffer-image.h>
  26 #include <dali/public-api/images/pixel-data.h>
  27 #include <dali/public-api/common/intrusive-ptr.h>
  28 #include <dali/public-api/common/vector-wrapper.h>
  29 #include <dali/public-api/object/ref-object.h>
  30 #include <dali/public-api/rendering/texture-set.h>
  31 #include <dali-toolkit/internal/visuals/visual-url.h>
  32
  33 struct NSVGimage;
  34 struct NSVGrasterizer;
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 class SvgVisual;
  46 typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
  47 class RasterizingTask;
  48 typedef IntrusivePtr< RasterizingTask > RasterizingTaskPtr;
  49
  50 /**
  51  * The svg rasterizing tasks to be processed in the worker thread.
  52  *
  53  * Life cycle of a rasterizing task is as follows:
  54  * 1. Created by SvgVisual in the main thread
  55  * 2. Queued in the worked thread waiting to be processed.
  56  * 3. If this task gets its turn to do the rasterization, it triggers main thread to apply the rasterized image to material then been deleted in main thread call back
  57  *    Or if this task is been removed ( new image/size set to the visual or actor off stage) before its turn to be processed, it then been deleted in the worker thread.
  58  */
  59 class RasterizingTask : public RefObject
  60 {
  61 public:
  62   /**
  63    * Constructor
  64    *
  65    * @param[in] svgRenderer The renderer which the rasterized image to be applied.
  66    * @param[in] parsedSvg The parsed svg for rasterizing.
  67    *            Note, after the task is added to the worker thread, the worker thread takes over the ownership.
  68    *            When the image is to be deleted, delete it in the worker thread by calling SvgRasterizeThread::DeleteImage( parsedSvg ).
  69    * @param[in] url The URL to svg resource to use.
  70    * @param[in] width The rasterization width.
  71    * @param[in] height The rasterization height.
  72    */
  73   RasterizingTask( SvgVisual* svgRenderer, NSVGimage* parsedSvg, const VisualUrl& url, float dpi, unsigned int width, unsigned int height );
  74
  75   /**
  76    * Destructor.
  77    */
  78   ~RasterizingTask();
  79
  80   /**
  81    * Do the rasterization with the mRasterizer.
  82    */
  83   void Rasterize( );
  84
  85   /**
  86    * Get the svg visual
  87    */
  88   SvgVisual* GetSvgVisual() const;
  89
  90   /**
  91    * Get the rasterization result.
  92    * @return The pixel data with the rasterized pixels.
  93    */
  94   PixelData GetPixelData() const;
  95
  96   /**
  97    * Get the parsed data.
  98    * @return parsed image data.
  99    */
 100   NSVGimage* GetParsedImage() const;
 101
 102   /**
 103    * Load svg file
 104    */
 105   void Load();
 106
 107 private:
 108   // Undefined
 109   RasterizingTask( const RasterizingTask& task );
 110
 111   // Undefined
 112   RasterizingTask& operator=( const RasterizingTask& task );
 113
 114 private:
 115   SvgVisualPtr    mSvgVisual;
 116   NSVGimage*      mParsedSvg;
 117   VisualUrl       mUrl;
 118   PixelData       mPixelData;
 119   float           mDpi;
 120   unsigned int    mWidth;
 121   unsigned int    mHeight;
 122   NSVGrasterizer* mRasterizer;
 123 };
 124
 125 /**
 126  * The worker thread for SVG rasterization.
 127  */
 128 class SvgRasterizeThread : public Thread
 129 {
 130 public:
 131
 132   /**
 133    * Constructor.
 134    *
 135    * @param[in] trigger The trigger to wake up the main thread.
 136    */
 137   SvgRasterizeThread( EventThreadCallback* trigger );
 138
 139   /**
 140    * Terminate the svg rasterize thread, join and delete.
 141    */
 142   static void TerminateThread( SvgRasterizeThread*& thread );
 143
 144   /**
 145    * Add a rasterization task into the waiting queue, called by main thread.
 146    *
 147    * @param[in] task The task added to the queue.
 148    */
 149   void AddTask( RasterizingTaskPtr task );
 150
 151   /**
 152    * Pop the next task out from the completed queue, called by main thread.
 153    *
 154    * @return The next task in the completed queue.
 155    */
 156   RasterizingTaskPtr NextCompletedTask();
 157
 158   /**
 159    * Remove the task with the given visual from the waiting queue, called by main thread.
 160    *
 161    * Typically called when the actor is put off stage, so the renderer is not needed anymore.
 162    *
 163    * @param[in] visual The visual pointer.
 164    */
 165   void RemoveTask( SvgVisual* visual );
 166
 167   /**
 168    * Delete the parsed SVG image, called by main thread.
 169    *
 170    * The parsed svg should be delelted in worker thread, as the main thread does not know whether a rasterization of this svg is ongoing.
 171    *
 172    * @param[in] parsedImage The image to be deleted
 173    */
 174   void DeleteImage( NSVGimage* parsedSvg );
 175
 176 private:
 177
 178   /**
 179    * Pop the next task out from the queue.
 180    *
 181    * @return The next task to be processed.
 182    */
 183   RasterizingTaskPtr NextTaskToProcess();
 184
 185   /**
 186    * Add a task in to the queue
 187    *
 188    * @param[in] task The task added to the queue.
 189    */
 190   void AddCompletedTask( RasterizingTaskPtr task );
 191
 192 protected:
 193
 194   /**
 195    * Destructor.
 196    */
 197   virtual ~SvgRasterizeThread();
 198
 199
 200   /**
 201    * The entry function of the worker thread.
 202    * It fetches task from the Queue, rasterizes the image and apply to the renderer.
 203    */
 204   void Run() override;
 205
 206 private:
 207
 208   // Undefined
 209   SvgRasterizeThread( const SvgRasterizeThread& thread );
 210
 211   // Undefined
 212   SvgRasterizeThread& operator=( const SvgRasterizeThread& thread );
 213
 214 private:
 215
 216   std::vector<RasterizingTaskPtr>  mRasterizeTasks;     //The queue of the tasks waiting to rasterize the SVG image
 217   std::vector <RasterizingTaskPtr> mCompletedTasks;     //The queue of the tasks with the SVG rasterization completed
 218   Vector<NSVGimage*>               mDeleteSvg;          //The images that the event thread requested to delete
 219
 220   ConditionalWait            mConditionalWait;
 221   Dali::Mutex                mMutex;
 222   EventThreadCallback*       mTrigger;
 223
 224   bool                       mIsThreadWaiting;
 225 };
 226
 227 } // namespace Internal
 228
 229 } // namespace Toolkit
 230
 231 } // namespace Dali
 232
 233 #endif // DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H