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 an image resource that can be added to
48 * A memory buffer of encoded image data is provided by the application and
49 * decoded asynchronously on a background thread to fill the image's
52 * The buffer of data provided to an EncodedBufferImage factory function
53 * (New) should be filled with encoded image data in one of %Dali's
54 * supported image file formats, with the sequence of bytes in the buffer
55 * exactly matching the sequence of bytes that a file in the file system
56 * holding the encoded image data would have.
58 * The application may free the encoded image buffer passed to one of the
59 * New() static factory member functions as soon as they return.
63 * Image::LoadingFinishedSignal is emitted when the decoding of the
64 * image data is completed, either successfully or not.
66 * Image::UploadedSignal is emitted when the decoded image data gets
67 * uploaded to the OpenGL ES implementation.
70 class DALI_IMPORT_API EncodedBufferImage : public Image
74 * @brief Constructor which creates an uninitialized EncodedBufferImage object.
76 * Use @ref EncodedBufferImage::New to create an initialised object.
82 * @DEPRECATED_1_1.3. Use New(const uint8_t* const, std::size_t,ImageDimensions,FittingMode::Type,SamplingMode::Type,bool) instead.
84 * @brief Create an initialised image object from an encoded image buffer in memory.
87 * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
88 * We do recommend not to use this method.
89 * Please refer the remarks of ReleasePolicy for more information.
90 * @param [in] encodedImage The encoded bytes of an image, in a supported
91 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
92 * exactly as it would be as a file in the filesystem.
93 * The caller retains ownership of this buffer and is free to modify or
94 * discard it as soon as the function returns.
95 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
97 * @param [in] size The width and height to fit the loaded image to.
98 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
99 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
100 * @param [in] releasePol The releasePolicy to apply to Image. The default value is Image::NEVER.
101 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
102 * policy is set, a reload will not be possible, so the Image should never be
103 * used once all actors using it have gone off-stage.
104 * @return A handle to a newly allocated object.
106 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 );
109 * @brief Create an initialised image object from an encoded image buffer in memory.
112 * @param [in] encodedImage The encoded bytes of an image, in a supported
113 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
114 * exactly as it would be as a file in the filesystem.
115 * The caller retains ownership of this buffer and is free to modify or
116 * discard it as soon as the function returns.
117 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
119 * @return A handle to a newly allocated object.
121 static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount );
124 * @brief Create an initialised image object from an encoded image buffer in memory.
127 * @param [in] encodedImage The encoded bytes of an image, in a supported
128 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
129 * exactly as it would be as a file in the filesystem.
130 * The caller retains ownership of this buffer and is free to modify or
131 * discard it as soon as the function returns.
132 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
134 * @param [in] size The width and height to fit the loaded image to.
135 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
136 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
137 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
138 * policy is set, a reload will not be possible, so the Image should never be
139 * used once all actors using it have gone off-stage.
140 * @return A handle to a newly allocated object.
142 static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, bool orientationCorrection = true );
145 * @brief Downcast a handle to EncodedBufferImage handle.
147 * If handle points to a EncodedBufferImage the
148 * downcast produces valid handle. If not the returned handle is left uninitialized.
150 * @param[in] handle Handle to an object
151 * @return Handle to a EncodedBufferImage or an uninitialized handle
153 static EncodedBufferImage DownCast( BaseHandle handle );
158 * This is non-virtual since derived Handle types must not contain data or virtual methods.
161 ~EncodedBufferImage();
164 * @brief This copy constructor is required for (smart) pointer semantics.
167 * @param [in] handle A reference to the copied handle
169 EncodedBufferImage(const EncodedBufferImage& handle);
172 * @brief This assignment operator is required for (smart) pointer semantics.
175 * @param [in] rhs A reference to the copied handle
176 * @return A reference to this
178 EncodedBufferImage& operator=(const EncodedBufferImage& rhs);
180 public: // Not intended for application developers
182 explicit DALI_INTERNAL EncodedBufferImage(Internal::EncodedBufferImage*);
190 #endif // __DALI_ENCODED_BUFFER_IMAGE_H__