Changed license to BSD
[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    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8    
9    - Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11    
12    - Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15    
16    - Neither the name of the Xiph.org Foundation nor the names of its
17    contributors may be used to endorse or promote products derived from
18    this software without specific prior written permission.
19    
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef CB_SEARCH_H
34 #define CB_SEARCH_H
35
36 #include "speex_bits.h"
37
38 typedef struct split_cb_params {
39    int     subvect_size;
40    int     nb_subvect;
41    float  *shape_cb;
42    int     shape_bits;
43 } split_cb_params;
44
45
46 void split_cb_search_nogain(
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 SpeexBits *bits,
56 float *stack,
57 int   complexity
58 );
59
60 void split_cb_search_shape_sign(
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 SpeexBits *bits,
70 float *stack,
71 int   complexity
72 );
73
74 void split_cb_shape_sign_unquant(
75 float *exc,
76 void *par,                      /* non-overlapping codebook */
77 int   nsf,                      /* number of samples in subframe */
78 SpeexBits *bits,
79 float *stack
80 );
81
82 void split_cb_nogain_unquant(
83 float *exc,
84 void *par,                      /* non-overlapping codebook */
85 int   nsf,                      /* number of samples in subframe */
86 SpeexBits *bits,
87 float *stack
88 );
89
90
91 void noise_codebook_quant(
92 float target[],                 /* target vector */
93 float ak[],                     /* LPCs for this subframe */
94 float awk1[],                   /* Weighted LPCs for this subframe */
95 float awk2[],                   /* Weighted LPCs for this subframe */
96 void *par,                      /* Codebook/search parameters*/
97 int   p,                        /* number of LPC coeffs */
98 int   nsf,                      /* number of samples in subframe */
99 float *exc,
100 SpeexBits *bits,
101 float *stack,
102 int   complexity
103 );
104
105
106 void noise_codebook_unquant(
107 float *exc,
108 void *par,                      /* non-overlapping codebook */
109 int   nsf,                      /* number of samples in subframe */
110 SpeexBits *bits,
111 float *stack
112 );
113
114 #endif