Added low bit-rate (8 kbps) narrowband mode. It is still sub-optimal but
[speexdsp.git] / libspeex / nb_celp.h
1 /* Copyright (C) 2002 Jean-Marc Valin 
2    File: nb_celp.h
3
4    This library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8    
9    This library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13    
14    You should have received a copy of the GNU Lesser General Public
15    License along with this library; if not, write to the Free Software
16    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
18 */
19
20 #ifndef SPEEX_H
21 #define SPEEX_H
22
23 #include "modes.h"
24 #include "speex_bits.h"
25
26 /**Structure representing the full state of the narrowband encoder*/
27 typedef struct EncState {
28    SpeexMode *mode;
29    int    first;          /* Is this the first frame? */
30    int    frameSize;      /* Size of frames */
31    int    subframeSize;   /* Size of sub-frames */
32    int    nbSubframes;    /* Number of sub-frames */
33    int    windowSize;     /* Analysis (LPC) window length */
34    int    lpcSize;        /* LPC order */
35    int    bufSize;        /* Buffer size */
36    int    min_pitch;      /* Minimum pitch value allowed */
37    int    max_pitch;      /* Maximum pitch value allowed */
38    int    lbr_pitch;      /* Forces pitch to be within +-7 samples of open-loop pitch*/
39    int    ol_pitch;       /* Open-loop pitch */
40    int    ol_voiced;      /* Open-loop voiced/non-voiced decision */
41    int   *pitch;
42    float  gamma1;         /* Perceptual filter: A(z/gamma1) */
43    float  gamma2;         /* Perceptual filter: A(z/gamma2) */
44    float  lag_factor;     /* Lag windowing gaussian width */
45    float  lpc_floor;      /* Noise floor multiplier for A[0] in LPC analysis*/
46    float  preemph;        /* Pre-emphasis: P(z) = 1 - a*z^-1*/
47    float  pre_mem;        /* 1-element memory for pre-emphasis */
48    float  pre_mem2;       /* 1-element memory for pre-emphasis */
49    float *stack;          /* Pseudo-stack allocation for temporary memory */
50    float *inBuf;          /* Input buffer (original signal) */
51    float *frame;          /* Start of original frame */
52    float *excBuf;         /* Excitation buffer */
53    float *exc;            /* Start of excitation frame */
54    float *exc2Buf;           /* "Pitch enhanced" excitation */
55    float *exc2;           /* "Pitch enhanced" excitation */
56    float *swBuf;          /* Weighted signal buffer */
57    float *sw;             /* Start of weighted signal frame */
58    float *window;         /* Temporary (Hanning) window */
59    float *buf2;           /* 2nd temporary buffer */
60    float *autocorr;       /* auto-correlation */
61    float *lagWindow;      /* Window applied to auto-correlation */
62    float *lpc;            /* LPCs for current frame */
63    float *lsp;            /* LSPs for current frame */
64    float *qlsp;           /* Quantized LSPs for current frame */
65    float *old_lsp;        /* LSPs for previous frame */
66    float *old_qlsp;       /* Quantized LSPs for previous frame */
67    float *interp_lsp;     /* Interpolated LSPs */
68    float *interp_qlsp;    /* Interpolated quantized LSPs */
69    float *interp_lpc;     /* Interpolated LPCs */
70    float *interp_qlpc;    /* Interpolated quantized LPCs */
71    float *bw_lpc1;        /* LPCs after bandwidth expansion by gamma1 for perceptual weighting*/
72    float *bw_lpc2;        /* LPCs after bandwidth expansion by gamma2 for perceptual weighting*/
73    float *rc;             /* Reflection coefficients */
74    float *mem_sp, *mem_sw;
75    float *dmem1, *dmem2;
76    float *pi_gain;
77
78    lsp_quant_func    lsp_quant;
79    ltp_quant_func    ltp_quant;
80    void             *ltp_params;
81    innovation_quant_func innovation_quant;
82    void             *innovation_params;
83 } EncState;
84
85 /**Structure representing the full state of the narrowband decoder*/
86 typedef struct DecState {
87    SpeexMode *mode;
88    int    first;          /* Is this the first frame? */
89    int    frameSize;      /* Size of frames */
90    int    subframeSize;   /* Size of sub-frames */
91    int    nbSubframes;    /* Number of sub-frames */
92    int    windowSize;     /* Analysis (LPC) window length */
93    int    lpcSize;        /* LPC order */
94    int    bufSize;        /* Buffer size */
95    int    min_pitch;      /* Minimum pitch value allowed */
96    int    max_pitch;      /* Maximum pitch value allowed */
97    int    lbr_pitch;      /* Forces pitch to be within +-7 samples of open-loop pitch*/
98    float  gamma1;         /* Perceptual filter: A(z/gamma1) */
99    float  gamma2;         /* Perceptual filter: A(z/gamma2) */
100    float  preemph;        /* Pre-emphasis: P(z) = 1 - a*z^-1*/
101    float  pre_mem;        /* 1-element memory for pre-emphasis */
102    float *stack;
103    float *inBuf;          /* Input buffer (original signal) */
104    float *frame;          /* Start of original frame */
105    float *excBuf;         /* Excitation buffer */
106    float *exc2Buf;        /* Excitation (after post-filter) buffer */
107    float *exc;            /* Start of excitation frame */
108    float *exc2;           /* Start of excitation frame after post-filter*/
109    float *qlsp;           /* Quantized LSPs for current frame */
110    float *old_qlsp;       /* Quantized LSPs for previous frame */
111    float *interp_qlsp;    /* Interpolated quantized LSPs */
112    float *interp_qlpc;    /* Interpolated quantized LPCs */
113    float *mem_sp;
114    float *mem_pf;
115    float *mem_pf2;
116    float *pi_gain;
117
118    lsp_unquant_func  lsp_unquant;
119    ltp_unquant_func  ltp_unquant;
120    void             *ltp_params;
121    innovation_unquant_func innovation_unquant;
122    void             *innovation_params;
123    nb_post_filter_func post_filter_func;
124    void             *post_filter_params;
125    int               pf_enabled;
126 } DecState;
127
128 /**Initializes encoder state*/
129 void *nb_encoder_init(SpeexMode *m);
130
131 /**De-allocates encoder state resources*/
132 void nb_encoder_destroy(void *state);
133
134 /**Encodes one frame*/
135 void nb_encode(void *state, float *in, SpeexBits *bits);
136
137
138 /**Initializes decoder state*/
139 void *nb_decoder_init(SpeexMode *m);
140
141 /**De-allocates decoder state resources*/
142 void nb_decoder_destroy(void *state);
143
144 /**Decodes one frame*/
145 void nb_decode(void *state, SpeexBits *bits, float *out, int lost);
146
147 void nb_encoder_ctl(void *state, int request, void *ptr);
148
149 void nb_decoder_ctl(void *state, int request, void *ptr);
150
151
152 #endif