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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
use crate::{
    common::{home_dir, Clocked, Powered, CONFIG_DIR},
    map_nes_err, mapper,
    mapper::Mapper,
    nes::{event::FrameEvent, Nes, REWIND_SIZE, REWIND_SLOT, REWIND_TIMER},
    nes_err,
    serialization::{validate_save_header, write_save_header, Savable},
    NesResult,
};
use chrono::prelude::{DateTime, Local};
use log::error;
use std::{
    collections::VecDeque,
    fs::File,
    io::{BufReader, BufWriter, Read, Write},
    path::{Path, PathBuf},
};

impl Nes {
    pub(super) fn paused(&mut self, paused: bool) {
        if !self.paused && paused {
            self.set_static_message("Paused");
        } else if !paused {
            self.unset_static_message("Paused");
        }
        self.paused = paused;
    }

    /// Loads a ROM cartridge into memory
    pub(super) fn load_rom(&mut self, rom_id: usize) -> NesResult<()> {
        self.loaded_rom = self.roms[rom_id].to_owned();
        let rom = File::open(&self.loaded_rom)
            .map_err(|e| map_nes_err!("unable to open file {:?}: {}", self.loaded_rom, e))?;
        let mut rom = BufReader::new(rom);
        let mapper = mapper::load_rom(&self.loaded_rom.to_string_lossy(), &mut rom)?;
        self.cpu.bus.load_mapper(mapper);
        Ok(())
    }

    /// Changes the savestate slot
    pub(super) fn set_save_slot(&mut self, slot: u8) {
        if self.config.save_enabled {
            if self.config.save_slot != slot {
                self.config.save_slot = slot;
                self.add_message(&format!("Set Save Slot to {}", slot));
            }
        } else {
            self.add_message("Savestates Disabled");
        }
    }

    /// Save the current state of the console into a save file
    pub(super) fn save_state(&mut self, slot: u8, rewind: bool) {
        if self.config.save_enabled || (rewind && self.config.rewind_enabled) {
            let save = || -> NesResult<()> {
                let save_path = save_path(&self.loaded_rom, slot)?;
                let save_dir = save_path.parent().unwrap(); // Safe to do because save_path is never root
                if !save_dir.exists() {
                    std::fs::create_dir_all(save_dir).map_err(|e| {
                        map_nes_err!("failed to create directory {:?}: {}", save_dir.display(), e)
                    })?;
                }
                let save_file = std::fs::File::create(&save_path).map_err(|e| {
                    map_nes_err!("failed to create file {:?}: {}", save_path.display(), e)
                })?;
                let mut writer = BufWriter::new(save_file);
                write_save_header(&mut writer).map_err(|e| {
                    map_nes_err!("failed to write header {:?}: {}", save_path.display(), e)
                })?;
                self.save(&mut writer)?;
                Ok(())
            };
            let save = save();
            if !rewind {
                match save {
                    Ok(_) => self.add_message(&format!("Saved Slot {}", slot)),
                    Err(e) => self.add_message(&e.to_string()),
                }
            } else if let Err(e) = save {
                eprintln!("{}", &e.to_string());
            }
        } else {
            self.add_message("Savestates Disabled");
        }
    }

    /// Load the console with data saved from a save state
    pub(super) fn load_state(&mut self, slot: u8, rewind: bool) {
        if self.config.save_enabled || (rewind && self.config.rewind_enabled) {
            if let Ok(save_path) = save_path(&self.loaded_rom, slot) {
                if save_path.exists() {
                    let mut load = || -> NesResult<()> {
                        let save_file = std::fs::File::open(&save_path).map_err(|e| {
                            map_nes_err!("Failed to open file {:?}: {}", save_path.display(), e)
                        })?;
                        let mut reader = BufReader::new(save_file);
                        match validate_save_header(&mut reader) {
                            Ok(_) => {
                                if let Err(e) = self.load(&mut reader) {
                                    self.power_cycle();
                                    return nes_err!("Failed to load savestate #{}: {}", slot, e);
                                }
                            }
                            Err(e) => return nes_err!("Failed to load savestate #{}: {}", slot, e),
                        }
                        Ok(())
                    };
                    let load = load();
                    if !rewind {
                        match load {
                            Ok(()) => self.add_message(&format!("Loaded Slot {}", slot)),
                            Err(e) => self.add_message(&e.to_string()),
                        }
                    } else if let Err(e) = load {
                        eprintln!("{}", &e.to_string());
                    }
                }
            }
        } else {
            self.add_message("Savestates Disabled");
        }
    }

    pub(super) fn save_rewind(&mut self, elapsed: f32) {
        if self.config.rewind_enabled {
            self.rewind_timer -= elapsed;
            if self.rewind_timer <= 0.0 {
                self.rewind_timer = REWIND_TIMER;
                let rewind_slot = if self.rewind_queue.len() >= REWIND_SIZE as usize {
                    self.rewind_queue.pop_front().unwrap() // Safe to unwrap
                } else {
                    REWIND_SLOT + self.rewind_queue.len() as u8
                };
                let rewind = true;
                self.save_state(rewind_slot, rewind);
                self.rewind_queue.push_back(rewind_slot);
            }
        }
    }

    pub(super) fn rewind(&mut self) {
        if self.config.rewind_enabled {
            if let Some(rewind_slot) = self.rewind_queue.pop_back() {
                self.add_message("Rewind");
                let rewind = true;
                self.load_state(rewind_slot, rewind);
            }
        } else {
            self.add_message("Rewind disabled");
        }
    }

    /// Save battery-backed Save RAM to a file (if cartridge supports it)
    pub(super) fn save_sram(&mut self) -> NesResult<()> {
        let mapper = &self.cpu.bus.mapper;
        if mapper.battery_backed() {
            let sram_path = sram_path(&self.loaded_rom)?;
            let sram_dir = sram_path.parent().unwrap(); // Safe to do because sram_path is never root
            if !sram_dir.exists() {
                std::fs::create_dir_all(sram_dir).map_err(|e| {
                    map_nes_err!("failed to create directory {:?}: {}", sram_dir.display(), e)
                })?;
            }

            let mut sram_opts = std::fs::OpenOptions::new()
                .read(true)
                .write(true)
                .create(true)
                .open(&sram_path)
                .map_err(|e| {
                    map_nes_err!("failed to open file {:?}: {}", sram_path.display(), e)
                })?;

            // Empty file means we just created it
            if sram_opts.metadata()?.len() == 0 {
                let mut sram_file = BufWriter::new(sram_opts);
                write_save_header(&mut sram_file).map_err(|e| {
                    map_nes_err!("failed to write header {:?}: {}", sram_path.display(), e)
                })?;
                mapper.save_sram(&mut sram_file)?;
            } else {
                // Check if exists and header is different, so we avoid overwriting
                match validate_save_header(&mut sram_opts) {
                    Ok(_) => {
                        let mut sram_file = BufWriter::new(sram_opts);
                        mapper.save_sram(&mut sram_file)?;
                    }
                    Err(e) => {
                        return nes_err!("failed to write sram due to invalid header. error: {}", e)
                    }
                }
            }
        }
        Ok(())
    }

    /// Load battery-backed Save RAM from a file (if cartridge supports it)
    pub(super) fn load_sram(&mut self) -> NesResult<()> {
        let mapper = &mut self.cpu.bus.mapper;
        if mapper.battery_backed() {
            let sram_path = sram_path(&self.loaded_rom)?;
            if sram_path.exists() {
                let sram_file = std::fs::File::open(&sram_path).map_err(|e| {
                    map_nes_err!("failed to open file {:?}: {}", sram_path.display(), e)
                })?;
                let mut sram_file = BufReader::new(sram_file);
                match validate_save_header(&mut sram_file) {
                            Ok(_) => {
                                if let Err(e) = mapper.load_sram(&mut sram_file) {
                                    return nes_err!("failed to load save sram: {}", e);
                                }
                            }
                            Err(e) => return nes_err!(
                                "failed to load sram: {}.\n  move or delete `{}` before exiting, otherwise sram data will be lost.",
                                e,
                                sram_path.display()
                            ),
                        }
            }
        }
        Ok(())
    }

    /// Saves the replay buffer out to a file
    pub fn save_replay(&mut self) -> NesResult<()> {
        let datetime: DateTime<Local> = Local::now();
        let mut path = PathBuf::from(datetime.format("tetanes_%Y-%m-%d_at_%H.%M.%S").to_string());
        path.set_extension("replay");
        let file = std::fs::File::create(&path)?;
        let mut file = BufWriter::new(file);
        self.replay_buffer.save(&mut file)?;
        println!("Saved replay: {:?}", path);
        Ok(())
    }

    /// Loads a replay file into a Vec
    pub(super) fn load_replay(&self) -> NesResult<Vec<FrameEvent>> {
        if let Some(replay) = &self.config.replay {
            let file = std::fs::File::open(&PathBuf::from(replay))
                .map_err(|e| map_nes_err!("failed to open file {:?}: {}", replay, e))?;
            let mut file = BufReader::new(file);
            let mut buffer: Vec<FrameEvent> = Vec::new();
            buffer.load(&mut file)?;
            buffer.reverse();
            Ok(buffer)
        } else {
            Ok(Vec::new())
        }
    }

    /// Searches for valid NES rom files ending in `.nes`
    ///
    /// If rom_path is a `.nes` file, uses that
    /// If no arg[1], searches current directory for `.nes` files
    pub(super) fn find_roms(&self) -> NesResult<Vec<PathBuf>> {
        use std::ffi::OsStr;
        let path = self.config.path.to_owned();
        let mut roms: Vec<PathBuf> = Vec::new();
        if path.is_dir() {
            path.read_dir()
                .map_err(|e| map_nes_err!("unable to read directory {:?}: {}", path, e))?
                .filter_map(|f| f.ok())
                .filter(|f| f.path().extension() == Some(OsStr::new("nes")))
                .for_each(|f| roms.push(f.path()));
        } else if path.is_file() {
            roms.push(path.clone());
        } else {
            nes_err!("invalid path: {:?}", path)?;
        }
        if roms.is_empty() {
            nes_err!("no rom files found or specified in {:?}", path)
        } else {
            Ok(roms)
        }
    }

    pub(super) fn check_window_focus(&mut self) {
        if self.config.pause_in_bg {
            if self.focused_window.is_none() {
                // Only pause and set background_pause if we weren't already paused
                if !self.paused && self.config.pause_in_bg {
                    self.background_pause = true;
                }
                self.paused(true);
            } else if self.background_pause {
                self.background_pause = false;
                // Only unpause if we weren't paused as a result of losing focus
                self.paused(false);
            }
        }
    }
}

impl Powered for Nes {
    /// Powers on the console
    fn power_on(&mut self) {
        self.cpu.power_on();
        if let Err(e) = self.load_sram() {
            self.add_message(&e.to_string());
        }
        self.paused = false;
        self.cycles_remaining = 0.0;
    }

    /// Powers off the console
    fn power_off(&mut self) {
        if self.recording {
            if let Err(e) = self.save_replay() {
                self.add_message(&e.to_string());
            }
        }
        if let Err(e) = self.save_sram() {
            self.add_message(&e.to_string());
            error!("{}", e);
        }
        // Clean up rewind states
        if self.config.rewind_enabled {
            for slot in REWIND_SLOT..(REWIND_SLOT + REWIND_SIZE) {
                if let Ok(save_path) = save_path(&self.loaded_rom, slot) {
                    if save_path.exists() {
                        let _ = std::fs::remove_file(&save_path);
                    }
                }
            }
        }
        self.paused = true;
    }

    /// Soft-resets the console
    fn reset(&mut self) {
        self.cpu.reset();
        self.running_time = 0.0;
        self.cycles_remaining = 0.0;
        if self.config.debug {
            self.paused(true);
        }
    }

    /// Hard-resets the console
    fn power_cycle(&mut self) {
        self.cpu.power_cycle();
        self.running_time = 0.0;
        self.cycles_remaining = 0.0;
        if self.config.debug {
            self.paused(true);
        }
    }
}

impl Clocked for Nes {
    /// Steps the console a single CPU instruction at a time
    fn clock(&mut self) -> usize {
        if self.config.debug && self.should_break() {
            if self.break_instr == Some(self.cpu.pc) {
                self.break_instr = None;
            } else {
                self.paused(true);
                self.cpu_break = true;
                self.break_instr = Some(self.cpu.pc);
                return 0;
            }
        }
        if self.zapper_decay > 0 {
            self.zapper_decay -= 1;
            // println!(
            //     "decay: {}, sense: {}, sl: {}",
            //     self.zapper_decay, self.cpu.bus.input.zapper.light_sense, self.cpu.bus.ppu.scanline
            // );
        }
        if self.zapper_decay == 0 {
            self.cpu.bus.input.zapper.light_sense = true;
        }
        self.cpu.clock()
    }
}

impl Savable for Nes {
    fn save<F: Write>(&self, fh: &mut F) -> NesResult<()> {
        // Ignore
        // roms
        // loaded_rom
        // paused
        // background_pause
        self.running_time.save(fh)?;
        self.turbo_clock.save(fh)?;
        self.cpu.save(fh)?;
        self.cycles_remaining.save(fh)?;
        self.zapper_decay.save(fh)?;
        // Ignore
        // focused_window
        // menus
        // held_keys
        // cpu_break
        // break_instr
        // should_close
        // nes_window
        // ppu_viewer_window
        // nt_viewer_window
        // ppu_viewer
        // nt_viewer
        // nt_scanline
        // pat_scanline
        // debug_image
        // ppu_info_image
        // nt_info_image
        // active_debug
        self.width.save(fh)?;
        self.height.save(fh)?;
        self.speed_counter.save(fh)?;
        self.rewind_timer.save(fh)?;
        self.rewind_queue.save(fh)?;
        // Ignore
        // recording
        // playback
        self.frame.save(fh)?;
        // Ignore
        // replay_buffer
        // messages
        // Config
        Ok(())
    }
    fn load<F: Read>(&mut self, fh: &mut F) -> NesResult<()> {
        // EXPL: Clone here prevents corrupt savestate data from crashing execution.
        let mut nes = self.clone();
        nes.running_time.load(fh)?;
        nes.turbo_clock.load(fh)?;
        nes.cpu.load(fh)?;
        nes.cycles_remaining.load(fh)?;
        nes.zapper_decay.load(fh)?;
        nes.width.load(fh)?;
        nes.height.load(fh)?;
        nes.speed_counter.load(fh)?;
        nes.rewind_timer.load(fh)?;
        nes.rewind_queue = VecDeque::with_capacity(REWIND_SIZE as usize);
        nes.rewind_queue.load(fh)?;
        nes.frame.load(fh)?;
        *self = nes;
        Ok(())
    }
}

/// Returns the path where battery-backed Save RAM files are stored
///
/// # Arguments
///
/// * `path` - An object that implements AsRef<Path> that holds the path to the currently
/// running ROM
///
/// # Errors
///
/// Panics if path is not a valid path
fn sram_path<P: AsRef<Path>>(path: &P) -> NesResult<PathBuf> {
    let save_name = path.as_ref().file_stem().and_then(|s| s.to_str()).unwrap();
    let mut path = home_dir().unwrap_or_else(|| PathBuf::from("./"));
    path.push(CONFIG_DIR);
    path.push("sram");
    path.push(save_name);
    path.set_extension("sram");
    Ok(path)
}

/// Returns the path where Save states are stored
///
/// # Arguments
///
/// * `path` - An object that implements AsRef<Path> that holds the path to the currently
/// running ROM
///
/// # Errors
///
/// Panics if path is not a valid path
pub fn save_path<P: AsRef<Path>>(path: &P, slot: u8) -> NesResult<PathBuf> {
    if let Some(save_name) = path.as_ref().file_stem().and_then(|s| s.to_str()) {
        let mut path = home_dir().unwrap_or_else(|| PathBuf::from("./"));
        path.push(CONFIG_DIR);
        path.push("save");
        path.push(save_name);
        path.push(format!("{}", slot));
        path.set_extension("save");
        Ok(path)
    } else {
        nes_err!("failed to create save path for {:?}", path.as_ref())
    }
}