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