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