Annotating pointer arguments with OPUS_RESTRICT and const
[opus.git] / silk / pitch_est_defines.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, are permitted provided that the following conditions
5 are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Internet Society, IETF or IETF Trust, nor the
12 names of specific contributors, may be used to endorse or promote
13 products derived from this software without specific prior written
14 permission.
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifndef SILK_PE_DEFINES_H
29 #define SILK_PE_DEFINES_H
30
31 #include "SigProc_FIX.h"
32
33 /********************************************************/
34 /* Definitions for pitch estimator                      */
35 /********************************************************/
36
37 #define PE_MAX_FS_KHZ               16 /* Maximum sampling frequency used */
38
39 #define PE_MAX_NB_SUBFR             4
40 #define PE_SUBFR_LENGTH_MS          5   /* 5 ms */
41
42 #define PE_LTP_MEM_LENGTH_MS        ( 4 * PE_SUBFR_LENGTH_MS )
43
44 #define PE_MAX_FRAME_LENGTH_MS      ( PE_LTP_MEM_LENGTH_MS + PE_MAX_NB_SUBFR * PE_SUBFR_LENGTH_MS )
45 #define PE_MAX_FRAME_LENGTH         ( PE_MAX_FRAME_LENGTH_MS * PE_MAX_FS_KHZ )
46 #define PE_MAX_FRAME_LENGTH_ST_1    ( PE_MAX_FRAME_LENGTH >> 2 )
47 #define PE_MAX_FRAME_LENGTH_ST_2    ( PE_MAX_FRAME_LENGTH >> 1 )
48
49 #define PE_MAX_LAG_MS               18           /* 18 ms -> 56 Hz */
50 #define PE_MIN_LAG_MS               2            /* 2 ms -> 500 Hz */
51 #define PE_MAX_LAG                  ( PE_MAX_LAG_MS * PE_MAX_FS_KHZ )
52 #define PE_MIN_LAG                  ( PE_MIN_LAG_MS * PE_MAX_FS_KHZ )
53
54 #define PE_D_SRCH_LENGTH            24
55
56 #define PE_NB_STAGE3_LAGS           5
57
58 #define PE_NB_CBKS_STAGE2           3
59 #define PE_NB_CBKS_STAGE2_EXT       11
60
61 #define PE_NB_CBKS_STAGE3_MAX       34
62 #define PE_NB_CBKS_STAGE3_MID       24
63 #define PE_NB_CBKS_STAGE3_MIN       16
64
65 #define PE_NB_CBKS_STAGE3_10MS      12
66 #define PE_NB_CBKS_STAGE2_10MS      3
67
68 #define PE_SHORTLAG_BIAS            0.2f    /* for logarithmic weighting    */
69 #define PE_PREVLAG_BIAS             0.2f    /* for logarithmic weighting    */
70 #define PE_FLATCONTOUR_BIAS         0.05f
71
72 #define SILK_PE_MIN_COMPLEX         0
73 #define SILK_PE_MID_COMPLEX         1
74 #define SILK_PE_MAX_COMPLEX         2
75
76 /* Tables for 20 ms frames */
77 extern const opus_int8 silk_CB_lags_stage2[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE2_EXT ];
78 extern const opus_int8 silk_CB_lags_stage3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ];
79 extern const opus_int8 silk_Lag_range_stage3[ SILK_PE_MAX_COMPLEX + 1 ] [ PE_MAX_NB_SUBFR ][ 2 ];
80 extern const opus_int8 silk_nb_cbk_searchs_stage3[ SILK_PE_MAX_COMPLEX + 1 ];
81
82 /* Tables for 10 ms frames */
83 extern const opus_int8 silk_CB_lags_stage2_10_ms[ PE_MAX_NB_SUBFR >> 1][ 3 ];
84 extern const opus_int8 silk_CB_lags_stage3_10_ms[ PE_MAX_NB_SUBFR >> 1 ][ 12 ];
85 extern const opus_int8 silk_Lag_range_stage3_10_ms[ PE_MAX_NB_SUBFR >> 1 ][ 2 ];
86
87 #endif
88