1 #ifndef DALI_TOOLKIT_IMAGE_LOAD_THREAD_H
2 #define DALI_TOOLKIT_IMAGE_LOAD_THREAD_H
5 * Copyright (c) 2019 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/public-api/common/dali-vector.h>
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/public-api/images/image-operations.h>
24 #include <dali/devel-api/threading/conditional-wait.h>
25 #include <dali/devel-api/threading/mutex.h>
26 #include <dali/devel-api/threading/thread.h>
27 #include <dali/devel-api/adaptor-framework/event-thread-callback.h>
28 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
29 #include <dali/integration-api/adaptors/log-factory-interface.h>
30 #include <dali-toolkit/internal/visuals/visual-url.h>
31 #include <dali-toolkit/devel-api/image-loader/async-image-loader-devel.h>
43 * The task of loading and packing an image into the atlas.
49 * @param [in] id of the task
50 * @param [in] url The URL of the image file to load.
51 * @param [in] size The width and height to fit the loaded image to, 0.0 means whole image
52 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
53 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
54 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
55 * @param [in] preMultiplyOnLoad ON if the image's color should be multiplied by it's alpha.
57 LoadingTask( uint32_t id, const VisualUrl& url, ImageDimensions dimensions,
58 FittingMode::Type fittingMode, SamplingMode::Type samplingMode,
59 bool orientationCorrection,
60 DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad );
70 LoadingTask( const LoadingTask& queue );
73 LoadingTask& operator=( const LoadingTask& queue );
77 Devel::PixelBuffer pixelBuffer; ///< pixelBuffer handle after successful load
78 VisualUrl url; ///< url of the image to load
79 uint32_t id; ///< The unique id associated with this task.
80 ImageDimensions dimensions; ///< dimensions to load
81 FittingMode::Type fittingMode; ///< fitting options
82 SamplingMode::Type samplingMode; ///< sampling options
83 bool orientationCorrection:1; ///< if orientation correction is needed
84 DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad; //< if the image's color should be multiplied by it's alpha
89 * The worker thread for image loading.
91 class ImageLoadThread : public Thread
98 * @param[in] mTrigger The trigger to wake up the main thread.
100 ImageLoadThread( EventThreadCallback* mTrigger );
105 virtual ~ImageLoadThread();
108 * Add a task in to the loading queue
110 * @param[in] task The task added to the queue.
112 * @note This class takes ownership of the task object
114 void AddTask( LoadingTask* task );
117 * Pop the next task out from the completed queue.
119 * @return The next task to be processed.
121 LoadingTask* NextCompletedTask();
124 * Remove the loading task from the waiting queue.
126 bool CancelTask( uint32_t loadingTaskId );
129 * Remove all the loading tasks in the waiting queue.
136 * Pop the next loading task out from the queue to process.
138 * @return The next task to be processed.
140 LoadingTask* NextTaskToProcess();
143 * Add a task in to the loading queue
145 * @param[in] task The task added to the queue.
147 void AddCompletedTask( LoadingTask* task );
152 * The entry function of the worker thread.
153 * It fetches loading task from the loadQueue, loads the image and adds to the completeQueue.
160 ImageLoadThread( const ImageLoadThread& thread );
163 ImageLoadThread& operator=( const ImageLoadThread& thread );
167 Vector< LoadingTask* > mLoadQueue; ///<The task queue with images for loading.
168 Vector< LoadingTask* > mCompleteQueue; ///<The task queue with images loaded.
169 EventThreadCallback* mTrigger;
170 const Dali::LogFactoryInterface& mLogFactory; ///< The log factory
172 ConditionalWait mConditionalWait;
176 } // namespace Internal
178 } // namespace Toolkit
182 #endif // DALI_TOOLKIT_IMAGE_LOAD_THREAD_H