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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/* ------------------------------------------------------------------
* 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_enc.h
Date: 09/26/2001
------------------------------------------------------------------------------
REVISION HISTORY
Description: Changing code as per review comments. These changes include
removing unnecessary tables and changing function descriptions.
The comments were changed to "slash-star" rather than double
slash, and some wordings of comments were corrected.
Description: Replaced GSMEncodeFrame function prototype with that of
AMREncode. Updated copyright year.
Description: Added #define for WMF and IF2, and updated function prototype
of AMREncode.
Description: Renamed WMF and IF2 to AMR_WMF and AMR_IF2, respectively. Added
AMR_ETS, and changed output_type to output_format in the
function prototype of AMREncode(). Removed function prototypes
for frame_header_move() and reverse_bits() since they are not
needed anymore.
Description: Moved WMFBytesUsed and IF2BytesUsed tables to
enc_output_format_tab.c.
Description: Added function prototypes for init, reset, and exit functions
in amrencode.c. Renamed output format #defines so that it it
unique to the encoder.
Description: Added comment to describe L_FRAME.
Description: Added Frame_Type_3GPP type definition.
Description: Moved _cplusplus #ifdef after Include section.
Description:
------------------------------------------------------------------------------
INCLUDE DESCRIPTION
This header contains all the necessary information needed to use the
GSM AMR encoder library.
------------------------------------------------------------------------------
*/
#ifndef _GSMAMR_ENC_H_
#define _GSMAMR_ENC_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
/* Output format types */
#define AMR_TX_WMF 0
#define AMR_TX_IF2 1
#define AMR_TX_ETS 2
/*----------------------------------------------------------------------------
; EXTERNAL VARIABLES REFERENCES
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; SIMPLE TYPEDEF'S
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; ENUMERATED TYPEDEF'S
----------------------------------------------------------------------------*/
enum Mode
{
MR475 = 0,/* 4.75 kbps */
MR515, /* 5.15 kbps */
MR59, /* 5.90 kbps */
MR67, /* 6.70 kbps */
MR74, /* 7.40 kbps */
MR795, /* 7.95 kbps */
MR102, /* 10.2 kbps */
MR122, /* 12.2 kbps */
MRDTX, /* DTX */
N_MODES /* Not Used */
};
/*----------------------------------------------------------------------------
; STRUCTURES TYPEDEF'S
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
; GLOBAL FUNCTION DEFINITIONS
----------------------------------------------------------------------------*/
/* AMREncodeInit initializes the GSM AMR Encoder library by calling
* GSMInitEncode and sid_sync_init. If initialization was successful,
* init_status is set to zero, otherwise, it is set to -1.
*/
int AMREncodeInit(
void **pEncStructure,
void **pSidSyncStructure,
Flag dtx_enable);
/* AMREncodeReset resets the state memory used by the Encoder and SID sync
* function. If reset was successful, reset_status is set to zero, otherwise,
* it is set to -1.
*/
int AMREncodeReset(
void *pEncStructure,
void *pSidSyncStructure);
/* AMREncodeExit frees up the state memory used by the Encoder and SID
* synchronization function.
*/
void AMREncodeExit(
void **pEncStructure,
void **pSidSyncStructure);
/*
* AMREncode is the entry point to the ETS Encoder library that encodes the raw
* data speech bits and converts the encoded bitstream into either an IF2-
* formatted bitstream, WMF-formatted bitstream, or ETS-formatted bitstream,
* depending on the the value of output_format. A zero is returned on success.
*/
int AMREncode(
void *pEncState,
void *pSidSyncState,
enum Mode mode,
Word16 *pEncInput,
unsigned char *pEncOutput,
enum Frame_Type_3GPP *p3gpp_frame_type,
Word16 output_format
);
#ifdef __cplusplus
}
#endif
#endif /* _GSMAMR_DEC_H_ */
|
