Changed the pulse spreading rotations so that the number of iterations is
[opus.git] / libcelt / bands.h
index 5a19576..4ef6d67 100644 (file)
 #ifndef BANDS_H
 #define BANDS_H
 
-
+#include "arch.h"
 #include "modes.h"
 #include "entenc.h"
 #include "entdec.h"
+#include "rate.h"
+
+/** Applies a series of rotations so that pulses are spread like a two-sided
+exponential. The effect of this is to reduce the tonal noise created by the
+sparse spectrum resulting from the pulse codebook */
+void exp_rotation(celt_norm_t *X, int len, int dir, int stride, int iter);
 
-void compute_band_energies(const CELTMode *m, float *X, float *bands);
+/** Normalise each band of X such that the energy in each band is 
+    equal to 1
+ * @param m Mode data 
+ * @param X Spectrum (returned normalised)
+ * @param bands Square root of the energy for each band
+ */
+void normalise_bands(const CELTMode *m, const celt_sig_t *freq, celt_norm_t *X, celt_ener_t *bands);
 
-void normalise_bands(const CELTMode *m, float *X, float *bands);
+void renormalise_bands(const CELTMode *m, celt_norm_t *X);
 
-void denormalise_bands(const CELTMode *m, float *X, float *bands);
+/** Denormalise each band of X to restore full amplitude
+ * @param m Mode data 
+ * @param X Spectrum (returned de-normalised)
+ * @param bands Square root of the energy for each band
+ */
+void denormalise_bands(const CELTMode *m, const celt_norm_t *X, celt_sig_t *freq, const celt_ener_t *bands);
 
-void compute_pitch_gain(const CELTMode *m, float *X, float *P, float *gains, float *bank);
+/** Compute the pitch predictor gain for each pitch band
+ * @param m Mode data 
+ * @param X Spectrum to predict
+ * @param P Pitch vector (normalised)
+ * @param gains Gain computed for each pitch band (returned)
+ * @param bank Square root of the energy for each band
+ */
+void compute_pitch_gain(const CELTMode *m, const celt_norm_t *X, const celt_norm_t *P, celt_pgain_t *gains);
 
-void pitch_quant_bands(const CELTMode *m, float *X, float *P, float *gains);
+void pitch_quant_bands(const CELTMode *m, celt_norm_t *P, const celt_pgain_t *gains);
 
-void quant_bands(const CELTMode *m, float *X, float *P, float *W, ec_enc *enc);
+/** Quantisation/encoding of the residual spectrum
+ * @param m Mode data 
+ * @param X Residual (normalised)
+ * @param P Pitch vector (normalised)
+ * @param W Perceptual weighting
+ * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
+ * @param enc Entropy encoder
+ */
+void quant_bands(const CELTMode *m, celt_norm_t *X, celt_norm_t *P, celt_mask_t *W, int total_bits, ec_enc *enc);
 
-void unquant_bands(const CELTMode *m, float *X, float *P, ec_dec *dec);
+/** Decoding of the residual spectrum
+ * @param m Mode data 
+ * @param X Residual (normalised)
+ * @param P Pitch vector (normalised)
+ * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
+ * @param dec Entropy decoder
+*/
+void unquant_bands(const CELTMode *m, celt_norm_t *X, celt_norm_t *P, int total_bits, ec_dec *dec);
 
-void band_rotation(const CELTMode *m, float *X, int dir);
+void stereo_mix(const CELTMode *m, celt_norm_t *X, const celt_ener_t *bank, int dir);
 
 #endif /* BANDS_H */