Convert all CRLF in the SILK code, tabs to spaces, and trailing
[opus.git] / silk / float / silk_residual_energy_FLP.c
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 #include "silk_main_FLP.h"
29
30 #define MAX_ITERATIONS_RESIDUAL_NRG         10
31 #define REGULARIZATION_FACTOR               1e-8f
32
33 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */
34 SKP_float silk_residual_energy_covar_FLP(           /* O    Weighted residual energy                */
35     const SKP_float                 *c,                 /* I    Filter coefficients                     */
36           SKP_float                 *wXX,               /* I/O  Weighted correlation matrix, reg. out   */
37     const SKP_float                 *wXx,               /* I    Weighted correlation vector             */
38     const SKP_float                 wxx,                /* I    Weighted correlation value              */
39     const opus_int                   D                   /* I    Dimension                               */
40 )
41 {
42     opus_int   i, j, k;
43     SKP_float tmp, nrg = 0.0f, regularization;
44
45     /* Safety checks */
46     SKP_assert( D >= 0 );
47
48     regularization = REGULARIZATION_FACTOR * ( wXX[ 0 ] + wXX[ D * D - 1 ] );
49     for( k = 0; k < MAX_ITERATIONS_RESIDUAL_NRG; k++ ) {
50         nrg = wxx;
51
52         tmp = 0.0f;
53         for( i = 0; i < D; i++ ) {
54             tmp += wXx[ i ] * c[ i ];
55         }
56         nrg -= 2.0f * tmp;
57
58         /* compute c' * wXX * c, assuming wXX is symmetric */
59         for( i = 0; i < D; i++ ) {
60             tmp = 0.0f;
61             for( j = i + 1; j < D; j++ ) {
62                 tmp += matrix_c_ptr( wXX, i, j, D ) * c[ j ];
63             }
64             nrg += c[ i ] * ( 2.0f * tmp + matrix_c_ptr( wXX, i, i, D ) * c[ i ] );
65         }
66         if( nrg > 0 ) {
67             break;
68         } else {
69             /* Add white noise */
70             for( i = 0; i < D; i++ ) {
71                 matrix_c_ptr( wXX, i, i, D ) +=  regularization;
72             }
73             /* Increase noise for next run */
74             regularization *= 2.0f;
75         }
76     }
77     if( k == MAX_ITERATIONS_RESIDUAL_NRG ) {
78         SKP_assert( nrg == 0 );
79         nrg = 1.0f;
80     }
81
82     return nrg;
83 }
84
85 /* Calculates residual energies of input subframes where all subframes have LPC_order   */
86 /* of preceeding samples                                                                */
87 void silk_residual_energy_FLP(
88           SKP_float nrgs[ MAX_NB_SUBFR ],       /* O    Residual energy per subframe    */
89     const SKP_float x[],                        /* I    Input signal                    */
90           SKP_float a[ 2 ][ MAX_LPC_ORDER ],    /* I    AR coefs for each frame half    */
91     const SKP_float gains[],                    /* I    Quantization gains              */
92     const opus_int   subfr_length,               /* I    Subframe length                 */
93     const opus_int   nb_subfr,                   /* I    number of subframes             */
94     const opus_int   LPC_order                   /* I    LPC order                       */
95 )
96 {
97     opus_int     shift;
98     SKP_float   *LPC_res_ptr, LPC_res[ ( MAX_FRAME_LENGTH + MAX_NB_SUBFR * MAX_LPC_ORDER ) / 2 ];
99
100     LPC_res_ptr = LPC_res + LPC_order;
101     shift = LPC_order + subfr_length;
102
103     /* Filter input to create the LPC residual for each frame half, and measure subframe energies */
104     silk_LPC_analysis_filter_FLP( LPC_res, a[ 0 ], x + 0 * shift, 2 * shift, LPC_order );
105     nrgs[ 0 ] = ( SKP_float )( gains[ 0 ] * gains[ 0 ] * silk_energy_FLP( LPC_res_ptr + 0 * shift, subfr_length ) );
106     nrgs[ 1 ] = ( SKP_float )( gains[ 1 ] * gains[ 1 ] * silk_energy_FLP( LPC_res_ptr + 1 * shift, subfr_length ) );
107
108     if( nb_subfr == MAX_NB_SUBFR ) {
109         silk_LPC_analysis_filter_FLP( LPC_res, a[ 1 ], x + 2 * shift, 2 * shift, LPC_order );
110         nrgs[ 2 ] = ( SKP_float )( gains[ 2 ] * gains[ 2 ] * silk_energy_FLP( LPC_res_ptr + 0 * shift, subfr_length ) );
111         nrgs[ 3 ] = ( SKP_float )( gains[ 3 ] * gains[ 3 ] * silk_energy_FLP( LPC_res_ptr + 1 * shift, subfr_length ) );
112     }
113 }