rubberband-c.h File Reference

Go to the source code of this file.

Defines
#define	RUBBERBAND_VERSION   "1.2.0"
#define	RUBBERBAND_API_MAJOR_VERSION   2
#define	RUBBERBAND_API_MINOR_VERSION   0
Typedefs
typedef int	RubberBandOptions
typedef struct RubberBandState_ *	RubberBandState
Enumerations
enum	RubberBandOption {   RubberBandOptionProcessOffline = 0x00000000, RubberBandOptionProcessRealTime = 0x00000001, RubberBandOptionStretchElastic = 0x00000000, RubberBandOptionStretchPrecise = 0x00000010,   RubberBandOptionTransientsCrisp = 0x00000000, RubberBandOptionTransientsMixed = 0x00000100, RubberBandOptionTransientsSmooth = 0x00000200, RubberBandOptionPhaseLaminar = 0x00000000,   RubberBandOptionPhaseIndependent = 0x00002000, RubberBandOptionThreadingAuto = 0x00000000, RubberBandOptionThreadingNever = 0x00010000, RubberBandOptionThreadingAlways = 0x00020000,   RubberBandOptionWindowStandard = 0x00000000, RubberBandOptionWindowShort = 0x00100000, RubberBandOptionWindowLong = 0x00200000, RubberBandOptionFormantShifted = 0x00000000,   RubberBandOptionFormantPreserved = 0x01000000, RubberBandOptionPitchHighQuality = 0x00000000, RubberBandOptionPitchHighSpeed = 0x02000000, RubberBandOptionPitchHighConsistency = 0x04000000 }
	This is a C-linkage interface to the Rubber Band time stretcher. More...
Functions
RubberBandState	rubberband_new (unsigned int sampleRate, unsigned int channels, RubberBandOptions options, double initialTimeRatio, double initialPitchScale)
void	rubberband_delete (RubberBandState)
void	rubberband_reset (RubberBandState)
void	rubberband_set_time_ratio (RubberBandState, double ratio)
void	rubberband_set_pitch_scale (RubberBandState, double scale)
double	rubberband_get_time_ratio (const RubberBandState)
double	rubberband_get_pitch_scale (const RubberBandState)
unsigned int	rubberband_get_latency (const RubberBandState)
void	rubberband_set_transients_option (RubberBandState, RubberBandOptions options)
void	rubberband_set_phase_option (RubberBandState, RubberBandOptions options)
void	rubberband_set_formant_option (RubberBandState, RubberBandOptions options)
void	rubberband_set_pitch_option (RubberBandState, RubberBandOptions options)
void	rubberband_set_expected_input_duration (RubberBandState, unsigned int samples)
unsigned int	rubberband_get_samples_required (const RubberBandState)
void	rubberband_set_max_process_size (RubberBandState, unsigned int samples)
void	rubberband_study (RubberBandState, const float *const *input, unsigned int samples, int final)
void	rubberband_process (RubberBandState, const float *const *input, unsigned int samples, int final)
int	rubberband_available (const RubberBandState)
unsigned int	rubberband_retrieve (const RubberBandState, float *const *output, unsigned int samples)
unsigned int	rubberband_get_channel_count (const RubberBandState)
void	rubberband_calculate_stretch (RubberBandState)
void	rubberband_set_debug_level (RubberBandState, int level)
void	rubberband_set_default_debug_level (int level)

---

Define Documentation

#define RUBBERBAND_VERSION   "1.2.0"

Definition at line 11 of file rubberband-c.h.

#define RUBBERBAND_API_MAJOR_VERSION   2

Definition at line 12 of file rubberband-c.h.

#define RUBBERBAND_API_MINOR_VERSION   0

Definition at line 13 of file rubberband-c.h.

---

Typedef Documentation

typedef int RubberBandOptions

Definition at line 59 of file rubberband-c.h.

typedef struct RubberBandState_* RubberBandState

Definition at line 62 of file rubberband-c.h.

---

Enumeration Type Documentation

enum RubberBandOption

This is a C-linkage interface to the Rubber Band time stretcher.

This is a wrapper interface: the primary interface is in C++ and is defined and documented in RubberBandStretcher.h. The library itself is implemented in C++, and requires C++ standard library support even when using the C-linkage API.

Please see RubberBandStretcher.h for documentation.

If you are writing to the C++ API, do not include this header.

Enumerator:

RubberBandOptionProcessOffline
RubberBandOptionProcessRealTime
RubberBandOptionStretchElastic
RubberBandOptionStretchPrecise
RubberBandOptionTransientsCrisp
RubberBandOptionTransientsMixed
RubberBandOptionTransientsSmooth
RubberBandOptionPhaseLaminar
RubberBandOptionPhaseIndependent
RubberBandOptionThreadingAuto
RubberBandOptionThreadingNever
RubberBandOptionThreadingAlways
RubberBandOptionWindowStandard
RubberBandOptionWindowShort
RubberBandOptionWindowLong
RubberBandOptionFormantShifted
RubberBandOptionFormantPreserved
RubberBandOptionPitchHighQuality
RubberBandOptionPitchHighSpeed
RubberBandOptionPitchHighConsistency

Definition at line 28 of file rubberband-c.h.

---

Function Documentation

RubberBandState rubberband_new	(	unsigned int	sampleRate,
		unsigned int	channels,
		RubberBandOptions	options,
		double	initialTimeRatio,
		double	initialPitchScale
	)

void rubberband_delete

(

RubberBandState

)

void rubberband_reset

(

RubberBandState

)

void rubberband_set_time_ratio	(	RubberBandState	,
		double	ratio
	)

void rubberband_set_pitch_scale	(	RubberBandState	,
		double	scale
	)

double rubberband_get_time_ratio

(

const

RubberBandState

)

double rubberband_get_pitch_scale

(

const

RubberBandState

)

unsigned int rubberband_get_latency

(

const

RubberBandState

)

void rubberband_set_transients_option	(	RubberBandState	,
		RubberBandOptions	options
	)

void rubberband_set_phase_option	(	RubberBandState	,
		RubberBandOptions	options
	)

void rubberband_set_formant_option	(	RubberBandState	,
		RubberBandOptions	options
	)

void rubberband_set_pitch_option	(	RubberBandState	,
		RubberBandOptions	options
	)

void rubberband_set_expected_input_duration	(	RubberBandState	,
		unsigned int	samples
	)

unsigned int rubberband_get_samples_required

(

const

RubberBandState

)

void rubberband_set_max_process_size	(	RubberBandState	,
		unsigned int	samples
	)

void rubberband_study	(	RubberBandState	,
		const float *const *	input,
		unsigned int	samples,
		int	final
	)

void rubberband_process	(	RubberBandState	,
		const float *const *	input,
		unsigned int	samples,
		int	final
	)

int rubberband_available

(

const

RubberBandState

)

unsigned int rubberband_retrieve	(	const	RubberBandState,
		float *const *	output,
		unsigned int	samples
	)

unsigned int rubberband_get_channel_count

(

const

RubberBandState

)

void rubberband_calculate_stretch

(

RubberBandState

)

void rubberband_set_debug_level	(	RubberBandState	,
		int	level
	)

void rubberband_set_default_debug_level

(

int

level

)