dali/internal/window-system/common/window-render-surface.h

   1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H
   2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H
   3
   4 /*
   5  * Copyright (c) 2021 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/devel-api/threading/mutex.h>
  23 #include <dali/integration-api/scene.h>
  24 #include <dali/public-api/signals/connection-tracker.h>
  25 #include <dali/public-api/signals/dali-signal.h>
  26 #include <unistd.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali/integration-api/adaptor-framework/egl-interface.h>
  30 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
  31 #include <dali/internal/graphics/common/graphics-interface.h>
  32 #include <dali/internal/system/common/file-descriptor-monitor.h>
  33
  34 namespace Dali
  35 {
  36 class TriggerEventInterface;
  37
  38 namespace Internal
  39 {
  40 namespace Adaptor
  41 {
  42 class WindowBase;
  43 class AdaptorInternalServices;
  44
  45 /**
  46  * Window interface of render surface.
  47  */
  48 class WindowRenderSurface : public Dali::RenderSurfaceInterface, public ConnectionTracker
  49 {
  50 public:
  51   using OutputSignalType      = Signal<void()>;
  52   using DamagedRectsContainer = std::list<std::vector<Rect<int>>>;
  53
  54   /**
  55     * Uses an window surface to render to.
  56     * @param [in] positionSize the position and size of the surface
  57     * @param [in] surface can be a window or pixmap.
  58     * @param [in] isTransparent if it is true, surface has 32 bit color depth, otherwise, 24 bit
  59     */
  60   WindowRenderSurface(Dali::PositionSize positionSize, Any surface, bool isTransparent = false);
  61
  62   /**
  63    * @brief Destructor
  64    */
  65   virtual ~WindowRenderSurface();
  66
  67 public: // API
  68   /**
  69    * @brief Get the native window handle
  70    * @return The native window handle
  71    */
  72   Any GetNativeWindow();
  73
  74   /**
  75    * @brief Get the native window id
  76    * @return The native window id
  77    */
  78   int GetNativeWindowId();
  79
  80   /**
  81    * @brief Map window
  82    */
  83   void Map();
  84
  85   /**
  86    * @brief Sets the render notification trigger to call when render thread is completed a frame
  87    * @param renderNotification to use
  88    */
  89   void SetRenderNotification(TriggerEventInterface* renderNotification);
  90
  91   /**
  92    * @brief Sets whether the surface is transparent or not.
  93    * @param[in] transparent Whether the surface is transparent
  94    */
  95   void SetTransparency(bool transparent);
  96
  97   /**
  98    * Request surface rotation
  99    * @param[in] angle A new angle of the surface
 100    * @param[in] width A new width of the surface
 101    * @param[in] height A new height of the surface
 102    */
 103   void RequestRotation(int angle, int width, int height);
 104
 105   /**
 106    * @brief Gets the window base object
 107    * @return The window base object
 108    */
 109   WindowBase* GetWindowBase();
 110
 111   /**
 112    * @brief Intiailize Ime Surface for Ime window rendering.
 113    *
 114    * It sets one flag and callback function for Ime window rendering
 115    * This callback function calls one special native window function for ready to commit buffer.
 116    * The special function notify to display server.
 117    * It is only used for Ime window.
 118    */
 119   void InitializeImeSurface();
 120
 121   /**
 122    * @brief This signal is emitted when the output is transformed.
 123    */
 124   OutputSignalType& OutputTransformedSignal();
 125
 126 public: // from Dali::RenderSurfaceInterface
 127   /**
 128    * @copydoc Dali::RenderSurfaceInterface::GetPositionSize()
 129    */
 130   PositionSize GetPositionSize() const override;
 131
 132   /**
 133    */
 134   void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
 135
 136   /**
 137    * @copydoc Dali::RenderSurfaceInterface::GetOrientation()
 138    */
 139   int GetOrientation() const override;
 140
 141   /**
 142    * @copydoc Dali::RenderSurfaceInterface::InitializeGraphics()
 143    */
 144   void InitializeGraphics() override;
 145
 146   /**
 147    * @copydoc Dali::RenderSurfaceInterface::CreateSurface()
 148    */
 149   void CreateSurface() override;
 150
 151   /**
 152    * @copydoc Dali::RenderSurfaceInterface::DestroySurface()
 153    */
 154   void DestroySurface() override;
 155
 156   /**
 157    * @copydoc Dali::RenderSurfaceInterface::ReplaceGraphicsSurface()
 158    */
 159   bool ReplaceGraphicsSurface() override;
 160
 161   /**
 162    * @copydoc Dali::RenderSurfaceInterface::MoveResize()
 163    */
 164   void MoveResize(Dali::PositionSize positionSize) override;
 165
 166   /**
 167    * @copydoc Dali::RenderSurfaceInterface::StartRender()
 168    */
 169   void StartRender() override;
 170
 171   /**
 172    * @copydoc Dali::RenderSurfaceInterface::PreRender()
 173    */
 174   bool PreRender(bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect) override;
 175
 176   /**
 177    * @copydoc Dali::RenderSurfaceInterface::PostRender()
 178    */
 179   void PostRender() override;
 180
 181   /**
 182    * @copydoc Dali::RenderSurfaceInterface::StopRender()
 183    */
 184   void StopRender() override;
 185
 186   /**
 187    * @copydoc Dali::RenderSurfaceInterface::SetThreadSynchronization
 188    */
 189   void SetThreadSynchronization(ThreadSynchronizationInterface& threadSynchronization) override;
 190
 191   /**
 192    * @copydoc Dali::RenderSurfaceInterface::ReleaseLock()
 193    */
 194   void ReleaseLock() override;
 195
 196   /**
 197    * @copydoc Dali::RenderSurfaceInterface::GetSurfaceType()
 198    */
 199   Dali::RenderSurfaceInterface::Type GetSurfaceType() override;
 200
 201   /**
 202    * @copydoc Dali::RenderSurfaceInterface::MakeContextCurrent()
 203    */
 204   void MakeContextCurrent() override;
 205
 206   /**
 207    * @copydoc Dali::RenderSurfaceInterface::GetDepthBufferRequired()
 208    */
 209   Integration::DepthBufferAvailable GetDepthBufferRequired() override;
 210
 211   /**
 212    * @copydoc Dali::RenderSurfaceInterface::GetStencilBufferRequired()
 213    */
 214   Integration::StencilBufferAvailable GetStencilBufferRequired() override;
 215
 216 private:
 217   /**
 218    * @brief Second stage construction
 219    */
 220   void Initialize(Any surface);
 221
 222   /**
 223    * Notify output is transformed.
 224    */
 225   void OutputTransformed();
 226
 227   /**
 228    * @brief Used as the callback for the post render.
 229    * It is used both window rotation and supporting Ime window
 230    */
 231   void ProcessPostRender();
 232
 233   /**
 234    * @brief Used as the callback for the frame rendered / presented.
 235    */
 236   void ProcessFrameCallback();
 237
 238   /**
 239    * @brief Called when our event file descriptor has been written to.
 240    * @param[in] eventBitMask bit mask of events that occured on the file descriptor
 241    * @param[in] fileDescriptor The file descriptor
 242    */
 243   void OnFileDescriptorEventDispatched(FileDescriptorMonitor::EventType eventBitMask, int fileDescriptor);
 244
 245   /**
 246    * @brief Set the buffer damage rects.
 247    * @param[in] damagedRects List of damaged rects
 248    * @param[in] clippingRect The rect to clip rendered scene
 249    */
 250   void SetBufferDamagedRects(const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect);
 251
 252   /**
 253    * @brief Swap buffers.
 254    * @param[in] damagedRects List of damaged rects
 255    */
 256   void SwapBuffers(const std::vector<Rect<int>>& damagedRects);
 257
 258 protected:
 259   // Undefined
 260   WindowRenderSurface(const WindowRenderSurface&) = delete;
 261
 262   // Undefined
 263   WindowRenderSurface& operator=(const WindowRenderSurface& rhs) = delete;
 264
 265 private:
 266   struct FrameCallbackInfo
 267   {
 268     FrameCallbackInfo(Dali::Integration::Scene::FrameCallbackContainer& callbackList, int fd)
 269     : callbacks(),
 270       fileDescriptorMonitor(),
 271       fileDescriptor(fd)
 272     {
 273       // Transfer owership of the CallbackBase
 274       for(auto&& iter : callbackList)
 275       {
 276         callbacks.push_back(std::make_pair(std::move(iter.first), iter.second));
 277       }
 278     }
 279
 280     ~FrameCallbackInfo()
 281     {
 282       // Delete FileDescriptorMonitor before close fd.
 283       fileDescriptorMonitor.release();
 284       close(fileDescriptor);
 285     }
 286
 287     Dali::Integration::Scene::FrameCallbackContainer callbacks;
 288     std::unique_ptr<FileDescriptorMonitor>           fileDescriptorMonitor;
 289     int                                              fileDescriptor;
 290   };
 291
 292   using FrameCallbackInfoContainer = std::vector<std::unique_ptr<FrameCallbackInfo>>;
 293
 294 private: // Data
 295   EglInterface*                          mEGL;
 296   Dali::DisplayConnection*               mDisplayConnection;
 297   PositionSize                           mPositionSize; ///< Position
 298   std::unique_ptr<WindowBase>            mWindowBase;
 299   ThreadSynchronizationInterface*        mThreadSynchronization;
 300   TriggerEventInterface*                 mRenderNotification; ///< Render notification trigger
 301   std::unique_ptr<TriggerEventInterface> mPostRenderTrigger;  ///< Post render callback function
 302   std::unique_ptr<TriggerEventInterface> mFrameRenderedTrigger;
 303   GraphicsInterface*                     mGraphics; ///< Graphics interface
 304   EGLSurface                             mEGLSurface;
 305   EGLContext                             mEGLContext;
 306   ColorDepth                             mColorDepth; ///< Color depth of surface (32 bit or 24 bit)
 307   OutputSignalType                       mOutputTransformedSignal;
 308   FrameCallbackInfoContainer             mFrameCallbackInfoContainer;
 309   DamagedRectsContainer                  mBufferDamagedRects;
 310   Dali::Mutex                            mMutex;
 311   int                                    mWindowRotationAngle;
 312   int                                    mScreenRotationAngle;
 313   uint32_t                               mDpiHorizontal;
 314   uint32_t                               mDpiVertical;
 315   std::vector<Rect<int>>                 mDamagedRects{}; ///< Keeps collected damaged render items rects for one render pass
 316   bool                                   mOwnSurface;     ///< Whether we own the surface (responsible for deleting it)
 317   bool                                   mWindowRotationFinished;
 318   bool                                   mScreenRotationFinished;
 319   bool                                   mResizeFinished;
 320   bool                                   mDefaultScreenRotationAvailable;
 321   bool                                   mIsImeWindowSurface;
 322
 323 }; // class WindowRenderSurface
 324
 325 } // namespace Adaptor
 326
 327 } // namespace Internal
 328
 329 } // namespace Dali
 330
 331 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H