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( UpdateMode updateMode );
 123
 124   /**
 125    * @copydoc ThreadControllerInterface::ReplaceSurface()
 126    */
 127   virtual void ReplaceSurface( Dali::RenderSurfaceInterface* surface );
 128
 129   /**
 130    * @copydoc ThreadControllerInterface::DeleteSurface()
 131    */
 132   virtual void DeleteSurface( Dali::RenderSurfaceInterface* surface );
 133
 134   /**
 135    * @copydoc ThreadControllerInterface::ResizeSurface()
 136    */
 137   virtual void ResizeSurface();
 138
 139   /**
 140    * @copydoc ThreadControllerInterface::SetRenderRefreshRate()
 141    */
 142   virtual void SetRenderRefreshRate( unsigned int numberOfFramesPerRender );
 143
 144   /**
 145    * @copydoc ThreadControllerInterface::SetPreRenderCallback
 146    */
 147   void SetPreRenderCallback( CallbackBase* callback ) override;
 148
 149 private:
 150
 151   // Undefined copy constructor.
 152   CombinedUpdateRenderController( const CombinedUpdateRenderController& );
 153
 154   // Undefined assignment operator.
 155   CombinedUpdateRenderController& operator=( const CombinedUpdateRenderController& );
 156
 157   /////////////////////////////////////////////////////////////////////////////////////////////////
 158   // EventThread
 159   /////////////////////////////////////////////////////////////////////////////////////////////////
 160
 161   enum AnimationProgression
 162   {
 163     USE_ELAPSED_TIME,          ///< Animation progression using elapsed time
 164     NONE                       ///< No animation progression
 165   };
 166
 167   /**
 168    * Runs the Update/Render Thread.
 169    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 170    *
 171    * @param[in]  numberOfCycles           The number of times the update/render cycle should run. If -1, then it will run continuously.
 172    * @param[in]  animationProgression     Whether to progress animation using time elapsed since the last frame.
 173    * @param[in]  updateMode               The update mode (i.e. either update & render or skip rendering)
 174    */
 175   inline void RunUpdateRenderThread( int numberOfCycles, AnimationProgression animationProgression, UpdateMode updateMode );
 176
 177   /**
 178    * Pauses the Update/Render Thread.
 179    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 180    */
 181   inline void PauseUpdateRenderThread();
 182
 183   /**
 184    * Stops the Update/Render Thread.
 185    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 186    *
 187    * @note Should only be called in Stop as calling this will kill the update-thread.
 188    */
 189   inline void StopUpdateRenderThread();
 190
 191   /**
 192    * Checks if the the Update/Render Thread is paused.
 193    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 194    *
 195    * @return true if paused, false otherwise
 196    */
 197   inline bool IsUpdateRenderThreadPaused();
 198
 199   /**
 200    * Used as the callback for the sleep-trigger.
 201    *
 202    * Will sleep when enough requests are made without any requests.
 203    */
 204   void ProcessSleepRequest();
 205
 206   /////////////////////////////////////////////////////////////////////////////////////////////////
 207   // UpdateRenderThread
 208   /////////////////////////////////////////////////////////////////////////////////////////////////
 209
 210   /**
 211    * The Update/Render thread loop. This thread will be destroyed on exit from this function.
 212    */
 213   void UpdateRenderThread();
 214
 215   /**
 216    * Called by the Update/Render Thread which ensures a wait if required.
 217    *
 218    * @param[out] useElapsedTime    If true when returned, then the actual elapsed time will be used for animation.
 219    *                               If false when returned, then there should NOT be any animation progression in the next Update.
 220    * @param[in]  updateRequired    Whether another update is required.
 221    * @param[out] timeToSleepUntil  The time remaining in nanoseconds to keep the thread sleeping before resuming.
 222    * @return false, if the thread should stop.
 223    */
 224   bool UpdateRenderReady( bool& useElapsedTime, bool updateRequired, uint64_t& timeToSleepUntil );
 225
 226   /**
 227    * Checks to see if the surface needs to be replaced.
 228    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 229    *
 230    * @return Pointer to the new surface, NULL otherwise
 231    */
 232   Integration::RenderSurface* ShouldSurfaceBeReplaced();
 233
 234   /**
 235    * Called by the Update/Render thread after a surface has been replaced.
 236    *
 237    * This will lock the mutex in mEventThreadWaitCondition
 238    */
 239   void SurfaceReplaced();
 240
 241   /**
 242    * Checks to see if the surface needs to be deleted.
 243    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 244    *
 245    * @return Pointer to the deleted surface, nullptr otherwise
 246    */
 247   Integration::RenderSurface* ShouldSurfaceBeDeleted();
 248
 249   /**
 250    * Called by the Update/Render thread after a surface has been deleted.
 251    *
 252    * This will lock the mutex in mEventThreadWaitCondition
 253    */
 254   void SurfaceDeleted();
 255
 256   /**
 257    * Checks to see if the surface needs to be resized.
 258    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 259    *
 260    * @return true if the surface should be resized, false otherwise
 261    */
 262   bool ShouldSurfaceBeResized();
 263
 264   /**
 265    * Called by the Update/Render thread after a surface has been resized.
 266    *
 267    * This will lock the mutex in mEventThreadWaitCondition
 268    */
 269   void SurfaceResized();
 270
 271   /**
 272    * Helper for the thread calling the entry function
 273    * @param[in] This A pointer to the current object
 274    */
 275   static void* InternalUpdateRenderThreadEntryFunc( void* This )
 276   {
 277     ( static_cast<CombinedUpdateRenderController*>( This ) )->UpdateRenderThread();
 278     return NULL;
 279   }
 280
 281   /////////////////////////////////////////////////////////////////////////////////////////////////
 282   // ALL Threads
 283   /////////////////////////////////////////////////////////////////////////////////////////////////
 284
 285   /**
 286    * Called by the update-render & v-sync threads when they up and running.
 287    *
 288    * This will lock the mutex in mEventThreadWaitCondition.
 289    */
 290   void NotifyThreadInitialised();
 291
 292   /**
 293    * Helper to add a performance marker to the performance server (if it's active)
 294    * @param[in]  type  performance marker type
 295    */
 296   void AddPerformanceMarker( PerformanceInterface::MarkerType type );
 297
 298   /////////////////////////////////////////////////////////////////////////////////////////////////
 299   // POST RENDERING - ThreadSynchronizationInterface overrides
 300   /////////////////////////////////////////////////////////////////////////////////////////////////
 301
 302   /////////////////////////////////////////////////////////////////////////////////////////////////
 303   //// Called by the Event Thread if post-rendering is required
 304   /////////////////////////////////////////////////////////////////////////////////////////////////
 305
 306   /**
 307    * @copydoc ThreadSynchronizationInterface::PostRenderComplete()
 308    */
 309   virtual void PostRenderComplete();
 310
 311   /////////////////////////////////////////////////////////////////////////////////////////////////
 312   //// Called by the Render Thread if post-rendering is required
 313   /////////////////////////////////////////////////////////////////////////////////////////////////
 314
 315   /**
 316    * @copydoc ThreadSynchronizationInterface::PostRenderStarted()
 317    */
 318   virtual void PostRenderStarted();
 319
 320   /**
 321    * @copydoc ThreadSynchronizationInterface::PostRenderStarted()
 322    */
 323   virtual void PostRenderWaitForCompletion();
 324
 325 private:
 326
 327   FpsTracker                        mFpsTracker;                       ///< Object that tracks the FPS
 328   UpdateStatusLogger                mUpdateStatusLogger;               ///< Object that logs the update-status as required.
 329
 330   sem_t                             mEventThreadSemaphore;             ///< Used by the event thread to ensure all threads have been initialised, and when replacing the surface.
 331
 332   ConditionalWait                   mUpdateRenderThreadWaitCondition;  ///< The wait condition for the update-render-thread.
 333
 334   AdaptorInternalServices&          mAdaptorInterfaces;                ///< The adaptor internal interface
 335   PerformanceInterface*             mPerformanceInterface;             ///< The performance logging interface
 336   Integration::Core&                mCore;                             ///< Dali core reference
 337   const EnvironmentOptions&         mEnvironmentOptions;               ///< Environment options
 338   TriggerEventInterface&            mNotificationTrigger;              ///< Reference to notification event trigger
 339   TriggerEventInterface*            mSleepTrigger;                     ///< Used by the update-render thread to trigger the event thread when it no longer needs to do any updates
 340   CallbackBase*                     mPreRenderCallback;                ///< Used by Update/Render thread when PreRender is about to be called on graphics.
 341
 342   pthread_t*                        mUpdateRenderThread;               ///< The Update/Render thread.
 343
 344   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.
 345   // TODO: mDefaultFrameDurationMilliseconds is defined as uint64_t, the only place where it is used, it is converted to an unsigned int!!!
 346   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.
 347   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.
 348   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.
 349
 350   unsigned int                      mUpdateRequestCount;               ///< Count of update-requests we have received to ensure we do not go to sleep too early.
 351   unsigned int                      mRunning;                          ///< Read and set on the event-thread only to state whether we are running.
 352
 353   //
 354   // NOTE: cannot use booleans as these are used from multiple threads, must use variable with machine word size for atomic read/write
 355   //
 356
 357   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).
 358   volatile unsigned int             mDestroyUpdateRenderThread;        ///< Whether the Update/Render thread be destroyed (set by the event-thread, read by the update-render-thread).
 359   volatile unsigned int             mUpdateRenderThreadCanSleep;       ///< Whether the Update/Render thread can sleep (set by the event-thread, read by the update-render-thread).
 360   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).
 361                                                                        ///< Ensures we do not go to sleep if we have not processed the most recent update-request.
 362
 363   volatile unsigned int             mUseElapsedTimeAfterWait;          ///< Whether we should use the elapsed time after waiting (set by the event-thread, read by the update-render-thread).
 364
 365   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).
 366   Integration::RenderSurface* volatile mDeletedSurface;                ///< Will be set to the deleted surface if requested (set by the event-thread, read & cleared by the update-render thread).
 367
 368   volatile unsigned int             mPostRendering;                    ///< Whether post-rendering is taking place (set by the event & render threads, read by the render-thread).
 369   volatile unsigned int             mSurfaceResized;                   ///< Will be set to resize the surface (set by the event-thread, read & cleared by the update-render thread).
 370   volatile unsigned int             mForceClear;                       ///< Will be set to clear forcibly
 371
 372   volatile unsigned int             mUploadWithoutRendering;           ///< Will be set to upload the resource only (with no rendering)
 373
 374   volatile unsigned int             mFirstFrameAfterResume;            ///< Will be set to check the first frame after resume (for log)
 375 };
 376
 377 } // namespace Adaptor
 378
 379 } // namespace Internal
 380
 381 } // namespace Dali
 382
 383 #endif // DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H