summaryrefslogtreecommitdiffstats
path: root/media/libstagefright/codecs/amrnb/common/pvgsmamrdecoderinterface.h
blob: ccbed44faaefb56ee8f01392d9f153a8893e6d1b (plain)
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
/* ------------------------------------------------------------------
 * 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.
 * -------------------------------------------------------------------
 */
//////////////////////////////////////////////////////////////////////////////////
//                                                                              //
//  File: pvgsmamrdecoderinterface.h                                            //
//                                                                              //
//////////////////////////////////////////////////////////////////////////////////

#ifndef _PVGSMAMR_DECODER_INTERFACE_H
#define _PVGSMAMR_DECODER_INTERFACE_H

/*----------------------------------------------------------------------------
; ENUMERATED TYPEDEF'S
----------------------------------------------------------------------------*/

typedef enum
{
    /*
     *    One word (2-byte) to indicate type of frame type.
     *    One word (2-byte) to indicate frame type.
     *    One word (2-byte) to indicate mode.
     *    N words (2-byte) containing N bits (bit 0 = 0xff81, bit 1 = 0x007f).
     */
    ETS = 0, /* Both AMR-Narrowband and AMR-Wideband */

    /*
     *    One word (2-byte) for sync word (good frames: 0x6b21, bad frames: 0x6b20)
     *    One word (2-byte) for frame length N.
     *    N words (2-byte) containing N bits (bit 0 = 0x007f, bit 1 = 0x0081).
     */
    ITU, /* AMR-Wideband */

    /*
     *   AMR-WB MIME/storage format, see RFC 3267 (sections 5.1 and 5.3) for details
     */
    MIME_IETF,

    WMF, /* AMR-Narrowband */

    IF2  /* AMR-Narrowband */

} bitstream_format;



/*----------------------------------------------------------------------------
; STRUCTURES TYPEDEF'S
----------------------------------------------------------------------------*/
typedef struct
{
    int16_t prev_ft;
    int16_t prev_mode;
} RX_State;


typedef struct tPVAmrDecoderExternal
{
    /*
     * INPUT:
     * Pointer to the input buffer that contains the encoded bistream data.
     * The data is filled in such that the first bit transmitted is
     * the most-significant bit (MSB) of the first array element.
     * The buffer is accessed in a linear fashion for speed, and the number of
     * bytes consumed varies frame to frame. This is use for mime/ietf data
     */
    uint8_t  *pInputBuffer;

    /*
     * INPUT:
     * Pointer to the input buffer that contains the encoded stream data.
     * The data is filled such that the first bit transmitted is
     * in the  first int16_t element.
     * The buffer is accessed in a linear fashion for speed, and the number of
     * bytes consumed varies frame to frame.
     */
    int16_t  *pInputSampleBuffer;

    /*
     * INPUT: (but what is pointed to is an output)
     * Pointer to the output buffer to hold the 16-bit PCM audio samples.
     */
    int16_t  *pOutputBuffer;

    /*
     * INPUT:
     * Number of requested output audio channels. This relieves the calling
     * environment from having to perform stereo-to-mono or mono-to-stereo
     * conversions.
     */
    int32_t     desiredChannels;

    /*
         * INPUT:
         * Format type of the encoded bitstream.
         */
    bitstream_format     input_format;

    /*
     * OUTPUT:
     * The sampling rate decoded from the bitstream, in units of
     * samples/second. For this release of the library this value does
     * not change from frame to frame, but future versions will.
     */
    int32_t   samplingRate;

    /*
     * OUTPUT:
     * This value is the bitrate in units of bits/second. IT
     * is calculated using the number of bits consumed for the current frame,
     * and then multiplying by the sampling_rate, divided by points in a frame.
     * This value can changes frame to frame.
     */
    int32_t   bitRate;

    /*
     * OUTPUT:
     * The number of channels decoded from the bitstream. The output data
     * will have be the amount specified in the variable desiredChannels,
     * this output is informative only, and can be ignored.
     */
    int32_t     encodedChannels;

    /*
     * OUTPUT:
     * This value is the number of output PCM samples per channel.
     * It is  320.
     */
    int16_t     frameLength;

    /*
     * OUTPUT:
     * This value is the quality indicator. 1 (good)  0 (bad)
    */
    uint8_t     quality;


    /*
     * OUTPUT:
     *  GSM AMR NB and WB mode (i.e. bit-rate )
     */
    int16_t     mode;
    int16_t     mode_old;

    /*
     * OUTPUT:
     *  GSM AMR NB and WB frame type ( speech_good, speech_bad, sid, etc.)
     */
    int16_t     frame_type;

    int16_t reset_flag;
    int16_t reset_flag_old;

    /*
     * OUTPUT:
     *  Decoder  status
     */
    int32_t     status;

    /*
     * OUTPUT:
     *  Rx status state
     */
    RX_State  rx_state;

} tPVAmrDecoderExternal;

#endif