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