1 #ifndef DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
2 #define DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H
5 * Copyright (c) 2021 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>
32 #include <dali/public-api/rendering/texture-set.h>
36 #include <dali-toolkit/internal/visuals/visual-url.h>
45 typedef IntrusivePtr<SvgVisual> SvgVisualPtr;
46 class RasterizingTask;
47 typedef IntrusivePtr<RasterizingTask> RasterizingTaskPtr;
50 * The svg rasterizing tasks to be processed in the worker thread.
52 * Life cycle of a rasterizing task is as follows:
53 * 1. Created by SvgVisual in the main thread
54 * 2. Queued in the worked thread waiting to be processed.
55 * 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
56 * 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 class RasterizingTask : public RefObject
63 * @param[in] svgRenderer The renderer which the rasterized image to be applied.
64 * @param[in] url The URL to svg resource to use.
65 * @param[in] width The rasterization width.
66 * @param[in] height The rasterization height.
68 RasterizingTask(SvgVisual* svgRenderer, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi, unsigned int width, unsigned int height);
73 ~RasterizingTask() override;
76 * Do the rasterization with the mRasterizer.
83 SvgVisual* GetSvgVisual() const;
86 * Get the rasterization result.
87 * @return The pixel data with the rasterized pixels.
89 PixelData GetPixelData() const;
92 * Get the VectorRenderer.
93 * @return VectorRenderer.
95 VectorImageRenderer GetVectorRenderer() const;
97 * Whether the resource is loaded.
98 * @return True if the resource is loaded.
100 bool IsLoaded() const;
109 RasterizingTask(const RasterizingTask& task);
112 RasterizingTask& operator=(const RasterizingTask& task);
115 SvgVisualPtr mSvgVisual;
116 VectorImageRenderer mVectorRenderer;
118 PixelData mPixelData;
121 unsigned int mHeight;
126 * The worker thread for SVG rasterization.
128 class SvgRasterizeThread : public Thread, Integration::Processor
134 * @param[in] trigger The trigger to wake up the main thread.
136 SvgRasterizeThread();
139 * Terminate the svg rasterize thread, join and delete.
141 static void TerminateThread(SvgRasterizeThread*& thread);
144 * Add a rasterization task into the waiting queue, called by main thread.
146 * @param[in] task The task added to the queue.
148 void AddTask(RasterizingTaskPtr task);
151 * Pop the next task out from the completed queue, called by main thread.
153 * @return The next task in the completed queue.
155 RasterizingTaskPtr NextCompletedTask();
158 * Remove the task with the given visual from the waiting queue, called by main thread.
160 * Typically called when the actor is put off stage, so the renderer is not needed anymore.
162 * @param[in] visual The visual pointer.
164 void RemoveTask(SvgVisual* visual);
167 * @copydoc Dali::Integration::Processor::Process()
169 void Process(bool postProcessor) override;
173 * Pop the next task out from the queue.
175 * @return The next task to be processed.
177 RasterizingTaskPtr NextTaskToProcess();
180 * Add a task in to the queue
182 * @param[in] task The task added to the queue.
184 void AddCompletedTask(RasterizingTaskPtr task);
187 * Applies the rasterized image to material
189 void ApplyRasterizedSVGToSampler();
192 * @brief Unregister a previously registered processor
195 void UnregisterProcessor();
201 ~SvgRasterizeThread() override;
204 * The entry function of the worker thread.
205 * It fetches task from the Queue, rasterizes the image and apply to the renderer.
211 SvgRasterizeThread(const SvgRasterizeThread& thread);
214 SvgRasterizeThread& operator=(const SvgRasterizeThread& thread);
217 std::vector<RasterizingTaskPtr> mRasterizeTasks; //The queue of the tasks waiting to rasterize the SVG image
218 std::vector<RasterizingTaskPtr> mCompletedTasks; //The queue of the tasks with the SVG rasterization completed
220 ConditionalWait mConditionalWait;
222 std::unique_ptr<EventThreadCallback> mTrigger;
223 const Dali::LogFactoryInterface& mLogFactory;
224 bool mIsThreadWaiting;
225 bool mProcessorRegistered;
228 } // namespace Internal
230 } // namespace Toolkit
234 #endif // DALI_TOOLKIT_SVG_RASTERIZE_THREAD_H