atarivox

Documentation

Overview

Package atarivox implements the atarivox peripheral. It supports output of atarivox voice audio through Festival (if installed). See atarivoxengines package.

The AtariVox type also embeds the SaveKey peripheral and forwards all data to it as necessary.

Index

• func NewAtariVox(env *environment.Environment, port plugging.PortID, bus ports.PeripheralBus) ports.Peripheral
• type AtariVox
  • func (vox *AtariVox) Disable(disabled bool)
  • func (vox *AtariVox) HandleEvent(_ ports.Event, _ ports.EventData) (bool, error)
  • func (vox *AtariVox) ID() plugging.PeripheralID
  • func (vox *AtariVox) IsActive() bool
  • func (vox *AtariVox) Mute(muted bool)
  • func (vox *AtariVox) Plumb(bus ports.PeripheralBus)
  • func (vox *AtariVox) PortID() plugging.PortID
  • func (vox *AtariVox) Reset()
  • func (vox *AtariVox) Restart()
  • func (vox *AtariVox) Snapshot() ports.Peripheral
  • func (vox *AtariVox) Step()
  • func (vox *AtariVox) String() string
  • func (vox *AtariVox) Unplug()
  • func (vox *AtariVox) Update(data chipbus.ChangedRegister) bool
• type AtariVoxState

Functions

func NewAtariVox

func NewAtariVox(env *environment.Environment, port plugging.PortID, bus ports.PeripheralBus) ports.Peripheral

NewAtariVox is the preferred method of initialisation for the AtariVox type.

Types

type AtariVox

type AtariVox struct {

	// speakjet pins
	SpeakJetDATA  i2c.Trace
	SpeakJetREADY i2c.Trace

	State AtariVoxState

	// Data is sent by the VCS one bit at a time. see pushBits(), popBits() and
	// resetBits() for
	Bits   uint8
	BitsCt int

	// text to speech engine
	Engine atarivoxengines.AtariVoxEngine

	// the savekey portion of the AtariVox is the same as a stand alone savekey
	SaveKey ports.Peripheral
	// contains filtered or unexported fields
}

func (*AtariVox) Disable

func (vox *AtariVox) Disable(disabled bool)

Restart implements the ports.DisablePeripheral interface.

func (*AtariVox) HandleEvent

func (vox *AtariVox) HandleEvent(_ ports.Event, _ ports.EventData) (bool, error)

handle an incoming input event

func (*AtariVox) ID

func (vox *AtariVox) ID() plugging.PeripheralID

ID implements the ports.Peripheral interface.

func (*AtariVox) IsActive

func (vox *AtariVox) IsActive() bool

whether the peripheral is currently "active"

func (*AtariVox) Mute

func (vox *AtariVox) Mute(muted bool)

Mute silences atarivox output for the duration muted is true.

This implements a private mutePeripheral interface in the ports package. It should not be called directly except via the Mute() function in the Ports implementation.

func (*AtariVox) Plumb

func (vox *AtariVox) Plumb(bus ports.PeripheralBus)

Plumb implements the ports.Peripheral interface.

func (*AtariVox) PortID

func (vox *AtariVox) PortID() plugging.PortID

PortID implements the ports.Peripheral interface.

func (*AtariVox) Reset

func (vox *AtariVox) Reset()

Reset implements the ports.Peripheral interface.

func (*AtariVox) Restart

func (vox *AtariVox) Restart()

Restart implements the ports.RestartPeripheral interface.

func (*AtariVox) Snapshot

func (vox *AtariVox) Snapshot() ports.Peripheral

Snapshot implements the ports.Peripheral interface.

func (*AtariVox) Step

func (vox *AtariVox) Step()

Step is called every CPU clock.

func (*AtariVox) String

func (vox *AtariVox) String() string

String implements the ports.Peripheral interface.

func (*AtariVox) Unplug

func (vox *AtariVox) Unplug()

Unplug implements the ports.Peripheral interface.

func (*AtariVox) Update

func (vox *AtariVox) Update(data chipbus.ChangedRegister) bool

memory has been updated. peripherals are notified.

type AtariVoxState

type AtariVoxState int

AtariVoxState records how incoming signals to the AtariVox will be interpreted.

const (
	AtariVoxStopped AtariVoxState = iota
	AtariVoxStarting
	AtariVoxData
	AtariVoxEnding
)

List of valid AtariVoxStaate values.