Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_PLC.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 #ifndef SKP_SILK_PLC_FIX_H\r
29 #define SKP_SILK_PLC_FIX_H\r
30 \r
31 #include "SKP_Silk_main_FIX.h"\r
32 \r
33 #define BWE_COEF_Q16                    64880           /* 0.99 in Q16                      */\r
34 #define V_PITCH_GAIN_START_MIN_Q14      11469           /* 0.7 in Q14                       */\r
35 #define V_PITCH_GAIN_START_MAX_Q14      15565           /* 0.95 in Q14                      */\r
36 #define MAX_PITCH_LAG_MS                18\r
37 #define SA_THRES_Q8                     50\r
38 #define USE_SINGLE_TAP                  1\r
39 #define RAND_BUF_SIZE                   128\r
40 #define RAND_BUF_MASK                   (RAND_BUF_SIZE - 1)\r
41 #define LOG2_INV_LPC_GAIN_HIGH_THRES    4               /* 2^4 = 12 dB LPC gain             */\r
42 #define LOG2_INV_LPC_GAIN_LOW_THRES     8               /* 2^8 = 24 dB LPC gain             */\r
43 #define PITCH_DRIFT_FAC_Q16             655             /* 0.01 in Q16                      */\r
44 \r
45 void SKP_Silk_PLC_Reset(\r
46     SKP_Silk_decoder_state      *psDec              /* I/O Decoder state        */\r
47 );\r
48 \r
49 void SKP_Silk_PLC(\r
50     SKP_Silk_decoder_state      *psDec,             /* I/O Decoder state        */\r
51     SKP_Silk_decoder_control    *psDecCtrl,         /* I/O Decoder control      */\r
52     SKP_int16                   signal[],           /* I/O  signal              */\r
53     SKP_int                     length,             /* I length of residual     */\r
54     SKP_int                     lost                /* I Loss flag              */\r
55 );\r
56 \r
57 void SKP_Silk_PLC_update(\r
58     SKP_Silk_decoder_state      *psDec,             /* I/O Decoder state        */\r
59     SKP_Silk_decoder_control    *psDecCtrl,         /* I/O Decoder control      */\r
60     SKP_int16                   signal[],\r
61     SKP_int                     length\r
62 );\r
63 \r
64 void SKP_Silk_PLC_conceal(\r
65     SKP_Silk_decoder_state      *psDec,             /* I/O Decoder state        */\r
66     SKP_Silk_decoder_control    *psDecCtrl,         /* I/O Decoder control      */\r
67     SKP_int16                   signal[],           /* O LPC residual signal    */\r
68     SKP_int                     length              /* I length of signal       */\r
69 );\r
70 \r
71 void SKP_Silk_PLC_glue_frames(\r
72     SKP_Silk_decoder_state      *psDec,             /* I/O decoder state        */\r
73     SKP_Silk_decoder_control    *psDecCtrl,         /* I/O Decoder control      */\r
74     SKP_int16                   signal[],           /* I/O signal               */\r
75     SKP_int                     length              /* I length of signal       */\r
76 );\r
77 \r
78 #endif\r
79 \r