Skip to main content

StreamingResampler

Struct StreamingResampler 

Source
pub struct StreamingResampler { /* private fields */ }
Expand description

Stateful streaming resampler that maintains SoX instances across chunks. This is used by AudioPipeline for memory-efficient streaming resampling.

FIX for Defect 33: Pre-allocate all buffers to avoid heap allocation in process_chunk

Implementations§

Source§

impl StreamingResampler

Source

pub fn from_rate(&self) -> u32

Source

pub fn to_rate(&self) -> u32

Source

pub fn max_output_len_for_input(&self, input_samples: usize) -> usize

Naive ratio upper bound, in interleaved samples, on the output a single process_chunk_* call can return.

Per-call Soxr output is now capped (via slicing the pre-allocated scratch to this bound) inside process_chunk_*, so this is a valid single-call ceiling: any excess input is buffered by Soxr and recovered on later calls. Callers reserving an output/leftover buffer for one render-loop input chunk should size it with this method.

Source

pub fn max_output_samples_per_chunk(&self) -> usize

Absolute hard upper bound, in interleaved samples, on the output a single process_chunk_* call can return for this resampler.

This equals the pre-allocated interleaved_output capacity. With per-call output now capped to the naive ratio bound (see max_output_len_for_input), max_output_len_for_input is the right size for per-call reserves; this method remains the absolute ceiling tied to the internal buffer capacity.

Source

pub fn input_frames_for_output_frames(&self, output_frames: usize) -> usize

Source

pub fn new( channels: usize, from_rate: u32, to_rate: u32, ) -> Result<Self, ResamplerError>

Create a new streaming resampler with default (linear) phase and High quality

Source

pub fn with_phase( channels: usize, from_rate: u32, to_rate: u32, phase: PhaseResponse, ) -> Result<Self, ResamplerError>

Create a new streaming resampler with specified phase response (High quality)

Returns Err if Soxr initialization fails (e.g., invalid sample rates like 0 Hz)

Source

pub fn with_quality( channels: usize, from_rate: u32, to_rate: u32, phase: PhaseResponse, quality: ResampleQuality, ) -> Result<Self, ResamplerError>

Create a new streaming resampler with specified phase response and quality level

FIX for Defect 30: Allow quality configuration FIX for Defect 33: Pre-allocate all buffers to avoid heap allocation in process_chunk

Returns Err if Soxr initialization fails (e.g., invalid sample rates like 0 Hz)

Source

pub fn process_chunk_borrowed<'a>( &'a mut self, input: &'a [f64], ) -> ResampleOutput<'a>

Process a chunk of interleaved audio and borrow the resampler-owned output.

Resampling processes only complete input frames; trailing samples where input.len() % channels != 0 are ignored to preserve existing behavior. The equal-rate bypass returns the original input slice unchanged. The borrowed slice remains valid until the next mutable resampler call.

Source

pub fn process_chunk_append( &mut self, input: &[f64], output: &mut Vec<f64>, ) -> usize

Process a chunk and append the result directly to a caller-owned buffer.

Source

pub fn process_chunk_into(&mut self, input: &[f64], output: &mut [f64]) -> usize

Process a chunk into a pre-allocated output buffer (zero-allocation version)

Returns the number of frames written to output. Output buffer must be large enough: output.len() >= input.len() * to_rate / from_rate + 64

Source

pub fn reset(&mut self)

Source

pub fn flush_borrowed(&mut self) -> ResampleOutput<'_>

Flush remaining samples and borrow the resampler-owned interleaved output.

Source

pub fn flush_into(&mut self, output: &mut Vec<f64>) -> usize

Flush any remaining samples directly into a caller-owned output buffer.

Source

pub fn flush(&mut self) -> Vec<f64>

Flush any remaining samples in the resampler’s internal buffers

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more