1/* Copyright (C) 2002 Jean-Marc Valin */
2/**
3   @file ltp.h
4   @brief Long-Term Prediction functions
5*/
6/*
7   Redistribution and use in source and binary forms, with or without
8   modification, are permitted provided that the following conditions
9   are met:
10
11   - Redistributions of source code must retain the above copyright
12   notice, this list of conditions and the following disclaimer.
13
14   - Redistributions in binary form must reproduce the above copyright
15   notice, this list of conditions and the following disclaimer in the
16   documentation and/or other materials provided with the distribution.
17
18   - Neither the name of the Xiph.org Foundation nor the names of its
19   contributors may be used to endorse or promote products derived from
20   this software without specific prior written permission.
21
22   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33*/
34
35#include <speex/speex_bits.h>
36#include "arch.h"
37
38/** LTP parameters. */
39typedef struct {
40   const signed char *gain_cdbk;
41   int     gain_bits;
42   int     pitch_bits;
43} ltp_params;
44
45#ifdef FIXED_POINT
46#define gain_3tap_to_1tap(g) (ABS(g[1]) + (g[0]>0 ? g[0] : -SHR16(g[0],1)) + (g[2]>0 ? g[2] : -SHR16(g[2],1)))
47#else
48#define gain_3tap_to_1tap(g) (ABS(g[1]) + (g[0]>0 ? g[0] : -.5*g[0]) + (g[2]>0 ? g[2] : -.5*g[2]))
49#endif
50
51spx_word32_t inner_prod(const spx_word16_t *x, const spx_word16_t *y, int len);
52void pitch_xcorr(const spx_word16_t *_x, const spx_word16_t *_y, spx_word32_t *corr, int len, int nb_pitch, char *stack);
53
54void open_loop_nbest_pitch(spx_word16_t *sw, int start, int end, int len, int *pitch, spx_word16_t *gain, int N, char *stack);
55
56
57/** Finds the best quantized 3-tap pitch predictor by analysis by synthesis */
58int pitch_search_3tap(
59spx_word16_t target[],                 /* Target vector */
60spx_word16_t *sw,
61spx_coef_t ak[],                     /* LPCs for this subframe */
62spx_coef_t awk1[],                   /* Weighted LPCs #1 for this subframe */
63spx_coef_t awk2[],                   /* Weighted LPCs #2 for this subframe */
64spx_sig_t exc[],                    /* Overlapping codebook */
65const void *par,
66int   start,                    /* Smallest pitch value allowed */
67int   end,                      /* Largest pitch value allowed */
68spx_word16_t pitch_coef,               /* Voicing (pitch) coefficient */
69int   p,                        /* Number of LPC coeffs */
70int   nsf,                      /* Number of samples in subframe */
71SpeexBits *bits,
72char *stack,
73spx_word16_t *exc2,
74spx_word16_t *r,
75int   complexity,
76int   cdbk_offset,
77int plc_tuning,
78spx_word32_t *cumul_gain
79);
80
81/*Unquantize adaptive codebook and update pitch contribution*/
82void pitch_unquant_3tap(
83spx_word16_t exc[],             /* Input excitation */
84spx_word32_t exc_out[],         /* Output excitation */
85int   start,                    /* Smallest pitch value allowed */
86int   end,                      /* Largest pitch value allowed */
87spx_word16_t pitch_coef,        /* Voicing (pitch) coefficient */
88const void *par,
89int   nsf,                      /* Number of samples in subframe */
90int *pitch_val,
91spx_word16_t *gain_val,
92SpeexBits *bits,
93char *stack,
94int lost,
95int subframe_offset,
96spx_word16_t last_pitch_gain,
97int cdbk_offset
98);
99
100/** Forced pitch delay and gain */
101int forced_pitch_quant(
102spx_word16_t target[],                 /* Target vector */
103spx_word16_t *sw,
104spx_coef_t ak[],                     /* LPCs for this subframe */
105spx_coef_t awk1[],                   /* Weighted LPCs #1 for this subframe */
106spx_coef_t awk2[],                   /* Weighted LPCs #2 for this subframe */
107spx_sig_t exc[],                    /* Excitation */
108const void *par,
109int   start,                    /* Smallest pitch value allowed */
110int   end,                      /* Largest pitch value allowed */
111spx_word16_t pitch_coef,               /* Voicing (pitch) coefficient */
112int   p,                        /* Number of LPC coeffs */
113int   nsf,                      /* Number of samples in subframe */
114SpeexBits *bits,
115char *stack,
116spx_word16_t *exc2,
117spx_word16_t *r,
118int complexity,
119int cdbk_offset,
120int plc_tuning,
121spx_word32_t *cumul_gain
122);
123
124/** Unquantize forced pitch delay and gain */
125void forced_pitch_unquant(
126spx_word16_t exc[],             /* Input excitation */
127spx_word32_t exc_out[],         /* Output excitation */
128int   start,                    /* Smallest pitch value allowed */
129int   end,                      /* Largest pitch value allowed */
130spx_word16_t pitch_coef,        /* Voicing (pitch) coefficient */
131const void *par,
132int   nsf,                      /* Number of samples in subframe */
133int *pitch_val,
134spx_word16_t *gain_val,
135SpeexBits *bits,
136char *stack,
137int lost,
138int subframe_offset,
139spx_word16_t last_pitch_gain,
140int cdbk_offset
141);
142