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/include/q_gain_p.h
     35 
     36      Date: 02/05/2002
     37 
     38 ------------------------------------------------------------------------------
     39  REVISION HISTORY
     40 
     41  Description: Placed header file in the proper template format.  Added
     42  parameter pOverflow for the basic math ops.
     43 
     44  Description: Moved _cplusplus #ifdef after Include section.
     45 
     46  Description:
     47 
     48 ------------------------------------------------------------------------------
     49  INCLUDE DESCRIPTION
     50 
     51  This file contains all the constant definitions and prototype definitions
     52  needed by the file, q_gain_p.c
     53 
     54 ------------------------------------------------------------------------------
     55 */
     56 
     57 /*----------------------------------------------------------------------------
     58 ; CONTINUE ONLY IF NOT ALREADY DEFINED
     59 ----------------------------------------------------------------------------*/
     60 #ifndef q_gain_p_h
     61 #define q_gain_p_h "$Id $"
     62 
     63 /*----------------------------------------------------------------------------
     64 ; INCLUDES
     65 ----------------------------------------------------------------------------*/
     66 #include "typedef.h"
     67 #include "mode.h"
     68 
     69 /*--------------------------------------------------------------------------*/
     70 #ifdef __cplusplus
     71 extern "C"
     72 {
     73 #endif
     74 
     75     /*----------------------------------------------------------------------------
     76     ; MACROS
     77     ; Define module specific macros here
     78     ----------------------------------------------------------------------------*/
     79 
     80     /*----------------------------------------------------------------------------
     81     ; DEFINES
     82     ; Include all pre-processor statements here.
     83     ----------------------------------------------------------------------------*/
     84 
     85     /*----------------------------------------------------------------------------
     86     ; EXTERNAL VARIABLES REFERENCES
     87     ; Declare variables used in this module but defined elsewhere
     88     ----------------------------------------------------------------------------*/
     89 
     90     /*----------------------------------------------------------------------------
     91     ; SIMPLE TYPEDEF'S
     92     ----------------------------------------------------------------------------*/
     93 
     94     /*----------------------------------------------------------------------------
     95     ; ENUMERATED TYPEDEF'S
     96     ----------------------------------------------------------------------------*/
     97 
     98     /*----------------------------------------------------------------------------
     99     ; STRUCTURES TYPEDEF'S
    100     ----------------------------------------------------------------------------*/
    101 
    102     /*----------------------------------------------------------------------------
    103     ; GLOBAL FUNCTION DEFINITIONS
    104     ; Function Prototype declaration
    105     ----------------------------------------------------------------------------*/
    106 
    107     Word16 q_gain_pitch(    /* Return index of quantization                      */
    108         enum Mode mode,     /* i  : AMR mode                                     */
    109         Word16 gp_limit,    /* i  : pitch gain limit                             */
    110         Word16 *gain,       /* i/o: Pitch gain (unquant/quant),              Q14 */
    111         Word16 gain_cand[], /* o  : pitch gain candidates (3),   MR795 only, Q14 */
    112         Word16 gain_cind[], /* o  : pitch gain cand. indices (3),MR795 only, Q0  */
    113         Flag   *pOverflow
    114     );
    115 
    116     /*----------------------------------------------------------------------------
    117     ; END
    118     ----------------------------------------------------------------------------*/
    119 #ifdef __cplusplus
    120 }
    121 #endif
    122 
    123 #endif /* q_gain_p_h */
    124 
    125