1 #ifndef DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
2 #define DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <dali/devel-api/adaptor-framework/event-thread-callback.h>
22 #include <dali/devel-api/adaptor-framework/vector-image-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/adaptor-framework/log-factory-interface.h>
27 #include <dali/integration-api/processor-interface.h>
28 #include <dali/public-api/common/intrusive-ptr.h>
29 #include <dali/public-api/common/vector-wrapper.h>
30 #include <dali/public-api/images/pixel-data.h>
31 #include <dali/public-api/object/ref-object.h>
35 #include <dali-toolkit/internal/visuals/visual-url.h>
44 typedef IntrusivePtr<SvgVisual> SvgVisualPtr;
46 typedef IntrusivePtr<SvgTask> SvgTaskPtr;
49 * The svg rasterizing tasks to be processed in the worker thread.
51 * Life cycle of a rasterizing task is as follows:
52 * 1. Created by SvgVisual in the main thread
53 * 2. Queued in the worked thread waiting to be processed.
54 * 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
55 * 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.
57 class SvgTask : public RefObject
62 * @param[in] svgVisual The visual which the rasterized image to be applied.
63 * @param[in] vectorRenderer The vector rasterizer.
65 SvgTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer);
70 virtual ~SvgTask() = default;
75 virtual void Process() = 0;
78 * Whether the task has succeeded.
79 * @return True if the task has succeeded.
81 bool HasSucceeded() const;
86 SvgVisual* GetSvgVisual() const;
89 * Get the rasterization result.
90 * @return The pixel data with the rasterized pixels.
92 virtual PixelData GetPixelData() const;
96 SvgTask(const SvgTask& task) = delete;
99 SvgTask& operator=(const SvgTask& task) = delete;
102 SvgVisualPtr mSvgVisual;
103 VectorImageRenderer mVectorRenderer;
107 class SvgLoadingTask : public SvgTask
112 * @param[in] svgVisual The visual which the rasterized image to be applied.
113 * @param[in] vectorRenderer The vector rasterizer.
114 * @param[in] url The URL to svg resource to use.
115 * @param[in] dpi The DPI of the screen.
117 SvgLoadingTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi);
122 ~SvgLoadingTask() override;
127 void Process() override;
131 SvgLoadingTask(const SvgLoadingTask& task) = delete;
134 SvgLoadingTask& operator=(const SvgLoadingTask& task) = delete;
141 class SvgRasterizingTask : public SvgTask
146 * @param[in] svgVisual The visual which the rasterized image to be applied.
147 * @param[in] vectorRenderer The vector rasterizer.
148 * @param[in] width The rasterization width.
149 * @param[in] height The rasterization height.
151 SvgRasterizingTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer, unsigned int width, unsigned int height);
156 ~SvgRasterizingTask() override;
159 * Process the task accodring to the type
161 void Process() override;
164 * Get the rasterization result.
165 * @return The pixel data with the rasterized pixels.
167 PixelData GetPixelData() const override;
171 SvgRasterizingTask(const SvgRasterizingTask& task) = delete;
174 SvgRasterizingTask& operator=(const SvgRasterizingTask& task) = delete;
177 PixelData mPixelData;
183 * The worker thread for SVG rasterization.
185 class SvgRasterizeThread : public Thread, Integration::Processor
191 * @param[in] trigger The trigger to wake up the main thread.
193 SvgRasterizeThread();
196 * Terminate the svg rasterize thread, join and delete.
198 static void TerminateThread(SvgRasterizeThread*& thread);
201 * Add a rasterization task into the waiting queue, called by main thread.
203 * @param[in] task The task added to the queue.
205 void AddTask(SvgTaskPtr task);
208 * Pop the next task out from the completed queue, called by main thread.
210 * @return The next task in the completed queue.
212 SvgTaskPtr NextCompletedTask();
215 * Remove the task with the given visual from the waiting queue, called by main thread.
217 * Typically called when the actor is put off stage, so the renderer is not needed anymore.
219 * @param[in] visual The visual pointer.
221 void RemoveTask(SvgVisual* visual);
224 * @copydoc Dali::Integration::Processor::Process()
226 void Process(bool postProcessor) override;
230 * Pop the next task out from the queue.
232 * @return The next task to be processed.
234 SvgTaskPtr NextTaskToProcess();
237 * Add a task in to the queue
239 * @param[in] task The task added to the queue.
241 void AddCompletedTask(SvgTaskPtr task);
244 * Applies the rasterized image to material
246 void ApplyRasterizedSVGToSampler();
249 * @brief Unregister a previously registered processor
252 void UnregisterProcessor();
258 ~SvgRasterizeThread() override;
261 * The entry function of the worker thread.
262 * It fetches task from the Queue, rasterizes the image and apply to the renderer.
268 SvgRasterizeThread(const SvgRasterizeThread& thread);
271 SvgRasterizeThread& operator=(const SvgRasterizeThread& thread);
274 std::vector<SvgTaskPtr> mRasterizeTasks; //The queue of the tasks waiting to rasterize the SVG image
275 std::vector<SvgTaskPtr> mCompletedTasks; //The queue of the tasks with the SVG rasterization completed
277 ConditionalWait mConditionalWait;
279 std::unique_ptr<EventThreadCallback> mTrigger;
280 const Dali::LogFactoryInterface& mLogFactory;
281 bool mIsThreadWaiting;
282 bool mProcessorRegistered;
285 } // namespace Internal
287 } // namespace Toolkit
291 #endif // DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H