make len==0 return OPUS_INVALID_PACKET rather than OPUS_BAD_ARG for opus_packet_parse...
[opus.git] / silk / gain_quant.c
index 189f5fd..64ccd06 100644 (file)
@@ -1,28 +1,28 @@
 /***********************************************************************
 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
 Redistribution and use in source and binary forms, with or without
 /***********************************************************************
 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
 Redistribution and use in source and binary forms, with or without
-modification, (subject to the limitations in the disclaimer below)
-are permitted provided that the following conditions are met:
+modification, are permitted provided that the following conditions
+are met:
 - Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 - Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
-- Neither the name of Skype Limited, nor the names of specific
-contributors, may be used to endorse or promote products derived from
-this software without specific prior written permission.
-NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
-BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
-CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
-BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+- Neither the name of Internet Society, IETF or IETF Trust, nor the
+names of specific contributors, may be used to endorse or promote
+products derived from this software without specific prior written
+permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
 ***********************************************************************/
 
 #ifdef HAVE_CONFIG_H
 ***********************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -37,24 +37,24 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 /* Gain scalar quantization with hysteresis, uniform on log scale */
 void silk_gains_quant(
 
 /* Gain scalar quantization with hysteresis, uniform on log scale */
 void silk_gains_quant(
-    opus_int8                        ind[ MAX_NB_SUBFR ],        /* O    gain indices                            */
-    opus_int32                       gain_Q16[ MAX_NB_SUBFR ],   /* I/O  gains (quantized out)                   */
-    opus_int8                        *prev_ind,                  /* I/O  last index in previous frame            */
-    const opus_int                   conditional,                /* I    first gain is delta coded if 1          */
-    const opus_int                   nb_subfr                    /* I    number of subframes                     */
+    opus_int8                   ind[ MAX_NB_SUBFR ],            /* O    gain indices                                */
+    opus_int32                  gain_Q16[ MAX_NB_SUBFR ],       /* I/O  gains (quantized out)                       */
+    opus_int8                   *prev_ind,                      /* I/O  last index in previous frame                */
+    const opus_int              conditional,                    /* I    first gain is delta coded if 1              */
+    const opus_int              nb_subfr                        /* I    number of subframes                         */
 )
 {
     opus_int k, double_step_size_threshold;
 
     for( k = 0; k < nb_subfr; k++ ) {
 )
 {
     opus_int k, double_step_size_threshold;
 
     for( k = 0; k < nb_subfr; k++ ) {
-        /* Add half of previous quantization error, convert to log scale, scale, floor() */
+        /* Convert to log scale, scale, floor() */
         ind[ k ] = silk_SMULWB( SCALE_Q16, silk_lin2log( gain_Q16[ k ] ) - OFFSET );
 
         /* Round towards previous quantized gain (hysteresis) */
         if( ind[ k ] < *prev_ind ) {
             ind[ k ]++;
         }
         ind[ k ] = silk_SMULWB( SCALE_Q16, silk_lin2log( gain_Q16[ k ] ) - OFFSET );
 
         /* Round towards previous quantized gain (hysteresis) */
         if( ind[ k ] < *prev_ind ) {
             ind[ k ]++;
         }
-        ind[ k ] = silk_max_int( ind[ k ], 0 );
+        ind[ k ] = silk_LIMIT_int( ind[ k ], 0, N_LEVELS_QGAIN - 1 );
 
         /* Compute delta indices and limit */
         if( k == 0 && conditional == 0 ) {
 
         /* Compute delta indices and limit */
         if( k == 0 && conditional == 0 ) {
@@ -84,25 +84,26 @@ void silk_gains_quant(
             ind[ k ] -= MIN_DELTA_GAIN_QUANT;
         }
 
             ind[ k ] -= MIN_DELTA_GAIN_QUANT;
         }
 
-        /* Convert to linear scale and scale */
+        /* Scale and convert to linear scale */
         gain_Q16[ k ] = silk_log2lin( silk_min_32( silk_SMULWB( INV_SCALE_Q16, *prev_ind ) + OFFSET, 3967 ) ); /* 3967 = 31 in Q7 */
     }
 }
 
 /* Gains scalar dequantization, uniform on log scale */
 void silk_gains_dequant(
         gain_Q16[ k ] = silk_log2lin( silk_min_32( silk_SMULWB( INV_SCALE_Q16, *prev_ind ) + OFFSET, 3967 ) ); /* 3967 = 31 in Q7 */
     }
 }
 
 /* Gains scalar dequantization, uniform on log scale */
 void silk_gains_dequant(
-    opus_int32                       gain_Q16[ MAX_NB_SUBFR ],   /* O    quantized gains                         */
-    const opus_int8                  ind[ MAX_NB_SUBFR ],        /* I    gain indices                            */
-    opus_int8                        *prev_ind,                  /* I/O  last index in previous frame            */
-    const opus_int                   conditional,                /* I    first gain is delta coded if 1          */
-    const opus_int                   nb_subfr                    /* I    number of subframes                     */
+    opus_int32                  gain_Q16[ MAX_NB_SUBFR ],       /* O    quantized gains                             */
+    const opus_int8             ind[ MAX_NB_SUBFR ],            /* I    gain indices                                */
+    opus_int8                   *prev_ind,                      /* I/O  last index in previous frame                */
+    const opus_int              conditional,                    /* I    first gain is delta coded if 1              */
+    const opus_int              nb_subfr                        /* I    number of subframes                          */
 )
 {
     opus_int   k, ind_tmp, double_step_size_threshold;
 
     for( k = 0; k < nb_subfr; k++ ) {
         if( k == 0 && conditional == 0 ) {
 )
 {
     opus_int   k, ind_tmp, double_step_size_threshold;
 
     for( k = 0; k < nb_subfr; k++ ) {
         if( k == 0 && conditional == 0 ) {
-            *prev_ind = ind[ k ];
+            /* Gain index is not allowed to go down more than 16 steps (~21.8 dB) */
+            *prev_ind = silk_max_int( ind[ k ], *prev_ind - 16 );
         } else {
             /* Delta index */
             ind_tmp = ind[ k ] + MIN_DELTA_GAIN_QUANT;
         } else {
             /* Delta index */
             ind_tmp = ind[ k ] + MIN_DELTA_GAIN_QUANT;
@@ -115,17 +116,17 @@ void silk_gains_dequant(
                 *prev_ind += ind_tmp;
             }
         }
                 *prev_ind += ind_tmp;
             }
         }
-        *prev_ind = silk_min( *prev_ind, N_LEVELS_QGAIN - 1 );
+        *prev_ind = silk_LIMIT_int( *prev_ind, 0, N_LEVELS_QGAIN - 1 );
 
 
-        /* Convert to linear scale and scale */
+        /* Scale and convert to linear scale */
         gain_Q16[ k ] = silk_log2lin( silk_min_32( silk_SMULWB( INV_SCALE_Q16, *prev_ind ) + OFFSET, 3967 ) ); /* 3967 = 31 in Q7 */
     }
 }
 
 /* Compute unique identifier of gain indices vector */
         gain_Q16[ k ] = silk_log2lin( silk_min_32( silk_SMULWB( INV_SCALE_Q16, *prev_ind ) + OFFSET, 3967 ) ); /* 3967 = 31 in Q7 */
     }
 }
 
 /* Compute unique identifier of gain indices vector */
-opus_int32 silk_gains_ID(                                        /* O    returns unique identifier of gains      */
-    const opus_int8                  ind[ MAX_NB_SUBFR ],        /* I    gain indices                            */
-    const opus_int                   nb_subfr                    /* I    number of subframes                     */
+opus_int32 silk_gains_ID(                                       /* O    returns unique identifier of gains          */
+    const opus_int8             ind[ MAX_NB_SUBFR ],            /* I    gain indices                                */
+    const opus_int              nb_subfr                        /* I    number of subframes                         */
 )
 {
     opus_int   k;
 )
 {
     opus_int   k;