include/core/dispatch.hpp

   1 #ifndef _dispatch__hpp__included__
   2 #define _dispatch__hpp__included__
   3
   4 #include "core/keymapper.hpp"
   5 #include "library/framebuffer.hpp"
   6 #include "library/dispatch.hpp"
   7
   8 #include <cstdint>
   9 #include <string>
  10 #include <stdexcept>
  11 #include <set>
  12 #include <map>
  13
  14 /**
  15  * Video data region is NTSC.
  16  */
  17 #define VIDEO_REGION_NTSC 0
  18 /**
  19  * Video data region is PAL.
  20  */
  21 #define VIDEO_REGION_PAL 1
  22
  23 /**
  24  * Information about run.
  25  */
  26 struct gameinfo_struct
  27 {
  28 public:
  29 /**
  30  * Construct game info.
  31  */
  32         gameinfo_struct() throw(std::bad_alloc);
  33 /**
  34  * Game name.
  35  */
  36         std::string gamename;
  37 /**
  38  * Run length in seconds.
  39  */
  40         double length;
  41 /**
  42  * Rerecord count (base 10 ASCII)
  43  */
  44         std::string rerecords;
  45 /**
  46  * Authors. The first components are real names, the second components are nicknames. Either (but not both) may be
  47  * blank.
  48  */
  49         std::vector<std::pair<std::string, std::string>> authors;
  50 /**
  51  * Format human-redable representation of the length.
  52  *
  53  * Parameter digits: Number of sub-second digits to use.
  54  * Returns: The time formated.
  55  * Throws std::bad_alloc: Not enough memory.
  56  */
  57         std::string get_readable_time(unsigned digits) const throw(std::bad_alloc);
  58 /**
  59  * Get number of authors.
  60  *
  61  * Returns: Number of authors.
  62  */
  63         size_t get_author_count() const throw();
  64 /**
  65  * Get short name of author (nickname if present, otherwise full name).
  66  *
  67  * Parameter idx: Index of author (0-based).
  68  * Returns: The short name.
  69  * Throws std::bad_alloc: Not enough memory.
  70  */
  71         std::string get_author_short(size_t idx) const throw(std::bad_alloc);
  72 /**
  73  * Get rerecord count as a number. If rerecord count is too high, returns the maximum representatible count.
  74  *
  75  * Returns: The rerecord count.
  76  */
  77         uint64_t get_rerecords() const throw();
  78 };
  79
  80
  81 /**
  82  * Information dispatch.
  83  *
  84  * This class handles dispatching information between the components of the emulator.
  85  *
  86  * Each kind of information has virtual method on_foo() which can be overridden to handle events of that type, and
  87  * static method do_foo(), which calls on_foo on all known objects.
  88  *
  89  * The information is delivered to each instance of this class.
  90  */
  91 class information_dispatch
  92 {
  93 public:
  94 /**
  95  * Create new object to receive information dispatch events.
  96  *
  97  * Parameter name: The name for the object.
  98  * Throws std::bad_alloc: Not enough memory.
  99  */
 100         information_dispatch(const std::string& name) throw(std::bad_alloc);
 101 /**
 102  * Destroy object.
 103  */
 104         virtual ~information_dispatch() throw();
 105 /**
 106  * A frame has been received.
 107  *
 108  * The default handler does nothing.
 109  *
 110  * Parameter _frame: The frame object.
 111  * Parameter fps_n: Numerator of current video fps.
 112  * Parameter fps_d: Denominator of current video fps.
 113  */
 114         virtual void on_frame(struct framebuffer_raw& _frame, uint32_t fps_n, uint32_t fps_d);
 115 /**
 116  * Call all on_frame() handlers.
 117  *
 118  * Calls on_new_dumper() on dumpers that had that not yet called.
 119  */
 120         static void do_frame(struct framebuffer_raw& _frame, uint32_t fps_n, uint32_t fps_d) throw();
 121 /**
 122  * A sample has been received.
 123  *
 124  * The default handler does nothing.
 125  *
 126  * Parameter l: The left channel sample (16 bit signed).
 127  * Parameter r: The right channel sample (16 bit signed).
 128  */
 129         virtual void on_sample(short l, short r);
 130 /**
 131  * Call all on_sample() handlers.
 132  *
 133  * Calls on_new_dumper() on dumpers that had that not yet called.
 134  */
 135         static void do_sample(short l, short r) throw();
 136 /**
 137  * Dump is ending.
 138  *
 139  * Calls on_new_dumper() on dumpers that had that not yet called.
 140  *
 141  * The default handler does nothing.
 142  */
 143         virtual void on_dump_end();
 144 /**
 145  * Call all on_dump_end() handlers.
 146  */
 147         static void do_dump_end() throw();
 148 /**
 149  * Sound sampling rate is changing
 150  *
 151  * The default handler prints warning if dumper flag is set.
 152  *
 153  * Parameter rate_n: Numerator of the new sampling rate in Hz.
 154  * Parameter rate_d: Denominator of the new sampling rate in Hz.
 155  */
 156         virtual void on_sound_rate(uint32_t rate_n, uint32_t rate_d);
 157 /**
 158  * Call all on_sound_rate() methods and save the parameters.
 159  *
 160  * Calls on_new_dumper() on dumpers that had that not yet called.
 161  */
 162         static void do_sound_rate(uint32_t rate_n, uint32_t rate_d) throw();
 163 /**
 164  * Get the sound rate most recently set by on_sound_rate().
 165  *
 166  * Returns: The first component is the numerator, the second is the denominator.
 167  */
 168         static std::pair<uint32_t, uint32_t> get_sound_rate() throw();
 169 /**
 170  * Game information is changing.
 171  *
 172  * The default handler does nothing.
 173  *
 174  * Parameter gi: The new game info.
 175  */
 176         virtual void on_gameinfo(const struct gameinfo_struct& gi);
 177 /**
 178  * Call all on_gameinfo() handlers and save the gameinfo.
 179  */
 180         static void do_gameinfo(const struct gameinfo_struct& gi) throw();
 181 /**
 182  * Get the gameinfo most recently set by do_gameinfo().
 183  *
 184  * Returns: The gameinfo.
 185  */
 186         static const struct gameinfo_struct& get_gameinfo() throw();
 187 /**
 188  * Return the dumper flag for this dispatch target.
 189  *
 190  * The default implementation returns false.
 191  *
 192  * If dumper flag is set:
 193  *      - on_sound_rate() default handler prints a warning.
 194  *      - All dumping related do_* functions triggers calls to to on_new_dumper() on all handlers the next time they
 195  *        are called.
 196  *      - Destroying the handler triggers calls to on_destroy_dumper() on all handlers (if on_new_dumper() has been
 197  *        called).
 198  */
 199         virtual bool get_dumper_flag() throw();
 200 /**
 201  * Notify that a new dumper is joining.
 202  *
 203  * Parameter dumper: The name of the dumper object.
 204  */
 205         virtual void on_new_dumper(const std::string& dumper);
 206 /**
 207  * Notify that a dumper is leaving.
 208  *
 209  * Parameter dumper: The name of the dumper object.
 210  */
 211         virtual void on_destroy_dumper(const std::string& dumper);
 212 /**
 213  * Get number of active dumpers.
 214  *
 215  * Calls on_new_dumper() on dumpers that had that not yet called.
 216  *
 217  * Returns: The dumper count.
 218  */
 219         static unsigned get_dumper_count() throw();
 220 /**
 221  * Get set of active dumpers.
 222  *
 223  * Calls on_new_dumper() on dumpers that had that not yet called.
 224  *
 225  * Returns: The set of dumper names.
 226  * Throws std::bad_alloc: Not enough memory.
 227  */
 228         static std::set<std::string> get_dumpers() throw(std::bad_alloc);
 229 /**
 230  * Get name of target.
 231  */
 232         const std::string& get_name() throw();
 233 /**
 234  * Notify that some dumper has attached, deattached, popped into existence or disappeared.
 235  *
 236  * Default implementation does nothing.
 237  */
 238         virtual void on_dumper_update();
 239 /**
 240  * Call on_dumper_update on on all objects.
 241  */
 242         static void do_dumper_update() throw();
 243 protected:
 244 /**
 245  * Call to indicate this target is interested in sound sample data.
 246  */
 247         void enable_send_sound() throw(std::bad_alloc);
 248 private:
 249         static void update_dumpers(bool nocalls = false) throw();
 250         bool known_if_dumper;
 251         bool marked_as_dumper;
 252         std::string target_name;
 253         bool notified_as_dumper;
 254 };
 255
 256 void dispatch_set_error_streams(std::ostream* stream);
 257
 258 extern struct dispatcher<> notify_autohold_reconfigure;
 259 extern struct dispatcher<unsigned, unsigned, unsigned, bool> notify_autohold_update;
 260 extern struct dispatcher<unsigned, unsigned, unsigned, unsigned, unsigned> notify_autofire_update;
 261 extern struct dispatcher<> notify_close;
 262 extern struct dispatcher<framebuffer<false>&> notify_set_screen;
 263 extern struct dispatcher<std::pair<std::string, std::string>> notify_sound_change;
 264 extern struct dispatcher<> notify_screen_update;
 265 extern struct dispatcher<> notify_status_update;
 266 extern struct dispatcher<bool> notify_sound_unmute;
 267 extern struct dispatcher<bool> notify_mode_change;
 268 extern struct dispatcher<> notify_core_change;
 269 extern struct dispatcher<bool> notify_core_changed;
 270 extern struct dispatcher<> notify_new_core;
 271 extern struct dispatcher<> notify_voice_stream_change;
 272 extern struct dispatcher<> notify_vu_change;
 273 extern struct dispatcher<> notify_subtitle_change;
 274
 275 #endif