Home | History | Annotate | Download | only in include 
      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  Filename: /audio/gsm_amr/c/include/l_extract.h
     32 
     33 ------------------------------------------------------------------------------
     34  REVISION HISTORY
     35 
     36  Description: Updated function prototype declaration to reflect new interface.
     37               A pointer to overflow flag is passed into the function. Updated
     38               template.
     39 
     40  Description: Moved _cplusplus #ifdef after Include section.
     41 
     42  Who:                       Date:
     43  Description:
     44 
     45 ------------------------------------------------------------------------------
     46  INCLUDE DESCRIPTION
     47 
     48  This file contains all the constant definitions and prototype definitions
     49  needed by the L_extract function.
     50 
     51 ------------------------------------------------------------------------------
     52 */
     53 
     54 /*----------------------------------------------------------------------------
     55 ; CONTINUE ONLY IF NOT ALREADY DEFINED
     56 ----------------------------------------------------------------------------*/
     57 #ifndef L_EXTRACT_H
     58 #define L_EXTRACT_H
     59 
     60 /*----------------------------------------------------------------------------
     61 ; INCLUDES
     62 ----------------------------------------------------------------------------*/
     63 #include        "typedef.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     /*----------------------------------------------------------------------------
     78     ; DEFINES
     79     ; Include all pre-processor statements here.
     80     ----------------------------------------------------------------------------*/
     81 
     82     /*----------------------------------------------------------------------------
     83     ; EXTERNAL VARIABLES REFERENCES
     84     ; Declare variables used in this module but defined elsewhere
     85     ----------------------------------------------------------------------------*/
     86 
     87     /*----------------------------------------------------------------------------
     88     ; SIMPLE TYPEDEF'S
     89     ----------------------------------------------------------------------------*/
     90 
     91     /*----------------------------------------------------------------------------
     92     ; ENUMERATED TYPEDEF'S
     93     ----------------------------------------------------------------------------*/
     94 
     95     /*----------------------------------------------------------------------------
     96     ; STRUCTURES TYPEDEF'S
     97     ----------------------------------------------------------------------------*/
     98 
     99     /*----------------------------------------------------------------------------
    100     ; GLOBAL FUNCTION DEFINITIONS
    101     ; Function Prototype declaration
    102     ----------------------------------------------------------------------------*/
    103     void L_Extract(Word32 L_var,
    104     Word16 *pL_var_hi,
    105     Word16 *pL_var_lo,
    106     Flag   *pOverflow);
    107 
    108     /*----------------------------------------------------------------------------
    109     ; END
    110     ----------------------------------------------------------------------------*/
    111 #ifdef __cplusplus
    112 }
    113 #endif
    114 
    115 #endif /* _L_EXTRACT_H_ */
    116