Finished cleaning up the sub-band mode
[speexdsp.git] / libspeex / cb_search.h
1 /* Copyright (C) 2002 Jean-Marc Valin & David Rowe
2    File: cb_search.c
3    Overlapped codebook search
4
5    This library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9    
10    This library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14    
15    You should have received a copy of the GNU Lesser General Public
16    License along with this library; if not, write to the Free Software
17    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18 */
19
20 #ifndef CB_SEARCH_H
21 #define CB_SEARCH_H
22
23 #include "speex_bits.h"
24
25 typedef struct split_cb_params {
26    int     subvect_size;
27    int     nb_subvect;
28    float  *shape_cb;
29    int     shape_bits;
30 } split_cb_params;
31
32 float overlap_cb_search(
33 float target[],                 /* target vector */
34 float ak[],                     /* LPCs for this subframe */
35 float awk1[],                   /* Weighted LPCs for this subframe */
36 float awk2[],                   /* Weighted LPCs for this subframe */
37 float codebook[],               /* overlapping codebook */
38 int   entries,                  /* number of overlapping entries to search */
39 float *gain,                    /* gain of optimum entry */
40 int   *index,                   /* index of optimum entry */
41 int   p,                        /* number of LPC coeffs */
42 int   nsf,                      /* number of samples in subframe */
43 float *stack
44 );
45
46 void split_cb_search(
47 float target[],                 /* target vector */
48 float ak[],                     /* LPCs for this subframe */
49 float awk1[],                   /* Weighted LPCs for this subframe */
50 float awk2[],                   /* Weighted LPCs for this subframe */
51 void *par,                      /* Codebook/search parameters*/
52 int   p,                        /* number of LPC coeffs */
53 int   nsf,                      /* number of samples in subframe */
54 float *exc,
55 FrameBits *bits,
56 float *stack
57 );
58
59 void split_cb_search_nogain(
60 float target[],                 /* target vector */
61 float ak[],                     /* LPCs for this subframe */
62 float awk1[],                   /* Weighted LPCs for this subframe */
63 float awk2[],                   /* Weighted LPCs for this subframe */
64 void *par,                      /* Codebook/search parameters*/
65 int   p,                        /* number of LPC coeffs */
66 int   nsf,                      /* number of samples in subframe */
67 float *exc,
68 FrameBits *bits,
69 float *stack
70 );
71
72
73 void split_cb_search2(
74 float target[],                 /* target vector */
75 float ak[],                     /* LPCs for this subframe */
76 float awk1[],                   /* Weighted LPCs for this subframe */
77 float awk2[],                   /* Weighted LPCs for this subframe */
78 void *par,                      /* Codebook/search parameters*/
79 int   p,                        /* number of LPC coeffs */
80 int   nsf,                      /* number of samples in subframe */
81 float *exc,
82 FrameBits *bits,
83 float *stack
84 );
85
86
87 void split_cb_unquant(
88 float *exc,
89 void  *par,                     /* Innovation parameters */
90 int   nsf,                      /* number of samples in subframe */
91 FrameBits *bits,
92 float *stack
93 );
94
95 void split_cb_nogain_unquant(
96 float *exc,
97 void *par,                      /* non-overlapping codebook */
98 int   nsf,                      /* number of samples in subframe */
99 FrameBits *bits,
100 float *stack
101 );
102
103 #endif