dali/public-api/images/encoded-buffer-image.h

   1 #ifndef __DALI_ENCODED_BUFFER_IMAGE_H__
   2 #define __DALI_ENCODED_BUFFER_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  22 #include <stdint.h>
  23
  24 // INTERNAL INCLUDES
  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>
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali-core-images
  33  * @{
  34  */
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 class EncodedBufferImage;
  39 }
  40
  41 typedef Uint16Pair ImageDimensions;
  42
  43
  44 /**
  45  * @brief EncodedBufferImage represents an image resource that can be added to
  46  * ImageActors.
  47  *
  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
  50  * pixel data.
  51  *
  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.
  57  *
  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.
  60  *
  61  * <h3> Signals </h3>
  62  *
  63  * Image::LoadingFinishedSignal is emitted when the decoding of the
  64  * image data is completed, either successfully or not.
  65  *
  66  * Image::UploadedSignal is emitted when the decoded image data gets
  67  * uploaded to the OpenGL ES implementation.
  68  */
  69 class DALI_IMPORT_API EncodedBufferImage : public Image
  70 {
  71 public:
  72   /**
  73    * @brief Constructor which creates an uninitialized EncodedBufferImage object.
  74    *
  75    * Use Image::New(...) to create an initialised object.
  76    */
  77   EncodedBufferImage();
  78
  79   /**
  80    * @brief Create an initialised image object from an encoded image buffer in memory.
  81    *
  82    * The image will be created eagerly using LoadPolicy::Immediate.
  83    * The function is non-blocking and returns immediately while the image
  84    * decoding happens on a background thread.
  85    * @param [in] encodedImage The encoded bytes of an image, in a supported
  86    * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
  87    * exactly as it would be as a file in the filesystem.
  88    * The caller retains ownership of this buffer and is free to modify or
  89    * discard it as soon as the function returns.
  90    * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
  91    * by encodedImage.
  92    * @param [in] size The width and height to fit the loaded image to.
  93    * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
  94    * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
  95    * @param [in] releasePol The ReleasePolicy to apply to Image. If the Unused
  96    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
  97    * policy is set, a reload will not be possible, so the Image should never be
  98    * used once all actors using it have gone off-stage.
  99    * @return A handle to a newly allocated object.
 100    */
 101   static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, ReleasePolicy releasePol = Image::NEVER, bool orientationCorrection = true );
 102
 103   /**
 104    * @brief Create an initialised image object from an encoded image buffer in memory.
 105    *
 106    * The image will be created eagerly using LoadPolicy::Immediate.
 107    * The function is non-blocking and returns immediately while the image
 108    * decoding happens on a background thread.
 109    * @param [in] encodedImage The encoded bytes of an image, in a supported
 110    * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
 111    * exactly as it would be as a file in the filesystem.
 112    * The caller retains ownership of this buffer and is free to modify or
 113    * discard it as soon as the function returns.
 114    * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
 115    * by encodedImage.
 116    * @return A handle to a newly allocated object.
 117    */
 118   static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount );
 119
 120   /**
 121    * @brief Downcast an Object handle to EncodedBufferImage.
 122    *
 123    * If handle points to a EncodedBufferImage the
 124    * downcast produces valid handle. If not the returned handle is left uninitialized.
 125    * @param[in] handle to An object
 126    * @return handle to a EncodedBufferImage or an uninitialized handle
 127    */
 128   static EncodedBufferImage DownCast( BaseHandle handle );
 129
 130   /**
 131    * @brief Destructor
 132    *
 133    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 134    */
 135   ~EncodedBufferImage();
 136
 137   /**
 138    * @brief This copy constructor is required for (smart) pointer semantics.
 139    *
 140    * @param [in] handle A reference to the copied handle
 141    */
 142   EncodedBufferImage(const EncodedBufferImage& handle);
 143
 144   /**
 145    * @brief This assignment operator is required for (smart) pointer semantics.
 146    *
 147    * @param [in] rhs  A reference to the copied handle
 148    * @return A reference to this
 149    */
 150   EncodedBufferImage& operator=(const EncodedBufferImage& rhs);
 151
 152 public: // Not intended for application developers
 153
 154   explicit DALI_INTERNAL EncodedBufferImage(Internal::EncodedBufferImage*);
 155 };
 156
 157 /**
 158  * @}
 159  */
 160 } // namespace Dali
 161
 162 #endif // __DALI_ENCODED_BUFFER_IMAGE_H__