1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/* ------------------------------------------------------------------
* Copyright (C) 1998-2009 PacketVideo
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied.
* See the License for the specific language governing permissions
* and limitations under the License.
* -------------------------------------------------------------------
*/
/****************************************************************************************
Portions of this file are derived from the following 3GPP standard:
3GPP TS 26.073
ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
Available from http://www.3gpp.org
(C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
Permission to distribute, modify and use this file under the standard license
terms listed above has been obtained from the copyright holder.
****************************************************************************************/
/*
------------------------------------------------------------------------------
Filename: /audio/gsm-amr/c/include/gsmamr_dec.h
Date: 09/10/2001
------------------------------------------------------------------------------
REVISION HISTORY
Description: Adding comments and removing some tables as per review comments.
Description: Replace enum Mode with enum Frame_Type_3GPP and updated function
prototype of AMRDecode().
Description: Added back the enum Mode type definition, removed RXFrameType
type definition, and updated AMRDecode and GSMInitDecode function
prototypes.
Description: Added #defines for WMF and IF2. Updated AMRDecode function
prototype.
Description: Removed enum Mode type definition and updated AMRDecode function
prototype.
Description: Renamed WMF and IF2 to AMR_WMF and AMR_IF2, respectively. Added
#define for AMR_ETS format.
Description: Rename input format defines to make it unique to the decoder.
Description: Added comment to describe L_FRAME.
Description: Moved _cplusplus #ifdef after Include section.
Description: Included file "typedefs.h" to avoid re-declaring similar typedef
this for OSCL-ed compatibility
Description: Included file "gsm_amr_typedefs.h" and eliminated re-definition
of types UWord8, Word8, Word16
Description:
------------------------------------------------------------------------------
INCLUDE DESCRIPTION
This header contains all the necessary information needed to allow the gsm amr
decoder library to be used properly upon release.
------------------------------------------------------------------------------
*/
#ifndef _GSMAMR_DEC_H_
#define _GSMAMR_DEC_H_
/*----------------------------------------------------------------------------
; INCLUDES
----------------------------------------------------------------------------*/
#include "gsm_amr_typedefs.h"
#include "frame_type_3gpp.h"
/*--------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C"
{
#endif
/*----------------------------------------------------------------------------
; MACROS
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; DEFINES
----------------------------------------------------------------------------*/
/* Number of 13-bit linear PCM samples per 20 ms frame */
/* L_FRAME = (8 kHz) * (20 msec) = 160 samples */
#define L_FRAME 160
/*----------------------------------------------------------------------------
; EXTERNAL VARIABLES REFERENCES
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; SIMPLE TYPEDEF'S
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; ENUMERATED TYPEDEF'S
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; STRUCTURES TYPEDEF'S
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; GLOBAL FUNCTION DEFINITIONS
----------------------------------------------------------------------------*/
/*
* This function allocates memory for filter structure and initializes state
* memory used by the GSM AMR decoder. This function returns zero. It will
* return negative one if there is an error.
*/
Word16 GSMInitDecode(void **state_data,
Word8 *id);
/*
* AMRDecode steps into the part of the library that decodes the raw data
* speech bits for the decoding process. It returns the address offset of
* the next frame to be decoded.
*/
Word16 AMRDecode(
void *state_data,
enum Frame_Type_3GPP frame_type,
UWord8 *speech_bits_ptr,
Word16 *raw_pcm_buffer,
Word16 input_format
);
/*
* This function resets the state memory used by the GSM AMR decoder. This
* function returns zero. It will return negative one if there is an error.
*/
Word16 Speech_Decode_Frame_reset(void *state_data);
/*
* This function frees up the memory used for the state memory of the
* GSM AMR decoder.
*/
void GSMDecodeFrameExit(void **state_data);
#ifdef __cplusplus
}
#endif
#endif /* _GSMAMR_DEC_H_ */
|
