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) 2014 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 <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(unsigned int width,
  58                           unsigned int 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, unsigned int &width, unsigned int &height, Pixel::Format& pixelFormat ) const override;
  70
  71   /**
  72    * @copydoc Dali::NativeImageSource::EncodeToFile(const std::string& )
  73    */
  74   bool EncodeToFile(const std::string& filename) const override;
  75
  76   /**
  77    * @copydoc Dali::NativeImageSource::SetSource( Any source )
  78    */
  79   void SetSource( Any source ) override;
  80
  81   /**
  82    * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
  83    */
  84   bool IsColorDepthSupported( Dali::NativeImageSource::ColorDepth colorDepth ) override;
  85
  86   /**
  87    * destructor
  88    */
  89   ~NativeImageSourceX() override;
  90
  91   /**
  92    * @copydoc Dali::NativeImageSource::GlExtensionCreate()
  93    */
  94   bool GlExtensionCreate() override;
  95
  96   /**
  97    * @copydoc Dali::NativeImageSource::GlExtensionDestroy()
  98    */
  99   void GlExtensionDestroy() override;
 100
 101   /**
 102    * @copydoc Dali::NativeImageSource::TargetTexture()
 103    */
 104   unsigned int TargetTexture() override;
 105
 106   /**
 107    * @copydoc Dali::NativeImageSource::PrepareTexture()
 108    */
 109   void PrepareTexture() override;
 110
 111   /**
 112    * @copydoc Dali::NativeImageSource::GetWidth()
 113    */
 114   unsigned int GetWidth() const override
 115   {
 116     return mWidth;
 117   }
 118
 119   /**
 120    * @copydoc Dali::NativeImageSource::GetHeight()
 121    */
 122   unsigned int GetHeight() const override
 123   {
 124     return mHeight;
 125   }
 126
 127   /**
 128    * @copydoc Dali::NativeImageSource::RequiresBlending()
 129    */
 130   bool RequiresBlending() const override
 131   {
 132     return mBlendingRequired;
 133   }
 134
 135   /**
 136    * @copydoc Dali::NativeImageInterface::GetExtension()
 137    */
 138   NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
 139   {
 140     return nullptr;
 141   }
 142
 143 private:
 144
 145   /**
 146    * Private constructor; @see NativeImageSource::New()
 147    * @param[in] width The width of the image.
 148    * @param[in] height The height of the image.
 149    * @param[in] colour depth of the image.
 150    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 151    */
 152   NativeImageSourceX(unsigned int width,
 153               unsigned  int height,
 154               Dali::NativeImageSource::ColorDepth depth,
 155               Any nativeImageSource);
 156
 157   /**
 158    * 2nd phase construction.
 159    */
 160   void Initialize();
 161
 162   /**
 163    * Uses X11 to get the default depth.
 164    * @param depth the PixelImage depth enum
 165    * @return default x11 pixel depth
 166    */
 167   int GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const;
 168
 169   /**
 170    * Gets the pixmap from the Any parameter
 171    * @param pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 172    * @return pixmap x11 pixmap
 173    */
 174   Ecore_X_Pixmap GetPixmapFromAny(Any pixmap) const;
 175
 176   /**
 177    * Given an existing pixmap, the function uses X to find out
 178    * the width, heigth and depth of that pixmap.
 179    */
 180   void GetPixmapDetails();
 181
 182 private:
 183
 184   unsigned int mWidth;                        ///< image width
 185   unsigned int mHeight;                       ///< image heights
 186   bool mOwnPixmap;                            ///< Whether we created pixmap or not
 187   Ecore_X_Pixmap mPixmap;                     ///< From Xlib
 188   bool mBlendingRequired;                      ///< Whether blending is required
 189   Dali::NativeImageSource::ColorDepth mColorDepth;  ///< color depth of image
 190   void* mEglImageKHR;                         ///< From EGL extension
 191   EglImageExtensions* mEglImageExtensions;    ///< The EGL Image Extensions
 192 };
 193
 194 } // namespace Adaptor
 195
 196 } // namespace Internal
 197
 198 } // namespace Dali
 199
 200 #endif // __DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H__