385cec007db207c732169dd0148ae1fbd9caa510
[speexdsp.git] / libspeex / modes.h
1 /* Copyright (C) 2002-2006 Jean-Marc Valin */
2 /**
3    @file modes.h
4    @brief Describes the different modes of the codec
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34 */
35
36 #ifndef MODES_H
37 #define MODES_H
38
39 #include <speex/speex.h>
40 #include <speex/speex_bits.h>
41 #include "misc.h"
42
43 #define NB_SUBMODES 16
44 #define NB_SUBMODE_BITS 4
45
46 #define SB_SUBMODES 8
47 #define SB_SUBMODE_BITS 3
48
49 /* Used internally, NOT TO BE USED in applications */
50 /** Used internally*/
51 #define SPEEX_GET_PI_GAIN 100
52 /** Used internally*/
53 #define SPEEX_GET_EXC     101
54 /** Used internally*/
55 #define SPEEX_GET_INNOV   102
56 /** Used internally*/
57 #define SPEEX_GET_DTX_STATUS   103
58 /** Used internally*/
59 #define SPEEX_SET_INNOVATION_SAVE   104
60 /** Used internally*/
61 #define SPEEX_SET_WIDEBAND   105
62
63
64 /** Quantizes LSPs */
65 typedef void (*lsp_quant_func)(spx_lsp_t *, spx_lsp_t *, int, SpeexBits *);
66
67 /** Decodes quantized LSPs */
68 typedef void (*lsp_unquant_func)(spx_lsp_t *, int, SpeexBits *);
69
70
71 /** Long-term predictor quantization */
72 typedef int (*ltp_quant_func)(spx_word16_t *, spx_word16_t *, spx_coef_t *, spx_coef_t *, 
73                               spx_coef_t *, spx_sig_t *, const void *, int, int, spx_word16_t, 
74                               int, int, SpeexBits*, char *, spx_word16_t *, spx_word16_t *, int, int, int, spx_word32_t *);
75
76 /** Long-term un-quantize */
77 typedef void (*ltp_unquant_func)(spx_word16_t *, spx_word32_t *, int, int, spx_word16_t, const void *, int, int *,
78                                  spx_word16_t *, SpeexBits*, char*, int, int, spx_word16_t, int);
79
80
81 /** Innovation quantization function */
82 typedef void (*innovation_quant_func)(spx_word16_t *, spx_coef_t *, spx_coef_t *, spx_coef_t *, const void *, int, int, 
83                                       spx_sig_t *, spx_word16_t *, SpeexBits *, char *, int, int);
84
85 /** Innovation unquantization function */
86 typedef void (*innovation_unquant_func)(spx_sig_t *, const void *, int, SpeexBits*, char *, spx_int32_t *);
87
88 /** Description of a Speex sub-mode (wither narrowband or wideband */
89 typedef struct SpeexSubmode {
90    int     lbr_pitch;          /**< Set to -1 for "normal" modes, otherwise encode pitch using a global pitch and allowing a +- lbr_pitch variation (for low not-rates)*/
91    int     forced_pitch_gain;  /**< Use the same (forced) pitch gain for all sub-frames */
92    int     have_subframe_gain; /**< Number of bits to use as sub-frame innovation gain */
93    int     double_codebook;    /**< Apply innovation quantization twice for higher quality (and higher bit-rate)*/
94    /*LSP functions*/
95    lsp_quant_func    lsp_quant; /**< LSP quantization function */
96    lsp_unquant_func  lsp_unquant; /**< LSP unquantization function */
97
98    /*Lont-term predictor functions*/
99    ltp_quant_func    ltp_quant; /**< Long-term predictor (pitch) quantizer */
100    ltp_unquant_func  ltp_unquant; /**< Long-term predictor (pitch) un-quantizer */
101    const void       *ltp_params; /**< Pitch parameters (options) */
102
103    /*Quantization of innovation*/
104    innovation_quant_func innovation_quant; /**< Innovation quantization */
105    innovation_unquant_func innovation_unquant; /**< Innovation un-quantization */
106    const void             *innovation_params; /**< Innovation quantization parameters*/
107
108    spx_word16_t      comb_gain;  /**< Gain of enhancer comb filter */
109
110    int               bits_per_frame; /**< Number of bits per frame after encoding*/
111 } SpeexSubmode;
112
113 /** Struct defining the encoding/decoding mode*/
114 typedef struct SpeexNBMode {
115    int     frameSize;      /**< Size of frames used for encoding */
116    int     subframeSize;   /**< Size of sub-frames used for encoding */
117    int     lpcSize;        /**< Order of LPC filter */
118    int     pitchStart;     /**< Smallest pitch value allowed */
119    int     pitchEnd;       /**< Largest pitch value allowed */
120
121    spx_word16_t gamma1;    /**< Perceptual filter parameter #1 */
122    spx_word16_t gamma2;    /**< Perceptual filter parameter #2 */
123    float   lag_factor;     /**< Lag-windowing parameter */
124    spx_word16_t   lpc_floor;      /**< Noise floor for LPC analysis */
125
126 #ifdef EPIC_48K
127    int     lbr48k;         /**< 1 for the special 4.8 kbps mode */
128 #endif
129
130    const SpeexSubmode *submodes[NB_SUBMODES]; /**< Sub-mode data for the mode */
131    int     defaultSubmode; /**< Default sub-mode to use when encoding */
132    int     quality_map[11]; /**< Mode corresponding to each quality setting */
133 } SpeexNBMode;
134
135
136 /** Struct defining the encoding/decoding mode for SB-CELP (wideband) */
137 typedef struct SpeexSBMode {
138    const SpeexMode *nb_mode;    /**< Embedded narrowband mode */
139    int     frameSize;     /**< Size of frames used for encoding */
140    int     subframeSize;  /**< Size of sub-frames used for encoding */
141    int     lpcSize;       /**< Order of LPC filter */
142    int     bufSize;       /**< Signal buffer size in encoder */
143    spx_word16_t gamma1;   /**< Perceptual filter parameter #1 */
144    spx_word16_t gamma2;   /**< Perceptual filter parameter #1 */
145    float   lag_factor;    /**< Lag-windowing parameter */
146    spx_word16_t   lpc_floor;     /**< Noise floor for LPC analysis */
147    spx_word16_t   folding_gain;
148
149    const SpeexSubmode *submodes[SB_SUBMODES]; /**< Sub-mode data for the mode */
150    int     defaultSubmode; /**< Default sub-mode to use when encoding */
151    int     low_quality_map[11]; /**< Mode corresponding to each quality setting */
152    int     quality_map[11]; /**< Mode corresponding to each quality setting */
153    const float (*vbr_thresh)[11];
154    int     nb_modes;
155 } SpeexSBMode;
156
157 int speex_encode_native(void *state, spx_word16_t *in, SpeexBits *bits);
158 int speex_decode_native(void *state, SpeexBits *bits, spx_word16_t *out);
159
160 int nb_mode_query(const void *mode, int request, void *ptr);
161 int wb_mode_query(const void *mode, int request, void *ptr);
162
163 #endif