supercharger

Documentation

Overview

Package supercharger implements the tape based cartridge format. The implementation is complex enough for it to be spread over more than one file and so for purposes of clarity it has been placed in its own package.

The package supports both loading from a sound file (supporting most WAV and MP3 files) or from a "fastload" file.

Tape loading "events" are handled through the notifications.Notify interface.

When loading from a sound file, Supercharger events can be ignored if so desired but for fastload files, the emulator needs to help the Supercharger mapper. See the playmode package reference implementation for details.

Mutliload tapes are supported from both sound file and fastload binaries. In the case of sound files the audio must be in a single file.

Index

• Constants
• func NewSupercharger(env *environment.Environment, cartload cartridgeloader.Loader) (mapper.CartMapper, error)
• type FastLoad
  • func (fl *FastLoad) Fastload(mc *cpu.CPU, ram *vcs.RAM, tmr *timer.Timer) error
• type Registers
  • func (r *Registers) MappedBanks() string
  • func (r Registers) String() string
• type SoundLoad
  • func (tap *SoundLoad) GetTapeState() (bool, mapper.CartTapeState)
  • func (tap *SoundLoad) Rewind()
  • func (tap *SoundLoad) SetTapeCounter(c int)
• type Supercharger
  • func (cart *Supercharger) Access(addr uint16, peek bool) (uint8, uint8, error)
  • func (cart *Supercharger) AccessPassive(addr uint16, _ uint8) error
  • func (cart *Supercharger) AccessVolatile(addr uint16, data uint8, _ bool) error
  • func (cart *Supercharger) CopyBanks() []mapper.BankContent
  • func (cart *Supercharger) Fastload(mc *cpu.CPU, ram *vcs.RAM, tmr *timer.Timer) error
  • func (cart *Supercharger) GetBank(addr uint16) mapper.BankInfo
  • func (cart *Supercharger) GetRAM() []mapper.CartRAM
  • func (cart Supercharger) GetRegisters() mapper.CartRegisters
  • func (cart *Supercharger) GetTapeState() (bool, mapper.CartTapeState)
  • func (cart *Supercharger) ID() string
  • func (cart *Supercharger) MappedBanks() string
  • func (cart *Supercharger) NumBanks() int
  • func (cart *Supercharger) Plumb(env *environment.Environment)
  • func (cart *Supercharger) PutRAM(bank int, idx int, data uint8)
  • func (cart *Supercharger) PutRegister(register string, data string)
  • func (cart *Supercharger) ReadHotspots() map[uint16]mapper.CartHotspotInfo
  • func (cart *Supercharger) Reset()
  • func (cart *Supercharger) Rewind()
  • func (cart *Supercharger) SetBank(bank string) error
  • func (cart *Supercharger) SetTapeCounter(c int)
  • func (cart *Supercharger) Snapshot() mapper.CartMapper
  • func (cart *Supercharger) Step(_ float32)
  • func (cart *Supercharger) WriteHotspots() map[uint16]mapper.CartHotspotInfo

Constants

const MutliloadByteAddress = 0xfa

The address in VCS RAM of the multiload byte. Tapes will not load unless the encoded multibyte in the stream is the same as the value in this address.

Functions

func NewSupercharger

func NewSupercharger(env *environment.Environment, cartload cartridgeloader.Loader) (mapper.CartMapper, error)

NewSupercharger is the preferred method of initialisation for the Supercharger type.

Types

type FastLoad

type FastLoad struct {
	// contains filtered or unexported fields
}

FastLoad implements the Tape interface. It loads data from a binary file rather than a sound file.

On success it returns the FastLoaded error. This must be interpreted by the emulator driver and called with the arguments listed in the error type.

Format information for fast-load binary rom mailing list post:

Subject: Re: [stella] Supercharger BIN format From: Eckhard Stolberg Date: Fri, 08 Jan 1999.

func (*FastLoad) Fastload

func (fl *FastLoad) Fastload(mc *cpu.CPU, ram *vcs.RAM, tmr *timer.Timer) error

Fastload implements the mapper.CartSuperChargerFastLoad interface.

type Registers

type Registers struct {
	Value uint8
	Delay int // 0=off, 1=trigger

	// the last value to be written to (not including fff8 writes)
	LastWriteValue   uint8
	LastWriteAddress uint16

	// config byte, raw value
	ConfigByte uint8

	// config byte broken into parts
	WriteDelay  int
	BankingMode int
	RAMwrite    bool
	ROMpower    bool
	// contains filtered or unexported fields
}

Registers implements the mapper.CartRegisters interface.

func (*Registers) MappedBanks

func (r *Registers) MappedBanks() string

MappedBanks is like string but just the bank information. we use this when building the mapper summary, the String() function is too verbose for that.

func (Registers) String

func (r Registers) String() string

type SoundLoad

type SoundLoad struct {
	// contains filtered or unexported fields
}

SoundLoad implements the Tape interface. It loads data from a sound file.

Compared to FastLoad this method is more 'authentic' and uses the BIOS correctly.

func (*SoundLoad) GetTapeState

func (tap *SoundLoad) GetTapeState() (bool, mapper.CartTapeState)

func (*SoundLoad) Rewind

func (tap *SoundLoad) Rewind()

Rewind implements the mapper.CartTapeBus interface.

func (*SoundLoad) SetTapeCounter

func (tap *SoundLoad) SetTapeCounter(c int)

SetTapeCounter implements the mapper.CartTapeBus interface.

type Supercharger

type Supercharger struct {
	// contains filtered or unexported fields
}

Supercharger represents a supercharger cartridge.

func (*Supercharger) Access

func (cart *Supercharger) Access(addr uint16, peek bool) (uint8, uint8, error)

Access implements the mapper.CartMapper interface.

func (*Supercharger) AccessPassive

func (cart *Supercharger) AccessPassive(addr uint16, _ uint8) error

AccessPassive implements the mapper.CartMapper interface.

func (*Supercharger) AccessVolatile

func (cart *Supercharger) AccessVolatile(addr uint16, data uint8, _ bool) error

AccessVolatile implements the mapper.CartMapper interface.

func (*Supercharger) CopyBanks

func (cart *Supercharger) CopyBanks() []mapper.BankContent

CopyBanks implements the mapper.CartMapper interface.

func (*Supercharger) Fastload

func (cart *Supercharger) Fastload(mc *cpu.CPU, ram *vcs.RAM, tmr *timer.Timer) error

Fastload implements the mapper.CartSuperChargerFastLoad interface.

func (*Supercharger) GetBank

func (cart *Supercharger) GetBank(addr uint16) mapper.BankInfo

GetBank implements the mapper.CartMapper interface.

func (*Supercharger) GetRAM

func (cart *Supercharger) GetRAM() []mapper.CartRAM

GetRAM implements the mapper.CartRAMBus interface.

func (Supercharger) GetRegisters

func (cart Supercharger) GetRegisters() mapper.CartRegisters

GetRegisters implements the mapper.CartRegistersBus interface.

func (*Supercharger) GetTapeState

func (cart *Supercharger) GetTapeState() (bool, mapper.CartTapeState)

GetTapeState implements the mapper.CartTapeBus interface

Whether this does anything meaningful depends on the interal implementation of the 'tape' interface.

func (*Supercharger) ID

func (cart *Supercharger) ID() string

ID implements the mapper.CartMapper interface.

func (*Supercharger) MappedBanks

func (cart *Supercharger) MappedBanks() string

MappedBanks implements the mapper.CartMapper interface.

func (*Supercharger) NumBanks

func (cart *Supercharger) NumBanks() int

NumBanks implements the mapper.CartMapper interface.

func (*Supercharger) Plumb

func (cart *Supercharger) Plumb(env *environment.Environment)

Plumb implements the mapper.CartMapper interface.

func (*Supercharger) PutRAM

func (cart *Supercharger) PutRAM(bank int, idx int, data uint8)

PutRAM implements the mapper.CartRAMBus interface.

func (*Supercharger) PutRegister

func (cart *Supercharger) PutRegister(register string, data string)

PutRegister implements the mapper.CartRegistersBus interface

the register argument must be one of the following and after the = sign, the type to which the data argument will be converted.

value = int
delay = int (0 ... 6)
ramwrite = bool
rompower = bool

note that PutRegister() will panic() if the register or data string is invalid.

func (*Supercharger) ReadHotspots

func (cart *Supercharger) ReadHotspots() map[uint16]mapper.CartHotspotInfo

ReadHotspots implements the mapper.CartHotspotsBus interface.

func (*Supercharger) Reset

func (cart *Supercharger) Reset()

Reset implements the mapper.CartMapper interface.

func (*Supercharger) Rewind

func (cart *Supercharger) Rewind()

Rewind implements the mapper.CartTapeBus interface

Whether this does anything meaningful depends on the interal implementation of the 'tape' interface.

func (*Supercharger) SetBank

func (cart *Supercharger) SetBank(bank string) error

SetBank implements the mapper.CartMapper interface.

func (*Supercharger) SetTapeCounter

func (cart *Supercharger) SetTapeCounter(c int)

SetTapeCounter implements the mapper.CartTapeBus interface

Whether this does anything meaningful depends on the interal implementation of the 'tape' interface.

func (*Supercharger) Snapshot

func (cart *Supercharger) Snapshot() mapper.CartMapper

Snapshot implements the mapper.CartMapper interface.

func (*Supercharger) Step

func (cart *Supercharger) Step(_ float32)

Step implements the mapper.CartMapper interface.

func (*Supercharger) WriteHotspots

func (cart *Supercharger) WriteHotspots() map[uint16]mapper.CartHotspotInfo

WriteHotspots implements the mapper.CartHotspotsBus interface.