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/shl.h
32 
33 ------------------------------------------------------------------------------
34  REVISION HISTORY
35 
36  Description: Created separate header file for shl function.
37 
38  Description: Changed prototype of the mult() function. Instead of using global
39               a pointer to overflow flag is now passed into the function.
40 
41  Description: Updated template. Changed the parameter name from "overflow" to
42               "pOverflow" in the function prototype declaration
43 
44  Description: Moved _cplusplus #ifdef after Include section.
45 
46  Who:                       Date:
47  Description:
48 
49 ------------------------------------------------------------------------------
50  INCLUDE DESCRIPTION
51 
52  This file contains all the constant definitions and prototype definitions
53  needed by the shl function.
54 
55 ------------------------------------------------------------------------------
56 */
57 
58 /*----------------------------------------------------------------------------
59 ; CONTINUE ONLY IF NOT ALREADY DEFINED
60 ----------------------------------------------------------------------------*/
61 #ifndef SHL_H
62 #define SHL_H
63 
64 /*----------------------------------------------------------------------------
65 ; INCLUDES
66 ----------------------------------------------------------------------------*/
67 #include    "basicop_malloc.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     Word16 shl(Word16 var1, Word16 var2, Flag *pOverflow);
107 
108     /*----------------------------------------------------------------------------
109     ; END
110     ----------------------------------------------------------------------------*/
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif  /* _SHL_H_ */
116 
117 
118 
119