rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h File Reference

#include "speexdsp_types.h"

Include dependency graph for rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SPEEX_RESAMPLER_QUALITY_DEFAULT   4
#define	SPEEX_RESAMPLER_QUALITY_DESKTOP   5
#define	SPEEX_RESAMPLER_QUALITY_MAX   10
#define	SPEEX_RESAMPLER_QUALITY_MIN   0
#define	SPEEX_RESAMPLER_QUALITY_VOIP   3

Typedefs
typedef struct SpeexResamplerState_	SpeexResamplerState

Enumerations
enum	{   RESAMPLER_ERR_SUCCESS = 0, RESAMPLER_ERR_ALLOC_FAILED = 1, RESAMPLER_ERR_BAD_STATE = 2, RESAMPLER_ERR_INVALID_ARG = 3,   RESAMPLER_ERR_PTR_OVERLAP = 4, RESAMPLER_ERR_OVERFLOW = 5, RESAMPLER_ERR_MAX_ERROR }

Functions
void	speex_resampler_destroy (SpeexResamplerState *st)
int	speex_resampler_get_input_latency (SpeexResamplerState *st)
void	speex_resampler_get_input_stride (SpeexResamplerState *st, spx_uint32_t *stride)
int	speex_resampler_get_output_latency (SpeexResamplerState *st)
void	speex_resampler_get_output_stride (SpeexResamplerState *st, spx_uint32_t *stride)
void	speex_resampler_get_quality (SpeexResamplerState *st, int *quality)
void	speex_resampler_get_rate (SpeexResamplerState *st, spx_uint32_t *in_rate, spx_uint32_t *out_rate)
void	speex_resampler_get_ratio (SpeexResamplerState *st, spx_uint32_t *ratio_num, spx_uint32_t *ratio_den)
SpeexResamplerState *	speex_resampler_init (spx_uint32_t nb_channels, spx_uint32_t in_rate, spx_uint32_t out_rate, int quality, int *err)
SpeexResamplerState *	speex_resampler_init_frac (spx_uint32_t nb_channels, spx_uint32_t ratio_num, spx_uint32_t ratio_den, spx_uint32_t in_rate, spx_uint32_t out_rate, int quality, int *err)
int	speex_resampler_process_float (SpeexResamplerState *st, spx_uint32_t channel_index, const float *in, spx_uint32_t *in_len, float *out, spx_uint32_t *out_len)
int	speex_resampler_process_int (SpeexResamplerState *st, spx_uint32_t channel_index, const spx_int16_t *in, spx_uint32_t *in_len, spx_int16_t *out, spx_uint32_t *out_len)
int	speex_resampler_process_interleaved_float (SpeexResamplerState *st, const float *in, spx_uint32_t *in_len, float *out, spx_uint32_t *out_len)
int	speex_resampler_process_interleaved_int (SpeexResamplerState *st, const spx_int16_t *in, spx_uint32_t *in_len, spx_int16_t *out, spx_uint32_t *out_len)
int	speex_resampler_reset_mem (SpeexResamplerState *st)
void	speex_resampler_set_input_stride (SpeexResamplerState *st, spx_uint32_t stride)
void	speex_resampler_set_output_stride (SpeexResamplerState *st, spx_uint32_t stride)
int	speex_resampler_set_quality (SpeexResamplerState *st, int quality)
int	speex_resampler_set_rate (SpeexResamplerState *st, spx_uint32_t in_rate, spx_uint32_t out_rate)
int	speex_resampler_set_rate_frac (SpeexResamplerState *st, spx_uint32_t ratio_num, spx_uint32_t ratio_den, spx_uint32_t in_rate, spx_uint32_t out_rate)
int	speex_resampler_skip_zeros (SpeexResamplerState *st)
const char *	speex_resampler_strerror (int err)

Macro Definition Documentation

SPEEX_RESAMPLER_QUALITY_DEFAULT

#define SPEEX_RESAMPLER_QUALITY_DEFAULT   4

Definition at line 99 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

SPEEX_RESAMPLER_QUALITY_DESKTOP

#define SPEEX_RESAMPLER_QUALITY_DESKTOP   5

Definition at line 101 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

SPEEX_RESAMPLER_QUALITY_MAX

#define SPEEX_RESAMPLER_QUALITY_MAX   10

Definition at line 97 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

SPEEX_RESAMPLER_QUALITY_MIN

#define SPEEX_RESAMPLER_QUALITY_MIN   0

Definition at line 98 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

SPEEX_RESAMPLER_QUALITY_VOIP

#define SPEEX_RESAMPLER_QUALITY_VOIP   3

Definition at line 100 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

Typedef Documentation

SpeexResamplerState

typedef struct SpeexResamplerState_ SpeexResamplerState

Definition at line 115 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
RESAMPLER_ERR_SUCCESS
RESAMPLER_ERR_ALLOC_FAILED
RESAMPLER_ERR_BAD_STATE
RESAMPLER_ERR_INVALID_ARG
RESAMPLER_ERR_PTR_OVERLAP
RESAMPLER_ERR_OVERFLOW
RESAMPLER_ERR_MAX_ERROR

Definition at line 103 of file rhino/demo/c/pvrecorder/src/miniaudio/extras/speex_resampler/thirdparty/speex_resampler.h.

Function Documentation

speex_resampler_destroy()

void speex_resampler_destroy

(

SpeexResamplerState *

st

)

Destroy a resampler state.

Parameters

st	Resampler state

Definition at line 868 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_input_latency()

int speex_resampler_get_input_latency

(

SpeexResamplerState *

st

)

Get the latency introduced by the resampler measured in input samples.

Parameters

st	Resampler state

Definition at line 1190 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_input_stride()

void speex_resampler_get_input_stride	(	SpeexResamplerState *	st,
		spx_uint32_t *	stride
	)

Get the input stride.

Parameters

st	Resampler state
stride	Input stride copied

Definition at line 1175 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_output_latency()

int speex_resampler_get_output_latency

(

SpeexResamplerState *

st

)

Get the latency introduced by the resampler measured in output samples.

Parameters

st	Resampler state

Definition at line 1195 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_output_stride()

void speex_resampler_get_output_stride	(	SpeexResamplerState *	st,
		spx_uint32_t *	stride
	)

Get the output stride.

Parameters

st	Resampler state copied
stride	Output stride

Definition at line 1185 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_quality()

void speex_resampler_get_quality	(	SpeexResamplerState *	st,
		int *	quality
	)

Get the conversion quality.

Parameters

st	Resampler state
quality	Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.

Definition at line 1165 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_rate()

void speex_resampler_get_rate	(	SpeexResamplerState *	st,
		spx_uint32_t *	in_rate,
		spx_uint32_t *	out_rate
	)

Get the current input/output sampling rates (integer value).

Parameters

st	Resampler state
in_rate	Input sampling rate (integer number of Hz) copied.
out_rate	Output sampling rate (integer number of Hz) copied.

Definition at line 1089 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_get_ratio()

void speex_resampler_get_ratio	(	SpeexResamplerState *	st,
		spx_uint32_t *	ratio_num,
		spx_uint32_t *	ratio_den
	)

Get the current resampling ratio. This will be reduced to the least common denominator.

Parameters

st	Resampler state
ratio_num	Numerator of the sampling rate ratio copied
ratio_den	Denominator of the sampling rate ratio copied

Definition at line 1147 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_init()

SpeexResamplerState* speex_resampler_init	(	spx_uint32_t	nb_channels,
		spx_uint32_t	in_rate,
		spx_uint32_t	out_rate,
		int	quality,
		int *	err
	)

Create a new resampler with integer input and output rates.

Parameters

nb_channels	Number of channels to be processed
in_rate	Input sampling rate (integer number of Hz).
out_rate	Output sampling rate (integer number of Hz).
quality	Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.

Returns

Newly created resampler state

Return values

NULL	Error: not enough memory

Definition at line 794 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_init_frac()

SpeexResamplerState* speex_resampler_init_frac	(	spx_uint32_t	nb_channels,
		spx_uint32_t	ratio_num,
		spx_uint32_t	ratio_den,
		spx_uint32_t	in_rate,
		spx_uint32_t	out_rate,
		int	quality,
		int *	err
	)

Create a new resampler with fractional input/output rates. The sampling rate ratio is an arbitrary rational number with both the numerator and denominator being 32-bit integers.

Parameters

nb_channels	Number of channels to be processed
ratio_num	Numerator of the sampling rate ratio
ratio_den	Denominator of the sampling rate ratio
in_rate	Input sampling rate rounded to the nearest integer (in Hz).
out_rate	Output sampling rate rounded to the nearest integer (in Hz).
quality	Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.

Returns

Newly created resampler state

Return values

NULL	Error: not enough memory

Definition at line 799 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_process_float()

int speex_resampler_process_float	(	SpeexResamplerState *	st,
		spx_uint32_t	channel_index,
		const float *	in,
		spx_uint32_t *	in_len,
		float *	out,
		spx_uint32_t *	out_len
	)

Resample a float array. The input and output buffers must not overlap.

Parameters

st	Resampler state
channel_index	Index of the channel to process for the multi-channel base (0 otherwise)
in	Input buffer
in_len	Number of input samples in the input buffer. Returns the number of samples processed
out	Output buffer
out_len	Size of the output buffer. Returns the number of samples written

Definition at line 927 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_process_int()

int speex_resampler_process_int	(	SpeexResamplerState *	st,
		spx_uint32_t	channel_index,
		const spx_int16_t *	in,
		spx_uint32_t *	in_len,
		spx_int16_t *	out,
		spx_uint32_t *	out_len
	)

Resample an int array. The input and output buffers must not overlap.

Parameters

st	Resampler state
channel_index	Index of the channel to process for the multi-channel base (0 otherwise)
in	Input buffer
in_len	Number of input samples in the input buffer. Returns the number of samples processed
out	Output buffer
out_len	Size of the output buffer. Returns the number of samples written

Definition at line 968 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_process_interleaved_float()

int speex_resampler_process_interleaved_float	(	SpeexResamplerState *	st,
		const float *	in,
		spx_uint32_t *	in_len,
		float *	out,
		spx_uint32_t *	out_len
	)

Resample an interleaved float array. The input and output buffers must not overlap.

Parameters

st	Resampler state
in	Input buffer
in_len	Number of input samples in the input buffer. Returns the number of samples processed. This is all per-channel.
out	Output buffer
out_len	Size of the output buffer. Returns the number of samples written. This is all per-channel.

Definition at line 1038 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_process_interleaved_int()

int speex_resampler_process_interleaved_int	(	SpeexResamplerState *	st,
		const spx_int16_t *	in,
		spx_uint32_t *	in_len,
		spx_int16_t *	out,
		spx_uint32_t *	out_len
	)

Resample an interleaved int array. The input and output buffers must not overlap.

Parameters

st	Resampler state
in	Input buffer
in_len	Number of input samples in the input buffer. Returns the number of samples processed. This is all per-channel.
out	Output buffer
out_len	Size of the output buffer. Returns the number of samples written. This is all per-channel.

Definition at line 1061 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_reset_mem()

int speex_resampler_reset_mem

(

SpeexResamplerState *

st

)

Reset a resampler so a new (unrelated) stream can be processed.

Parameters

st	Resampler state

Definition at line 1208 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_set_input_stride()

void speex_resampler_set_input_stride	(	SpeexResamplerState *	st,
		spx_uint32_t	stride
	)

Set (change) the input stride.

Parameters

st	Resampler state
stride	Input stride

Definition at line 1170 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_set_output_stride()

void speex_resampler_set_output_stride	(	SpeexResamplerState *	st,
		spx_uint32_t	stride
	)

Set (change) the output stride.

Parameters

st	Resampler state
stride	Output stride

Definition at line 1180 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_set_quality()

int speex_resampler_set_quality	(	SpeexResamplerState *	st,
		int	quality
	)

Set (change) the conversion quality.

Parameters

st	Resampler state
quality	Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.

Definition at line 1153 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_set_rate()

int speex_resampler_set_rate	(	SpeexResamplerState *	st,
		spx_uint32_t	in_rate,
		spx_uint32_t	out_rate
	)

Set (change) the input/output sampling rates (integer value).

Parameters

st	Resampler state
in_rate	Input sampling rate (integer number of Hz).
out_rate	Output sampling rate (integer number of Hz).

Definition at line 1084 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_set_rate_frac()

int speex_resampler_set_rate_frac	(	SpeexResamplerState *	st,
		spx_uint32_t	ratio_num,
		spx_uint32_t	ratio_den,
		spx_uint32_t	in_rate,
		spx_uint32_t	out_rate
	)

Set (change) the input/output sampling rates and resampling ratio (fractional values in Hz supported).

Parameters

st	Resampler state
ratio_num	Numerator of the sampling rate ratio
ratio_den	Denominator of the sampling rate ratio
in_rate	Input sampling rate rounded to the nearest integer (in Hz).
out_rate	Output sampling rate rounded to the nearest integer (in Hz).

Definition at line 1107 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_skip_zeros()

int speex_resampler_skip_zeros

(

SpeexResamplerState *

st

)

Make sure that the first samples to go out of the resamplers don't have leading zeros. This is only useful before starting to use a newly created resampler. It is recommended to use that when resampling an audio file, as it will generate a file with the same length. For real-time processing, it is probably easier not to use this call (so that the output duration is the same for the first frame).

Parameters

st	Resampler state

Definition at line 1200 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.

speex_resampler_strerror()

const char* speex_resampler_strerror

(

int

err

)

Returns the English meaning for an error code

Parameters

err	Error code

Returns

English string

Definition at line 1222 of file porcupine/demo/c/dr_libs/tests/external/miniaudio/extras/speex_resampler/thirdparty/resample.c.