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