1 #ifndef DALI_PIXEL_BUFFER_H
2 #define DALI_PIXEL_BUFFER_H
5 * Copyright (c) 2022 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/pixel-data.h>
23 #include <dali/public-api/images/pixel.h>
24 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/dali-adaptor-common.h>
37 } // namespace Internal
39 // Use namespace to separate from PixelBuffer typedef in buffer-image.h
43 * @brief The PixelBuffer object holds a pixel buffer.
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
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)
58 class DALI_ADAPTOR_API PixelBuffer : public BaseHandle
62 * Create a PixelBuffer with it's own data buffer.
64 static PixelBuffer New(unsigned int width,
66 Dali::Pixel::Format pixelFormat);
69 * @brief Creates an empty handle.
70 * Use PixelBuffer::New() to create an initialized object.
84 * @brief This copy constructor is required for (smart) pointer semantics.
87 * @param[in] handle A reference to the copied handle
89 PixelBuffer(const PixelBuffer& handle);
92 * @brief This assignment operator is required for (smart) pointer semantics.
95 * @param[in] rhs A reference to the copied handle
96 * @return A reference to this object
98 PixelBuffer& operator=(const PixelBuffer& rhs);
101 * Convert to a pixel data and release the pixelBuffer's object.
102 * This handle is left empty.
104 * @warning Any other handles that keep a reference to this object
105 * will be left with no buffer, trying to access it will return NULL.
108 * @param[in,out] pixelBuffer
109 * @return a new PixelData which takes ownership of the PixelBuffer's buffer.
111 static PixelData Convert(PixelBuffer& pixelBuffer);
114 * Copy the data from this object into a new PixelData object, which could be
115 * used for uploading to a texture.
116 * @return a new PixelData object containing a copy of this pixel buffer's data.
118 Dali::PixelData CreatePixelData() const;
121 * @brief Gets the pixel buffer. This is a pointer to the internal
124 * @warning If there is no pixel buffer (e.g. this object has been
125 * converted to a PixelData), this method will return NULL.
128 * @return The pixel buffer, or NULL.
130 unsigned char* GetBuffer();
133 * @brief Gets the pixel buffer. This is a pointer to the internal
136 * @warning If there is no pixel buffer (e.g. this object has been
137 * converted to a PixelData), this method will return NULL.
139 * @return The pixel buffer, or NULL.
141 const unsigned char* const GetBuffer() const;
144 * @brief Gets the width of the buffer in pixels.
147 * @return The width of the buffer in pixels
149 unsigned int GetWidth() const;
152 * @brief Gets the height of the buffer in pixels.
155 * @return The height of the buffer in pixels
157 unsigned int GetHeight() const;
160 * @brief Gets the stride of the buffer in pixels.
163 * @return The stride of the buffer in pixels. 0 means the buffer is tightly packed.
165 unsigned int GetStride() const;
168 * @brief Gets the pixel format.
171 * @return The pixel format
173 Pixel::Format GetPixelFormat() const;
176 * Apply the mask to this pixel data, and return a new pixel data containing
177 * the masked image. If this PixelBuffer doesn't have an alpha channel, then
178 * the resultant PixelBuffer will be converted to a format that supports at
179 * least the width of the color channels and the alpha channel from the mask.
181 * If cropToMask is set to true, then the contentScale is applied first to
182 * this buffer, and the target buffer is cropped to the size of the mask. If
183 * it's set to false, then the mask is scaled to match this buffer's size
184 * before the mask is applied.
186 * @param[in] mask The mask to apply.
187 * @param[in] contentScale The scaling factor to apply to the content
188 * @param[in] cropToMask Whether to crop the output to the mask size (true)
189 * or scale the mask to the content size (false)
191 void ApplyMask(PixelBuffer mask, float contentScale = 1.0f, bool cropToMask = false);
194 * Apply a Gaussian blur to this pixel data with the given radius.
196 * @note A bigger radius will yield a blurrier image. Only works for pixel data in RGBA format.
198 * @param[in] blurRadius The radius for Gaussian blur. A value of 0 or negative value indicates no blur.
200 void ApplyGaussianBlur(const float blurRadius);
203 * @brief Crops this buffer to the given crop rectangle.
205 * The crop rectangle will be clamped to the edges of the buffer if it is larger.
206 * @param[in] x The top left corner's X
207 * @param[in] y The top left corner's y
208 * @param[in] width The crop width
209 * @param[in] height The crop height
211 void Crop(uint16_t x, uint16_t y, uint16_t width, uint16_t height);
214 * @brief Resizes the buffer to the given dimensions.
216 * Uses either Lanczos4 for downscaling or Mitchell for upscaling
217 * @param[in] width The new width
218 * @param[in] height The new height
220 void Resize(uint16_t width, uint16_t height);
223 * @brief Returns Exif metadata as a property map
225 * @param[out] metadata Property map object to write into
226 * @return True on success
228 bool GetMetadata(Property::Map& metadata) const;
231 * @brief Multiplies the image's color values by the alpha value. This provides better
232 * blending capability.
234 void MultiplyColorByAlpha();
237 * @brief Rotates the pixel buffer by the given angle.
239 * @note Operation valid for pixel formats: A8, L8, LA88, RGB888, RGB8888, BGR8888, RGBA8888 and BGRA8888. Fails otherwise.
240 * @note The operation does nothing for angles equivalent to 0 degrees: -360, 360, 720, etc.
241 * @note If the pixel buffer does rotate, all the pointers to the internal pixel buffer retrieved by the method GetPixelBuffer() become invalid.
243 * @param[in] angle The angle in degrees.
245 * @return @e false if the rotation fails (invalid pixel format or memory issues).
247 bool Rotate(Degree angle);
250 * @brief Returns pixel-buffer is premultiplied or not.
251 * @return true if alpha is pre-multiplied.
253 bool IsAlphaPreMultiplied() const;
256 * @brief Get the brightness of the pixel buffer.
257 * @note The range is 255 to 0. The closer to 255, the brighter. 0 is not bright.
258 * @return brightness of the pixel buffer.
260 uint32_t GetBrightness() const;
264 * @brief The constructor.
265 * @note Not intended for application developers.
267 * @param[in] pointer A pointer to a newly allocated PixelBuffer
269 explicit DALI_INTERNAL PixelBuffer(Internal::Adaptor::PixelBuffer* pointer);
275 #endif // DALI_PIXEL_BUFFER_H