Struct XmSampleHeader 

pub struct XmSampleHeader {

    pub name: String,
    pub length: u32,
    pub loop_start: u32,
    pub loop_length: u32,
    pub volume: u8,
    pub finetune: i8,
    pub type_byte: u8,
    pub panning: u8,
    pub relative_note: i8,
    pub loop_mode: XmSampleLoopMode,
    pub is_16_bit: bool,
    pub pcm16: Vec<i16>,
    pub pcm8: Vec<i8>,
}

Decoded sample header (40 bytes + variable-length PCM body following all sample headers of the instrument).

Fields

name: String

length: u32

Sample length in bytes (not frames). For 16-bit samples the frame count is length / 2.

loop_start: u32

loop_length: u32

volume: u8

finetune: i8

Signed finetune -128..+127.

type_byte: u8

panning: u8

relative_note: i8

Signed relative-note, -96..+95 (0 => C-4 = C-4).

loop_mode: XmSampleLoopMode

is_16_bit: bool

pcm16: Vec<i16>

Decoded PCM samples. Empty until extract_samples is called. For 16-bit samples the values are i16 halves, one per frame.

pcm8: Vec<i8>

Decoded 8-bit PCM samples (if !is_16_bit). Empty otherwise.

Trait Implementations

impl Clone for XmSampleHeader

fn clone(&self) -> XmSampleHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmSampleHeader

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

Formats the value using the given formatter.

impl Default for XmSampleHeader

fn default() -> XmSampleHeader

Returns the “default value” for a type.

impl SampleSource for XmSampleHeader

fn len(&self) -> usize

Total number of PCM frames.

fn loop_start(&self) -> usize

Loop start index (frames).

fn loop_end(&self) -> usize

Loop end index (frames), exclusive.

fn loop_kind(&self) -> LoopKind

Loop mode.

fn at(&self, idx: usize) -> f32

Sample at integer index, normalised to -1.0..=1.0. Callers are responsible for ensuring idx < len(); implementations may return 0.0 for out-of-range indices defensively.

fn is_empty(&self) -> bool

True if this sample has no PCM data.