7cf9aca7c50b6d54d7ba74b86b05175f4642a1e1
[speexdsp.git] / libspeex / speex.h
1 /* Copyright (C) 2002 Jean-Marc Valin 
2    File: speex.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 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    ol_pitch;       /* Open-loop pitch */
39    int    ol_voiced;      /* Open-loop voiced/non-voiced decision */
40    int   *pitch;
41    float  gamma1;         /* Perceptual filter: A(z/gamma1) */
42    float  gamma2;         /* Perceptual filter: A(z/gamma2) */
43    float  lag_factor;     /* Lag windowing gaussian width */
44    float  lpc_floor;      /* Noise floor multiplier for A[0] in LPC analysis*/
45    float  preemph;        /* Pre-emphasis: P(z) = 1 - a*z^-1*/
46    float  pre_mem;        /* 1-element memory for pre-emphasis */
47    float  pre_mem2;       /* 1-element memory for pre-emphasis */
48    float *stack;          /* Pseudo-stack allocation for temporary memory */
49    int    os_fact;        /* Over-sampling factor for fractional pitch */
50    int    os_filt_ord2;   /* Over-sampling filter size for fractional pitch */
51    float *os_exc;         /* Over-sampled excitation for fractional pitch */
52    float *os_filt;        /* Over-sampling filter for fractional pitch */
53    float *inBuf;          /* Input buffer (original signal) */
54    float *frame;          /* Start of original frame */
55    float *excBuf;         /* Excitation buffer */
56    float *exc;            /* Start of excitation frame */
57    float *exc2Buf;           /* "Pitch enhanced" excitation */
58    float *exc2;           /* "Pitch enhanced" excitation */
59    float *swBuf;          /* Weighted signal buffer */
60    float *sw;             /* Start of weighted signal frame */
61    float *window;         /* Temporary (Hanning) window */
62    float *buf2;           /* 2nd temporary buffer */
63    float *autocorr;       /* auto-correlation */
64    float *lagWindow;      /* Window applied to auto-correlation */
65    float *lpc;            /* LPCs for current frame */
66    float *lsp;            /* LSPs for current frame */
67    float *qlsp;           /* Quantized LSPs for current frame */
68    float *old_lsp;        /* LSPs for previous frame */
69    float *old_qlsp;       /* Quantized LSPs for previous frame */
70    float *interp_lsp;     /* Interpolated LSPs */
71    float *interp_qlsp;    /* Interpolated quantized LSPs */
72    float *interp_lpc;     /* Interpolated LPCs */
73    float *interp_qlpc;    /* Interpolated quantized LPCs */
74    float *bw_lpc1;        /* LPCs after bandwidth expansion by gamma1 for perceptual weighting*/
75    float *bw_lpc2;        /* LPCs after bandwidth expansion by gamma2 for perceptual weighting*/
76    float *rc;             /* Reflection coefficients */
77    float *mem_sp, *mem_sw;
78    float *dmem1, *dmem2;
79    float *pi_gain;
80
81    lsp_quant_func    lsp_quant;
82    ltp_quant_func    ltp_quant;
83    void             *ltp_params;
84    innovation_quant_func innovation_quant;
85    void             *innovation_params;
86 } EncState;
87
88 typedef struct DecState {
89    SpeexMode *mode;
90    int    first;          /* Is this the first frame? */
91    int    frameSize;      /* Size of frames */
92    int    subframeSize;   /* Size of sub-frames */
93    int    nbSubframes;    /* Number of sub-frames */
94    int    windowSize;     /* Analysis (LPC) window length */
95    int    lpcSize;        /* LPC order */
96    int    bufSize;        /* Buffer size */
97    int    min_pitch;      /* Minimum pitch value allowed */
98    int    max_pitch;      /* Maximum pitch value allowed */
99    float  gamma1;         /* Perceptual filter: A(z/gamma1) */
100    float  gamma2;         /* Perceptual filter: A(z/gamma2) */
101    float  preemph;        /* Pre-emphasis: P(z) = 1 - a*z^-1*/
102    float  pre_mem;        /* 1-element memory for pre-emphasis */
103    float *stack;
104    float *inBuf;          /* Input buffer (original signal) */
105    float *frame;          /* Start of original frame */
106    float *excBuf;         /* Excitation buffer */
107    float *exc;            /* Start of excitation frame */
108    float *qlsp;           /* Quantized LSPs for current frame */
109    float *old_qlsp;       /* Quantized LSPs for previous frame */
110    float *interp_qlsp;    /* Interpolated quantized LSPs */
111    float *interp_qlpc;    /* Interpolated quantized LPCs */
112    float *mem_sp;
113    float *pi_gain;
114
115    lsp_unquant_func  lsp_unquant;
116    ltp_unquant_func  ltp_unquant;
117    void             *ltp_params;
118    innovation_unquant_func innovation_unquant;
119    void             *innovation_params;
120 } DecState;
121
122 /**Initializes encoder state*/
123 void *nb_encoder_init(SpeexMode *m);
124
125 /**De-allocates encoder state resources*/
126 void nb_encoder_destroy(void *state);
127
128 /**Encodes one frame*/
129 void nb_encode(void *state, float *in, FrameBits *bits);
130
131
132 /**Initializes decoder state*/
133 void *nb_decoder_init(SpeexMode *m);
134
135 /**De-allocates decoder state resources*/
136 void nb_decoder_destroy(void *state);
137
138 /**Decodes one frame*/
139 void nb_decode(void *state, FrameBits *bits, float *out);
140
141
142
143 #endif