dali/internal/imaging/ubuntu-x11/native-image-source-impl-x.h

   1 #ifndef DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H
   2 #define DALI_INTERNAL_NATIVE_IMAGE_SOURCE_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 // EXTERNAL INCLUDES
  22 #include <dali/internal/system/linux/dali-ecore-x.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/graphics/common/graphics-interface.h>
  26
  27 #include <dali/public-api/adaptor-framework/native-image-source.h>
  28
  29 #include <dali/internal/imaging/common/native-image-source-impl.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Internal
  35 {
  36
  37 namespace Adaptor
  38 {
  39 class EglImageExtensions;
  40
  41 /**
  42  * Dali internal NativeImageSource.
  43  */
  44 class NativeImageSourceX : public Internal::Adaptor::NativeImageSource
  45 {
  46 public:
  47
  48   /**
  49    * Create a new NativeImageSource internally.
  50    * Depending on hardware the width and height may have to be a power of two.
  51    * @param[in] width The width of the image.
  52    * @param[in] height The height of the image.
  53    * @param[in] depth color depth of the image.
  54    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
  55    * @return A smart-pointer to a newly allocated image.
  56    */
  57   static NativeImageSourceX* New( uint32_t width,
  58                           uint32_t height,
  59                           Dali::NativeImageSource::ColorDepth depth,
  60                           Any nativeImageSource);
  61   /**
  62    * @copydoc Dali::NativeImageSource::GetNativeImageSource()
  63    */
  64   Any GetNativeImageSource() const override;
  65
  66   /**
  67    * @copydoc Dali::NativeImageSource::GetPixels()
  68    */
  69   bool GetPixels(std::vector<unsigned char> &pixbuf, uint32_t &width, uint32_t &height, Pixel::Format& pixelFormat ) const override;
  70
  71   /**
  72    * @copydoc Dali::NativeImageSource::SetSource( Any source )
  73    */
  74   void SetSource( Any source ) override;
  75
  76   /**
  77    * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
  78    */
  79   bool IsColorDepthSupported( Dali::NativeImageSource::ColorDepth colorDepth ) override;
  80
  81   /**
  82    * destructor
  83    */
  84   ~NativeImageSourceX() override;
  85
  86   /**
  87    * @copydoc Dali::NativeImageSource::GlExtensionCreate()
  88    */
  89   bool GlExtensionCreate() override;
  90
  91   /**
  92    * @copydoc Dali::NativeImageSource::GlExtensionDestroy()
  93    */
  94   void GlExtensionDestroy() override;
  95
  96   /**
  97    * @copydoc Dali::NativeImageSource::TargetTexture()
  98    */
  99   uint32_t TargetTexture() override;
 100
 101   /**
 102    * @copydoc Dali::NativeImageSource::PrepareTexture()
 103    */
 104   void PrepareTexture() override;
 105
 106   /**
 107    * @copydoc Dali::NativeImageSource::GetWidth()
 108    */
 109   uint32_t GetWidth() const override
 110   {
 111     return mWidth;
 112   }
 113
 114   /**
 115    * @copydoc Dali::NativeImageSource::GetHeight()
 116    */
 117   uint32_t GetHeight() const override
 118   {
 119     return mHeight;
 120   }
 121
 122   /**
 123    * @copydoc Dali::NativeImageSource::RequiresBlending()
 124    */
 125   bool RequiresBlending() const override
 126   {
 127     return mBlendingRequired;
 128   }
 129
 130   /**
 131    * @copydoc Dali::NativeImageInterface::GetExtension()
 132    */
 133   NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
 134   {
 135     return nullptr;
 136   }
 137
 138   /**
 139    * @copydoc Dali::Internal::Adaptor::NativeImageSource::AcquireBuffer()
 140    */
 141   uint8_t* AcquireBuffer( uint16_t& width, uint16_t& height, uint16_t& stride ) override;
 142
 143   /**
 144    * @copydoc Dali::Internal::Adaptor::NativeImageSource::ReleaseBuffer()
 145    */
 146   bool ReleaseBuffer() override;
 147
 148 private:
 149
 150   /**
 151    * Private constructor; @see NativeImageSource::New()
 152    * @param[in] width The width of the image.
 153    * @param[in] height The height of the image.
 154    * @param[in] colour depth of the image.
 155    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 156    */
 157   NativeImageSourceX( uint32_t width,
 158               uint32_t height,
 159               Dali::NativeImageSource::ColorDepth depth,
 160               Any nativeImageSource);
 161
 162   /**
 163    * 2nd phase construction.
 164    */
 165   void Initialize();
 166
 167   /**
 168    * Uses X11 to get the default depth.
 169    * @param depth the PixelImage depth enum
 170    * @return default x11 pixel depth
 171    */
 172   int GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const;
 173
 174   /**
 175    * Gets the pixmap from the Any parameter
 176    * @param pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 177    * @return pixmap x11 pixmap
 178    */
 179   Ecore_X_Pixmap GetPixmapFromAny(Any pixmap) const;
 180
 181   /**
 182    * Given an existing pixmap, the function uses X to find out
 183    * the width, heigth and depth of that pixmap.
 184    */
 185   void GetPixmapDetails();
 186
 187 private:
 188
 189   uint32_t mWidth;                            ///< image width
 190   uint32_t mHeight;                           ///< image heights
 191   bool mOwnPixmap;                            ///< Whether we created pixmap or not
 192   Ecore_X_Pixmap mPixmap;                     ///< From Xlib
 193   bool mBlendingRequired;                      ///< Whether blending is required
 194   Dali::NativeImageSource::ColorDepth mColorDepth;  ///< color depth of image
 195   void* mEglImageKHR;                         ///< From EGL extension
 196   EglImageExtensions* mEglImageExtensions;    ///< The EGL Image Extensions
 197 };
 198
 199 } // namespace Adaptor
 200
 201 } // namespace Internal
 202
 203 } // namespace Dali
 204
 205 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H