summaryrefslogtreecommitdiff
path: root/media/libstagefright/codecs/aacdec/getbits.h
blob: e854be51316104896171688a2faf1ecf44329976 (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/* ------------------------------------------------------------------
 * 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.
 * -------------------------------------------------------------------
 */
/*

 Pathname: getbits.h

------------------------------------------------------------------------------
 REVISION HISTORY

 Description: Update comments for the structure

 Description: Move structur to another file

 Who:                                            Date: MM/DD/YYYY
 Description:


------------------------------------------------------------------------------
 INCLUDE DESCRIPTION

 Header file for the function getbits().

------------------------------------------------------------------------------
*/

/*----------------------------------------------------------------------------
; CONTINUE ONLY IF NOT ALREADY DEFINED
----------------------------------------------------------------------------*/
#ifndef GETBITS_H
#define GETBITS_H

#ifdef __cplusplus
extern "C"
{
#endif

    /*----------------------------------------------------------------------------
    ; INCLUDES
    ----------------------------------------------------------------------------*/
#include "pv_audio_type_defs.h"
#include "ibstream.h"

    /*----------------------------------------------------------------------------
    ; MACROS
    ; Define module specific macros here
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; DEFINES
    ; Include all pre-processor statements here.
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; EXTERNAL VARIABLES REFERENCES
    ; Declare variables used in this module but defined elsewhere
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; SIMPLE TYPEDEF'S
    ----------------------------------------------------------------------------*/

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

    /*----------------------------------------------------------------------------
    ; STRUCTURES TYPEDEF'S
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; GLOBAL FUNCTION DEFINITIONS
    ; Function Prototype declaration
    ----------------------------------------------------------------------------*/

#define INBUF_ARRAY_INDEX_SHIFT  (3)
#define INBUF_BIT_WIDTH         (1<<(INBUF_ARRAY_INDEX_SHIFT))
#define INBUF_BIT_MODULO_MASK   ((INBUF_BIT_WIDTH)-1)

#define MAX_GETBITS             (25)

#define  CHECK_INPUT_BUFFER_LIMITS  1

    __inline UInt32 getbits(
        const UInt  neededBits,
        BITS       *pInputStream)
    {
        UInt32   returnValue = 0;
        UInt     offset;
        UInt     bitIndex;
        UChar    *pElem;        /* Needs to be same type as pInput->pBuffer */

        offset = (pInputStream->usedBits) >> INBUF_ARRAY_INDEX_SHIFT;

        pElem = pInputStream->pBuffer + offset;

#if CHECK_INPUT_BUFFER_LIMITS

        offset =  pInputStream->inputBufferCurrentLength - offset;
        /*  check if access to input buffer does not go beyond boundaries */
        if (offset > 3)
        {
            returnValue = (((UInt32) * (pElem)) << 24) |
                          (((UInt32) * (pElem + 1)) << 16) |
                          (((UInt32) * (pElem + 2)) << 8) |
                          ((UInt32) * (pElem + 3));
        }
        else  /*  then access only available bytes  */
        {
            /*  Access to the bitstream beyond frame boundaries are not allowed,
             *  Here, only what was available before the end of the frame will
             *  be processed. Non-accessible bytes will be filled in with zeros.
             *  Zero values guarantees that the data structures are filled in with values
             *  that eventually will signal an error (like invalid parameters) or that allow
             *  completion of the parsing routine.
             *  Overrun is detected on file pvmp4audiodecodeframe.cpp.
             */
            switch (offset)
            {
                case 3:
                    returnValue  = (((UInt32) * (pElem + 2)) << 8);
                case 2:
                    returnValue |= (((UInt32) * (pElem + 1)) << 16);
                case 1:
                    returnValue |= (((UInt32) * (pElem)) << 24);
                default:
                    break;
            }
        }


#else

        returnValue = (((UInt32) * (pElem)) << 24) |
                      (((UInt32) * (pElem + 1)) << 16) |
                      (((UInt32) * (pElem + 2)) << 8) |
                      ((UInt32) * (pElem + 3));
#endif

        /* Remove extra high bits by shifting up */
        bitIndex = (UInt)((pInputStream->usedBits) & INBUF_BIT_MODULO_MASK);

        /* This line is faster way to mask off the high bits. */
        returnValue = returnValue << (bitIndex);

        /* Move the field down. */
        returnValue = returnValue >> (32 - neededBits);

        pInputStream->usedBits += neededBits;

        return (returnValue);

    }



    __inline UInt get1bits(
        BITS       *pInputStream)
    {
        UInt     returnValue;
        UInt     offset;
        UInt     bitIndex;
        UChar    *pElem;        /* Needs to be same type as pInput->pBuffer */

        offset = (pInputStream->usedBits) >> INBUF_ARRAY_INDEX_SHIFT;

        pElem = pInputStream->pBuffer + offset;

#if CHECK_INPUT_BUFFER_LIMITS
        returnValue = (offset < pInputStream->inputBufferCurrentLength) ? ((UInt) * (pElem)) : 0;
#else
        returnValue = ((UInt32) * (pElem));
#endif


        /* Remove extra high bits by shifting up */
        bitIndex = (UInt)((pInputStream->usedBits++) & INBUF_BIT_MODULO_MASK);

        /* This line is faster way to mask off the high bits. */
        returnValue = 0xFF & (returnValue << (bitIndex));

        /* Move the field down. */

        return ((UInt)(returnValue >> 7));

    }



    __inline UInt get9_n_lessbits(
        const UInt  neededBits,
        BITS       *pInputStream)

    {
        UInt     returnValue;
        UInt     offset;
        UInt     bitIndex;
        UChar    *pElem;        /* Needs to be same type as pInput->pBuffer */

        offset = (pInputStream->usedBits) >> INBUF_ARRAY_INDEX_SHIFT;

        pElem = pInputStream->pBuffer + offset;

#if CHECK_INPUT_BUFFER_LIMITS


        offset =  pInputStream->inputBufferCurrentLength - offset;
        /*  check if access to input buffer does not go beyond boundaries */
        if (offset > 1)
        {
            returnValue = (((UInt32) * (pElem)) << 8) |
                          ((UInt32) * (pElem + 1));
        }
        else  /*  then access only available bytes  */
        {
            /*  Access to the bitstream beyond frame boundaries are not allowed,
             *  Here, only what was available before the end of the frame will
             *  be processed. Non-accessible bytes will be filled in with zeros.
             *  Zero values guarantees that the data structures are filled in with values
             *  that eventually will signal an error (like invalid parameters) or that allow
             *  completion of the parsing routine.
             *  Overrun is detected on file pvmp4audiodecodeframe.cpp
             */
            switch (offset)
            {
                case 1:
                    returnValue  = (((UInt32) * (pElem)) << 8);
                    break;
                default:
                    returnValue = 0;
                    break;
            }
        }


#else
        returnValue = (((UInt32) * (pElem)) << 8) |
                      ((UInt32) * (pElem + 1)) ;
#endif

        /* Remove extra high bits by shifting up */
        bitIndex = (UInt)((pInputStream->usedBits) & INBUF_BIT_MODULO_MASK);

        pInputStream->usedBits += neededBits;

        /* This line is faster way to mask off the high bits. */
        returnValue = 0xFFFF & (returnValue << (bitIndex));

        /* Move the field down. */

        return (UInt)(returnValue >> (16 - neededBits));

    }

    __inline UInt32 get17_n_lessbits(
        const UInt  neededBits,
        BITS       *pInputStream)
    {
        UInt32   returnValue;
        UInt     offset;
        UInt     bitIndex;
        UChar    *pElem;        /* Needs to be same type as pInput->pBuffer */

        offset = (pInputStream->usedBits) >> INBUF_ARRAY_INDEX_SHIFT;

        pElem = pInputStream->pBuffer + offset;

#if CHECK_INPUT_BUFFER_LIMITS

        offset =  pInputStream->inputBufferCurrentLength - offset;
        /*  check if access to input buffer does not go beyond boundaries */

        if (offset > 2)
        {
            returnValue = (((UInt32) * (pElem)) << 16) |
                          (((UInt32) * (pElem + 1)) << 8) |
                          ((UInt32)  * (pElem + 2));
        }
        else   /*  then access only available bytes  */
        {
            /*  Access to the bitstream beyond frame boundaries are not allowed,
             *  Here, only what was available before the end of the frame will
             *  be processed. Non-accessible bytes will be filled in with zeros.
             *  Zero values guarantees that the data structures are filled in with values
             *  that eventually will signal an error (like invalid parameters) or that allow
             *  completion of the parsing routine.
             *  Overrun is detected on file pvmp4audiodecodeframe.cpp
             */
            returnValue = 0;
            switch (offset)
            {
                case 2:
                    returnValue  = (((UInt32) * (pElem + 1)) << 8);
                case 1:
                    returnValue |= (((UInt32) * (pElem)) << 16);
                default:
                    break;
            }
        }

#else

        returnValue = (((UInt32) * (pElem)) << 16) |
                      (((UInt32) * (pElem + 1)) << 8) |
                      ((UInt32)  * (pElem + 2));
#endif

        /* Remove extra high bits by shifting up */
        bitIndex = (UInt)((pInputStream->usedBits) & INBUF_BIT_MODULO_MASK);

        /* This line is faster way to mask off the high bits. */
        returnValue = 0xFFFFFF & (returnValue << (bitIndex));

        /* Move the field down. */
        returnValue = returnValue >> (24 - neededBits);

        pInputStream->usedBits += neededBits;

        return (returnValue);

    }

#ifdef __cplusplus
}
#endif

/*----------------------------------------------------------------------------
; END
----------------------------------------------------------------------------*/
#endif /* GETBITS_H*/