dali/internal/imaging/tizen/native-image-source-impl-tizen.h

   1 #ifndef DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_TIZEN_H
   2 #define DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_TIZEN_H
   3
   4 /*
   5  * Copyright (c) 2023 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/public-api/common/dali-vector.h>
  23 #include <tbm_surface.h>
  24 #include <memory>
  25 #include <mutex>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali/internal/imaging/common/native-image-source-impl.h>
  29 #include <dali/public-api/adaptor-framework/native-image-source.h>
  30
  31 namespace Dali
  32 {
  33 namespace Internal
  34 {
  35 namespace Adaptor
  36 {
  37 class EglGraphics;
  38 class EglImageExtensions;
  39
  40 /**
  41  * Dali internal NativeImageSource.
  42  */
  43 class NativeImageSourceTizen : public Internal::Adaptor::NativeImageSource
  44 {
  45 public:
  46   /**
  47    * Create a new NativeImageSource internally.
  48    * Depending on hardware the width and height may have to be a power of two.
  49    * @param[in] width The width of the image.
  50    * @param[in] height The height of the image.
  51    * @param[in] depth color depth of the image.
  52    * @param[in] nativeImageSource contains tbm_surface_h or is empty
  53    * @return A smart-pointer to a newly allocated image.
  54    */
  55   static NativeImageSourceTizen* New(uint32_t                            width,
  56                                      uint32_t                            height,
  57                                      Dali::NativeImageSource::ColorDepth depth,
  58                                      Any                                 nativeImageSource);
  59
  60   /**
  61    * @copydoc Dali::NativeImageSource::GetNativeImageSource()
  62    */
  63   Any GetNativeImageSource() const override;
  64
  65   /**
  66    * @copydoc Dali::NativeImageSource::GetPixels()
  67    */
  68   bool GetPixels(std::vector<uint8_t>& pixbuf, uint32_t& width, uint32_t& height, Pixel::Format& pixelFormat) const override;
  69
  70   /**
  71    * @copydoc Dali::NativeImageSource::SetSource( Any source )
  72    */
  73   void SetSource(Any source) override;
  74
  75   /**
  76    * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
  77    */
  78   bool IsColorDepthSupported(Dali::NativeImageSource::ColorDepth colorDepth) override;
  79
  80   /**
  81    * destructor
  82    */
  83   ~NativeImageSourceTizen() override;
  84
  85   /**
  86    * @copydoc Dali::NativeImageSource::CreateResource()
  87    */
  88   bool CreateResource() override;
  89
  90   /**
  91    * @copydoc Dali::NativeImageSource::DestroyResource()
  92    */
  93   void DestroyResource() override;
  94
  95   /**
  96    * @copydoc Dali::NativeImageSource::TargetTexture()
  97    */
  98   uint32_t TargetTexture() override;
  99
 100   /**
 101    * @copydoc Dali::NativeImageSource::PrepareTexture()
 102    */
 103   void PrepareTexture() override;
 104
 105   /**
 106    * @copydoc Dali::NativeImageSource::GetWidth()
 107    */
 108   uint32_t GetWidth() const override
 109   {
 110     return mWidth;
 111   }
 112
 113   /**
 114    * @copydoc Dali::NativeImageSource::GetHeight()
 115    */
 116   uint32_t GetHeight() const override
 117   {
 118     return mHeight;
 119   }
 120
 121   /**
 122    * @copydoc Dali::NativeImageSource::RequiresBlending()
 123    */
 124   bool RequiresBlending() const override
 125   {
 126     return mBlendingRequired;
 127   }
 128
 129   /**
 130    * @copydoc Dali::NativeImageInterface::ApplyNativeFragmentShader(std::string& shader)
 131    */
 132   bool ApplyNativeFragmentShader(std::string& shader) override;
 133
 134   /**
 135    * @copydoc Dali::NativeImageInterface::GetCustomSamplerTypename()
 136    */
 137   const char* GetCustomSamplerTypename() const override;
 138
 139   /**
 140    * @copydoc Dali::NativeImageInterface::GetTextureTarget()
 141    */
 142   int GetTextureTarget() const override;
 143
 144   /**
 145    * @copydoc Dali::NativeImageInterface::GetNativeImageHandle()
 146    */
 147   Any GetNativeImageHandle() const override;
 148
 149   /**
 150    * @copydoc Dali::NativeImageInterface::SourceChanged()
 151    */
 152   bool SourceChanged() const override;
 153
 154   /**
 155    * @copydoc Dali::NativeImageInterface::GetUpdatedArea()
 156    */
 157   Rect<uint32_t> GetUpdatedArea() override;
 158
 159   /**
 160    * @copydoc Dali::NativeImageInterface::GetExtension()
 161    */
 162   NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
 163   {
 164     return nullptr;
 165   }
 166
 167   /**
 168    * @copydoc Dali::Internal::Adaptor::NativeImageSource::AcquireBuffer()
 169    */
 170   uint8_t* AcquireBuffer(uint32_t& width, uint32_t& height, uint32_t& stride) override;
 171
 172   /**
 173    * @copydoc Dali::Internal::Adaptor::NativeImageSource::ReleaseBuffer()
 174    */
 175   bool ReleaseBuffer(const Rect<uint32_t>& updatedArea) override;
 176
 177   /**
 178    * @copydoc Dali::NativeImageSource::SetResourceDestructionCallback()
 179    */
 180   void SetResourceDestructionCallback(EventThreadCallback* callback) override;
 181
 182   /**
 183    * @copydoc Dali::DevelNativeImageSource::EnableBackBuffer()
 184    */
 185   void EnableBackBuffer(bool enable) override;
 186
 187 private:
 188   /**
 189    * Private constructor; @see NativeImageSource::New()
 190    * @param[in] width The width of the image.
 191    * @param[in] height The height of the image.
 192    * @param[in] colour depth of the image.
 193    * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 194    */
 195   NativeImageSourceTizen(uint32_t                            width,
 196                          unsigned int                        height,
 197                          Dali::NativeImageSource::ColorDepth depth,
 198                          Any                                 nativeImageSource);
 199
 200   void Initialize();
 201
 202   tbm_surface_h GetSurfaceFromAny(Any source) const;
 203
 204   bool CheckBlending(tbm_format format);
 205
 206   void DestroySurface();
 207
 208   /**
 209    * @brief Create back buffer
 210    */
 211   void CreateBackBuffer();
 212
 213   /**
 214    * @brief Destroy back buffer
 215    */
 216   void DestroyBackBuffer();
 217
 218 private:
 219   uint32_t                             mWidth;          ///< image width
 220   uint32_t                             mHeight;         ///< image height
 221   tbm_surface_h                        mTbmSurface;     ///< Tbm surface
 222   tbm_surface_h                        mTbmBackSurface; ///< Back buffer
 223   tbm_format                           mTbmFormat;
 224   Dali::NativeImageSource::ColorDepth  mColorDepth;    ///< color depth of image
 225   Rect<uint32_t>                       mUpdatedArea{}; ///< Updated area
 226   mutable std::mutex                   mMutex;
 227   void*                                mEglImageKHR;                 ///< From EGL extension
 228   EglGraphics*                         mEglGraphics;                 ///< EGL Graphics
 229   EglImageExtensions*                  mEglImageExtensions;          ///< The EGL Image Extensions
 230   std::unique_ptr<EventThreadCallback> mResourceDestructionCallback; ///< The Resource Destruction Callback
 231   bool                                 mOwnTbmSurface : 1;           ///< Whether we created pixmap or not
 232   bool                                 mBlendingRequired : 1;        ///< Whether blending is required
 233   bool                                 mSetSource : 1;
 234   bool                                 mIsBufferAcquired : 1;  ///< Whether AcquireBuffer is called
 235   bool                                 mBackBufferEnabled : 1; ///< Whether the back buffer is enabled
 236 };
 237
 238 } // namespace Adaptor
 239
 240 } // namespace Internal
 241
 242 } // namespace Dali
 243
 244 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_TIZEN_H