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::CreateResource()
  88    */
  89   bool CreateResource() override;
  90
  91   /**
  92    * @copydoc Dali::NativeImageSource::DestroyResource()
  93    */
  94   void DestroyResource() 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::NativeImageSource::GetTextureTarget()
 132    */
 133   int GetTextureTarget() const override;
 134
 135   /**
 136    * @copydoc Dali::NativeImageSource::GetCustomFragmentPrefix()
 137    */
 138   const char* GetCustomFragmentPrefix() const override;
 139
 140   /**
 141    * @copydoc Dali::NativeImageSource::GetCustomSamplerTypename()
 142    */
 143   const char* GetCustomSamplerTypename() const override;
 144
 145   /**
 146    * @copydoc Dali::NativeImageSource::GetNativeImageHandle()
 147    */
 148   Any GetNativeImageHandle() const override;
 149
 150   /**
 151    * @copydoc Dali::NativeImageSource::SourceChanged()
 152    */
 153   bool SourceChanged() const override;
 154
 155
 156   /**
 157    * @copydoc Dali::NativeImageInterface::GetExtension()
 158    */
 159   NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
 160   {
 161     return nullptr;
 162   }
 163
 164   /**
 165    * @copydoc Dali::Internal::Adaptor::NativeImageSource::AcquireBuffer()
 166    */
 167   uint8_t* AcquireBuffer( uint16_t& width, uint16_t& height, uint16_t& stride ) override;
 168
 169   /**
 170    * @copydoc Dali::Internal::Adaptor::NativeImageSource::ReleaseBuffer()
 171    */
 172   bool ReleaseBuffer() override;
 173
 174   /**
 175    * @copydoc Dali::NativeImageSource::SetResourceDestructionCallback()
 176    */
 177   void SetResourceDestructionCallback(EventThreadCallback* callback) override;
 178
 179 private:
 180
 181   /**
 182    * Private constructor; @see NativeImageSource::New()
 183    * @param[in] width The width of the image.
 184    * @param[in] height The height of the image.
 185    * @param[in] colour depth of the image.
 186    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 187    */
 188   NativeImageSourceX( uint32_t width,
 189               uint32_t height,
 190               Dali::NativeImageSource::ColorDepth depth,
 191               Any nativeImageSource);
 192
 193   /**
 194    * 2nd phase construction.
 195    */
 196   void Initialize();
 197
 198   /**
 199    * Uses X11 to get the default depth.
 200    * @param depth the PixelImage depth enum
 201    * @return default x11 pixel depth
 202    */
 203   int GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const;
 204
 205   /**
 206    * Gets the pixmap from the Any parameter
 207    * @param pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 208    * @return pixmap x11 pixmap
 209    */
 210   Ecore_X_Pixmap GetPixmapFromAny(Any pixmap) const;
 211
 212   /**
 213    * Given an existing pixmap, the function uses X to find out
 214    * the width, heigth and depth of that pixmap.
 215    */
 216   void GetPixmapDetails();
 217
 218 private:
 219
 220   uint32_t mWidth;                            ///< image width
 221   uint32_t mHeight;                           ///< image heights
 222   bool mOwnPixmap;                            ///< Whether we created pixmap or not
 223   Ecore_X_Pixmap mPixmap;                     ///< From Xlib
 224   bool mBlendingRequired;                      ///< Whether blending is required
 225   Dali::NativeImageSource::ColorDepth mColorDepth;  ///< color depth of image
 226   void* mEglImageKHR;                         ///< From EGL extension
 227   EglImageExtensions* mEglImageExtensions;    ///< The EGL Image Extensions
 228   std::unique_ptr<EventThreadCallback> mResourceDestructionCallback;
 229 };
 230
 231 } // namespace Adaptor
 232
 233 } // namespace Internal
 234
 235 } // namespace Dali
 236
 237 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H