Saturates the last RC to 0.99 when Schur blows up
[opus.git] / silk / fixed / structs_FIX.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_FIX_H
29 #define SILK_STRUCTS_FIX_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     opus_int32                  HarmBoost_smth_Q16;
46     opus_int32                  HarmShapeGain_smth_Q16;
47     opus_int32                  Tilt_smth_Q16;
48 } silk_shape_state_FIX;
49
50 /********************************/
51 /* Prefilter state              */
52 /********************************/
53 typedef struct {
54     opus_int16                  sLTP_shp[ LTP_BUF_LENGTH ];
55     opus_int32                  sAR_shp[ MAX_SHAPE_LPC_ORDER + 1 ];
56     opus_int                    sLTP_shp_buf_idx;
57     opus_int32                  sLF_AR_shp_Q12;
58     opus_int32                  sLF_MA_shp_Q12;
59     opus_int32                  sHarmHP_Q2;
60     opus_int32                  rand_seed;
61     opus_int                    lagPrev;
62 } silk_prefilter_state_FIX;
63
64 /********************************/
65 /* Encoder state FIX            */
66 /********************************/
67 typedef struct {
68     silk_encoder_state          sCmn;                                   /* Common struct, shared with floating-point code       */
69     silk_shape_state_FIX        sShape;                                 /* Shape state                                          */
70     silk_prefilter_state_FIX    sPrefilt;                               /* Prefilter State                                      */
71
72     /* Buffer for find pitch and noise shape analysis */
73     silk_DWORD_ALIGN opus_int16 x_buf[ 2 * MAX_FRAME_LENGTH + LA_SHAPE_MAX ];/* Buffer for find pitch and noise shape analysis  */
74     opus_int                    LTPCorr_Q15;                            /* Normalized correlation from pitch lag estimator      */
75 } silk_encoder_state_FIX;
76
77 /************************/
78 /* Encoder control FIX  */
79 /************************/
80 typedef struct {
81     /* Prediction and coding parameters */
82     opus_int32                  Gains_Q16[ MAX_NB_SUBFR ];
83     silk_DWORD_ALIGN opus_int16 PredCoef_Q12[ 2 ][ MAX_LPC_ORDER ];
84     opus_int16                  LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ];
85     opus_int                    LTP_scale_Q14;
86     opus_int                    pitchL[ MAX_NB_SUBFR ];
87
88     /* Noise shaping parameters */
89     /* Testing */
90     silk_DWORD_ALIGN opus_int16 AR1_Q13[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];
91     silk_DWORD_ALIGN opus_int16 AR2_Q13[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];
92     opus_int32                  LF_shp_Q14[        MAX_NB_SUBFR ];      /* Packs two int16 coefficients per int32 value         */
93     opus_int                    GainsPre_Q14[      MAX_NB_SUBFR ];
94     opus_int                    HarmBoost_Q14[     MAX_NB_SUBFR ];
95     opus_int                    Tilt_Q14[          MAX_NB_SUBFR ];
96     opus_int                    HarmShapeGain_Q14[ MAX_NB_SUBFR ];
97     opus_int                    Lambda_Q10;
98     opus_int                    input_quality_Q14;
99     opus_int                    coding_quality_Q14;
100
101     /* measures */
102     opus_int                    sparseness_Q8;
103     opus_int32                  predGain_Q16;
104     opus_int                    LTPredCodGain_Q7;
105     opus_int32                  ResNrg[ MAX_NB_SUBFR ];                 /* Residual energy per subframe                         */
106     opus_int                    ResNrgQ[ MAX_NB_SUBFR ];                /* Q domain for the residual energy > 0                 */
107
108     /* Parameters for CBR mode */
109     opus_int32                  GainsUnq_Q16[ MAX_NB_SUBFR ];
110     opus_int8                   lastGainIndexPrev;
111 } silk_encoder_control_FIX;
112
113 /************************/
114 /* Encoder Super Struct */
115 /************************/
116 typedef struct {
117     silk_encoder_state_FIX      state_Fxx[ ENCODER_NUM_CHANNELS ];
118     stereo_enc_state            sStereo;
119     opus_int32                  nBitsExceeded;
120     opus_int                    nChannelsAPI;
121     opus_int                    nChannelsInternal;
122     opus_int                    nPrevChannelsInternal;
123     opus_int                    timeSinceSwitchAllowed_ms;
124     opus_int                    allowBandwidthSwitch;
125     opus_int                    prev_decode_only_middle;
126 } silk_encoder;
127
128
129 #ifdef __cplusplus
130 }
131 #endif
132
133 #endif