1 #ifndef __DALI_ENCODED_BUFFER_IMAGE_H__
2 #define __DALI_ENCODED_BUFFER_IMAGE_H__
5 * Copyright (c) 2015 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.
25 #include <dali/public-api/images/image.h>
26 #include <dali/public-api/images/image-operations.h>
27 #include <dali/public-api/math/uint-16-pair.h>
32 * @addtogroup dali_core_images
36 namespace Internal DALI_INTERNAL
38 class EncodedBufferImage;
41 typedef Uint16Pair ImageDimensions;
45 * @brief EncodedBufferImage represents a Image as a buffer of encoded pixel data.
47 * A memory buffer of encoded image data is provided by the application and
48 * decoded asynchronously on a background thread to fill the image's
51 * The buffer of data provided to an EncodedBufferImage factory function
52 * (New) should be filled with encoded image data in one of %Dali's
53 * supported image file formats, with the sequence of bytes in the buffer
54 * exactly matching the sequence of bytes that a file in the file system
55 * holding the encoded image data would have.
57 * The application may free the encoded image buffer passed to one of the
58 * New() static factory member functions as soon as they return.
62 * Image::LoadingFinishedSignal is emitted when the decoding of the
63 * image data is completed, either successfully or not.
65 * Image::UploadedSignal is emitted when the decoded image data gets
66 * uploaded to the OpenGL ES implementation.
69 class DALI_IMPORT_API EncodedBufferImage : public Image
73 * @brief Constructor which creates an uninitialized EncodedBufferImage object.
75 * Use Image::New(...) to create an initialised object.
81 * @DEPRECATED_1_1.3. Use New(const uint8_t* const, std::size_t,ImageDimensions,FittingMode::Type,SamplingMode::Type,bool) instead.
83 * @brief Create an initialised image object from an encoded image buffer in memory.
86 * @param [in] encodedImage The encoded bytes of an image, in a supported
87 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
88 * exactly as it would be as a file in the filesystem.
89 * The caller retains ownership of this buffer and is free to modify or
90 * discard it as soon as the function returns.
91 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
93 * @param [in] size The width and height to fit the loaded image to.
94 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
95 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
96 * @param [in] releasePol The ReleasePolicy to apply to Image.
97 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
98 * policy is set, a reload will not be possible, so the Image should never be
99 * used once all actors using it have gone off-stage.
100 * @return A handle to a newly allocated object.
102 static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, ReleasePolicy releasePol, bool orientationCorrection = true );
105 * @brief Create an initialised image object from an encoded image buffer in memory.
108 * @param [in] encodedImage The encoded bytes of an image, in a supported
109 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
110 * exactly as it would be as a file in the filesystem.
111 * The caller retains ownership of this buffer and is free to modify or
112 * discard it as soon as the function returns.
113 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
115 * @return A handle to a newly allocated object.
117 static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount );
120 * @brief Create an initialised image object from an encoded image buffer in memory.
123 * @param [in] encodedImage The encoded bytes of an image, in a supported
124 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
125 * exactly as it would be as a file in the filesystem.
126 * The caller retains ownership of this buffer and is free to modify or
127 * discard it as soon as the function returns.
128 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
130 * @param [in] size The width and height to fit the loaded image to.
131 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
132 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
133 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
134 * policy is set, a reload will not be possible, so the Image should never be
135 * used once all actors using it have gone off-stage.
136 * @return A handle to a newly allocated object.
138 static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, bool orientationCorrection = true );
141 * @brief Downcast an Object handle to EncodedBufferImage.
143 * If handle points to a EncodedBufferImage the
144 * downcast produces valid handle. If not the returned handle is left uninitialized.
146 * @param[in] handle to An object
147 * @return handle to a EncodedBufferImage or an uninitialized handle
149 static EncodedBufferImage DownCast( BaseHandle handle );
154 * This is non-virtual since derived Handle types must not contain data or virtual methods.
157 ~EncodedBufferImage();
160 * @brief This copy constructor is required for (smart) pointer semantics.
163 * @param [in] handle A reference to the copied handle
165 EncodedBufferImage(const EncodedBufferImage& handle);
168 * @brief This assignment operator is required for (smart) pointer semantics.
171 * @param [in] rhs A reference to the copied handle
172 * @return A reference to this
174 EncodedBufferImage& operator=(const EncodedBufferImage& rhs);
176 public: // Not intended for application developers
178 explicit DALI_INTERNAL EncodedBufferImage(Internal::EncodedBufferImage*);
186 #endif // __DALI_ENCODED_BUFFER_IMAGE_H__