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) 2021 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 #include <memory>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/adaptor-framework/native-image-source.h>
  27 #include <dali/internal/imaging/common/native-image-source-impl.h>
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33 namespace Adaptor
  34 {
  35 class EglImageExtensions;
  36
  37 /**
  38  * Dali internal NativeImageSource.
  39  */
  40 class NativeImageSourceX : public Internal::Adaptor::NativeImageSource
  41 {
  42 public:
  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 NativeImageSourceX* New(uint32_t                            width,
  53                                  uint32_t                            height,
  54                                  Dali::NativeImageSource::ColorDepth depth,
  55                                  Any                                 nativeImageSource);
  56   /**
  57    * @copydoc Dali::NativeImageSource::GetNativeImageSource()
  58    */
  59   Any GetNativeImageSource() const override;
  60
  61   /**
  62    * @copydoc Dali::NativeImageSource::GetPixels()
  63    */
  64   bool GetPixels(std::vector<unsigned char>& pixbuf, uint32_t& width, uint32_t& height, Pixel::Format& pixelFormat) const override;
  65
  66   /**
  67    * @copydoc Dali::NativeImageSource::SetSource( Any source )
  68    */
  69   void SetSource(Any source) override;
  70
  71   /**
  72    * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
  73    */
  74   bool IsColorDepthSupported(Dali::NativeImageSource::ColorDepth colorDepth) override;
  75
  76   /**
  77    * destructor
  78    */
  79   ~NativeImageSourceX() override;
  80
  81   /**
  82    * @copydoc Dali::NativeImageSource::CreateResource()
  83    */
  84   bool CreateResource() override;
  85
  86   /**
  87    * @copydoc Dali::NativeImageSource::DestroyResource()
  88    */
  89   void DestroyResource() override;
  90
  91   /**
  92    * @copydoc Dali::NativeImageSource::TargetTexture()
  93    */
  94   uint32_t TargetTexture() override;
  95
  96   /**
  97    * @copydoc Dali::NativeImageSource::PrepareTexture()
  98    */
  99   void PrepareTexture() override;
 100
 101   /**
 102    * @copydoc Dali::NativeImageSource::GetWidth()
 103    */
 104   uint32_t GetWidth() const override
 105   {
 106     return mWidth;
 107   }
 108
 109   /**
 110    * @copydoc Dali::NativeImageSource::GetHeight()
 111    */
 112   uint32_t GetHeight() const override
 113   {
 114     return mHeight;
 115   }
 116
 117   /**
 118    * @copydoc Dali::NativeImageSource::RequiresBlending()
 119    */
 120   bool RequiresBlending() const override
 121   {
 122     return mBlendingRequired;
 123   }
 124
 125   /**
 126    * @copydoc Dali::NativeImageSource::GetTextureTarget()
 127    */
 128   int GetTextureTarget() const override;
 129
 130   /**
 131    * @copydoc Dali::NativeImageSource::ApplyNativeFragmentShader()
 132    */
 133   bool ApplyNativeFragmentShader(std::string& shader) override;
 134
 135   /**
 136    * @copydoc Dali::NativeImageSource::GetCustomSamplerTypename()
 137    */
 138   const char* GetCustomSamplerTypename() const override;
 139
 140   /**
 141    * @copydoc Dali::NativeImageSource::GetNativeImageHandle()
 142    */
 143   Any GetNativeImageHandle() const override;
 144
 145   /**
 146    * @copydoc Dali::NativeImageSource::SourceChanged()
 147    */
 148   bool SourceChanged() const override;
 149
 150   /**
 151    * @copydoc Dali::NativeImageInterface::GetExtension()
 152    */
 153   NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
 154   {
 155     return nullptr;
 156   }
 157
 158   /**
 159    * @copydoc Dali::Internal::Adaptor::NativeImageSource::AcquireBuffer()
 160    */
 161   uint8_t* AcquireBuffer(uint16_t& width, uint16_t& height, uint16_t& stride) override;
 162
 163   /**
 164    * @copydoc Dali::Internal::Adaptor::NativeImageSource::ReleaseBuffer()
 165    */
 166   bool ReleaseBuffer() override;
 167
 168   /**
 169    * @copydoc Dali::NativeImageSource::SetResourceDestructionCallback()
 170    */
 171   void SetResourceDestructionCallback(EventThreadCallback* callback) override;
 172
 173 private:
 174   /**
 175    * Private constructor; @see NativeImageSource::New()
 176    * @param[in] width The width of the image.
 177    * @param[in] height The height of the image.
 178    * @param[in] colour depth of the image.
 179    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 180    */
 181   NativeImageSourceX(uint32_t                            width,
 182                      uint32_t                            height,
 183                      Dali::NativeImageSource::ColorDepth depth,
 184                      Any                                 nativeImageSource);
 185
 186   /**
 187    * 2nd phase construction.
 188    */
 189   void Initialize();
 190
 191   /**
 192    * Uses X11 to get the default depth.
 193    * @param depth the PixelImage depth enum
 194    * @return default x11 pixel depth
 195    */
 196   int GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const;
 197
 198   /**
 199    * Gets the pixmap from the Any parameter
 200    * @param pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 201    * @return pixmap x11 pixmap
 202    */
 203   Ecore_X_Pixmap GetPixmapFromAny(Any pixmap) const;
 204
 205   /**
 206    * Given an existing pixmap, the function uses X to find out
 207    * the width, heigth and depth of that pixmap.
 208    */
 209   void GetPixmapDetails();
 210
 211 private:
 212   uint32_t                             mWidth;                        ///< image width
 213   uint32_t                             mHeight;                       ///< image heights
 214   bool                                 mOwnPixmap;                    ///< Whether we created pixmap or not
 215   Ecore_X_Pixmap                       mPixmap;                       ///< From Xlib
 216   bool                                 mBlendingRequired;             ///< Whether blending is required
 217   Dali::NativeImageSource::ColorDepth  mColorDepth;                   ///< color depth of image
 218   void*                                mEglImageKHR;                  ///< From EGL extension
 219   EglImageExtensions*                  mEglImageExtensions;           ///< The EGL Image Extensions
 220   std::unique_ptr<EventThreadCallback> mResourceDestructionCallback;  ///< The Resource Destruction Callback
 221 };
 222
 223 } // namespace Adaptor
 224
 225 } // namespace Internal
 226
 227 } // namespace Dali
 228
 229 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H