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