dali/internal/imaging/common/native-image-source-impl.h

   1 #ifndef DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_H
   2 #define DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/adaptor-framework/native-image-source.h>
  23 #include <dali/devel-api/adaptor-framework/bitmap-saver.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 namespace Adaptor
  32 {
  33
  34 /**
  35  * Dali internal NativeImageSource.
  36  */
  37 class NativeImageSource
  38 {
  39 public:
  40
  41   static constexpr uint32_t DEFAULT_QUALITY = 100;
  42
  43   /**
  44    * Create a new NativeImageSource internally.
  45    * Depending on hardware the width and height may have to be a power of two.
  46    * @param[in] width The width of the image.
  47    * @param[in] height The height of the image.
  48    * @param[in] depth color depth of the image.
  49    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
  50    * @return A smart-pointer to a newly allocated image.
  51    */
  52   static NativeImageSource* New(uint32_t width,
  53                                 uint32_t height,
  54                                 Dali::NativeImageSource::ColorDepth depth,
  55                                 Any nativeImageSource);
  56   /**
  57    * @copydoc Dali::NativeImageSource::GetNativeImageSource()
  58    */
  59   virtual Any GetNativeImageSource() const = 0;
  60
  61   /**
  62    * @copydoc Dali::NativeImageSource::GetPixels()
  63    */
  64   virtual bool GetPixels(std::vector<unsigned char> &pixbuf, uint32_t &width, uint32_t &height, Pixel::Format& pixelFormat ) const = 0;
  65
  66   /**
  67    * @copydoc Dali::NativeImageSource::SetSource( Any source )
  68    */
  69   virtual void SetSource( Any source ) = 0;
  70
  71   /**
  72    * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
  73    */
  74   virtual bool IsColorDepthSupported( Dali::NativeImageSource::ColorDepth colorDepth ) = 0;
  75
  76   /**
  77    * destructor
  78    */
  79   virtual ~NativeImageSource() = default;
  80
  81   /**
  82    * @copydoc Dali::NativeImageSource::GlExtensionCreate()
  83    */
  84   virtual bool GlExtensionCreate() = 0;
  85
  86   /**
  87    * @copydoc Dali::NativeImageSource::GlExtensionDestroy()
  88    */
  89   virtual void GlExtensionDestroy() = 0;
  90
  91   /**
  92    * @copydoc Dali::NativeImageSource::TargetTexture()
  93    */
  94   virtual uint32_t TargetTexture() = 0;
  95
  96   /**
  97    * @copydoc Dali::NativeImageSource::PrepareTexture()
  98    */
  99   virtual void PrepareTexture() = 0;
 100
 101   /**
 102    * @copydoc Dali::NativeImageSource::GetWidth()
 103    */
 104   virtual uint32_t GetWidth() const = 0;
 105
 106   /**
 107    * @copydoc Dali::NativeImageSource::GetHeight()
 108    */
 109   virtual uint32_t GetHeight() const = 0;
 110
 111   /**
 112    * @copydoc Dali::NativeImageSource::RequiresBlending()
 113    */
 114   virtual bool RequiresBlending() const = 0;
 115
 116   /**
 117    * @copydoc Dali::NativeImageInterface::GetExtension()
 118    */
 119   virtual NativeImageInterface::Extension* GetNativeImageInterfaceExtension() = 0;
 120
 121   /**
 122    * @brief Dali::DevelNativeImageSource::AcquireBuffer()
 123    */
 124   virtual uint8_t* AcquireBuffer( uint16_t& width, uint16_t& height, uint16_t& stride ) = 0;
 125
 126   /**
 127    * @brief Dali::DevelNativeImageSource::ReleaseBuffer()
 128    */
 129   virtual bool ReleaseBuffer() = 0;
 130
 131   /**
 132    * @copydoc Dali::NativeImageSource::EncodeToFile(const std::string& )
 133    */
 134   inline bool EncodeToFile( const std::string& filename ) const
 135   {
 136     return EncodeToFile( filename, DEFAULT_QUALITY );
 137   }
 138
 139   /**
 140    * @brief Converts the current pixel contents to either a JPEG or PNG format
 141    * and write that to the filesystem.
 142    *
 143    * @param[in] filename Identify the filesystem location at which to write the encoded image.
 144    *                     The extension determines the encoding used.
 145    *                     The two valid encoding are (".jpeg"|".jpg") and ".png".
 146    * @param[in] quality The quality of encoded jpeg image
 147    * @return    @c true if the pixels were written, and @c false otherwise
 148    */
 149   inline bool EncodeToFile( const std::string& filename, const uint32_t quality ) const
 150   {
 151     std::vector< uint8_t > pixbuf;
 152     uint32_t width( 0 ), height( 0 );
 153     Pixel::Format pixelFormat;
 154
 155     if( GetPixels( pixbuf, width, height, pixelFormat ) )
 156     {
 157       return Dali::EncodeToFile( &pixbuf[0], filename, pixelFormat, width, height, quality );
 158     }
 159     return false;
 160   }
 161
 162 public:
 163   inline static Internal::Adaptor::NativeImageSource& GetImplementation( Dali::NativeImageSource& image ) { return *image.mImpl; }
 164 };
 165
 166 } // namespace Adaptor
 167
 168 } // namespace Internal
 169
 170 } // namespace Dali
 171
 172 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_H