Struct cybergrape::spatial_data_format::GrapeFile

pub struct GrapeFile {
    header: GrapeFileHeader,
    samples: Vec<f32>,
}

This struct contains the header and samples associated with a GrapeFile

Fields

header: GrapeFileHeader

samples: Vec<f32>

Implementations

impl GrapeFile

pub fn builder() -> GrapeFileBuilder

Make a GrapeFileBuilder, which can be used to set sample rate and add streams, before building the GrapeFile.

pub fn to_path(&self, path: impl AsRef<Path>) -> Result<(), GrapeFileError>

Write out a GrapeFile to the path provided.

pub fn to_file(&self, file: &mut impl Write) -> Result<(), GrapeFileError>

Write out a GrapeFile to the Writeable object provided.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, GrapeFileError>

Read a GrapeFile from the path provided.

pub fn from_file(file: &mut impl Read) -> Result<Self, GrapeFileError>

Read a GrapeFile from the Readable object provided.

pub fn streams_native_sample_rate(&self) -> (u64, Vec<(GrapeTag, Vec<f32>)>)

Extract the streams from a GrapeFile, also returns the sample rate because the streams can be encoded at any sample rate.

pub fn streams_with_sample_rate( &self, sample_rate: u64, ) -> Vec<(GrapeTag, Vec<f32>)>

Extracts the streams from a GrapeFile, interpolating or quantizing the streams to produce datapoints at the requested sample rate.

fn attach_tags( tags: &[GrapeTag], samples: Vec<Vec<f32>>, ) -> Vec<(GrapeTag, Vec<f32>)>

Take a slice of GrapeTags and sample vectors and zip them.

fn get_raw_streams(&self) -> Vec<Vec<f32>>

Returns a cloned, de-interleaved version of the samples in the file.

fn streams_interpolated(&self, sample_rate: u64) -> Vec<(GrapeTag, Vec<f32>)>

Extracts the streams from the file, and interpolates data points to produce data points at the requrested sample_rate.

Right now, this function only really works if the requested sample rate is a multiple of the native sample rate. This needs some work.

fn streams_quantized(&self, sample_rate: u64) -> Vec<(GrapeTag, Vec<f32>)>

Extracts the streams from the file, and quantizes data points to produce data points at the requested sample_rate.

Right now, this function only really works if the requested sample rate is a factor of the native sample rate. This needs some work.

Trait Implementations

impl Clone for GrapeFile

fn clone(&self) -> GrapeFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrapeFile

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

Formats the value using the given formatter.

impl PartialEq for GrapeFile

fn eq(&self, other: &GrapeFile) -> 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 StructuralPartialEq for GrapeFile