Fix stack corruption with high rate SILK encoding added by the recent CBR changes...
[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, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions 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 Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE 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
76     /* Parameters for LTP scaling control */
77     silk_float                   prevLTPredCodGain;
78     silk_float                   HPLTPredCodGain;
79 } silk_encoder_state_FLP;
80
81 /************************/
82 /* Encoder control FLP  */
83 /************************/
84 typedef struct {
85     /* Prediction and coding parameters */
86     silk_float                    Gains[ MAX_NB_SUBFR ];
87     silk_float                    PredCoef[ 2 ][ MAX_LPC_ORDER ];        /* holds interpolated and final coefficients */
88     silk_float                    LTPCoef[LTP_ORDER * MAX_NB_SUBFR];
89     silk_float                    LTP_scale;
90     opus_int                     pitchL[ MAX_NB_SUBFR ];
91
92     /* Noise shaping parameters */
93     silk_float                    AR1[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];
94     silk_float                    AR2[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];
95     silk_float                    LF_MA_shp[     MAX_NB_SUBFR ];
96     silk_float                    LF_AR_shp[     MAX_NB_SUBFR ];
97     silk_float                    GainsPre[      MAX_NB_SUBFR ];
98     silk_float                    HarmBoost[     MAX_NB_SUBFR ];
99     silk_float                    Tilt[          MAX_NB_SUBFR ];
100     silk_float                    HarmShapeGain[ MAX_NB_SUBFR ];
101     silk_float                    Lambda;
102     silk_float                    input_quality;
103     silk_float                    coding_quality;
104
105     /* Measures */
106     silk_float                    sparseness;
107     silk_float                   predGain;
108     silk_float                    LTPredCodGain;
109     silk_float                    ResNrg[ MAX_NB_SUBFR ];                    /* Residual energy per subframe */
110
111     /* Parameters for CBR mode */
112     opus_int32                    GainsUnq_Q16[ MAX_NB_SUBFR ];
113     opus_int8                     lastGainIndexPrev;
114 } silk_encoder_control_FLP;
115
116 /************************/
117 /* Encoder Super Struct */
118 /************************/
119 typedef struct {
120     silk_encoder_state_FLP      state_Fxx[ ENCODER_NUM_CHANNELS ];
121     stereo_enc_state            sStereo;
122     opus_int32                   nBitsExceeded;
123     opus_int                     nChannelsAPI;
124     opus_int                     nChannelsInternal;
125     opus_int                     nPrevChannelsInternal;
126     opus_int                     timeSinceSwitchAllowed_ms;
127     opus_int                     allowBandwidthSwitch;
128     opus_int                     prev_decode_only_middle;
129 } silk_encoder;
130
131 #ifdef __cplusplus
132 }
133 #endif
134
135 #endif