include/core/framerate.hpp

   1 #ifndef _framerate__hpp__included__
   2 #define _framerate__hpp__included__
   3
   4 #include <cstdint>
   5 #include "library/threads.hpp"
   6 #include "library/command.hpp"
   7
   8 #define FRAMERATE_HISTORY_FRAMES 10
   9
  10 /**
  11  * Framerate regulator.
  12  */
  13 class framerate_regulator
  14 {
  15 public:
  16         framerate_regulator(command::group& _cmd);
  17 /**
  18  * Set the target speed multiplier.
  19  *
  20  * Parameter multiplier: The multiplier target. May be INFINITE.
  21  */
  22         void set_speed_multiplier(double multiplier) throw();
  23
  24 /**
  25  * Get the target speed multiplier.
  26  *
  27  * Returns: The multiplier. May be INFINITE.
  28  */
  29         double get_speed_multiplier() throw();
  30
  31 /**
  32  * Sets the nominal frame rate. Framerate limiting tries to maintain the nominal framerate when there is no other
  33  * explict framerate to maintain.
  34  */
  35         void set_nominal_framerate(double fps) throw();
  36
  37 /**
  38  * Returns the current realized framerate multiplier.
  39  *
  40  * returns: The framerate multiplier the system is currently archiving.
  41  */
  42         double get_realized_multiplier() throw();
  43
  44 /**
  45  * Freeze time.
  46  *
  47  * Parameter usec: Current time in microseconds.
  48  */
  49         void freeze_time(uint64_t usec);
  50
  51 /**
  52  * Unfreeze time.
  53  *
  54  * Parameter usec: Current time in microseconds.
  55  */
  56         void unfreeze_time(uint64_t usec);
  57
  58 /**
  59  * Acknowledge frame start for timing purposes. If time is frozen, it is automatically unfrozen.
  60  *
  61  * parameter usec: Current time (relative to some unknown epoch) in microseconds.
  62  */
  63         void ack_frame_tick(uint64_t usec) throw();
  64
  65 /**
  66  * Computes the number of microseconds to wait for next frame.
  67  *
  68  * parameter usec: Current time (relative to some unknown epoch) in microseconds.
  69  * returns: Number of more microseconds to wait.
  70  */
  71         uint64_t to_wait_frame(uint64_t usec) throw();
  72
  73 /**
  74  * Return microsecond-resolution time since unix epoch.
  75  */
  76         static uint64_t get_utime();
  77
  78 /**
  79  * Wait specified number of microseconds.
  80  */
  81         void wait_usec(uint64_t usec);
  82 /**
  83  * Turbo flag.
  84  */
  85         bool turboed;
  86 private:
  87         void set_speed_cmd(const std::string& args);
  88         uint64_t get_time(uint64_t curtime, bool update);
  89         double get_realized_fps();
  90         void add_frame(uint64_t linear_time);
  91         std::pair<bool, double> read_fps();
  92         uint64_t last_time_update;
  93         uint64_t time_at_last_update;
  94         bool time_frozen;
  95         uint64_t frame_number;
  96         uint64_t frame_start_times[FRAMERATE_HISTORY_FRAMES];
  97         //Framerate.
  98         double nominal_framerate;
  99         double multiplier_framerate;
 100         threads::lock framerate_lock;
 101         command::group& cmd;
 102         command::_fnptr<> turbo_p;
 103         command::_fnptr<> turbo_r;
 104         command::_fnptr<> turbo_t;
 105         command::_fnptr<const std::string&> setspeed_t;
 106 };
 107
 108 #endif