dali/devel-api/adaptor-framework/native-image-source-queue.h

   1 #ifndef DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
   2 #define DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/images/native-image-interface.h>
  23 #include <dali/public-api/object/any.h>
  24 #include <memory>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/dali-adaptor-common.h>
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali_adaptor_framework
  33  * @{
  34  */
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 namespace Adaptor
  39 {
  40 class NativeImageSourceQueue;
  41 }
  42 } // namespace DALI_INTERNAL
  43
  44 class NativeImageSourceQueue;
  45
  46 /**
  47  * @brief Pointer to Dali::NativeImageSourceQueue.
  48  */
  49 typedef Dali::IntrusivePtr<Dali::NativeImageSourceQueue> NativeImageSourceQueuePtr;
  50
  51 /**
  52  * @brief Used for displaying native images.
  53  *
  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.
  58  */
  59 class DALI_ADAPTOR_API NativeImageSourceQueue : public NativeImageInterface
  60 {
  61 public:
  62   /**
  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.
  65     */
  66   enum class ColorFormat
  67   {
  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
  74   };
  75
  76   /**
  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
  83    */
  84   static NativeImageSourceQueuePtr New(uint32_t width, uint32_t height, ColorFormat colorFormat);
  85
  86   /**
  87    * @brief Creates a new NativeImageSourceQueue from an existing native image source.
  88    *
  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
  92    */
  93   static NativeImageSourceQueuePtr New(Any nativeImageSourceQueue);
  94
  95   /**
  96    * @brief Retrieves the internal native image.
  97    *
  98    * @return Any object containing the internal native image source queue
  99    */
 100   Any GetNativeImageSourceQueue();
 101
 102   /**
 103    * @brief Sets the size of the image.
 104    *
 105    * @param[in] width The width of the image
 106    * @param[in] height The height of the image
 107    */
 108   void SetSize(uint32_t width, uint32_t height);
 109
 110   /**
 111    * @brief Ignores a source image which is inserted to the queue.
 112    *
 113    * @note This can be called from worker threads.
 114    */
 115   void IgnoreSourceImage();
 116
 117   /**
 118    * @brief Checks if the buffer can be got from the queue.
 119    *
 120    * Check the available buffer using this API before call DequeueBuffer()
 121    * @return True if the buffer can be got from the queue.
 122    */
 123   bool CanDequeueBuffer();
 124
 125   /**
 126    * @brief Dequeue buffer from the queue.
 127    *
 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
 134    */
 135   uint8_t* DequeueBuffer(uint32_t& width, uint32_t& height, uint32_t& stride);
 136
 137   /**
 138    * @brief Enqueue buffer to the queue.
 139    *
 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
 144    */
 145   bool EnqueueBuffer(uint8_t* buffer);
 146
 147   /**
 148    * @copydoc Dali::NativeImageInterface::GetTextureTarget()
 149    */
 150   int GetTextureTarget() const override;
 151
 152   /**
 153    * @copydoc Dali::NativeImageInterface::ApplyNativeFragmentShader()
 154    */
 155   bool ApplyNativeFragmentShader(std::string& shader) override;
 156
 157   /**
 158    * @copydoc Dali::NativeImageInterface::GetCustomSamplerTypename()
 159    */
 160   const char* GetCustomSamplerTypename() const override;
 161
 162 private: // native image
 163   /**
 164    * @copydoc Dali::NativeImageInterface::CreateResource()
 165    */
 166   bool CreateResource() override;
 167
 168   /**
 169    * @copydoc Dali::NativeImageInterface::DestroyResource()
 170    */
 171   void DestroyResource() override;
 172
 173   /**
 174    * @copydoc Dali::NativeImageInterface::TargetTexture()
 175    */
 176   uint32_t TargetTexture() override;
 177
 178   /**
 179    * @copydoc Dali::NativeImageInterface::PrepareTexture()
 180    */
 181   void PrepareTexture() override;
 182
 183   /**
 184    * @copydoc Dali::NativeImageInterface::GetWidth()
 185    */
 186   uint32_t GetWidth() const override;
 187
 188   /**
 189    * @copydoc Dali::NativeImageInterface::GetHeight()
 190    */
 191   uint32_t GetHeight() const override;
 192
 193   /**
 194    * @copydoc Dali::NativeImageInterface::RequiresBlending()
 195    */
 196   bool RequiresBlending() const override;
 197
 198   /**
 199    * @copydoc Dali::NativeImageInterface::GetNativeImageHandle()
 200    */
 201   Any GetNativeImageHandle() const override;
 202
 203   /**
 204    * @copydoc Dali::NativeImageInterface::SourceChanged()
 205    */
 206   bool SourceChanged() const override;
 207
 208   /**
 209    * @copydoc Dali::NativeImageInterface::GetExtension()
 210    */
 211   NativeImageInterface::Extension* GetExtension() override;
 212
 213 private:
 214   /// @cond internal
 215   /**
 216    * @brief Private constructor.
 217    * @param[in] width The width of the image
 218    * @param[in] height The height of the image
 219    * @param[in] colorFormat The color format of the image
 220    * @param[in] nativeImageSourceQueue contains either: native image source or is empty
 221    */
 222   DALI_INTERNAL NativeImageSourceQueue(uint32_t width, uint32_t height, ColorFormat colorFormat, Any nativeImageSourceQueue);
 223
 224   /**
 225    * @brief A reference counted object may only be deleted by calling Unreference().
 226    *
 227    * The implementation should destroy the NativeImage resources.
 228    */
 229   DALI_INTERNAL ~NativeImageSourceQueue() override;
 230
 231   /**
 232    * @brief Undefined copy constructor.
 233    *
 234    * This avoids accidental calls to a default copy constructor.
 235    * @param[in] nativeImageSourceQueue A reference to the object to copy
 236    */
 237   DALI_INTERNAL NativeImageSourceQueue(const NativeImageSourceQueue& nativeImageSourceQueue);
 238
 239   /**
 240    * @brief Undefined assignment operator.
 241    *
 242    * This avoids accidental calls to a default assignment operator.
 243    * @param[in] rhs A reference to the object to copy
 244    */
 245   DALI_INTERNAL NativeImageSourceQueue& operator=(const NativeImageSourceQueue& rhs);
 246   /// @endcond
 247
 248 private:
 249   /// @cond internal
 250   std::unique_ptr<Internal::Adaptor::NativeImageSourceQueue> mImpl; ///< Implementation pointer
 251   /// @endcond
 252 };
 253
 254 /**
 255  * @}
 256  */
 257 } // namespace Dali
 258
 259 #endif // DALI_NATIVE_IMAGE_SOURCE_QUEUE_H