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