Struct AudioSource 

pub struct AudioSource { /* private fields */ }

An open audio file: its header and a map of its bytes, read a window at a time.

Implementations

impl AudioSource

pub fn open(path: &Path, normalize: bool) -> Result<Self>

pub fn from_bytes(bytes: &[u8], normalize: bool) -> Result<Self>

An audio file from its bytes, copied into an anonymous map: for the fuzz target, which has bytes and no file.

pub fn header(&self) -> &AudioHeader

pub fn frames(&self) -> u64

pub fn normalize(&self) -> bool

pub fn seconds(&self) -> f64

Duration of the frames on hand, in seconds.

pub fn frames_past_limit(&self) -> u64

Frames the file holds past the most datui shows, MAX_FRAMES.

pub fn trailing_bytes(&self) -> u64

Bytes in the data region that are not a whole frame: a cut-short last frame.

pub fn cut_short(&self) -> Option<(u64, u64)>

Whether the header states more data than the file holds.

pub fn schema(&self) -> Schema

pub fn window( &self, start: u64, len: u64, columns: Option<&[PlSmallStr]>, ) -> PolarsResult<DataFrame>

Frames [start, start + len) (cut to the frames on hand) as columns, in that order, or every column. Only those frames’ bytes are read.

pub fn lazy(self: &Arc<Self>) -> LazyFrame

The frames as a lazy frame that Polars can stream, slice and prune: decoded over a frame index (crate::formats::row_index), so a slice anywhere decodes only its own frames and a query that names one channel decodes only that channel.

pub fn full_scale_bounds(&self) -> (f64, f64)

The lowest and highest value a channel’s column can hold, in the column’s own units: the most negative and most positive integer the valid bits allow, or [-1, 1] for float. A sample at either is at full scale.

pub fn signal_report( &self, stop: &dyn Fn() -> bool, ) -> PolarsResult<Option<Vec<SignalReport>>>

One pass over every frame, per channel, measuring clipping (runs at full scale), dropouts (runs of exact zeros) and DC offset (the mean), in flat memory. stop is checked every million frames; None when stopped.

Trait Implementations

impl Debug for AudioSource

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

Formats the value using the given formatter.

impl RowSource for AudioSource

fn height(&self) -> usize

Rows on hand, at most MAX_ROWS.

fn schema(&self) -> SchemaRef

fn decode(&self, column: usize, index: &IdxCa) -> PolarsResult<Column>

The schema’s columnth column for the rows index names, in that order. The index comes from the plan’s row index, so it has no nulls and every row is under Self::height; a source still refuses one that is not, rather than read past its bytes.

impl Windowed for AudioSource

fn window(&self, start: usize, len: usize) -> PolarsResult<LazyFrame>

The rows as a frame, read when it is collected.