dali/internal/adaptor/common/combined-update-render-controller.h

   1 #ifndef DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H
   2 #define DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H
   3
   4 /*
   5  * Copyright (c) 2018 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 <semaphore.h>
  23 #include <stdint.h>
  24 #include <dali/integration-api/core.h>
  25 #include <dali/devel-api/threading/conditional-wait.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali/integration-api/thread-synchronization-interface.h>
  29 #include <dali/internal/system/common/performance-interface.h>
  30 #include <dali/internal/system/common/fps-tracker.h>
  31 #include <dali/internal/adaptor/common/thread-controller-interface.h>
  32 #include <dali/internal/system/common/update-status-logger.h>
  33 #include <dali/internal/window-system/common/display-connection.h>
  34
  35
  36 namespace Dali
  37 {
  38
  39 class RenderSurfaceInterface;
  40 class TriggerEventInterface;
  41
  42 namespace Internal
  43 {
  44
  45 namespace Adaptor
  46 {
  47
  48 class AdaptorInternalServices;
  49 class EnvironmentOptions;
  50
  51 /**
  52  * @brief Two threads where events/application interaction is handled on the main/event thread and the Update & Render
  53  * happen on the other thread.
  54  *
  55  * Key Points:
  56  *  1. Two Threads:
  57  *    a. Main/Event Thread.
  58  *    b. Update/Render Thread.
  59  *  2. There is NO VSync thread:
  60  *    a. We retrieve the time before Update.
  61  *    b. Then retrieve the time after Render.
  62  *    c. We calculate the difference between these two times and if:
  63  *      i.  The difference is less than the default frame time, we sleep.
  64  *      ii. If it’s more or the same, we continue.
  65  *  3. On the update/render thread, if we discover that we do not need to do any more updates, we use a trigger-event
  66  *     to inform the main/event thread. This is then processed as soon as the event thread is able to do so where it
  67  *     is easier to make a decision about whether we should stop the update/render thread or not (depending on any
  68  *     update requests etc.).
  69  *  4. The main thread is blocked while the surface is being replaced.
  70  *  5. When we resume from paused, elapsed time is used for the animations, i.e. the could have finished while we were paused.
  71  *     However, FinishedSignal emission will only happen upon resumption.
  72  *  6. Elapsed time is NOT used while if we are waking up from a sleep state or doing an UpdateOnce.
  73  */
  74 class CombinedUpdateRenderController : public ThreadControllerInterface,
  75                                        public ThreadSynchronizationInterface
  76 {
  77 public:
  78
  79   /**
  80    * Constructor
  81    */
  82   CombinedUpdateRenderController( AdaptorInternalServices& adaptorInterfaces, const EnvironmentOptions& environmentOptions );
  83
  84   /**
  85    * Non virtual destructor. Not intended as base class.
  86    */
  87   ~CombinedUpdateRenderController();
  88
  89   /**
  90    * @copydoc ThreadControllerInterface::Initialize()
  91    */
  92   virtual void Initialize();
  93
  94   /**
  95    * @copydoc ThreadControllerInterface::Start()
  96    */
  97   virtual void Start();
  98
  99   /**
 100    * @copydoc ThreadControllerInterface::Pause()
 101    */
 102   virtual void Pause();
 103
 104   /**
 105    * @copydoc ThreadControllerInterface::Resume()
 106    */
 107   virtual void Resume();
 108
 109   /**
 110    * @copydoc ThreadControllerInterface::Stop()
 111    */
 112   virtual void Stop();
 113
 114   /**
 115    * @copydoc ThreadControllerInterface::RequestUpdate()
 116    */
 117   virtual void RequestUpdate();
 118
 119   /**
 120    * @copydoc ThreadControllerInterface::RequestUpdateOnce()
 121    */
 122   virtual void RequestUpdateOnce();
 123
 124   /**
 125    * @copydoc ThreadControllerInterface::ReplaceSurface()
 126    */
 127   virtual void ReplaceSurface( Dali::RenderSurfaceInterface* surface );
 128
 129   /**
 130    * @copydoc ThreadControllerInterface::ResizeSurface()
 131    */
 132   virtual void ResizeSurface();
 133
 134   /**
 135    * @copydoc ThreadControllerInterface::SetRenderRefreshRate()
 136    */
 137   virtual void SetRenderRefreshRate( unsigned int numberOfFramesPerRender );
 138
 139   /**
 140    * @copydoc ThreadControllerInterface::SetPreRenderCallback
 141    */
 142   void SetPreRenderCallback( CallbackBase* callback ) override;
 143
 144 private:
 145
 146   // Undefined copy constructor.
 147   CombinedUpdateRenderController( const CombinedUpdateRenderController& );
 148
 149   // Undefined assignment operator.
 150   CombinedUpdateRenderController& operator=( const CombinedUpdateRenderController& );
 151
 152   /////////////////////////////////////////////////////////////////////////////////////////////////
 153   // EventThread
 154   /////////////////////////////////////////////////////////////////////////////////////////////////
 155
 156   /**
 157    * Runs the Update/Render Thread.
 158    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 159    *
 160    * @param[in]  numberOfCycles           The number of times the update/render cycle should run. If -1, then it will run continuously.
 161    * @param[in]  useElapsedTimeAfterWait  If true, then the elapsed time during wait is used for animations, otherwise no animation progression is made.
 162    */
 163   inline void RunUpdateRenderThread( int numberOfCycles, bool useElapsedTimeAfterWait );
 164
 165   /**
 166    * Pauses the Update/Render Thread.
 167    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 168    */
 169   inline void PauseUpdateRenderThread();
 170
 171   /**
 172    * Stops the Update/Render Thread.
 173    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 174    *
 175    * @note Should only be called in Stop as calling this will kill the update-thread.
 176    */
 177   inline void StopUpdateRenderThread();
 178
 179   /**
 180    * Checks if the the Update/Render Thread is paused.
 181    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 182    *
 183    * @return true if paused, false otherwise
 184    */
 185   inline bool IsUpdateRenderThreadPaused();
 186
 187   /**
 188    * Used as the callback for the sleep-trigger.
 189    *
 190    * Will sleep when enough requests are made without any requests.
 191    */
 192   void ProcessSleepRequest();
 193
 194   /////////////////////////////////////////////////////////////////////////////////////////////////
 195   // UpdateRenderThread
 196   /////////////////////////////////////////////////////////////////////////////////////////////////
 197
 198   /**
 199    * The Update/Render thread loop. This thread will be destroyed on exit from this function.
 200    */
 201   void UpdateRenderThread();
 202
 203   /**
 204    * Called by the Update/Render Thread which ensures a wait if required.
 205    *
 206    * @param[out] useElapsedTime    If true when returned, then the actual elapsed time will be used for animation.
 207    *                               If false when returned, then there should NOT be any animation progression in the next Update.
 208    * @param[in]  updateRequired    Whether another update is required.
 209    * @param[out] timeToSleepUntil  The time remaining in nanoseconds to keep the thread sleeping before resuming.
 210    * @return false, if the thread should stop.
 211    */
 212   bool UpdateRenderReady( bool& useElapsedTime, bool updateRequired, uint64_t& timeToSleepUntil );
 213
 214   /**
 215    * Checks to see if the surface needs to be replaced.
 216    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 217    *
 218    * @return Pointer to the new surface, NULL otherwise
 219    */
 220   Integration::RenderSurface* ShouldSurfaceBeReplaced();
 221
 222   /**
 223    * Called by the Update/Render thread after a surface has been replaced.
 224    *
 225    * This will lock the mutex in mEventThreadWaitCondition
 226    */
 227   void SurfaceReplaced();
 228
 229   /**
 230    * Checks to see if the surface needs to be resized.
 231    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 232    *
 233    * @return true if the surface should be resized, false otherwise
 234    */
 235   bool ShouldSurfaceBeResized();
 236
 237   /**
 238    * Called by the Update/Render thread after a surface has been resized.
 239    *
 240    * This will lock the mutex in mEventThreadWaitCondition
 241    */
 242   void SurfaceResized();
 243
 244   /**
 245    * Helper for the thread calling the entry function
 246    * @param[in] This A pointer to the current object
 247    */
 248   static void* InternalUpdateRenderThreadEntryFunc( void* This )
 249   {
 250     ( static_cast<CombinedUpdateRenderController*>( This ) )->UpdateRenderThread();
 251     return NULL;
 252   }
 253
 254   /////////////////////////////////////////////////////////////////////////////////////////////////
 255   // ALL Threads
 256   /////////////////////////////////////////////////////////////////////////////////////////////////
 257
 258   /**
 259    * Called by the update-render & v-sync threads when they up and running.
 260    *
 261    * This will lock the mutex in mEventThreadWaitCondition.
 262    */
 263   void NotifyThreadInitialised();
 264
 265   /**
 266    * Helper to add a performance marker to the performance server (if it's active)
 267    * @param[in]  type  performance marker type
 268    */
 269   void AddPerformanceMarker( PerformanceInterface::MarkerType type );
 270
 271   /////////////////////////////////////////////////////////////////////////////////////////////////
 272   // POST RENDERING - ThreadSynchronizationInterface overrides
 273   /////////////////////////////////////////////////////////////////////////////////////////////////
 274
 275   /////////////////////////////////////////////////////////////////////////////////////////////////
 276   //// Called by the Event Thread if post-rendering is required
 277   /////////////////////////////////////////////////////////////////////////////////////////////////
 278
 279   /**
 280    * @copydoc ThreadSynchronizationInterface::PostRenderComplete()
 281    */
 282   virtual void PostRenderComplete();
 283
 284   /////////////////////////////////////////////////////////////////////////////////////////////////
 285   //// Called by the Render Thread if post-rendering is required
 286   /////////////////////////////////////////////////////////////////////////////////////////////////
 287
 288   /**
 289    * @copydoc ThreadSynchronizationInterface::PostRenderStarted()
 290    */
 291   virtual void PostRenderStarted();
 292
 293   /**
 294    * @copydoc ThreadSynchronizationInterface::PostRenderStarted()
 295    */
 296   virtual void PostRenderWaitForCompletion();
 297
 298 private:
 299
 300   FpsTracker                        mFpsTracker;                       ///< Object that tracks the FPS
 301   UpdateStatusLogger                mUpdateStatusLogger;               ///< Object that logs the update-status as required.
 302
 303   sem_t                             mEventThreadSemaphore;             ///< Used by the event thread to ensure all threads have been initialised, and when replacing the surface.
 304
 305   ConditionalWait                   mUpdateRenderThreadWaitCondition;  ///< The wait condition for the update-render-thread.
 306
 307   AdaptorInternalServices&          mAdaptorInterfaces;                ///< The adaptor internal interface
 308   PerformanceInterface*             mPerformanceInterface;             ///< The performance logging interface
 309   Integration::Core&                mCore;                             ///< Dali core reference
 310   const EnvironmentOptions&         mEnvironmentOptions;               ///< Environment options
 311   TriggerEventInterface&            mNotificationTrigger;              ///< Reference to notification event trigger
 312   TriggerEventInterface*            mSleepTrigger;                     ///< Used by the update-render thread to trigger the event thread when it no longer needs to do any updates
 313   CallbackBase*                     mPreRenderCallback;                ///< Used by Update/Render thread when PreRender is about to be called on graphics.
 314
 315   pthread_t*                        mUpdateRenderThread;               ///< The Update/Render thread.
 316
 317   float                             mDefaultFrameDelta;                ///< Default time delta between each frame (used for animations). Not protected by lock, but written to rarely so not worth adding a lock when reading.
 318   uint64_t                          mDefaultFrameDurationMilliseconds; ///< Default duration of a frame (used for predicting the time of the next frame). Not protected by lock, but written to rarely so not worth adding a lock when reading.
 319   uint64_t                          mDefaultFrameDurationNanoseconds;  ///< Default duration of a frame (used for sleeping if not enough time elapsed). Not protected by lock, but written to rarely so not worth adding a lock when reading.
 320   uint64_t                          mDefaultHalfFrameNanoseconds;      ///< Is half of mDefaultFrameDurationNanoseconds. Using a member variable avoids having to do the calculation every frame. Not protected by lock, but written to rarely so not worth adding a lock when reading.
 321
 322   unsigned int                      mUpdateRequestCount;               ///< Count of update-requests we have received to ensure we do not go to sleep too early.
 323   unsigned int                      mRunning;                          ///< Read and set on the event-thread only to state whether we are running.
 324
 325   //
 326   // NOTE: cannot use booleans as these are used from multiple threads, must use variable with machine word size for atomic read/write
 327   //
 328
 329   volatile int                      mUpdateRenderRunCount;             ///< The number of times Update/Render cycle should run. If -1, then will run continuously (set by the event-thread, read by v-sync-thread).
 330   volatile unsigned int             mDestroyUpdateRenderThread;        ///< Whether the Update/Render thread be destroyed (set by the event-thread, read by the update-render-thread).
 331   volatile unsigned int             mUpdateRenderThreadCanSleep;       ///< Whether the Update/Render thread can sleep (set by the event-thread, read by the update-render-thread).
 332   volatile unsigned int             mPendingRequestUpdate;             ///< Is set as soon as an RequestUpdate is made and unset when the next update happens (set by the event-thread and update-render thread, read by the update-render-thread).
 333                                                                        ///< Ensures we do not go to sleep if we have not processed the most recent update-request.
 334
 335   volatile unsigned int             mUseElapsedTimeAfterWait;          ///< Whether we should use the elapsed time after waiting (set by the event-thread, read by the update-render-thread).
 336
 337   Integration::RenderSurface* volatile mNewSurface;                    ///< Will be set to the new-surface if requested (set by the event-thread, read & cleared by the update-render thread).
 338
 339   volatile unsigned int             mPostRendering;                    ///< Whether post-rendering is taking place (set by the event & render threads, read by the render-thread).
 340   volatile unsigned int             mSurfaceResized;                   ///< Will be set to resize the surface (set by the event-thread, read & cleared by the update-render thread).
 341   volatile unsigned int             mForceClear;                       ///< Will be set to clear forcibly
 342 };
 343
 344 } // namespace Adaptor
 345
 346 } // namespace Internal
 347
 348 } // namespace Dali
 349
 350 #endif // DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H