Home | History | Annotate | Download | only in src 
      1 /* ------------------------------------------------------------------
      2  * Copyright (C) 1998-2009 PacketVideo
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
     13  * express or implied.
     14  * See the License for the specific language governing permissions
     15  * and limitations under the License.
     16  * -------------------------------------------------------------------
     17  */
     18 /****************************************************************************************
     19 Portions of this file are derived from the following 3GPP standard:
     20 
     21     3GPP TS 26.073
     22     ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
     23     Available from http://www.3gpp.org
     24 
     25 (C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
     26 Permission to distribute, modify and use this file under the standard license
     27 terms listed above has been obtained from the copyright holder.
     28 ****************************************************************************************/
     29 /*
     30 ------------------------------------------------------------------------------
     31 
     32 
     33 
     34  Filename: /audio/gsm_amr/c/src/include/dec_gain.h
     35 
     36      Date: 01/31/2002
     37 
     38 ------------------------------------------------------------------------------
     39  REVISION HISTORY
     40 
     41  Description: Moved _cplusplus #ifdef after Include section.
     42 
     43  Description:
     44 
     45 ------------------------------------------------------------------------------
     46  INCLUDE DESCRIPTION
     47 
     48       File             : dec_gain.h
     49       Purpose          : Decode the pitch and codebook gains
     50 
     51 ------------------------------------------------------------------------------
     52 */
     53 
     54 #ifndef _DEC_GAIN_H_
     55 #define _DEC_GAIN_H_
     56 #define dec_gain_h "$Id $"
     57 
     58 /*----------------------------------------------------------------------------
     59 ; INCLUDES
     60 ----------------------------------------------------------------------------*/
     61 #include "typedef.h"
     62 #include "gc_pred.h"
     63 #include "mode.h"
     64 
     65 /*--------------------------------------------------------------------------*/
     66 #ifdef __cplusplus
     67 extern "C"
     68 {
     69 #endif
     70 
     71     /*----------------------------------------------------------------------------
     72     ; MACROS
     73     ; [Define module specific macros here]
     74     ----------------------------------------------------------------------------*/
     75 
     76     /*----------------------------------------------------------------------------
     77     ; DEFINES
     78     ; [Include all pre-processor statements here.]
     79     ----------------------------------------------------------------------------*/
     80 
     81     /*----------------------------------------------------------------------------
     82     ; EXTERNAL VARIABLES REFERENCES
     83     ; [Declare variables used in this module but defined elsewhere]
     84     ----------------------------------------------------------------------------*/
     85 
     86     /*----------------------------------------------------------------------------
     87     ; SIMPLE TYPEDEF'S
     88     ----------------------------------------------------------------------------*/
     89 
     90     /*----------------------------------------------------------------------------
     91     ; ENUMERATED TYPEDEF'S
     92     ----------------------------------------------------------------------------*/
     93 
     94     /*----------------------------------------------------------------------------
     95     ; STRUCTURES TYPEDEF'S
     96     ----------------------------------------------------------------------------*/
     97 
     98     /*----------------------------------------------------------------------------
     99     ; GLOBAL FUNCTION DEFINITIONS
    100     ; [List function prototypes here]
    101     ----------------------------------------------------------------------------*/
    102 
    103     /*
    104      *   FUNCTION:  Dec_gain()
    105      *   PURPOSE: Decode the pitch and codebook gains
    106      */
    107     void Dec_gain(
    108         gc_predState *pred_state, /* i/o: MA predictor state           */
    109         enum Mode mode,           /* i  : AMR mode                     */
    110         Word16 index,             /* i  : index of quantization.       */
    111         Word16 code[],            /* i  : Innovative vector.           */
    112         Word16 evenSubfr,         /* i  : Flag for even subframes      */
    113         Word16 * gain_pit,        /* o  : Pitch gain.                  */
    114         Word16 * gain_cod,        /* o  : Code gain.                   */
    115         Flag   * pOverflow
    116     );
    117 
    118 
    119 
    120 #ifdef __cplusplus
    121 }
    122 #endif
    123 
    124 #endif  /* _DEC_GAIN_H_ */
    125 
    126 
    127 
    128