possible to re-record playback files

this is useful for recreating playback files for the regression
database. playback entries not currently supported for REDUX mode

added -playbackIgnoreDigest and -recordingFilename options for RUN mode

.gitignore

@@ -33,3 +33,4 @@ armcode.map
 *.macro
 go.work
 go.work.sum
+REDUX_PLAYBACK_FILES

debugger/commandline_options.go

@@ -36,14 +36,16 @@ type CommandLineOptions struct {
 	ELF       string
 
 	// playmode only
-	ComparisonROM    string
-	ComparisonPrefs  string
-	Record           bool
-	PlaybackCheckROM bool
-	PatchFile        string
-	Wav              bool
-	NoEject          bool
-	Macro            string
+	ComparisonROM        string
+	ComparisonPrefs      string
+	Record               bool
+	RecordFilename       string
+	PlaybackCheckROM     bool
+	PlaybackIgnoreDigest bool
+	PatchFile            string
+	Wav                  bool
+	NoEject              bool
+	Macro                string
 
 	// debugger only
 	InitScript string

debugger/debugger.go

@@ -820,7 +820,7 @@ func (dbg *Debugger) StartInPlayMode(filename string) error {
 
 		// record wav file
 		if dbg.opts.Wav {
-			fn := unique.Filename("audio", cartload.Name)
+			fn := unique.Filename("audio", dbg.cartload.Name)
 			ww, err := wavwriter.NewWavWriter(fn)
 			if err != nil {
 				return fmt.Errorf("debugger: %w", err)
@@ -830,17 +830,18 @@ func (dbg *Debugger) StartInPlayMode(filename string) error {
 
 		// record gameplay
 		if dbg.opts.Record {
-			dbg.startRecording(cartload.Name)
+			dbg.startRecording(dbg.cartload.Name)
 		}
 	} else {
-		if dbg.opts.Record {
-			return fmt.Errorf("debugger: cannot make a new recording using a playback file")
-		}
-
 		err = dbg.startPlayback(filename)
 		if err != nil {
 			return fmt.Errorf("debugger: %w", err)
 		}
+
+		// record gameplay
+		if dbg.opts.Record {
+			dbg.startRecording(dbg.cartload.Name)
+		}
 	}
 
 	if dbg.opts.Macro != "" {
@@ -1274,7 +1275,12 @@ func (dbg *Debugger) startRecording(cartShortName string) error {
 	dbg.vcs.TV.SetSimple(true)
 
 	var err error
-	recording := unique.Filename("recording", cartShortName)
+	var recording string
+	if dbg.opts.RecordFilename == "" {
+		recording = unique.Filename("recording", cartShortName)
+	} else {
+		recording = dbg.opts.RecordFilename
+	}
 	dbg.recorder, err = recorder.NewRecorder(recording, dbg.vcs)
 	if err != nil {
 		return err
@@ -1301,7 +1307,7 @@ func (dbg *Debugger) endRecording() {
 func (dbg *Debugger) startPlayback(filename string) error {
 	dbg.vcs.TV.SetSimple(true)
 
-	plb, err := recorder.NewPlayback(filename)
+	plb, err := recorder.NewPlayback(filename, dbg.opts.PlaybackIgnoreDigest)
 	if err != nil {
 		return err
 	}
@@ -1311,7 +1317,6 @@ func (dbg *Debugger) startPlayback(filename string) error {
 	if err != nil {
 		return fmt.Errorf("debugger: %w", err)
 	}
-	defer cartload.Close()
 
 	// check hash of cartridge before continuing
 	if dbg.opts.PlaybackCheckROM && cartload.HashSHA1 != plb.Hash {

gopher2600.go

@@ -314,8 +314,10 @@ func emulate(mode string, sync *mainSync, args []string) error {
 	if emulationMode == govern.ModePlay {
 		flgs.StringVar(&opts.ComparisonROM, "comparisonROM", "", "ROM to run in parallel for comparison")
 		flgs.StringVar(&opts.ComparisonPrefs, "comparisonPrefs", "", "preferences for comparison emulation")
-		flgs.BoolVar(&opts.Record, "record", false, "record user input to playback file")
-		flgs.BoolVar(&opts.PlaybackCheckROM, "playbackCheckROM", true, "check ROM hashes on playback")
+		flgs.BoolVar(&opts.Record, "record", false, "record user input to new file for future playback")
+		flgs.StringVar(&opts.RecordFilename, "recordFilename", "", "set output name for recording")
+		flgs.BoolVar(&opts.PlaybackCheckROM, "playbackCheckROM", true, "check ROM hash on playback")
+		flgs.BoolVar(&opts.PlaybackIgnoreDigest, "playbackIgnoreDigest", false, "ignore video digests in playback files")
 		flgs.StringVar(&opts.PatchFile, "patch", "", "path to apply to emulation (not playback files")
 		flgs.BoolVar(&opts.Wav, "wav", false, "record audio to wav file")
 		flgs.BoolVar(&opts.NoEject, "noeject", false, "emulator will not quit is noeject is true")

hardware/input/input.go

@@ -81,10 +81,6 @@ func (inp *Input) PeripheralID(id plugging.PortID) plugging.PeripheralID {
 // If a playback is currently active the input will not be handled and false
 // will be returned.
 func (inp *Input) HandleInputEvent(ev ports.InputEvent) (bool, error) {
-	if inp.playback != nil {
-		return false, nil
-	}
-
 	for _, r := range inp.recorder {
 		err := r.RecordEvent(ports.TimedInputEvent{Time: inp.tv.GetCoords(), InputEvent: ev})
 		if err != nil {

hardware/input/recording.go

@@ -43,12 +43,8 @@ type EventRecorder interface {
 }
 
 // AttachEventRecorder attaches an EventRecorder implementation.
-func (inp *Input) AddRecorder(r EventRecorder) error {
-	if inp.playback != nil {
-		return fmt.Errorf("input: attach recorder: emulator already has a playback attached")
-	}
+func (inp *Input) AddRecorder(r EventRecorder) {
 	inp.recorder = append(inp.recorder, r)
-	return nil
 }
 
 // ClearRecorders removes all registered event recorders.
@@ -105,6 +101,14 @@ func (inp *Input) handlePlaybackEvents() error {
 					return fmt.Errorf("input: passenger event queue is full: input dropped")
 				}
 			}
+
+			// forward event to attached recorders
+			for _, r := range inp.recorder {
+				err := r.RecordEvent(ev)
+				if err != nil {
+					return err
+				}
+			}
 		}
 	}
 

recorder/playback.go

@@ -53,6 +53,9 @@ type Playback struct {
 	vcs    *hardware.VCS
 	digest *digest.Video
 
+	// whether to ignore video digest for each playback input
+	ignoreDigest bool
+
 	// the last frame where an event occurs
 	endFrame int
 }
@@ -77,12 +80,13 @@ func (plb Playback) EndFrame() (bool, error) {
 //
 // The returned playback must be attached to the VCS input system (with
 // AttachToVCSInput() function) for it it to be useful.
-func NewPlayback(transcript string) (*Playback, error) {
+func NewPlayback(transcript string, ignoreDigest bool) (*Playback, error) {
 	var err error
 
 	plb := &Playback{
-		transcript: transcript,
-		sequence:   make([]playbackEntry, 0),
+		transcript:   transcript,
+		sequence:     make([]playbackEntry, 0),
+		ignoreDigest: ignoreDigest,
 	}
 
 	tf, err := os.Open(transcript)
@@ -241,7 +245,7 @@ func (plb *Playback) GetPlayback() (ports.TimedInputEvent, error) {
 	entry := plb.sequence[plb.seqCt]
 	if coords.Equal(entry.event.Time, c) {
 		plb.seqCt++
-		if entry.hash != plb.digest.Hash() {
+		if !plb.ignoreDigest && entry.hash != plb.digest.Hash() {
 			return ports.TimedInputEvent{
 				Time: c,
 				InputEvent: ports.InputEvent{

regression/playback.go

@@ -107,7 +107,7 @@ func (reg PlaybackRegression) String() string {
 func (reg *PlaybackRegression) regress(newRegression bool, output io.Writer, msg string) (_ bool, _ string, rerr error) {
 	output.Write([]byte(msg))
 
-	plb, err := recorder.NewPlayback(reg.Script)
+	plb, err := recorder.NewPlayback(reg.Script, false)
 	if err != nil {
 		return false, "", fmt.Errorf("playback: %w", err)
 	}