Added joint optimization of excitation gains
[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 "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    float  *gain_cb;
31    int     gain_bits;
32 } split_cb_params;
33
34 float overlap_cb_search(
35 float target[],                 /* target vector */
36 float ak[],                     /* LPCs for this subframe */
37 float awk1[],                   /* Weighted LPCs for this subframe */
38 float awk2[],                   /* Weighted LPCs for this subframe */
39 float codebook[],               /* overlapping codebook */
40 int   entries,                  /* number of overlapping entries to search */
41 float *gain,                    /* gain of optimum entry */
42 int   *index,                   /* index of optimum entry */
43 int   p,                        /* number of LPC coeffs */
44 int   nsf                       /* number of samples in subframe */
45 );
46
47 void split_cb_search(
48 float target[],                 /* target vector */
49 float ak[],                     /* LPCs for this subframe */
50 float awk1[],                   /* Weighted LPCs for this subframe */
51 float awk2[],                   /* Weighted LPCs for this subframe */
52 void *par,                      /* Codebook/search parameters*/
53 int   p,                        /* number of LPC coeffs */
54 int   nsf,                      /* number of samples in subframe */
55 float *exc,
56 FrameBits *bits,
57 float *stack
58 );
59
60 void split_cb_search_wb(
61 float target[],                 /* target vector */
62 float ak[],                     /* LPCs for this subframe */
63 float awk1[],                   /* Weighted LPCs for this subframe */
64 float awk2[],                   /* Weighted LPCs for this subframe */
65 void *par,                      /* Codebook/search parameters*/
66 int   p,                        /* number of LPC coeffs */
67 int   nsf,                      /* number of samples in subframe */
68 float *exc,
69 FrameBits *bits,
70 float *stack
71 );
72
73 void split_cb_unquant(
74 float *exc,
75 void  *par,                     /* Innovation parameters */
76 int   nsf,                      /* number of samples in subframe */
77 FrameBits *bits,
78 float *stack
79 );
80
81 #endif