Show the broken image in case of invalid svg files
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-rasterize-thread.h
index 46c6966..86e233f 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
 #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/buffer-image.h>
 #include <dali/public-api/images/pixel-data.h>
 #include <dali/public-api/common/intrusive-ptr.h>
 #include <dali/public-api/common/vector-wrapper.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 <dali/integration-api/processor-interface.h>
+#include <memory>
 
-struct NSVGimage;
-struct NSVGrasterizer;
+// INTERNAL INCLUDES
+#include <dali-toolkit/internal/visuals/visual-url.h>
 
 namespace Dali
 {
@@ -60,21 +63,22 @@ class RasterizingTask : public RefObject
 public:
   /**
    * Constructor
-   *
    * @param[in] svgRenderer The renderer which the rasterized image to be applied.
-   * @param[in] parsedSvg The parsed svg for rasterizing.
-   *            Note, after the task is added to the worker thread, the worker thread takes over the ownership.
-   *            When the image is to be deleted, delete it in the worker thread by calling SvgRasterizeThread::DeleteImage( parsedSvg ).
+   * @param[in] url The URL to svg resource to use.
    * @param[in] width The rasterization width.
    * @param[in] height The rasterization height.
    */
-  RasterizingTask( SvgVisual* svgRenderer, NSVGimage* parsedSvg, unsigned int width, unsigned int height );
+  RasterizingTask(SvgVisual* svgRenderer, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi, unsigned int width, unsigned int height);
 
   /**
-   * Do the rasterization with the given rasterizer.
-   *@param[in] rasterizer The rasterizer that rasterize the SVG to a buffer image
+   * Destructor.
    */
-  void Rasterize( NSVGrasterizer* rasterizer );
+  ~RasterizingTask() override;
+
+  /**
+   * Do the rasterization with the mRasterizer.
+   */
+  void Rasterize();
 
   /**
    * Get the svg visual
@@ -87,8 +91,23 @@ public:
    */
   PixelData GetPixelData() const;
 
-private:
+  /**
+   * Get the VectorRenderer.
+   * @return VectorRenderer.
+   */
+  VectorImageRenderer GetVectorRenderer() const;
+  /**
+   * Whether the resource is loaded.
+   * @return True if the resource is loaded.
+   */
+  bool IsLoaded() const;
+
+  /**
+   * Load svg file
+   */
+  void Load();
 
+private:
   // Undefined
   RasterizingTask( const RasterizingTask& task );
 
@@ -96,18 +115,20 @@ private:
   RasterizingTask& operator=( const RasterizingTask& task );
 
 private:
-  SvgVisualPtr  mSvgVisual;
+  SvgVisualPtr    mSvgVisual;
+  VectorImageRenderer mVectorRenderer;
+  VisualUrl       mUrl;
   PixelData       mPixelData;
-  NSVGimage*      mParsedSvg;
+  float           mDpi;
   unsigned int    mWidth;
   unsigned int    mHeight;
+  bool            mLoadSuccess;
 };
 
-
 /**
  * The worker thread for SVG rasterization.
  */
-class SvgRasterizeThread : public Thread
+class SvgRasterizeThread : public Thread, Integration::Processor
 {
 public:
 
@@ -116,7 +137,7 @@ public:
    *
    * @param[in] trigger The trigger to wake up the main thread.
    */
-  SvgRasterizeThread( EventThreadCallback* trigger );
+  SvgRasterizeThread();
 
   /**
    * Terminate the svg rasterize thread, join and delete.
@@ -149,11 +170,16 @@ public:
   /**
    * Delete the parsed SVG image, called by main thread.
    *
-   * The parsed svg should be delelted in worker thread, as the main thread does not know whether a rasterization of this svg is ongoing.
+   * 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] parsedImage The image to be deleted
+   * @param[in] VectorImage The image to be deleted
+   */
+  void DeleteImage( VectorImageRenderer vectorImage );
+
+    /**
+   * @copydoc Dali::Integration::Processor::Process()
    */
-  void DeleteImage( NSVGimage* parsedSvg );
+  void Process() override;
 
 private:
 
@@ -171,19 +197,30 @@ private:
    */
   void AddCompletedTask( RasterizingTaskPtr task );
 
+  /**
+   * Applies the rasterized image to material
+   */
+  void ApplyRasterizedSVGToSampler();
+
+  /**
+   * @brief Unregister a previously registered processor
+   *
+   */
+  void UnregisterProcessor();
+
 protected:
 
   /**
    * Destructor.
    */
-  virtual ~SvgRasterizeThread();
+  ~SvgRasterizeThread() override;
 
 
   /**
    * The entry function of the worker thread.
    * It fetches task from the Queue, rasterizes the image and apply to the renderer.
    */
-  virtual void Run();
+  void Run() override;
 
 private:
 
@@ -197,14 +234,14 @@ 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<NSVGimage*>               mDeleteSvg;          //The images that the event thread requested to delete
+  Vector <VectorImageRenderer*>    mDeleteSvg;          //The images that the event thread requested to delete
 
   ConditionalWait            mConditionalWait;
   Dali::Mutex                mMutex;
-  EventThreadCallback*       mTrigger;
-
-  NSVGrasterizer*            mRasterizer;
+  std::unique_ptr< EventThreadCallback > mTrigger;
+  const Dali::LogFactoryInterface&       mLogFactory;
   bool                       mIsThreadWaiting;
+  bool                       mProcessorRegistered;
 };
 
 } // namespace Internal