adaptors/base/update-thread.h

   1 #ifndef __DALI_INTERNAL_UPDATE_THREAD_H__
   2 #define __DALI_INTERNAL_UPDATE_THREAD_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/public-api/common/vector-wrapper.h>
  23
  24 namespace boost
  25 {
  26
  27 class thread;
  28
  29 } // namespace boost
  30
  31 namespace Dali
  32 {
  33
  34 namespace Integration
  35 {
  36 class Core;
  37 }
  38
  39 namespace Internal
  40 {
  41
  42 namespace Adaptor
  43 {
  44
  45 class UpdateRenderSynchronization;
  46 class AdaptorInternalServices;
  47 class EnvironmentOptions;
  48
  49 /**
  50  * The update-thread is responsible for calling Core::Update(), and
  51  * for triggering the render-thread after each update.
  52  */
  53 class UpdateThread
  54 {
  55 public:
  56
  57   /**
  58    * Create the update-thread; this will not do anything until Start() is called.
  59    * @param[in] sync An object used to synchronize update & render threads.
  60    * @param[in] adaptorInterfaces base adaptor interface
  61    * @param[in] environmentOptions environment options
  62    */
  63   UpdateThread(UpdateRenderSynchronization& sync,
  64                AdaptorInternalServices& adaptorInterfaces,
  65                const EnvironmentOptions& environmentOptions );
  66
  67   /**
  68    * Non-virtual destructor; UpdateThread is not suitable as a base class.
  69    */
  70   ~UpdateThread();
  71
  72   /**
  73    * Starts the update-thread
  74    */
  75   void Start();
  76
  77   /**
  78    * Stops the update-thread
  79    */
  80   void Stop();
  81
  82 private:
  83
  84   /**
  85    * This method is used by the update-thread for calling Core::Update().
  86    * @return true, if the thread finishes properly.
  87    */
  88   bool Run();
  89
  90   /**
  91    * When DALI_FPS_TRACKING is enabled, this method calculates the frame rates for the specified time period
  92    */
  93   void FPSTracking(float secondsFromLastFrame);
  94
  95   /**
  96    * Output the FPS information
  97    * when the FSP tracking is enabled,
  98    * it is called when the specified tracking period is elapsed or in the destructor when the process finished beforehand
  99    */
 100   void OutputFPSRecord();
 101
 102   /**
 103    * Optionally output the update thread status.
 104    * @param[in] keepUpdatingStatus Whether the update-thread requested further updates.
 105    * @param[in] renderNeedsUpdate Whether the render-thread requested another update.
 106    */
 107   void UpdateStatusLogging( unsigned int keepUpdatingStatus, bool renderNeedsUpdate );
 108
 109 private: // Data
 110
 111   UpdateRenderSynchronization&        mUpdateRenderSync;    ///< Used to synchronize the update & render threads
 112
 113   Dali::Integration::Core&            mCore;                ///< Dali core reference
 114
 115   unsigned int                        mFpsTrackingSeconds;  ///< fps tracking time length in seconds
 116   std::vector<float>                  mFpsRecord;           ///< Record of frame rate
 117   float                               mElapsedTime;         ///< time elapsed within current second
 118   unsigned int                        mElapsedSeconds;      ///< seconds elapsed since the fps tracking started
 119
 120   unsigned int                        mStatusLogInterval;   ///< Interval in frames between status debug prints
 121   unsigned int                        mStatusLogCount;      ///< Used to count frames between status debug prints
 122
 123   boost::thread*                      mThread;              ///< The actual update-thread.
 124   const EnvironmentOptions&           mEnvironmentOptions;  ///< environment options
 125 }; // class UpdateThread
 126
 127 } // namespace Adaptor
 128
 129 } // namespace Internal
 130
 131 } // namespace Dali
 132
 133 #endif // __DALI_INTERNAL_UPDATE_THREAD_H__