bands.h File Reference

#include "arch.h"
#include "modes.h"
#include "entenc.h"
#include "entdec.h"
#include "rate.h"

Go to the source code of this file.

Macros
#define	SPREAD_NONE   (0)
#define	SPREAD_LIGHT   (1)
#define	SPREAD_NORMAL   (2)
#define	SPREAD_AGGRESSIVE   (3)

Functions
void	compute_band_energies (const CELTMode *m, const celt_sig *X, celt_ener *bandE, int end, int C, int LM)
void	normalise_bands (const CELTMode *m, const celt_sig *OPUS_RESTRICT freq, celt_norm *OPUS_RESTRICT X, const celt_ener *bandE, int end, int C, int M)
void	denormalise_bands (const CELTMode *m, const celt_norm *OPUS_RESTRICT X, celt_sig *OPUS_RESTRICT freq, const opus_val16 *bandE, int start, int end, int M, int downsample, int silence)
int	spreading_decision (const CELTMode *m, const celt_norm *X, int *average, int last_decision, int *hf_average, int *tapset_decision, int update_hf, int end, int C, int M)
void	haar1 (celt_norm *X, int N0, int stride)
void	quant_all_bands (int encode, const CELTMode *m, int start, int end, celt_norm *X, celt_norm *Y, unsigned char *collapse_masks, const celt_ener *bandE, int *pulses, int shortBlocks, int spread, int dual_stereo, int intensity, int *tf_res, opus_int32 total_bits, opus_int32 balance, ec_ctx *ec, int M, int codedBands, opus_uint32 *seed, int arch)
void	anti_collapse (const CELTMode *m, celt_norm *X_, unsigned char *collapse_masks, int LM, int C, int size, int start, int end, const opus_val16 *logE, const opus_val16 *prev1logE, const opus_val16 *prev2logE, const int *pulses, opus_uint32 seed, int arch)
opus_uint32	celt_lcg_rand (opus_uint32 seed)
int	hysteresis_decision (opus_val16 val, const opus_val16 *thresholds, const opus_val16 *hysteresis, int N, int prev)

Macro Definition Documentation

SPREAD_AGGRESSIVE

#define SPREAD_AGGRESSIVE   (3)

SPREAD_LIGHT

#define SPREAD_LIGHT   (1)

SPREAD_NONE

#define SPREAD_NONE   (0)

SPREAD_NORMAL

#define SPREAD_NORMAL   (2)

Function Documentation

anti_collapse()

void anti_collapse	(	const CELTMode *	m,
		celt_norm *	X_,
		unsigned char *	collapse_masks,
		int	LM,
		int	C,
		int	size,
		int	start,
		int	end,
		const opus_val16 *	logE,
		const opus_val16 *	prev1logE,
		const opus_val16 *	prev2logE,
		const int *	pulses,
		opus_uint32	seed,
		int	arch
	)

celt_lcg_rand()

opus_uint32 celt_lcg_rand

(

opus_uint32

seed

)

compute_band_energies()

void compute_band_energies	(	const CELTMode *	m,
		const celt_sig *	X,
		celt_ener *	bandE,
		int	end,
		int	C,
		int	LM
	)

Compute the amplitude (sqrt energy) in each of the bands

Parameters

m	Mode data
X	Spectrum
bandE	Square root of the energy for each band (returned)

denormalise_bands()

void denormalise_bands	(	const CELTMode *	m,
		const celt_norm *OPUS_RESTRICT	X,
		celt_sig *OPUS_RESTRICT	freq,
		const opus_val16 *	bandE,
		int	start,
		int	end,
		int	M,
		int	downsample,
		int	silence
	)

Denormalise each band of X to restore full amplitude

Parameters

m	Mode data
X	Spectrum (returned de-normalised)
bandE	Square root of the energy for each band

haar1()

void haar1	(	celt_norm *	X,
		int	N0,
		int	stride
	)

hysteresis_decision()

int hysteresis_decision	(	opus_val16	val,
		const opus_val16 *	thresholds,
		const opus_val16 *	hysteresis,
		int	N,
		int	prev
	)

normalise_bands()

void normalise_bands	(	const CELTMode *	m,
		const celt_sig *OPUS_RESTRICT	freq,
		celt_norm *OPUS_RESTRICT	X,
		const celt_ener *	bandE,
		int	end,
		int	C,
		int	M
	)

Normalise each band of X such that the energy in each band is equal to 1

Parameters

m	Mode data
X	Spectrum (returned normalised)
bandE	Square root of the energy for each band

quant_all_bands()

void quant_all_bands	(	int	encode,
		const CELTMode *	m,
		int	start,
		int	end,
		celt_norm *	X,
		celt_norm *	Y,
		unsigned char *	collapse_masks,
		const celt_ener *	bandE,
		int *	pulses,
		int	shortBlocks,
		int	spread,
		int	dual_stereo,
		int	intensity,
		int *	tf_res,
		opus_int32	total_bits,
		opus_int32	balance,
		ec_ctx *	ec,
		int	M,
		int	codedBands,
		opus_uint32 *	seed,
		int	arch
	)

Quantisation/encoding of the residual spectrum

Parameters

encode	flag that indicates whether we're encoding (1) or decoding (0)
m	Mode data
start	First band to process
end	Last band to process + 1
X	Residual (normalised)
Y	Residual (normalised) for second channel (or NULL for mono)
collapse_masks	Anti-collapse tracking mask
bandE	Square root of the energy for each band
pulses	Bit allocation (per band) for PVQ
shortBlocks	Zero for long blocks, non-zero for short blocks
spread	Amount of spreading to use
dual_stereo	Zero for MS stereo, non-zero for dual stereo
intensity	First band to use intensity stereo
tf_res	Time-frequency resolution change
total_bits	Total number of bits that can be used for the frame (including the ones already spent)
balance	Number of unallocated bits
en	Entropy coder state
LM	log2() of the number of 2.5 subframes in the frame
codedBands	Last band to receive bits + 1
seed	Random generator seed
arch	Run-time architecture (see opus_select_arch())

spreading_decision()

int spreading_decision	(	const CELTMode *	m,
		const celt_norm *	X,
		int *	average,
		int	last_decision,
		int *	hf_average,
		int *	tapset_decision,
		int	update_hf,
		int	end,
		int	C,
		int	M
	)