Skip to main content

SampleBody

Struct SampleBody 

Source
pub struct SampleBody {
    pub pcm: Vec<i8>,
    pub loop_start: u32,
    pub loop_length: u32,
    pub volume: u8,
    pub finetune: i8,
}
Expand description

Per-sample decoded body plus the loop metadata needed by the mixer.

Fields§

§pcm: Vec<i8>

Raw signed 8-bit PCM. Empty if the header declared zero length.

§loop_start: u32

Loop start in samples (0 if sample does not loop).

§loop_length: u32

Loop length in samples (0 if sample does not loop — spec says repeat length of 2 also means “no loop”).

§volume: u8

Default volume 0..=64.

§finetune: i8

Finetune -8..=7.

Implementations§

Source§

impl SampleBody

Source

pub fn is_looped(&self) -> bool

True if this sample has a valid loop region.

Trait Implementations§

Source§

impl Clone for SampleBody

Source§

fn clone(&self) -> SampleBody

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SampleBody

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SampleBody

Source§

fn default() -> SampleBody

Returns the “default value” for a type. Read more
Source§

impl SampleSource for SampleBody

Source§

fn len(&self) -> usize

Total number of PCM frames.
Source§

fn loop_start(&self) -> usize

Loop start index (frames).
Source§

fn loop_end(&self) -> usize

Loop end index (frames), exclusive.
Source§

fn loop_kind(&self) -> LoopKind

Loop mode.
Source§

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.
Source§

fn is_empty(&self) -> bool

True if this sample has no PCM data.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.