Gopher2600/reflection/reflection.go
JetSetIlly 2d02764e60 moved coprocessor interface/types from mapper to coprocessor package
there could be more work to do here to make this more readable
2023-08-09 15:26:05 +01:00

90 lines
3.1 KiB
Go

// This file is part of Gopher2600.
//
// Gopher2600 is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Gopher2600 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Gopher2600. If not, see <https://www.gnu.org/licenses/>.
package reflection
import (
"github.com/jetsetilly/gopher2600/coprocessor"
"github.com/jetsetilly/gopher2600/hardware/cpu/execution"
"github.com/jetsetilly/gopher2600/hardware/memory/cartridge/mapper"
"github.com/jetsetilly/gopher2600/hardware/television/signal"
"github.com/jetsetilly/gopher2600/hardware/tia/video"
)
// Renderer implementations display or otherwise process VideoStep values.
type Renderer interface {
// Reflect is used to render a series of ReflectedVideoSteps. The number of
// entries in the array will always be television.MaxSignalHistory.
//
// The layout of the ref array is roughly equivalent to the sig array sent
// by PixelRenderer.SetPixels(). That is, the first entry always
// corresponds to the top-left pixel.
//
// The array should be copied on reception (see note in the
// ReflectedVideoStep type).
Reflect(ref []ReflectedVideoStep) error
}
// Broker implementations can identify a reflection.Renderer.
type Broker interface {
GetReflectionRenderer() Renderer
}
// ReflectedVideoStep packages together the details of the the last video step that
// would otherwise be difficult for a debugger to access.
//
// It includes the CPU execution result, the bank from which the instruction
// originates, the video element that produced the last video pixel on screen;
// among other information.
//
// Note that ordering of the structure is important. There's a saving of about
// 2MB per frame compared to the unoptimal ordering.
type ReflectedVideoStep struct {
CPU execution.Result
Collision video.Collisions
Bank mapper.BankInfo
Signal signal.SignalAttributes
Hmove Hmove
VideoElement video.Element
WSYNC bool
IsRAM bool
CoProcSync coprocessor.CoProcSynchronisation
IsHblank bool
RSYNCalign bool
RSYNCreset bool
AudioPhase0 bool
AudioPhase1 bool
AudioChanged bool
// All the fields in this struct are copy()able. An array of this type
// therefore should also be copyable and safe to use in other goroutines.
//
// The only pointer is in execution.Result, which points to a CPU
// instruction defintion. the definition never changes however so this is
// also safe.
}
// Hmove groups the HMOVE reflection information. It's too complex a property
// to distil into a single variable.
//
// Ordering of the structure is important in order to keep memory usage at a
// minimum.
type Hmove struct {
DelayCt int
Delay bool
Latch bool
RippleCt uint8
}