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  * Increase the speed to next step.
  26  */
  27         void increase_speed() throw();
  28
  29 /**
  30  * Decrease the speed to next step.
  31  */
  32         void decrease_speed() throw();
  33
  34 /**
  35  * Get the target speed multiplier.
  36  *
  37  * Returns: The multiplier. May be INFINITE.
  38  */
  39         double get_speed_multiplier() throw();
  40
  41 /**
  42  * Sets the nominal frame rate. Framerate limiting tries to maintain the nominal framerate when there is no other
  43  * explict framerate to maintain.
  44  */
  45         void set_nominal_framerate(double fps) throw();
  46
  47 /**
  48  * Returns the current realized framerate multiplier.
  49  *
  50  * returns: The framerate multiplier the system is currently archiving.
  51  */
  52         double get_realized_multiplier() throw();
  53
  54 /**
  55  * Freeze time.
  56  *
  57  * Parameter usec: Current time in microseconds.
  58  */
  59         void freeze_time(uint64_t usec);
  60
  61 /**
  62  * Unfreeze time.
  63  *
  64  * Parameter usec: Current time in microseconds.
  65  */
  66         void unfreeze_time(uint64_t usec);
  67
  68 /**
  69  * Acknowledge frame start for timing purposes. If time is frozen, it is automatically unfrozen.
  70  *
  71  * parameter usec: Current time (relative to some unknown epoch) in microseconds.
  72  */
  73         void ack_frame_tick(uint64_t usec) throw();
  74
  75 /**
  76  * Computes the number of microseconds to wait for next frame.
  77  *
  78  * parameter usec: Current time (relative to some unknown epoch) in microseconds.
  79  * returns: Number of more microseconds to wait.
  80  */
  81         uint64_t to_wait_frame(uint64_t usec) throw();
  82
  83 /**
  84  * Return microsecond-resolution time since unix epoch.
  85  */
  86         static uint64_t get_utime();
  87
  88 /**
  89  * Wait specified number of microseconds.
  90  */
  91         void wait_usec(uint64_t usec);
  92 /**
  93  * Turbo flag.
  94  */
  95         bool turboed;
  96 private:
  97         void set_speed_cmd(const std::string& args);
  98         uint64_t get_time(uint64_t curtime, bool update);
  99         double get_realized_fps();
 100         void add_frame(uint64_t linear_time);
 101         std::pair<bool, double> read_fps();
 102         //Step should be ODD.
 103         void set_speedstep(unsigned step);
 104         //Step can be EVEN if between steps.
 105         unsigned get_speedstep();
 106         uint64_t last_time_update;
 107         uint64_t time_at_last_update;
 108         bool time_frozen;
 109         uint64_t frame_number;
 110         uint64_t frame_start_times[FRAMERATE_HISTORY_FRAMES];
 111         //Framerate.
 112         double nominal_framerate;
 113         double multiplier_framerate;
 114         bool framerate_realtime_locked;
 115         threads::lock framerate_lock;
 116         command::group& cmd;
 117         command::_fnptr<> turbo_p;
 118         command::_fnptr<> turbo_r;
 119         command::_fnptr<> turbo_t;
 120         command::_fnptr<const std::string&> setspeed_t;
 121         command::_fnptr<> spd_inc;
 122         command::_fnptr<> spd_dec;
 123 };
 124
 125 #endif