avsnoop.hpp

   1 #ifndef _avsnoop__hpp__included__
   2 #define _avsnoop__hpp__included__
   3
   4 #include "render.hpp"
   5 #include <list>
   6 #include <string>
   7 #include <stdexcept>
   8
   9 /**
  10  * A/V snooper.
  11  */
  12 class av_snooper
  13 {
  14 public:
  15 /**
  16  * Create new A/V snooper.
  17  *
  18  * throws std::bad_alloc: Not enough memory.
  19  */
  20         av_snooper() throw(std::bad_alloc);
  21
  22 /**
  23  * Destroy A/V snooper. This will not call end method.
  24  */
  25         ~av_snooper() throw();
  26
  27 /**
  28  * Dump a frame.
  29  *
  30  * parameter _frame: The frame to dump.
  31  * parameter fps_n: Current fps numerator.
  32  * parameter fps_d: Current fps denomerator.
  33  * throws std::bad_alloc: Not enough memory.
  34  * throws std::runtime_error: Error dumping frame.
  35  */
  36         virtual void frame(struct lcscreen& _frame, uint32_t fps_n, uint32_t fps_d) throw(std::bad_alloc,
  37                 std::runtime_error) = 0;
  38
  39 /**
  40  * Dump a frame.
  41  *
  42  * parameter _frame: The frame to dump.
  43  * parameter fps_n: Current fps numerator.
  44  * parameter fps_d: Current fps denomerator.
  45  * throws std::bad_alloc: Not enough memory.
  46  */
  47         static void frame(struct lcscreen& _frame, uint32_t fps_n, uint32_t fps_d, bool dummy)
  48                 throw(std::bad_alloc);
  49
  50 /**
  51  * Dump a sample.
  52  *
  53  * parameter l: Left channel sample.
  54  * parameter r: Right channel sample.
  55  * throws std::bad_alloc: Not enough memory.
  56  * throws std::runtime_error: Error dumping sample.
  57  */
  58         virtual void sample(short l, short r) throw(std::bad_alloc, std::runtime_error) = 0;
  59
  60 /**
  61  * Dump a sample.
  62  *
  63  * parameter l: Left channel sample.
  64  * parameter r: Right channel sample.
  65  * throws std::bad_alloc: Not enough memory.
  66  */
  67         static void sample(short l, short r, bool dummy) throw(std::bad_alloc);
  68
  69 /**
  70  * End dump.
  71  *
  72  * throws std::bad_alloc: Not enough memory.
  73  * throws std::runtime_error: Error dumping sample.
  74  */
  75         virtual void end() throw(std::bad_alloc, std::runtime_error) = 0;
  76
  77 /**
  78  * End dump.
  79  *
  80  * throws std::bad_alloc: Not enough memory.
  81  */
  82         static void end(bool dummy) throw(std::bad_alloc);
  83
  84 /**
  85  * Notify game information.
  86  *
  87  * parameter gamename: Name of the game.
  88  * parameter authors: Authors of the run.
  89  * parameter gametime: Game time.
  90  * parameter rercords: Rerecord count.
  91  * throws std::bad_alloc: Not enough memory.
  92  * throws std::runtime_error: Error recording this info.
  93  */
  94         virtual void gameinfo(const std::string& gamename, const std::list<std::pair<std::string, std::string>>&
  95                 authors, double gametime, const std::string& rerecords) throw(std::bad_alloc, std::runtime_error) = 0;
  96
  97 /**
  98  * Notify game information.
  99  *
 100  * parameter gamename: Name of the game.
 101  * parameter authors: Authors of the run.
 102  * parameter gametime: Game time.
 103  * parameter rercords: Rerecord count.
 104  * throws std::bad_alloc Not enough memory.
 105  */
 106         static void gameinfo(const std::string& gamename, const std::list<std::pair<std::string, std::string>>&
 107                 authors, double gametime, const std::string& rerecords, bool dummy) throw(std::bad_alloc);
 108
 109 /**
 110  * Send game info. This causes gameinfo method to be called on object this method is called on.
 111  */
 112         void send_gameinfo() throw();
 113
 114 /**
 115  * Is there dump in progress?
 116  *
 117  * returns: True if dump is in progress, false if not.
 118  */
 119         static bool dump_in_progress() throw();
 120
 121 /**
 122  * Notifier for dumps starting/ending.
 123  */
 124         class dump_notification
 125         {
 126         public:
 127 /**
 128  * Destructor.
 129  */
 130                 virtual ~dump_notification() throw();
 131 /**
 132  * New dump starting.
 133  */
 134                 virtual void dump_starting() throw();
 135 /**
 136  * Dump ending.
 137  */
 138                 virtual void dump_ending() throw();
 139         };
 140
 141 /**
 142  * Add a notifier.
 143  *
 144  * parameter notifier: New notifier to add.
 145  */
 146         static void add_dump_notifier(dump_notification& notifier) throw(std::bad_alloc);
 147
 148 /**
 149  * Remove a notifier.
 150  *
 151  * parameter notifier: Existing notifier to remove.
 152  */
 153         static void remove_dump_notifier(dump_notification& notifier) throw();
 154 };
 155
 156 #endif