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 Sets the necessary for window rotation acknowledge.
 123    * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
 124    *
 125    * More detail description is written in DevelWindow::SetNeedsRotationCompletedAcknowledgement().
 126    *
 127    * @param[in] window The window instance.
 128    * @param[in] needAcknowledgement the flag is true if window rotation acknowledgement is sent.
 129    */
 130   void SetNeedsRotationCompletedAcknowledgement(bool needAcknowledgement);
 131
 132   /**
 133    * @brief Updates window surface's position and size.
 134    * It is just to update the local variable in window surface.
 135    * This function is only called when window's position or size is changed by display server.
 136    *
 137    * @param[in] positionSize The updated window surface's position and size.
 138    */
 139   void UpdatePositionSize(Dali::PositionSize positionSize);
 140
 141   /**
 142    * @brief This signal is emitted when the output is transformed.
 143    */
 144   OutputSignalType& OutputTransformedSignal();
 145
 146 public: // from Dali::RenderSurfaceInterface
 147   /**
 148    * @copydoc Dali::RenderSurfaceInterface::GetPositionSize()
 149    */
 150   PositionSize GetPositionSize() const override;
 151
 152   /**
 153    */
 154   void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
 155
 156   /**
 157    * @copydoc Dali::RenderSurfaceInterface::GetOrientation()
 158    */
 159   int GetOrientation() const override;
 160
 161   /**
 162    * @copydoc Dali::RenderSurfaceInterface::InitializeGraphics()
 163    */
 164   void InitializeGraphics() override;
 165
 166   /**
 167    * @copydoc Dali::RenderSurfaceInterface::CreateSurface()
 168    */
 169   void CreateSurface() override;
 170
 171   /**
 172    * @copydoc Dali::RenderSurfaceInterface::DestroySurface()
 173    */
 174   void DestroySurface() override;
 175
 176   /**
 177    * @copydoc Dali::RenderSurfaceInterface::ReplaceGraphicsSurface()
 178    */
 179   bool ReplaceGraphicsSurface() override;
 180
 181   /**
 182    * @copydoc Dali::RenderSurfaceInterface::MoveResize()
 183    */
 184   void MoveResize(Dali::PositionSize positionSize) override;
 185
 186   /**
 187    * @copydoc Dali::RenderSurfaceInterface::StartRender()
 188    */
 189   void StartRender() override;
 190
 191   /**
 192    * @copydoc Dali::RenderSurfaceInterface::PreRender()
 193    */
 194   bool PreRender(bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect) override;
 195
 196   /**
 197    * @copydoc Dali::RenderSurfaceInterface::PostRender()
 198    */
 199   void PostRender() override;
 200
 201   /**
 202    * @copydoc Dali::RenderSurfaceInterface::StopRender()
 203    */
 204   void StopRender() override;
 205
 206   /**
 207    * @copydoc Dali::RenderSurfaceInterface::SetThreadSynchronization
 208    */
 209   void SetThreadSynchronization(ThreadSynchronizationInterface& threadSynchronization) override;
 210
 211   /**
 212    * @copydoc Dali::RenderSurfaceInterface::ReleaseLock()
 213    */
 214   void ReleaseLock() override;
 215
 216   /**
 217    * @copydoc Dali::RenderSurfaceInterface::GetSurfaceType()
 218    */
 219   Dali::RenderSurfaceInterface::Type GetSurfaceType() override;
 220
 221   /**
 222    * @copydoc Dali::RenderSurfaceInterface::MakeContextCurrent()
 223    */
 224   void MakeContextCurrent() override;
 225
 226   /**
 227    * @copydoc Dali::RenderSurfaceInterface::GetDepthBufferRequired()
 228    */
 229   Integration::DepthBufferAvailable GetDepthBufferRequired() override;
 230
 231   /**
 232    * @copydoc Dali::RenderSurfaceInterface::GetStencilBufferRequired()
 233    */
 234   Integration::StencilBufferAvailable GetStencilBufferRequired() override;
 235
 236 private:
 237   /**
 238    * @brief Second stage construction
 239    */
 240   void Initialize(Any surface);
 241
 242   /**
 243    * Notify output is transformed.
 244    */
 245   void OutputTransformed();
 246
 247   /**
 248    * @brief Used as the callback for the post render.
 249    * It is used both window rotation and supporting Ime window
 250    */
 251   void ProcessPostRender();
 252
 253   /**
 254    * @brief Used as the callback for the frame rendered / presented.
 255    */
 256   void ProcessFrameCallback();
 257
 258   /**
 259    * @brief Called when our event file descriptor has been written to.
 260    * @param[in] eventBitMask bit mask of events that occured on the file descriptor
 261    * @param[in] fileDescriptor The file descriptor
 262    */
 263   void OnFileDescriptorEventDispatched(FileDescriptorMonitor::EventType eventBitMask, int fileDescriptor);
 264
 265   /**
 266    * @brief Set the buffer damage rects.
 267    * @param[in] damagedRects List of damaged rects
 268    * @param[in] clippingRect The rect to clip rendered scene
 269    */
 270   void SetBufferDamagedRects(const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect);
 271
 272   /**
 273    * @brief Swap buffers.
 274    * @param[in] damagedRects List of damaged rects
 275    */
 276   void SwapBuffers(const std::vector<Rect<int>>& damagedRects);
 277
 278 protected:
 279   // Undefined
 280   WindowRenderSurface(const WindowRenderSurface&) = delete;
 281
 282   // Undefined
 283   WindowRenderSurface& operator=(const WindowRenderSurface& rhs) = delete;
 284
 285 private:
 286   struct FrameCallbackInfo
 287   {
 288     FrameCallbackInfo(Dali::Integration::Scene::FrameCallbackContainer& callbackList, int fd)
 289     : callbacks(),
 290       fileDescriptorMonitor(),
 291       fileDescriptor(fd)
 292     {
 293       // Transfer owership of the CallbackBase
 294       for(auto&& iter : callbackList)
 295       {
 296         callbacks.push_back(std::make_pair(std::move(iter.first), iter.second));
 297       }
 298     }
 299
 300     ~FrameCallbackInfo()
 301     {
 302       // Delete FileDescriptorMonitor before close fd.
 303       fileDescriptorMonitor.release();
 304       close(fileDescriptor);
 305     }
 306
 307     Dali::Integration::Scene::FrameCallbackContainer callbacks;
 308     std::unique_ptr<FileDescriptorMonitor>           fileDescriptorMonitor;
 309     int                                              fileDescriptor;
 310   };
 311
 312   using FrameCallbackInfoContainer = std::vector<std::unique_ptr<FrameCallbackInfo>>;
 313
 314 private: // Data
 315   EglInterface*                          mEGL;
 316   Dali::DisplayConnection*               mDisplayConnection;
 317   PositionSize                           mPositionSize; ///< Position
 318   std::unique_ptr<WindowBase>            mWindowBase;
 319   ThreadSynchronizationInterface*        mThreadSynchronization;
 320   TriggerEventInterface*                 mRenderNotification; ///< Render notification trigger
 321   std::unique_ptr<TriggerEventInterface> mPostRenderTrigger;  ///< Post render callback function
 322   std::unique_ptr<TriggerEventInterface> mFrameRenderedTrigger;
 323   GraphicsInterface*                     mGraphics; ///< Graphics interface
 324   EGLSurface                             mEGLSurface;
 325   EGLContext                             mEGLContext;
 326   ColorDepth                             mColorDepth; ///< Color depth of surface (32 bit or 24 bit)
 327   OutputSignalType                       mOutputTransformedSignal;
 328   FrameCallbackInfoContainer             mFrameCallbackInfoContainer;
 329   DamagedRectsContainer                  mBufferDamagedRects;
 330   Dali::Mutex                            mMutex;
 331   int                                    mWindowRotationAngle;
 332   int                                    mScreenRotationAngle;
 333   uint32_t                               mDpiHorizontal;
 334   uint32_t                               mDpiVertical;
 335   std::vector<Rect<int>>                 mDamagedRects{}; ///< Keeps collected damaged render items rects for one render pass
 336   bool                                   mOwnSurface;     ///< Whether we own the surface (responsible for deleting it)
 337   bool                                   mWindowRotationFinished;
 338   bool                                   mScreenRotationFinished;
 339   bool                                   mResizeFinished;
 340   bool                                   mDefaultScreenRotationAvailable;
 341   bool                                   mIsImeWindowSurface;
 342   bool                                   mNeedWindowRotationAcknowledgement;
 343
 344 }; // class WindowRenderSurface
 345
 346 } // namespace Adaptor
 347
 348 } // namespace Internal
 349
 350 } // namespace Dali
 351
 352 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H