1 #ifndef DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
2 #define DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
5 * Copyright (c) 2023 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.
22 #include <dali/public-api/images/native-image-interface.h>
23 #include <dali/public-api/object/any.h>
27 #include <dali/public-api/dali-adaptor-common.h>
32 * @addtogroup dali_adaptor_framework
36 namespace Internal DALI_INTERNAL
40 class NativeImageSourceQueue;
42 } // namespace DALI_INTERNAL
44 class NativeImageSourceQueue;
47 * @brief Pointer to Dali::NativeImageSourceQueue.
49 typedef Dali::IntrusivePtr<Dali::NativeImageSourceQueue> NativeImageSourceQueuePtr;
52 * @brief Used for displaying native images.
54 * NativeImage is a platform specific way of providing pixel data to the GPU for rendering,for example via an EGL image.
55 * NativeImageSourceQueue can be created internally or externally by native image source.
56 * It has a queue which handles some image buffers.
57 * Someone should fill the buffers and enqueue them, then DALi will show them.
59 class DALI_ADAPTOR_API NativeImageSourceQueue : public NativeImageInterface
63 * @brief Enumeration for the instance when creating a native image, the color depth has to be specified.
64 * @note This ColorFormat follows pixel byte order.
66 enum class ColorFormat
68 BGR888 = 0, /// 8 blue bits, 8 green bits, 8 red bits
69 BGRA8888 = 1, /// 8 blue bits, 8 green bits, 8 red bits, alpha 8 bits
70 BGRX8888 = 2, /// 8 blue bits, 8 green bits, 8 red bits, and 8 ignored bits
71 RGB888 = 3, /// 8 red bits, 8 green bits, 8 blue bits
72 RGBA8888 = 4, /// 8 red bits, 8 green bits, 8 blue bits, alpha 8 bits
73 RGBX8888 = 5, /// 8 red bits, 8 green bits, 8 blue bits, and 8 ignored bits
77 * @brief Creates a new NativeImageSourceQueue.
78 * Depending on hardware, the width and height may have to be a power of two.
79 * @param[in] width The width of the image
80 * @param[in] height The height of the image
81 * @param[in] colorFormat The color format of the image
82 * @return A smart-pointer to a newly allocated image
84 static NativeImageSourceQueuePtr New(uint32_t width, uint32_t height, ColorFormat colorFormat);
87 * @brief Creates a new NativeImageSourceQueue from an existing native image source.
89 * @param[in] nativeImageSourceQueue NativeImageSourceQueue must be a any handle with native image source
90 * @return A smart-pointer to a newly allocated image
91 * @see NativeImageInterface
93 static NativeImageSourceQueuePtr New(Any nativeImageSourceQueue);
96 * @brief Retrieves the internal native image.
98 * @return Any object containing the internal native image source queue
100 Any GetNativeImageSourceQueue();
103 * @brief Sets the size of the image.
105 * @param[in] width The width of the image
106 * @param[in] height The height of the image
108 void SetSize(uint32_t width, uint32_t height);
111 * @brief Ignores a source image which is inserted to the queue.
113 * @note This can be called from worker threads.
115 void IgnoreSourceImage();
118 * @brief Checks if the buffer can be got from the queue.
120 * Check the available buffer using this API before call DequeueBuffer()
121 * @return True if the buffer can be got from the queue.
123 bool CanDequeueBuffer();
126 * @brief Dequeue buffer from the queue.
128 * Acquire buffer and information of the queue.
129 * it returns the information of the buffer.
130 * @param[out] width The width of buffer
131 * @param[out] height The height of buffer
132 * @param[out] stride The stride of buffer
133 * @return A pointer of buffer
135 uint8_t* DequeueBuffer(uint32_t& width, uint32_t& height, uint32_t& stride);
138 * @brief Enqueue buffer to the queue.
140 * Enqueue buffer to the queue
141 * this requests the release of the buffer internally.
142 * @param[in] buffer A pointer of buffer
143 * @return True if success
145 bool EnqueueBuffer(uint8_t* buffer);
148 * @brief Free all released buffers.
150 void FreeReleasedBuffers();
153 * @copydoc Dali::NativeImageInterface::GetTextureTarget()
155 int GetTextureTarget() const override;
158 * @copydoc Dali::NativeImageInterface::ApplyNativeFragmentShader()
160 bool ApplyNativeFragmentShader(std::string& shader) override;
163 * @copydoc Dali::NativeImageInterface::GetCustomSamplerTypename()
165 const char* GetCustomSamplerTypename() const override;
167 private: // native image
169 * @copydoc Dali::NativeImageInterface::CreateResource()
171 bool CreateResource() override;
174 * @copydoc Dali::NativeImageInterface::DestroyResource()
176 void DestroyResource() override;
179 * @copydoc Dali::NativeImageInterface::TargetTexture()
181 uint32_t TargetTexture() override;
184 * @copydoc Dali::NativeImageInterface::PrepareTexture()
186 void PrepareTexture() override;
189 * @copydoc Dali::NativeImageInterface::GetWidth()
191 uint32_t GetWidth() const override;
194 * @copydoc Dali::NativeImageInterface::GetHeight()
196 uint32_t GetHeight() const override;
199 * @copydoc Dali::NativeImageInterface::RequiresBlending()
201 bool RequiresBlending() const override;
204 * @copydoc Dali::NativeImageInterface::GetNativeImageHandle()
206 Any GetNativeImageHandle() const override;
209 * @copydoc Dali::NativeImageInterface::SourceChanged()
211 bool SourceChanged() const override;
214 * @copydoc Dali::NativeImageInterface::GetUpdatedArea()
216 Rect<uint32_t> GetUpdatedArea() override;
219 * @copydoc Dali::NativeImageInterface::GetExtension()
221 NativeImageInterface::Extension* GetExtension() override;
226 * @brief Private constructor.
227 * @param[in] width The width of the image
228 * @param[in] height The height of the image
229 * @param[in] colorFormat The color format of the image
230 * @param[in] nativeImageSourceQueue contains either: native image source or is empty
232 DALI_INTERNAL NativeImageSourceQueue(uint32_t width, uint32_t height, ColorFormat colorFormat, Any nativeImageSourceQueue);
235 * @brief A reference counted object may only be deleted by calling Unreference().
237 * The implementation should destroy the NativeImage resources.
239 DALI_INTERNAL ~NativeImageSourceQueue() override;
242 * @brief Undefined copy constructor.
244 * This avoids accidental calls to a default copy constructor.
245 * @param[in] nativeImageSourceQueue A reference to the object to copy
247 DALI_INTERNAL NativeImageSourceQueue(const NativeImageSourceQueue& nativeImageSourceQueue);
250 * @brief Undefined assignment operator.
252 * This avoids accidental calls to a default assignment operator.
253 * @param[in] rhs A reference to the object to copy
255 DALI_INTERNAL NativeImageSourceQueue& operator=(const NativeImageSourceQueue& rhs);
260 std::unique_ptr<Internal::Adaptor::NativeImageSourceQueue> mImpl; ///< Implementation pointer
269 #endif // DALI_NATIVE_IMAGE_SOURCE_QUEUE_H