moviefile.hpp

   1 #ifndef _moviefile__hpp__included__
   2 #define _moviefile__hpp__included__
   3
   4 #include <string>
   5 #include <vector>
   6 #include <stdexcept>
   7 #include <map>
   8 #include "controllerdata.hpp"
   9 #include "rom.hpp"
  10
  11
  12 /**
  13  * This structure gives parsed representationg of movie file, as result of decoding or for encoding.
  14  */
  15 struct moviefile
  16 {
  17 /**
  18  * This constructor construct movie structure with default settings.
  19  *
  20  * throws std::bad_alloc: Not enough memory.
  21  */
  22         moviefile() throw(std::bad_alloc);
  23
  24 /**
  25  * This constructor loads a movie/savestate file and fills structure accordingly.
  26  *
  27  * parameter filename: The file to load.
  28  * throws std::bad_alloc: Not enough memory.
  29  * throws std::runtime_error: Can't load the movie file
  30  */
  31         moviefile(const std::string& filename) throw(std::bad_alloc, std::runtime_error);
  32
  33 /**
  34  * Reads this movie structure and saves it into file.
  35  *
  36  * parameter filename: The file to save to.
  37  * parameter compression: The compression level 0-9. 0 is uncompressed.
  38  * throws std::bad_alloc: Not enough memory.
  39  * throws std::runtime_error: Can't save the movie file.
  40  */
  41         void save(const std::string& filename, unsigned compression) throw(std::bad_alloc, std::runtime_error);
  42
  43 /**
  44  * What is the ROM type and region?
  45  */
  46         gametype_t gametype;
  47 /**
  48  * What's in port #1?
  49  */
  50         porttype_t port1;
  51 /**
  52  * What's in port #2?
  53  */
  54         porttype_t port2;
  55 /**
  56  * Emulator Core version string.
  57  */
  58         std::string coreversion;
  59 /**
  60  * Name of the game
  61  */
  62         std::string gamename;
  63 /**
  64  * Project ID (used to identify if two movies are from the same project).
  65  */
  66         std::string projectid;
  67 /**
  68  * Rerecord count (only saved).
  69  */
  70         std::string rerecords;
  71 /**
  72  * SHA-256 of main ROM (empty string if none).
  73  */
  74         std::string rom_sha256;                 //SHA-256 of main ROM.
  75 /**
  76  * SHA-256 of main ROM XML (empty string if none).
  77  */
  78         std::string romxml_sha256;              //SHA-256 of main ROM XML.
  79 /**
  80  * SHA-256 of slot A ROM (empty string if none).
  81  */
  82         std::string slota_sha256;               //SHA-256 of SLOT A ROM.
  83 /**
  84  * SHA-256 of slot A XML (empty string if none).
  85  */
  86         std::string slotaxml_sha256;            //SHA-256 of SLOT A XML.
  87 /**
  88  * SHA-256 of slot B ROM (empty string if none).
  89  */
  90         std::string slotb_sha256;               //SHA-256 of SLOT B ROM.
  91 /**
  92  * SHA-256 of slot B XML (empty string if none).
  93  */
  94         std::string slotbxml_sha256;            //SHA-256 of SLOT B XML.
  95 /**
  96  * Authors of the run, first in each pair is full name, second is nickname.
  97  */
  98         std::vector<std::pair<std::string, std::string>> authors;
  99 /**
 100  * Contents of SRAM on time of initial powerup.
 101  */
 102         std::map<std::string, std::vector<char>> movie_sram;
 103 /**
 104  * True if savestate, false if movie.
 105  */
 106         bool is_savestate;
 107 /**
 108  * Contents of SRAM on time of savestate (if is_savestate is true).
 109  */
 110         std::map<std::string, std::vector<char>> sram;
 111 /**
 112  * Core savestate (if is_savestate is true).
 113  */
 114         std::vector<char> savestate;            //Savestate to load (if is_savestate is true).
 115 /**
 116  * Host memory (if is_savestate is true).
 117  */
 118         std::vector<char> host_memory;
 119 /**
 120  * Screenshot (if is_savestate is true).
 121  */
 122         std::vector<char> screenshot;
 123 /**
 124  * State of movie code (if is_savestate is true).
 125  */
 126         std::vector<char> movie_state;
 127 /**
 128  * Input for each (sub)frame.
 129  */
 130         std::vector<controls_t> input;          //Input for each frame.
 131
 132 /**
 133  * Get number of frames in movie.
 134  *
 135  * returns: Number of frames.
 136  */
 137         uint64_t get_frame_count() throw();
 138
 139 /**
 140  * Get length of the movie
 141  *
 142  * returns: Length of the movie in nanoseconds.
 143  */
 144         uint64_t get_movie_length() throw();
 145 };
 146
 147 #endif