Struct rubato::SincFixedOut

pub struct SincFixedOut<T> { /* private fields */ }

An asynchronous resampler that returns a fixed number of audio frames. The number of input frames required is given by the input_frames_next function.

The resampling is done by creating a number of intermediate points (defined by oversampling_factor) by sinc interpolation. The new samples are then calculated by interpolating between these points.

The resampling ratio can be freely adjusted within the range specified to the constructor. Adjusting the ratio does not recalculate the sinc functions used by the anti-aliasing filter. This causes no issue when increasing the ratio (which slows down the output). However when decreasing more than a few percent (i.e. speeding up the output), the filters can no longer suppress all aliasing and this may lead to some artefacts. Higher maximum ratios require more memory to be allocated by input_buffer_allocate and an internal buffer.

Implementations

impl<T> SincFixedOut<T>

where T: Sample,

pub fn new( resample_ratio: f64, max_resample_ratio_relative: f64, parameters: SincInterpolationParameters, chunk_size: usize, nbr_channels: usize ) -> Result<Self, ResamplerConstructionError>

Create a new SincFixedOut.

Parameters are:

• resample_ratio: Starting ratio between output and input sample rates, must be > 0.
• max_resample_ratio_relative: Maximum ratio that can be set with Resampler::set_resample_ratio relative to resample_ratio, must be >= 1.0. The minimum relative ratio is the reciprocal of the maximum. For example, with max_resample_ratio_relative of 10.0, the ratio can be set between resample_ratio * 10.0 and resample_ratio / 10.0.
• parameters: Parameters for interpolation, see SincInterpolationParameters.
• chunk_size: Size of output data in frames.
• nbr_channels: Number of channels in input/output.

pub fn new_with_interpolator( resample_ratio: f64, max_resample_ratio_relative: f64, interpolation_type: SincInterpolationType, interpolator: Box<dyn SincInterpolator<T>>, chunk_size: usize, nbr_channels: usize ) -> Result<Self, ResamplerConstructionError>

Create a new SincFixedOut using an existing Interpolator.

Parameters are:

• resample_ratio: Starting ratio between output and input sample rates, must be > 0.
• max_resample_ratio_relative: Maximum ratio that can be set with Resampler::set_resample_ratio relative to resample_ratio, must be >= 1.0. The minimum relative ratio is the reciprocal of the maximum. For example, with max_resample_ratio_relative of 10.0, the ratio can be set between resample_ratio * 10.0 and resample_ratio / 10.0.
• interpolation_type: Parameters for interpolation, see SincInterpolationParameters.
• interpolator: The interpolator to use.
• chunk_size: Size of output data in frames.
• nbr_channels: Number of channels in input/output.

Trait Implementations

impl<T> Resampler<T> for SincFixedOut<T>

where T: Sample,

fn process_into_buffer<Vin: AsRef<[T]>, Vout: AsMut<[T]>>( &mut self, wave_in: &[Vin], wave_out: &mut [Vout], active_channels_mask: Option<&[bool]> ) -> ResampleResult<(usize, usize)>

Resample a buffer of audio to a pre-allocated output buffer. Use this in real-time applications where the unpredictable time required to allocate memory from the heap can cause glitches. If this is not a problem, you may use the process method instead.

fn input_frames_max(&self) -> usize

Get the maximum number of input frames per channel the resampler could require.

fn input_frames_next(&self) -> usize

Get the number of frames per channel needed for the next call to process_into_buffer or process.

fn nbr_channels(&self) -> usize

Get the maximum number of channels this Resampler is configured for.

fn output_frames_max(&self) -> usize

Get the max number of output frames per channel.

fn output_frames_next(&self) -> usize

Get the number of frames per channel that will be output from the next call to process_into_buffer or process.

fn output_delay(&self) -> usize

Get the delay for the resampler, reported as a number of output frames.

fn set_resample_ratio( &mut self, new_ratio: f64, ramp: bool ) -> ResampleResult<()>

Update the resample ratio.

fn set_resample_ratio_relative( &mut self, rel_ratio: f64, ramp: bool ) -> ResampleResult<()>

Update the resample ratio as a factor relative to the original one.

fn reset(&mut self)

Reset the resampler state and clear all internal buffers.

fn process<V: AsRef<[T]>>( &mut self, wave_in: &[V], active_channels_mask: Option<&[bool]> ) -> ResampleResult<Vec<Vec<T>>>

This is a convenience wrapper for process_into_buffer that allocates the output buffer with each call. For realtime applications, use process_into_buffer with a buffer allocated by output_buffer_allocate instead of this function.

fn process_partial_into_buffer<Vin: AsRef<[T]>, Vout: AsMut<[T]>>( &mut self, wave_in: Option<&[Vin]>, wave_out: &mut [Vout], active_channels_mask: Option<&[bool]> ) -> ResampleResult<(usize, usize)>

This is a convenience method for processing the last frames at the end of a stream. Use this when there are fewer frames remaining than what the resampler requires as input. Calling this function is equivalent to padding the input buffer with zeros to make it the right input length, and then calling process_into_buffer. This method can also be called without any input frames, by providing None as input buffer. This can be utilized to push any remaining delayed frames out from the internal buffers. Note that this method allocates space for a temporary input buffer. Real-time applications should instead call process_into_buffer with a zero-padded pre-allocated input buffer.

fn process_partial<V: AsRef<[T]>>( &mut self, wave_in: Option<&[V]>, active_channels_mask: Option<&[bool]> ) -> ResampleResult<Vec<Vec<T>>>

This is a convenience method for processing the last frames at the end of a stream. It is similar to process_partial_into_buffer but allocates the output buffer with each call. Note that this method allocates space for both input and output.

fn input_buffer_allocate(&self, filled: bool) -> Vec<Vec<T>>

Convenience method for allocating an input buffer suitable for use with process_into_buffer. The buffer’s capacity is big enough to prevent allocating additional heap memory before any call to process_into_buffer regardless of the current resampling ratio.

fn output_buffer_allocate(&self, filled: bool) -> Vec<Vec<T>>

Convenience method for allocating an output buffer suitable for use with process_into_buffer. The buffer’s capacity is big enough to prevent allocating additional heap memory during any call to process_into_buffer regardless of the current resampling ratio.