1 #ifndef DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
2 #define DALI_NATIVE_IMAGE_SOURCE_QUEUE_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.
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.
65 enum class ColorFormat
67 RGB888, /// 8 red bits, 8 green bits, 8 blue bits
68 RGBA8888, /// 8 red bits, 8 green bits, 8 blue bits, alpha 8 bits
69 RGBX8888 /// 8 red bits, 8 green bits, 8 blue bits, and 8 ignored bits
73 * @brief Creates a new NativeImageSourceQueue.
74 * Depending on hardware, the width and height may have to be a power of two.
75 * @param[in] width The width of the image
76 * @param[in] height The height of the image
77 * @param[in] colorFormat The color format of the image
78 * @return A smart-pointer to a newly allocated image
80 static NativeImageSourceQueuePtr New(uint32_t width, uint32_t height, ColorFormat colorFormat);
83 * @brief Creates a new NativeImageSourceQueue from an existing native image source.
85 * @param[in] nativeImageSourceQueue NativeImageSourceQueue must be a any handle with native image source
86 * @return A smart-pointer to a newly allocated image
87 * @see NativeImageInterface
89 static NativeImageSourceQueuePtr New(Any nativeImageSourceQueue);
92 * @brief Retrieves the internal native image.
94 * @return Any object containing the internal native image source queue
96 Any GetNativeImageSourceQueue();
99 * @brief Sets the size of the image.
101 * @param[in] width The width of the image
102 * @param[in] height The height of the image
104 void SetSize(uint32_t width, uint32_t height);
107 * @brief Ignores a source image which is inserted to the queue.
109 * @note This can be called from worker threads.
111 void IgnoreSourceImage();
114 * @brief Checks if the buffer can be got from the queue.
116 * Check the available buffer using this API before call DequeueBuffer()
117 * @return True if the buffer can be got from the queue.
119 bool CanDequeueBuffer();
122 * @brief Dequeue buffer from the queue.
124 * Acquire buffer and information of the queue.
125 * it returns the information of the buffer.
126 * @param[out] width The width of buffer
127 * @param[out] height The height of buffer
128 * @param[out] stride The stride of buffer
129 * @return A pointer of buffer
131 uint8_t* DequeueBuffer(uint32_t& width, uint32_t& height, uint32_t& stride);
134 * @brief Enqueue buffer to the queue.
136 * Enqueue buffer to the queue
137 * this requests the release of the buffer internally.
138 * @param[in] buffer A pointer of buffer
139 * @return True if success
141 bool EnqueueBuffer(uint8_t* buffer);
144 * @copydoc Dali::NativeImageInterface::GetTextureTarget()
146 int GetTextureTarget() const override;
149 * @copydoc Dali::NativeImageInterface::ApplyNativeFragmentShader()
151 bool ApplyNativeFragmentShader(std::string& shader) override;
154 * @copydoc Dali::NativeImageInterface::GetCustomSamplerTypename()
156 const char* GetCustomSamplerTypename() const override;
158 private: // native image
160 * @copydoc Dali::NativeImageInterface::CreateResource()
162 bool CreateResource() override;
165 * @copydoc Dali::NativeImageInterface::DestroyResource()
167 void DestroyResource() override;
170 * @copydoc Dali::NativeImageInterface::TargetTexture()
172 uint32_t TargetTexture() override;
175 * @copydoc Dali::NativeImageInterface::PrepareTexture()
177 void PrepareTexture() override;
180 * @copydoc Dali::NativeImageInterface::GetWidth()
182 uint32_t GetWidth() const override;
185 * @copydoc Dali::NativeImageInterface::GetHeight()
187 uint32_t GetHeight() const override;
190 * @copydoc Dali::NativeImageInterface::RequiresBlending()
192 bool RequiresBlending() const override;
195 * @copydoc Dali::NativeImageInterface::GetNativeImageHandle()
197 Any GetNativeImageHandle() const override;
200 * @copydoc Dali::NativeImageInterface::SourceChanged()
202 bool SourceChanged() const override;
205 * @copydoc Dali::NativeImageInterface::GetExtension()
207 NativeImageInterface::Extension* GetExtension() override;
212 * @brief Private constructor.
213 * @param[in] width The width of the image
214 * @param[in] height The height of the image
215 * @param[in] colorFormat The color format of the image
216 * @param[in] nativeImageSourceQueue contains either: native image source or is empty
218 DALI_INTERNAL NativeImageSourceQueue(uint32_t width, uint32_t height, ColorFormat colorFormat, Any nativeImageSourceQueue);
221 * @brief A reference counted object may only be deleted by calling Unreference().
223 * The implementation should destroy the NativeImage resources.
225 DALI_INTERNAL ~NativeImageSourceQueue() override;
228 * @brief Undefined copy constructor.
230 * This avoids accidental calls to a default copy constructor.
231 * @param[in] nativeImageSourceQueue A reference to the object to copy
233 DALI_INTERNAL NativeImageSourceQueue(const NativeImageSourceQueue& nativeImageSourceQueue);
236 * @brief Undefined assignment operator.
238 * This avoids accidental calls to a default assignment operator.
239 * @param[in] rhs A reference to the object to copy
241 DALI_INTERNAL NativeImageSourceQueue& operator=(const NativeImageSourceQueue& rhs);
246 std::unique_ptr<Internal::Adaptor::NativeImageSourceQueue> mImpl; ///< Implementation pointer
255 #endif // DALI_NATIVE_IMAGE_SOURCE_QUEUE_H