Struct Song 

pub struct Song {
    pub global_volume: u8,
    pub mix_volume: u8,
    pub initial_speed: NonZero<u8>,
    pub initial_tempo: NonZero<u8>,
    pub pan_separation: u8,
    pub pitch_wheel_depth: u8,
    pub patterns: [Pattern; 240],
    pub pattern_order: [PatternOrder; 256],
    pub volume: [u8; 64],
    pub pan: [Pan; 64],
    pub samples: [Option<(SampleMetaData, Sample)>; 236],
}

Fields

global_volume: u8

mix_volume: u8

initial_speed: NonZero<u8>

Speed specifies how many ticks are in one row. This reduces tempo, but increases resolution of some effects.

initial_tempo: NonZero<u8>

Tempo determines how many ticks are in one second with the following formula: tempo/2 = ticks per second.

pan_separation: u8

pitch_wheel_depth: u8

patterns: [Pattern; 240]

pattern_order: [PatternOrder; 256]

volume: [u8; 64]

pan: [Pan; 64]

samples: [Option<(SampleMetaData, Sample)>; 236]

Implementations

impl Song

pub const MAX_ORDERS: usize = 256usize

pub const MAX_PATTERNS: usize = 240usize

pub const MAX_SAMPLES_INSTR: usize = 236usize

pub const MAX_CHANNELS: usize = 64usize

pub fn next_pattern(&self, order: &mut u16) -> Option<u8>

order value shouldn’t be modified outside of this function. This moves it forward correctly and returns the pattern to be played

pub fn copy_values_from_header(&mut self, header: &ImpulseHeader)

takes the values that are included in Song from the header and write them to the song.

Mostly applies to metadata about the song. Samples, patterns, instruments are not filled as they are not included in the header

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

debug like impl which isn’t as long by cutting down a lot of information

Trait Implementations

impl Clone for Song

fn clone(&self) -> Song

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Song

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

Formats the value using the given formatter.

impl Default for Song

fn default() -> Self

Returns the “default value” for a type.