Trigger svg loading early
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-rasterize-thread.h
index d7eb16b..13d284b 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 // EXTERNAL INCLUDES
 #include <dali/devel-api/adaptor-framework/event-thread-callback.h>
+#include <dali/devel-api/adaptor-framework/vector-image-renderer.h>
 #include <dali/devel-api/threading/conditional-wait.h>
 #include <dali/devel-api/threading/mutex.h>
 #include <dali/devel-api/threading/thread.h>
-#include <dali/public-api/images/pixel-data.h>
+#include <dali/integration-api/adaptor-framework/log-factory-interface.h>
+#include <dali/integration-api/processor-interface.h>
 #include <dali/public-api/common/intrusive-ptr.h>
 #include <dali/public-api/common/vector-wrapper.h>
+#include <dali/public-api/images/pixel-data.h>
 #include <dali/public-api/object/ref-object.h>
-#include <dali/public-api/rendering/texture-set.h>
-#include <dali/devel-api/adaptor-framework/vector-image-renderer.h>
-#include <dali/integration-api/adaptor-framework/log-factory-interface.h>
 #include <memory>
 
 // INTERNAL INCLUDES
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Internal
 {
-
 class SvgVisual;
-typedef IntrusivePtr< SvgVisual > SvgVisualPtr;
-class RasterizingTask;
-typedef IntrusivePtr< RasterizingTask > RasterizingTaskPtr;
+typedef IntrusivePtr<SvgVisual> SvgVisualPtr;
+class SvgTask;
+typedef IntrusivePtr<SvgTask> SvgTaskPtr;
 
 /**
  * The svg rasterizing tasks to be processed in the worker thread.
@@ -57,28 +54,31 @@ typedef IntrusivePtr< RasterizingTask > RasterizingTaskPtr;
  * 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
  *    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.
  */
-class RasterizingTask : public RefObject
+class SvgTask : public RefObject
 {
 public:
   /**
    * Constructor
-   * @param[in] svgRenderer The renderer which the rasterized image to be applied.
-   * @param[in] url The URL to svg resource to use.
-   * @param[in] width The rasterization width.
-   * @param[in] height The rasterization height.
-   * @param[in] loaded The svg resource is loaded or not.
+   * @param[in] svgVisual The visual which the rasterized image to be applied.
+   * @param[in] vectorRenderer The vector rasterizer.
    */
-  RasterizingTask( SvgVisual* svgRenderer, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi, unsigned int width, unsigned int height, bool loaded );
+  SvgTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer);
 
   /**
    * Destructor.
    */
-  ~RasterizingTask() override;
+  virtual ~SvgTask() = default;
+
+  /**
+   * Process the task
+   */
+  virtual void Process() = 0;
 
   /**
-   * Do the rasterization with the mRasterizer.
+   * Whether the task has succeeded.
+   * @return True if the task has succeeded.
    */
-  void Rasterize();
+  bool HasSucceeded() const;
 
   /**
    * Get the svg visual
@@ -89,74 +89,127 @@ public:
    * Get the rasterization result.
    * @return The pixel data with the rasterized pixels.
    */
-  PixelData GetPixelData() const;
+  virtual PixelData GetPixelData() const;
+
+private:
+  // Undefined
+  SvgTask(const SvgTask& task) = delete;
+
+  // Undefined
+  SvgTask& operator=(const SvgTask& task) = delete;
+
+protected:
+  SvgVisualPtr        mSvgVisual;
+  VectorImageRenderer mVectorRenderer;
+  bool                mHasSucceeded;
+};
 
+class SvgLoadingTask : public SvgTask
+{
+public:
   /**
-   * Get the VectorRenderer.
-   * @return VectorRenderer.
+   * Constructor
+   * @param[in] svgVisual The visual which the rasterized image to be applied.
+   * @param[in] vectorRenderer The vector rasterizer.
+   * @param[in] url The URL to svg resource to use.
+   * @param[in] dpi The DPI of the screen.
    */
-  VectorImageRenderer GetVectorRenderer() const;
+  SvgLoadingTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi);
+
   /**
-   * Whether the resource is loaded.
-   * @return True if the resource is loaded.
+   * Destructor.
    */
-  bool IsLoaded() const;
+  ~SvgLoadingTask() override;
 
   /**
-   * Load svg file
+   * Process the task
    */
-  void Load();
+  void Process() override;
 
 private:
   // Undefined
-  RasterizingTask( const RasterizingTask& task );
+  SvgLoadingTask(const SvgLoadingTask& task) = delete;
 
   // Undefined
-  RasterizingTask& operator=( const RasterizingTask& task );
+  SvgLoadingTask& operator=(const SvgLoadingTask& task) = delete;
 
 private:
-  SvgVisualPtr    mSvgVisual;
-  VectorImageRenderer mVectorRenderer;
-  VisualUrl       mUrl;
-  PixelData       mPixelData;
-  float           mDpi;
-  unsigned int    mWidth;
-  unsigned int    mHeight;
-  bool            mLoaded;
+  VisualUrl mUrl;
+  float     mDpi;
+};
+
+class SvgRasterizingTask : public SvgTask
+{
+public:
+  /**
+   * Constructor
+   * @param[in] svgVisual The visual which the rasterized image to be applied.
+   * @param[in] vectorRenderer The vector rasterizer.
+   * @param[in] width The rasterization width.
+   * @param[in] height The rasterization height.
+   */
+  SvgRasterizingTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer, unsigned int width, unsigned int height);
+
+  /**
+   * Destructor.
+   */
+  ~SvgRasterizingTask() override;
+
+  /**
+   * Process the task accodring to the type
+   */
+  void Process() override;
+
+  /**
+   * Get the rasterization result.
+   * @return The pixel data with the rasterized pixels.
+   */
+  PixelData GetPixelData() const override;
+
+private:
+  // Undefined
+  SvgRasterizingTask(const SvgRasterizingTask& task) = delete;
+
+  // Undefined
+  SvgRasterizingTask& operator=(const SvgRasterizingTask& task) = delete;
+
+private:
+  PixelData mPixelData;
+  uint32_t  mWidth;
+  uint32_t  mHeight;
 };
 
 /**
  * The worker thread for SVG rasterization.
  */
-class SvgRasterizeThread : public Thread
+class SvgRasterizeThread : public Thread, Integration::Processor
 {
 public:
-
   /**
    * Constructor.
    *
    * @param[in] trigger The trigger to wake up the main thread.
    */
-  SvgRasterizeThread( EventThreadCallback* trigger );
+  SvgRasterizeThread();
 
   /**
    * Terminate the svg rasterize thread, join and delete.
    */
-  static void TerminateThread( SvgRasterizeThread*& thread );
+  static void TerminateThread(SvgRasterizeThread*& thread);
 
   /**
    * Add a rasterization task into the waiting queue, called by main thread.
    *
    * @param[in] task The task added to the queue.
    */
-  void AddTask( RasterizingTaskPtr task );
+  void AddTask(SvgTaskPtr task);
 
   /**
    * Pop the next task out from the completed queue, called by main thread.
    *
    * @return The next task in the completed queue.
    */
-  RasterizingTaskPtr NextCompletedTask();
+  SvgTaskPtr NextCompletedTask();
 
   /**
    * Remove the task with the given visual from the waiting queue, called by main thread.
@@ -165,41 +218,45 @@ public:
    *
    * @param[in] visual The visual pointer.
    */
-  void RemoveTask( SvgVisual* visual );
+  void RemoveTask(SvgVisual* visual);
 
   /**
-   * Delete the parsed SVG image, called by main thread.
-   *
-   * The parsed svg should be deleted in worker thread, as the main thread does not know whether a rasterization of this svg is ongoing.
-   *
-   * @param[in] VectorImage The image to be deleted
+   * @copydoc Dali::Integration::Processor::Process()
    */
-  void DeleteImage( VectorImageRenderer vectorImage );
+  void Process(bool postProcessor) override;
 
 private:
-
   /**
    * Pop the next task out from the queue.
    *
    * @return The next task to be processed.
    */
-  RasterizingTaskPtr NextTaskToProcess();
+  SvgTaskPtr NextTaskToProcess();
 
   /**
    * Add a task in to the queue
    *
    * @param[in] task The task added to the queue.
    */
-  void AddCompletedTask( RasterizingTaskPtr task );
+  void AddCompletedTask(SvgTaskPtr task);
 
-protected:
+  /**
+   * Applies the rasterized image to material
+   */
+  void ApplyRasterizedSVGToSampler();
 
   /**
+   * @brief Unregister a previously registered processor
+   *
+   */
+  void UnregisterProcessor();
+
+protected:
+  /**
    * Destructor.
    */
   ~SvgRasterizeThread() override;
 
-
   /**
    * The entry function of the worker thread.
    * It fetches task from the Queue, rasterizes the image and apply to the renderer.
@@ -207,24 +264,22 @@ protected:
   void Run() override;
 
 private:
-
   // Undefined
-  SvgRasterizeThread( const SvgRasterizeThread& thread );
+  SvgRasterizeThread(const SvgRasterizeThread& thread);
 
   // Undefined
-  SvgRasterizeThread& operator=( const SvgRasterizeThread& thread );
+  SvgRasterizeThread& operator=(const SvgRasterizeThread& thread);
 
 private:
-
-  std::vector<RasterizingTaskPtr>  mRasterizeTasks;     //The queue of the tasks waiting to rasterize the SVG image
-  std::vector <RasterizingTaskPtr> mCompletedTasks;     //The queue of the tasks with the SVG rasterization completed
-  Vector <VectorImageRenderer*>    mDeleteSvg;          //The images that the event thread requested to delete
-
-  ConditionalWait            mConditionalWait;
-  Dali::Mutex                mMutex;
-  std::unique_ptr< EventThreadCallback > mTrigger;
-  const Dali::LogFactoryInterface&       mLogFactory;
-  bool                       mIsThreadWaiting;
+  std::vector<SvgTaskPtr> mRasterizeTasks; //The queue of the tasks waiting to rasterize the SVG image
+  std::vector<SvgTaskPtr> mCompletedTasks; //The queue of the tasks with the SVG rasterization completed
+
+  ConditionalWait                      mConditionalWait;
+  Dali::Mutex                          mMutex;
+  std::unique_ptr<EventThreadCallback> mTrigger;
+  const Dali::LogFactoryInterface&     mLogFactory;
+  bool                                 mIsThreadWaiting;
+  bool                                 mProcessorRegistered;
 };
 
 } // namespace Internal