bsnes/emulator/interface.hpp

#ifndef EMULATOR_INTERFACE_HPP
#define EMULATOR_INTERFACE_HPP

namespace Emulator {

struct Interface {
  struct Information {
    string name;
    unsigned width;
    unsigned height;
    bool overscan;
    double aspectRatio;
    bool resettable;
    struct Capability {
      bool states;
      bool cheats;
    } capability;
  } information;

  struct Media {
    unsigned id;
    string name;
    string type;
    bool bootable;  //false for cartridge slots (eg Sufami Turbo cartridges)
  };
  vector<Media> media;

  struct Device {
    unsigned id;
    unsigned portmask;
    string name;
    struct Input {
      unsigned id;
      unsigned type;  //0 = digital, 1 = analog (relative), 2 = analog (absolute), 3 = rumble
      string name;
      unsigned guid;
    };
    vector<Input> input;
    vector<unsigned> order;
  };

  struct Port {
    unsigned id;
    string name;
    vector<Device> device;
  };
  vector<Port> port;

  struct Bind {
    virtual void loadRequest(unsigned, string, string) {}
    virtual void loadRequest(unsigned, string) {}
    virtual void saveRequest(unsigned, string) {}
    virtual uint32_t videoColor(unsigned, uint16_t, uint16_t, uint16_t, uint16_t) { return 0u; }
    virtual void videoRefresh(const uint32_t*, const uint32_t*, unsigned, unsigned, unsigned) {}
    virtual void audioSample(int16_t, int16_t) {}
    virtual int16_t inputPoll(unsigned, unsigned, unsigned) { return 0; }
    virtual void inputRumble(unsigned, unsigned, unsigned, bool) {}
    virtual unsigned dipSettings(const Markup::Node&) { return 0; }
    virtual string path(unsigned) { return ""; }
    virtual string server() { return ""; }
    virtual void notify(string text) { print(text, "\n"); }
  };
  Bind* bind = nullptr;

  //callback bindings (provided by user interface)
  void loadRequest(unsigned id, string name, string type) { return bind->loadRequest(id, name, type); }
  void loadRequest(unsigned id, string path) { return bind->loadRequest(id, path); }
  void saveRequest(unsigned id, string path) { return bind->saveRequest(id, path); }
  uint32_t videoColor(unsigned source, uint16_t alpha, uint16_t red, uint16_t green, uint16_t blue) { return bind->videoColor(source, alpha, red, green, blue); }
  void videoRefresh(const uint32_t* palette, const uint32_t* data, unsigned pitch, unsigned width, unsigned height) { return bind->videoRefresh(palette, data, pitch, width, height); }
  void audioSample(int16_t lsample, int16_t rsample) { return bind->audioSample(lsample, rsample); }
  int16_t inputPoll(unsigned port, unsigned device, unsigned input) { return bind->inputPoll(port, device, input); }
  void inputRumble(unsigned port, unsigned device, unsigned input, bool enable) { return bind->inputRumble(port, device, input, enable); }
  unsigned dipSettings(const Markup::Node& node) { return bind->dipSettings(node); }
  string path(unsigned group) { return bind->path(group); }
  string server() { return bind->server(); }
  template<typename... Args> void notify(Args&&... args) { return bind->notify({std::forward<Args>(args)...}); }

  //information
  virtual string title() = 0;
  virtual double videoFrequency() = 0;
  virtual double audioFrequency() = 0;

  //media interface
  virtual bool loaded() { return false; }
  virtual string sha256() { return ""; }
  virtual unsigned group(unsigned id) = 0;
  virtual void load(unsigned id) {}
  virtual void save() {}
  virtual void load(unsigned id, const stream& memory) {}
  virtual void save(unsigned id, const stream& memory) {}
  virtual void unload() {}

  //system interface
  virtual void connect(unsigned port, unsigned device) {}
  virtual void power() {}
  virtual void reset() {}
  virtual void run() {}

  //time functions
  virtual bool rtc() { return false; }
  virtual void rtcsync() {}

  //state functions
  virtual serializer serialize() = 0;
  virtual bool unserialize(serializer&) = 0;

  //cheat functions
  virtual void cheatSet(const lstring& = lstring{}) {}

  //utility functions
  enum class PaletteMode : unsigned { Literal, Channel, Standard, Emulation };
  virtual void paletteUpdate(PaletteMode mode) {}

  //debugger functions
  virtual bool tracerEnable(bool) { return false; }
  virtual void exportMemory() {}
};

}

#endif