1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
mod apu;
mod cartridge;
mod cpu;
mod joypad;
mod memory;
mod ppu;
mod printer;
mod save_error;
mod serial;
mod timer;
#[cfg(test)]
mod tests;
use std::cell::RefCell;
use std::fs::File;
use std::io::{Cursor, Read, Seek, SeekFrom, Write};
use std::path::{Path, PathBuf};
use std::rc::Rc;
use save_state::Savable;
use cartridge::Cartridge;
use cpu::Cpu;
use memory::Bus;
pub use apu::AudioBuffers;
pub use cartridge::CartridgeError;
pub use joypad::JoypadButton;
pub use printer::Printer;
pub use save_error::SaveError;
pub use serial::SerialDevice;
pub const SAVE_STATE_VERSION: usize = 2;
const SAVE_STATE_MAGIC: &[u8; 4] = b"MST\xee";
const SAVE_STATE_ZSTD_COMPRESSION_LEVEL: i32 = 0;
#[derive(Debug, Default, Clone, Copy, Savable)]
pub struct GameBoyConfig {
pub is_dmg: bool,
}
impl GameBoyConfig {
pub fn boot_rom_len(&self) -> usize {
if self.is_dmg {
0x100
} else {
0x900
}
}
}
pub struct GameBoyBuilder {
config: GameBoyConfig,
rom_file: PathBuf,
boot_rom_file: Option<PathBuf>,
sram_file: Option<PathBuf>,
save_on_shutdown: bool,
}
impl GameBoyBuilder {
pub fn config(mut self, config: GameBoyConfig) -> Self {
self.config = config;
self
}
pub fn boot_rom_file<P: AsRef<Path>>(mut self, boot_rom_file: P) -> Self {
self.boot_rom_file = Some(boot_rom_file.as_ref().to_path_buf());
self
}
pub fn sram_file<P: AsRef<Path>>(mut self, save_file: P) -> Self {
self.sram_file = Some(save_file.as_ref().to_path_buf());
self
}
pub fn save_on_shutdown(mut self, save_on_shutdown: bool) -> Self {
self.save_on_shutdown = save_on_shutdown;
self
}
pub fn build(self) -> Result<GameBoy, CartridgeError> {
GameBoy::build(self)
}
}
pub struct GameBoy {
cpu: Cpu,
bus: Bus,
}
impl GameBoy {
pub fn builder<RomP: AsRef<Path>>(rom_file: RomP) -> GameBoyBuilder {
GameBoyBuilder {
config: GameBoyConfig::default(),
rom_file: rom_file.as_ref().to_path_buf(),
boot_rom_file: None,
sram_file: None,
save_on_shutdown: true,
}
}
fn build(builder: GameBoyBuilder) -> Result<Self, CartridgeError> {
let file_path = builder.rom_file;
let sram_file_path = builder.sram_file;
let boot_rom_file_path = builder.boot_rom_file;
let config = builder.config;
let save_on_shutdown = builder.save_on_shutdown;
let cartridge = Cartridge::from_file(file_path, sram_file_path, save_on_shutdown)?;
let (bus, cpu) = if let Some(boot_rom_file) = boot_rom_file_path {
let mut boot_rom_file = File::open(boot_rom_file)?;
let mut data = vec![0; config.boot_rom_len()];
assert_eq!(
boot_rom_file.metadata()?.len(),
data.len() as u64,
"boot_rom file size is not correct"
);
boot_rom_file.read_exact(&mut data)?;
(
Bus::new_with_boot_rom(cartridge, data, config),
Cpu::new(config),
)
} else {
let is_cartridge_color = cartridge.is_cartridge_color();
(
Bus::new_without_boot_rom(cartridge, config),
Cpu::new_without_boot_rom(config, is_cartridge_color),
)
};
Ok(Self { bus, cpu })
}
pub fn clock_for_frame(&mut self) {
const PPU_CYCLES_PER_FRAME: u32 = 456 * 154;
let mut cycles = 0u32;
while cycles < PPU_CYCLES_PER_FRAME {
self.cpu.next_instruction(&mut self.bus);
cycles += self.bus.elapsed_ppu_cycles() as u32;
}
}
pub fn game_title(&self) -> &str {
self.bus.cartridge().game_title()
}
pub fn file_path(&self) -> &Path {
self.bus.cartridge().file_path()
}
pub fn screen_buffer(&self) -> &[u8] {
self.bus.screen_buffer()
}
pub fn audio_buffers(&mut self) -> AudioBuffers {
self.bus.audio_buffers()
}
pub fn press_joypad(&mut self, button: JoypadButton) {
self.bus.press_joypad(button);
}
pub fn release_joypad(&mut self, button: JoypadButton) {
self.bus.release_joypad(button);
}
pub fn connect_device(&mut self, device: Rc<RefCell<dyn SerialDevice>>) {
self.bus.connect_device(device);
}
pub fn disconnect_device(&mut self) {
self.bus.disconnect_device();
}
pub fn save_state<W: Write>(&self, mut writer: W) -> Result<(), SaveError> {
SAVE_STATE_MAGIC.save(&mut writer)?;
SAVE_STATE_VERSION.save(&mut writer)?;
let cartridge_hash: &[u8; 32] = self.bus.cartridge().hash();
cartridge_hash.save(&mut writer)?;
let mut writer = zstd::Encoder::new(&mut writer, SAVE_STATE_ZSTD_COMPRESSION_LEVEL)?;
self.cpu.save(&mut writer)?;
self.bus.save(&mut writer)?;
let _writer = writer.finish()?;
Ok(())
}
pub fn load_state<R: Read + Seek>(&mut self, mut reader: R) -> Result<(), SaveError> {
let mut recovery_save_state = Vec::new();
self.cpu
.save(&mut recovery_save_state)
.expect("recovery save cpu");
self.bus
.save(&mut recovery_save_state)
.expect("recovery save bus");
let mut load_routine = || {
let mut magic = [0u8; 4];
let mut version = 0usize;
let mut hash = [0u8; 32];
magic.load(&mut reader)?;
if &magic != SAVE_STATE_MAGIC {
return Err(SaveError::InvalidSaveStateHeader);
}
version.load(&mut reader)?;
hash.load(&mut reader)?;
if &hash != self.bus.cartridge().hash() {
return Err(SaveError::InvalidCartridgeHash);
}
{
let mut second_stage_reader: Box<dyn Read>;
if version == 1 && SAVE_STATE_VERSION == 2 {
second_stage_reader = Box::new(&mut reader);
} else if version != SAVE_STATE_VERSION {
return Err(SaveError::UnmatchedSaveErrorVersion(version));
} else {
second_stage_reader = Box::new(zstd::Decoder::new(&mut reader)?);
}
self.cpu.load(&mut second_stage_reader)?;
self.bus.load(&mut second_stage_reader)?;
}
let stream_current_pos = reader.stream_position()?;
reader.seek(SeekFrom::End(0))?;
let stream_last_pos = reader.stream_position()?;
let (remaining_data_len, overflow) =
stream_last_pos.overflowing_sub(stream_current_pos);
assert!(!overflow);
if remaining_data_len > 0 {
reader.seek(SeekFrom::Start(stream_current_pos))?;
Err(SaveError::SaveStateError(save_state::Error::TrailingData(
remaining_data_len,
)))
} else {
Ok(())
}
};
if let Err(err) = load_routine() {
let mut cursor = Cursor::new(&recovery_save_state);
self.cpu.load(&mut cursor).expect("recovery load cpu");
self.bus.load(&mut cursor).expect("recovery load bus");
Err(err)
} else {
Ok(())
}
}
}