adaptors/public-api/adaptor-framework/native-image-source.h

   1 #ifndef __DALI_NATIVE_IMAGE_SOURCE_H__
   2 #define __DALI_NATIVE_IMAGE_SOURCE_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 <string>
  23
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/images/native-image-interface.h>
  26 #include <dali/public-api/images/pixel.h>
  27 #include <dali/public-api/object/any.h>
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali_adaptor_framework
  33  * @{
  34  */
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 namespace Adaptor
  39 {
  40 class NativeImageSource;
  41 }
  42 }
  43
  44 class NativeImageSource;
  45 /**
  46  * @brief Pointer to Dali::NativeImageSource.
  47  * @SINCE_1_0.0
  48  */
  49 typedef Dali::IntrusivePtr<Dali::NativeImageSource> NativeImageSourcePtr;
  50
  51 /**
  52  * @brief Used for displaying native images.
  53  *
  54  * NativeImageSource can be created internally or
  55  * externally by native image source.
  56  * NativeImage is a platform specific way of providing pixel data to the GPU for rendering,
  57  * for example via an EGL image.
  58  *
  59  * @SINCE_1_1.4
  60  * @see NativeImage
  61  */
  62 class DALI_IMPORT_API NativeImageSource : public NativeImageInterface
  63 {
  64 public:
  65
  66    /**
  67     * @brief When creating a native image the color depth has to be specified.
  68     * @SINCE_1_0.0
  69     */
  70    enum ColorDepth
  71    {
  72      COLOR_DEPTH_DEFAULT,     ///< Uses the current screen default depth (recommended) @SINCE_1_0.0
  73      COLOR_DEPTH_8,           ///< 8 bits per pixel @SINCE_1_0.0
  74      COLOR_DEPTH_16,          ///< 16 bits per pixel @SINCE_1_0.0
  75      COLOR_DEPTH_24,          ///< 24 bits per pixel @SINCE_1_0.0
  76      COLOR_DEPTH_32           ///< 32 bits per pixel @SINCE_1_0.0
  77    };
  78
  79   /**
  80    * @brief Create a new NativeImageSource.
  81    *
  82    * Depending on hardware the width and height may have to be a power of two.
  83    * @SINCE_1_0.0
  84    * @param[in] width The width of the image.
  85    * @param[in] height The height of the image.
  86    * @param[in] depth color depth of the image.
  87    * @return A smart-pointer to a newly allocated image.
  88    */
  89   static NativeImageSourcePtr New( unsigned int width, unsigned int height, ColorDepth depth );
  90
  91   /**
  92    * @brief Create a new NativeImageSource from an existing native image source.
  93    *
  94    * @SINCE_1_0.0
  95    * @param[in] nativeImageSource must be a any handle with native image source
  96    * @return A smart-pointer to a newly allocated image.
  97    * @see NativeImageInterface
  98    */
  99   static NativeImageSourcePtr New( Any nativeImageSource );
 100
 101   /**
 102    * @brief Retrieve the internal native image.
 103    *
 104    * @SINCE_1_0.0
 105    * @return Any object containing the internal native image source.
 106    */
 107   Any GetNativeImageSource();
 108
 109   /**
 110    * @brief Get a copy of the pixels used by NativeImageSource.
 111    *
 112    * This is only supported for 24 bit RGB and 32 bit RGBA internal formats
 113    * (COLOR_DEPTH_24 and COLOR_DEPTH_32).
 114    * @SINCE_1_0.0
 115    * @param[out] pixbuf a vector to store the pixels in
 116    * @param[out] width  The width of image
 117    * @param[out] height The height of image
 118    * @param[out] pixelFormat pixel format used by image
 119    * @return     True if the pixels were gotten, and false otherwise.
 120    */
 121   bool GetPixels( std::vector<unsigned char>& pixbuf, unsigned int& width, unsigned int& height, Pixel::Format& pixelFormat ) const;
 122
 123   /**
 124    * @brief Convert the current pixel contents to either a JPEG or PNG format
 125    * and write that to the filesytem.
 126    *
 127    * @SINCE_1_0.0
 128    * @param[in] filename Identify the filesytem location at which to write the
 129    *                     encoded image. The extension determines the encoding used.
 130    *                     The two valid encoding are (".jpeg"|".jpg") and ".png".
 131    * @return    True if the pixels were written, and false otherwise.
 132    */
 133   bool EncodeToFile(const std::string& filename) const;
 134
 135   /**
 136    * @brief Set an existing source
 137    *
 138    * @SINCE_1_1.19
 139    * @param[in] source Any handle with the source
 140    */
 141   void SetSource( Any source );
 142
 143   /**
 144    * @brief Check if the specified color depth is supported.
 145    *
 146    * @SINCE_1_1.34
 147    * @param[in] colorDepth The color depth to check.
 148    * @return true if colorDepth is supported, false otherwise.
 149    */
 150   bool IsColorDepthSupported( ColorDepth colorDepth );
 151
 152 private:   // native image
 153
 154   /**
 155    * @copydoc Dali::NativeImageInterface::GlExtensionCreate()
 156    */
 157   virtual bool GlExtensionCreate();
 158
 159   /**
 160    * @copydoc Dali::NativeImageInterface::GlExtensionDestroy()
 161    */
 162   virtual void GlExtensionDestroy();
 163
 164   /**
 165    * @copydoc Dali::NativeImageInterface::TargetTexture()
 166    */
 167   virtual unsigned int TargetTexture();
 168
 169   /**
 170    * @copydoc Dali::NativeImageInterface::PrepareTexture()
 171    */
 172   virtual void PrepareTexture();
 173
 174   /**
 175    * @copydoc Dali::NativeImageInterface::GetWidth()
 176    */
 177   virtual unsigned int GetWidth() const;
 178
 179   /**
 180    * @copydoc Dali::NativeImageInterface::GetHeight()
 181    */
 182   virtual unsigned int GetHeight() const;
 183
 184   /**
 185    * @copydoc Dali::NativeImageInterface::RequiresBlending()
 186    */
 187   virtual bool RequiresBlending() const;
 188
 189   /**
 190    * @copydoc Dali::NativeImageInterface::GetExtension()
 191    */
 192   NativeImageInterface::Extension* GetExtension();
 193
 194 private:
 195
 196   /**
 197    * @internal
 198    * @brief Private constructor
 199    * @SINCE_1_0.0
 200    * @param[in] width The width of the image.
 201    * @param[in] height The height of the image.
 202    * @param[in] depth color depth of the image.
 203    * @param[in] nativeImageSource contains either: native image source or is empty
 204    */
 205   DALI_INTERNAL NativeImageSource( unsigned int width, unsigned int height, ColorDepth depth, Any nativeImageSource );
 206
 207   /**
 208    * @internal
 209    * @brief A reference counted object may only be deleted by calling Unreference().
 210    *
 211    * The implementation should destroy the NativeImage resources.
 212    * @SINCE_1_0.0
 213    */
 214   DALI_INTERNAL virtual ~NativeImageSource();
 215
 216   /**
 217    * @internal
 218    * @brief Undefined copy constructor
 219    *
 220    * This avoids accidental calls to a default copy constructor.
 221    * @SINCE_1_0.0
 222    * @param[in] nativeImageSource A reference to the object to copy.
 223    */
 224   DALI_INTERNAL NativeImageSource( const NativeImageSource& nativeImageSource );
 225
 226   /**
 227    * @internal
 228    * @brief Undefined assignment operator.
 229    *
 230    * This avoids accidental calls to a default assignment operator.
 231    * @SINCE_1_0.0
 232    * @param[in] rhs A reference to the object to copy.
 233    */
 234   DALI_INTERNAL NativeImageSource& operator=(const NativeImageSource& rhs);
 235
 236 private:
 237
 238   Internal::Adaptor::NativeImageSource* mImpl; ///< Implementation pointer
 239 };
 240
 241 /**
 242  * @}
 243  */
 244 } // namespace Dali
 245
 246 #endif // __DALI_NATIVE_IMAGE_SOURCE_H__