Struct spectrusty::peripherals::bus::ay::Ay3_891xAudio

pub struct Ay3_891xAudio { /* private fields */ }

Implements AY-3-8910/8912/8913 programmable sound generator.

For the implementation of I/O ports see crate::ay.

Implementations

impl Ay3_891xAudio

Use the Default trait to create instances of this struct.

pub fn reset(&mut self)

Resets the internal state to the one initialized with.

pub fn freq_to_tone_period(clock_hz: f32, hz: f32) -> Option<NonZeroU16>

Converts a tone frequency given in Hz to a closest 16-bit tone period register value.

clock_hz AY-3-891x clock frequency in Hz. In ZX Spectrum it equals to CPU_HZ / 2. Amstrad CPC has PSG clocked at 1 MHz. Atari ST at 2 MHz.

Returns None if the result can’t be properly represented by 16-bit unsigned integer or if the result is 0.

pub fn tone_period_to_freq(clock_hz: f32, tp: u16) -> f32

Converts a 16-bit tone period register value to a tone frequency in Hz.

clock_hz AY-3-891x clock frequency in Hz. In ZX Spectrum it equals to CPU_HZ / 2. Amstrad CPC has PSG clocked at 1 MHz. Atari ST at 2 MHz.

pub fn tone_periods<I>(
    clock_hz: f32,
    min_octave: i32,
    max_octave: i32,
    note_freqs: I
) -> impl IntoIterator<Item = u16>where
    I: Clone + IntoIterator<Item = f32>,

Creates an iterator of tone periods for the AY-3-891x chip.

min_octave A minimal octave number, 0-based (0 is the minimum). max_octave A maximal octave number, 0-based (7 is the maximum). note_freqs An array of tone frequencies (in Hz) in the 5th octave (0-based: 4). To generate frequencies you may want to use audio::music::equal_tempered_scale_note_freqs. clock_hz The AY-3-891x clock frequency in Hz. Usually, it’s CPU_HZ / 2.

Panics

Panics if any period can’t be expressed by 16-bit unsigned integer.

pub fn render_audio<V, I, A>(
    &mut self,
    changes: I,
    blep: &mut A,
    end_ts: i32,
    frame_tstates: i32,
    chans: [usize; 3]
)where
    V: AmpLevels<<A as Blep>::SampleDelta>,
    I: IntoIterator<Item = AyRegChange>,
    A: Blep,

Renders square-wave audio pulses via the Blep interface while mutating the internal state.

The internal state is being altered every INTERNAL_CLOCK_DIVISOR * HOST_CLOCK_RATIO Cpu clock cycles until end_ts is reached. The internal cycle counter is then decremented by the value of frame_tstates before returning from this method.

Provide AmpLevels that can handle level values from 0 to 15 (4-bits).

• changes should be ordered by time and recorded only with time < end_ts otherwise, some register changes may be lost - the iterator will be drained anyway.
• end_ts should be a value of an end of frame T-state counter value.
• frame_tstates should be a duration of a single frame in T-states.
• channels - indicate Blep audio channels for [A, B, C] AY channels.

pub fn update_register(&mut self, reg: AyRegister, val: u8)

Updates the value of one of the sound generator registers for the indicated reg register, with the value given in val.

This method can be used to instantly set the state of the sound generator without the need to generate audio pulses.

pub fn get_tone_periods(&self) -> [u16; 3]

Returns the current tone periods of each channel.

The period is in the range: [1, 4095].

pub fn get_amp_levels(&self) -> [u8; 3]

Returns the current amplitude level of each channel.

If the channel volume register’s envelope bit is set, it returns the current envelope level for that channel.

The levels are in the range: [0, 15].

pub fn get_noise_pitch(&self) -> u8

Returns the current noise pitch.

The pitch is in the range: [0, 31].

pub fn get_mixer(&self) -> u8

Returns the current value of the mixer register.

t - tone bit: 0 tone enabled, 1 disabled
n - noise bit: 0 noise enabled, 1 disabled

b7 b6 b5 b4 b3 b2 b1 b0 bit
-  -  n  n  n  t  t  t  value
-  -  C  B  A  C  B  A  channel

pub fn get_envelope_level(&self) -> u8

Returns the current level of the envelope generator.

pub fn get_envelope_shape(&self) -> u8

Returns the envelope shape.

pub fn get_envelope_period(&self) -> u16

Returns the envelope period.

The period is in the range: [1, 65535].

Trait Implementations

impl Clone for Ay3_891xAudio

fn clone(&self) -> Ay3_891xAudio

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ay3_891xAudio

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Ay3_891xAudio

fn default() -> Ay3_891xAudio

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ay3_891xAudio

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Ay3_891xAudio, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Ay3_891xAudio

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.