Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
roc::audio::IResampler Class Referenceabstract

Audio writer interface. More...

#include <iresampler.h>

Inheritance diagram for roc::audio::IResampler:
roc::audio::BuiltinResampler roc::audio::SpeexResampler

Public Member Functions

virtual bool valid () const =0
 Check if object is successfully constructed.
 
virtual bool set_scaling (size_t input_rate, size_t output_rate, float multiplier)=0
 Set new resample factor.
 
virtual const core::Slice< sample_t > & begin_push_input ()=0
 Get buffer to be filled with input data.
 
virtual void end_push_input ()=0
 Commit buffer with input data.
 
virtual size_t pop_output (Frame &out)=0
 Read samples from input buffer and fill output frame.
 

Detailed Description

Audio writer interface.

Definition at line 23 of file iresampler.h.

Member Function Documentation

◆ begin_push_input()

virtual const core::Slice< sample_t > & roc::audio::IResampler::begin_push_input ( )
pure virtual

Get buffer to be filled with input data.

Remarks
After this call, the caller should fill returned buffer with input data and invoke end_push_input().

Implemented in roc::audio::BuiltinResampler, and roc::audio::SpeexResampler.

◆ end_push_input()

virtual void roc::audio::IResampler::end_push_input ( )
pure virtual

Commit buffer with input data.

Remarks
Should be called after begin_push_input() to commit the push operation.

Implemented in roc::audio::BuiltinResampler, and roc::audio::SpeexResampler.

◆ pop_output()

virtual size_t roc::audio::IResampler::pop_output ( Frame out)
pure virtual

Read samples from input buffer and fill output frame.

Remarks
May return lesser samples than requested if there are no more samples in the input ring buffer. In this case the caller should provide resampler with more input samples using begin_push_input() and end_push_input().

Implemented in roc::audio::BuiltinResampler, and roc::audio::SpeexResampler.

◆ set_scaling()

virtual bool roc::audio::IResampler::set_scaling ( size_t  input_rate,
size_t  output_rate,
float  multiplier 
)
pure virtual

Set new resample factor.

Remarks
Returns false if the scaling is invalid or out of bounds.

Implemented in roc::audio::BuiltinResampler, and roc::audio::SpeexResampler.

◆ valid()

virtual bool roc::audio::IResampler::valid ( ) const
pure virtual

Check if object is successfully constructed.

Implemented in roc::audio::BuiltinResampler, and roc::audio::SpeexResampler.


The documentation for this class was generated from the following file: