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  Filename: /audio/gsm_amr/c/include/l_shr.h
31 
32 ------------------------------------------------------------------------------
33  REVISION HISTORY
34 
35  Description: Created separate header file for L_shr function.
36 
37  Description: Updated function prototype declaration to reflect new interface.
38               A pointer to overflow flag is passed into the function. Updated
39               template.
40 
41  Description: Moved _cplusplus #ifdef after Include section.
42 
43  Who:                       Date:
44  Description:
45 
46 ------------------------------------------------------------------------------
47  INCLUDE DESCRIPTION
48 
49  This file contains all the constant definitions and prototype definitions
50  needed by the L_shr function.
51 
52 ------------------------------------------------------------------------------
53 */
54 
55 /*----------------------------------------------------------------------------
56 ; CONTINUE ONLY IF NOT ALREADY DEFINED
57 ----------------------------------------------------------------------------*/
58 #ifndef L_SHR_H
59 #define L_SHR_H
60 
61 /*----------------------------------------------------------------------------
62 ; INCLUDES
63 ----------------------------------------------------------------------------*/
64 #include    "basicop_malloc.h"
65 
66 /*--------------------------------------------------------------------------*/
67 #ifdef __cplusplus
68 extern "C"
69 {
70 #endif
71 
72     /*----------------------------------------------------------------------------
73     ; MACROS
74     ; Define module specific macros here
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     Word32 L_shr(Word32 L_var1, Word16 var2, Flag *pOverflow);
104 
105     /*----------------------------------------------------------------------------
106     ; END
107     ----------------------------------------------------------------------------*/
108 #ifdef __cplusplus
109 }
110 #endif
111 
112 #endif /* _L_SHR_H_ */
113 
114 
115 
116