Replaces log2() with celt_log2() and fixes a potential divide-by-zero
[opus.git] / silk / float / structs_FLP.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_STRUCTS_FLP_H
29 #define SILK_STRUCTS_FLP_H
30
31 #include "typedef.h"
32 #include "main.h"
33 #include "structs.h"
34
35 #ifdef __cplusplus
36 extern "C"
37 {
38 #endif
39
40 /********************************/
41 /* Noise shaping analysis state */
42 /********************************/
43 typedef struct {
44     opus_int8                   LastGainIndex;
45     silk_float                  HarmBoost_smth;
46     silk_float                  HarmShapeGain_smth;
47     silk_float                  Tilt_smth;
48 } silk_shape_state_FLP;
49
50 /********************************/
51 /* Prefilter state              */
52 /********************************/
53 typedef struct {
54     silk_float                  sLTP_shp[ LTP_BUF_LENGTH ];
55     silk_float                  sAR_shp[ MAX_SHAPE_LPC_ORDER + 1 ];
56     opus_int                    sLTP_shp_buf_idx;
57     silk_float                  sLF_AR_shp;
58     silk_float                  sLF_MA_shp;
59     silk_float                  sHarmHP;
60     opus_int32                  rand_seed;
61     opus_int                    lagPrev;
62 } silk_prefilter_state_FLP;
63
64 /********************************/
65 /* Encoder state FLP            */
66 /********************************/
67 typedef struct {
68     silk_encoder_state          sCmn;                               /* Common struct, shared with fixed-point code */
69     silk_shape_state_FLP        sShape;                             /* Noise shaping state */
70     silk_prefilter_state_FLP    sPrefilt;                           /* Prefilter State */
71
72     /* Buffer for find pitch and noise shape analysis */
73     silk_float                  x_buf[ 2 * MAX_FRAME_LENGTH + LA_SHAPE_MAX ];/* Buffer for find pitch and noise shape analysis */
74     silk_float                  LTPCorr;                            /* Normalized correlation from pitch lag estimator */
75 } silk_encoder_state_FLP;
76
77 /************************/
78 /* Encoder control FLP  */
79 /************************/
80 typedef struct {
81     /* Prediction and coding parameters */
82     silk_float                  Gains[ MAX_NB_SUBFR ];
83     silk_float                  PredCoef[ 2 ][ MAX_LPC_ORDER ];     /* holds interpolated and final coefficients */
84     silk_float                  LTPCoef[LTP_ORDER * MAX_NB_SUBFR];
85     silk_float                  LTP_scale;
86     opus_int                    pitchL[ MAX_NB_SUBFR ];
87
88     /* Noise shaping parameters */
89     silk_float                  AR1[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];
90     silk_float                  AR2[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];
91     silk_float                  LF_MA_shp[     MAX_NB_SUBFR ];
92     silk_float                  LF_AR_shp[     MAX_NB_SUBFR ];
93     silk_float                  GainsPre[      MAX_NB_SUBFR ];
94     silk_float                  HarmBoost[     MAX_NB_SUBFR ];
95     silk_float                  Tilt[          MAX_NB_SUBFR ];
96     silk_float                  HarmShapeGain[ MAX_NB_SUBFR ];
97     silk_float                  Lambda;
98     silk_float                  input_quality;
99     silk_float                  coding_quality;
100
101     /* Measures */
102     silk_float                  sparseness;
103     silk_float                  predGain;
104     silk_float                  LTPredCodGain;
105     silk_float                  ResNrg[ MAX_NB_SUBFR ];             /* Residual energy per subframe */
106
107     /* Parameters for CBR mode */
108     opus_int32                  GainsUnq_Q16[ MAX_NB_SUBFR ];
109     opus_int8                   lastGainIndexPrev;
110 } silk_encoder_control_FLP;
111
112 /************************/
113 /* Encoder Super Struct */
114 /************************/
115 typedef struct {
116     silk_encoder_state_FLP      state_Fxx[ ENCODER_NUM_CHANNELS ];
117     stereo_enc_state            sStereo;
118     opus_int32                  nBitsExceeded;
119     opus_int                    nChannelsAPI;
120     opus_int                    nChannelsInternal;
121     opus_int                    nPrevChannelsInternal;
122     opus_int                    timeSinceSwitchAllowed_ms;
123     opus_int                    allowBandwidthSwitch;
124     opus_int                    prev_decode_only_middle;
125 } silk_encoder;
126
127 #ifdef __cplusplus
128 }
129 #endif
130
131 #endif