dali/devel-api/adaptor-framework/pixel-buffer.h

   1 #ifndef DALI_PIXEL_BUFFER_H
   2 #define DALI_PIXEL_BUFFER_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/images/pixel-data.h>
  23 #include <dali/public-api/images/pixel.h>
  24 #include <dali/public-api/object/base-handle.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/dali-adaptor-common.h>
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33 namespace Adaptor
  34 {
  35 class PixelBuffer;
  36 }
  37 } // namespace Internal
  38
  39 // Use namespace to separate from PixelBuffer typedef in buffer-image.h
  40 namespace Devel
  41 {
  42 /**
  43  * @brief The PixelBuffer object holds a pixel buffer.
  44  *
  45  * The PixelBuffer keeps ownership of it's initial buffer however, the
  46  * user is free to modify the pixel data, either directly, or via
  47  * image operations.
  48  *
  49  * In order to upload the pixel data to texture memory, there are two
  50  * possibilities - either convert it back to a PixelData object, which
  51  * releases the PixelBuffer object, leaving the user with an empty handle
  52  * (ideal for one-time indirect image manipulation), or create a new
  53  * PixelData object from this object, leaving the buffer intact (ideal
  54  * for continuous manipulation)
  55  *
  56  * @SINCE_1_2.46
  57  */
  58 class DALI_ADAPTOR_API PixelBuffer : public BaseHandle
  59 {
  60 public:
  61   /**
  62    * Create a PixelBuffer with it's own data buffer.
  63    */
  64   static PixelBuffer New(uint32_t            width,
  65                          uint32_t            height,
  66                          Dali::Pixel::Format pixelFormat);
  67
  68   /**
  69    * @brief Creates an empty handle.
  70    * Use PixelBuffer::New() to create an initialized object.
  71    *
  72    * @SINCE_1_2.46
  73    */
  74   PixelBuffer();
  75
  76   /**
  77    * @brief Destructor.
  78    *
  79    * @SINCE_1_2.46
  80    */
  81   ~PixelBuffer();
  82
  83   /**
  84    * @brief This copy constructor is required for (smart) pointer semantics.
  85    *
  86    * @SINCE_1_2.46
  87    * @param[in] handle A reference to the copied handle
  88    */
  89   PixelBuffer(const PixelBuffer& handle);
  90
  91   /**
  92    * @brief This assignment operator is required for (smart) pointer semantics.
  93    *
  94    * @SINCE_1_2.46
  95    * @param[in] rhs A reference to the copied handle
  96    * @return A reference to this object
  97    */
  98   PixelBuffer& operator=(const PixelBuffer& rhs);
  99
 100   /**
 101    * @brief This move constructor is required for (smart) pointer semantics.
 102    *
 103    * @SINCE_2_1.45
 104    * @param[in] handle A reference to the moved handle
 105    */
 106   PixelBuffer(PixelBuffer&& handle);
 107
 108   /**
 109    * @brief This move assignment operator is required for (smart) pointer semantics.
 110    *
 111    * @SINCE_2_1.45
 112    * @param[in] rhs A reference to the moved handle
 113    * @return A reference to this object
 114    */
 115   PixelBuffer& operator=(PixelBuffer&& rhs);
 116
 117   /**
 118    * Convert to a pixel data and release the pixelBuffer's object.
 119    * This handle is left empty.
 120    *
 121    * @warning Any other handles that keep a reference to this object
 122    * will be left with no buffer, trying to access it will return NULL.
 123    *
 124    * @SINCE_1_2.46
 125    * @param[in,out] pixelBuffer
 126    * @return a new PixelData which takes ownership of the PixelBuffer's buffer.
 127    */
 128   static PixelData Convert(PixelBuffer& pixelBuffer);
 129
 130   /**
 131    * Copy the data from this object into a new PixelData object, which could be
 132    * used for uploading to a texture.
 133    * @return a new PixelData object containing a copy of this pixel buffer's data.
 134    */
 135   Dali::PixelData CreatePixelData() const;
 136
 137   /**
 138    * @brief Gets the pixel buffer. This is a pointer to the internal
 139    * pixel buffer.
 140    *
 141    * @warning If there is no pixel buffer (e.g. this object has been
 142    * converted to a PixelData), this method will return NULL.
 143    *
 144    * @SINCE_1_2.46
 145    * @return The pixel buffer, or NULL.
 146    */
 147   uint8_t* GetBuffer();
 148
 149   /**
 150    * @brief Gets the pixel buffer. This is a pointer to the internal
 151    * pixel buffer.
 152    *
 153    * @warning If there is no pixel buffer (e.g. this object has been
 154    * converted to a PixelData), this method will return NULL.
 155    *
 156    * @return The pixel buffer, or NULL.
 157    */
 158   const uint8_t* GetBuffer() const;
 159
 160   /**
 161    * @brief Gets the width of the buffer in pixels.
 162    *
 163    * @SINCE_1_2.46
 164    * @return The width of the buffer in pixels
 165    */
 166   uint32_t GetWidth() const;
 167
 168   /**
 169    * @brief Gets the height of the buffer in pixels.
 170    *
 171    * @SINCE_1_2.46
 172    * @return The height of the buffer in pixels
 173    */
 174   uint32_t GetHeight() const;
 175
 176   /**
 177    * @brief Gets the stride of the buffer in pixels.
 178    *
 179    * @SINCE_2_1.17
 180    * @return The stride of the buffer in pixels. 0 means the buffer is tightly packed.
 181    */
 182   uint32_t GetStride() const;
 183
 184   /**
 185    * @brief Gets the pixel format.
 186    *
 187    * @SINCE_1_2.46
 188    * @return The pixel format
 189    */
 190   Pixel::Format GetPixelFormat() const;
 191
 192   /**
 193    * Apply the mask to this pixel data, and return a new pixel data containing
 194    * the masked image. If this PixelBuffer doesn't have an alpha channel, then
 195    * the resultant PixelBuffer will be converted to a format that supports at
 196    * least the width of the color channels and the alpha channel from the mask.
 197    *
 198    * If cropToMask is set to true, then the contentScale is applied first to
 199    * this buffer, and the target buffer is cropped to the size of the mask. If
 200    * it's set to false, then the mask is scaled to match this buffer's size
 201    * before the mask is applied.
 202    *
 203    * @param[in] mask The mask to apply.
 204    * @param[in] contentScale The scaling factor to apply to the content
 205    * @param[in] cropToMask Whether to crop the output to the mask size (true)
 206    * or scale the mask to the content size (false)
 207    */
 208   void ApplyMask(PixelBuffer mask, float contentScale = 1.0f, bool cropToMask = false);
 209
 210   /**
 211    * Apply a Gaussian blur to this pixel data with the given radius.
 212    *
 213    * @note A bigger radius will yield a blurrier image. Only works for pixel data in RGBA format.
 214    *
 215    * @param[in] blurRadius The radius for Gaussian blur. A value of 0 or negative value indicates no blur.
 216    */
 217   void ApplyGaussianBlur(const float blurRadius);
 218
 219   /**
 220    * @brief Crops this buffer to the given crop rectangle.
 221    *
 222    * The crop rectangle will be clamped to the edges of the buffer if it is larger.
 223    * @param[in] x The top left corner's X
 224    * @param[in] y The top left corner's y
 225    * @param[in] width The crop width
 226    * @param[in] height The crop height
 227    */
 228   void Crop(uint16_t x, uint16_t y, uint16_t width, uint16_t height);
 229
 230   /**
 231    * @brief Resizes the buffer to the given dimensions.
 232    *
 233    * Uses either Lanczos4 for downscaling or Mitchell for upscaling
 234    * @param[in] width The new width
 235    * @param[in] height The new height
 236    */
 237   void Resize(uint16_t width, uint16_t height);
 238
 239   /**
 240    * @brief Returns Exif metadata as a property map
 241    *
 242    * @param[out] metadata Property map object to write into
 243    * @return True on success
 244    */
 245   bool GetMetadata(Property::Map& metadata) const;
 246
 247   /**
 248    * @brief Multiplies the image's color values by the alpha value. This provides better
 249    * blending capability.
 250    */
 251   void MultiplyColorByAlpha();
 252
 253   /**
 254    * @brief Rotates the pixel buffer by the given angle.
 255    *
 256    * @note Operation valid for pixel formats: A8, L8, LA88, RGB888, RGB8888, BGR8888, RGBA8888 and BGRA8888. Fails otherwise.
 257    * @note The operation does nothing for angles equivalent to 0 degrees: -360, 360, 720, etc.
 258    * @note If the pixel buffer does rotate, all the pointers to the internal pixel buffer retrieved by the method GetPixelBuffer() become invalid.
 259    *
 260    * @param[in] angle The angle in degrees.
 261    *
 262    * @return @e false if the rotation fails (invalid pixel format or memory issues).
 263    */
 264   bool Rotate(Degree angle);
 265
 266   /**
 267    * @brief Returns pixel-buffer is premultiplied or not.
 268    * @return true if alpha is pre-multiplied.
 269    */
 270   bool IsAlphaPreMultiplied() const;
 271
 272   /**
 273    * @brief Get the brightness of the pixel buffer.
 274    * @note The range is 255 to 0. The closer to 255, the brighter. 0 is not bright.
 275    * @return brightness of the pixel buffer.
 276    */
 277   uint32_t GetBrightness() const;
 278
 279 public:
 280   /**
 281    * @brief The constructor.
 282    * @note  Not intended for application developers.
 283    * @SINCE_1_2.46
 284    * @param[in] pointer A pointer to a newly allocated PixelBuffer
 285    */
 286   explicit DALI_INTERNAL PixelBuffer(Internal::Adaptor::PixelBuffer* pointer);
 287 };
 288
 289 } // namespace Devel
 290 } // namespace Dali
 291
 292 #endif // DALI_PIXEL_BUFFER_H