Struct playdate_sys::ffi::playdate_sound_sample

#[repr(C)]
pub struct playdate_sound_sample {
    pub newSampleBuffer: Option<unsafe extern "C" fn(byteCount: c_int) -> *mut AudioSample>,
    pub loadIntoSample: Option<unsafe extern "C" fn(sample: *mut AudioSample, path: *const c_char) -> c_int>,
    pub load: Option<unsafe extern "C" fn(path: *const c_char) -> *mut AudioSample>,
    pub newSampleFromData: Option<unsafe extern "C" fn(data: *mut u8, format: SoundFormat, sampleRate: u32, byteCount: c_int) -> *mut AudioSample>,
    pub getData: Option<unsafe extern "C" fn(sample: *mut AudioSample, data: *mut *mut u8, format: *mut SoundFormat, sampleRate: *mut u32, bytelength: *mut u32)>,
    pub freeSample: Option<unsafe extern "C" fn(sample: *mut AudioSample)>,
    pub getLength: Option<unsafe extern "C" fn(sample: *mut AudioSample) -> c_float>,
    pub decompress: Option<unsafe extern "C" fn(sample: *mut AudioSample) -> c_int>,
}

Fields

newSampleBuffer: Option<unsafe extern "C" fn(byteCount: c_int) -> *mut AudioSample>

AudioSample* playdate->sound->sample->newSampleBuffer(int length)

Allocates and returns a new AudioSample with a buffer large enough to load a file of length bytes.

loadIntoSample: Option<unsafe extern "C" fn(sample: *mut AudioSample, path: *const c_char) -> c_int>

void playdate->sound->sample->loadIntoSample(AudioSample* sample, const char* path)

Loads the sound data from the file at path into an existing AudioSample, sample.

load: Option<unsafe extern "C" fn(path: *const c_char) -> *mut AudioSample>

AudioSample* playdate->sound->sample->load(const char* path)

Allocates and returns a new AudioSample, with the sound data loaded in memory. If there is no file at path, the function returns null.

newSampleFromData: Option<unsafe extern "C" fn(data: *mut u8, format: SoundFormat, sampleRate: u32, byteCount: c_int) -> *mut AudioSample>

AudioSample* playdate->sound->sample->newSampleFromData(uint8_t* data, SoundFormat format, uint32_t sampleRate, int byteCount)

Returns a new AudioSample referencing the given audio data. The sample keeps a pointer to the data instead of copying it, so the data must remain valid while the sample is active. format is one of the following values:

SoundFormat

typedef enum
{
	kSound8bitMono = 0,
	kSound8bitStereo = 1,
	kSound16bitMono = 2,
	kSound16bitStereo = 3,
	kSoundADPCMMono = 4,
	kSoundADPCMStereo = 5
} SoundFormat;

pd_api_sound.h also provides some helper macros and functions:

#define SoundFormatIsStereo(f) ((f)&1)
#define SoundFormatIs16bit(f) ((f)>=kSound16bitMono)
static inline uint32_t SoundFormat_bytesPerFrame(SoundFormat fmt);

getData: Option<unsafe extern "C" fn(sample: *mut AudioSample, data: *mut *mut u8, format: *mut SoundFormat, sampleRate: *mut u32, bytelength: *mut u32)>

freeSample: Option<unsafe extern "C" fn(sample: *mut AudioSample)>

void playdate->sound->sample->freeSample(AudioSample* sample)

Frees the given sample.

getLength: Option<unsafe extern "C" fn(sample: *mut AudioSample) -> c_float>

float playdate->sound->sample->getLength(AudioSample* sample)

Returns the length, in seconds, of sample.

decompress: Option<unsafe extern "C" fn(sample: *mut AudioSample) -> c_int>

int playdate->sound->sample->decompress(void)

If the sample is ADPCM compressed, decompresses the sample data to 16-bit PCM data. This increases the sample’s memory footprint by 4x and does not affect the quality in any way, but it is necessary if you want to use the sample in a synth or play the file backwards. Returns 1 if successful, 0 if there’s not enough memory for the uncompressed data.

Trait Implementations

impl Clone for playdate_sound_sample

fn clone(&self) -> playdate_sound_sample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for playdate_sound_sample

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

Formats the value using the given formatter.

impl Default for playdate_sound_sample

fn default() -> playdate_sound_sample

Returns the “default value” for a type.

impl Hash for playdate_sound_sample

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl Ord for playdate_sound_sample

fn cmp(&self, other: &playdate_sound_sample) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for playdate_sound_sample

fn eq(&self, other: &playdate_sound_sample) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for playdate_sound_sample

fn partial_cmp(&self, other: &playdate_sound_sample) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for playdate_sound_sample

impl Eq for playdate_sound_sample

impl StructuralPartialEq for playdate_sound_sample

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes