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