1/* -----------------------------------------------------------------------------
2Software License for The Fraunhofer FDK AAC Codec Library for Android
3
4© Copyright  1995 - 2018 Fraunhofer-Gesellschaft zur Förderung der angewandten
5Forschung e.V. All rights reserved.
6
7 1.    INTRODUCTION
8The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
9that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
10scheme for digital audio. This FDK AAC Codec software is intended to be used on
11a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
14general perceptual audio codecs. AAC-ELD is considered the best-performing
15full-bandwidth communications codec by independent studies and is widely
16deployed. AAC has been standardized by ISO and IEC as part of the MPEG
17specifications.
18
19Patent licenses for necessary patent claims for the FDK AAC Codec (including
20those of Fraunhofer) may be obtained through Via Licensing
21(www.vialicensing.com) or through the respective patent owners individually for
22the purpose of encoding or decoding bit streams in products that are compliant
23with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
24Android devices already license these patent claims through Via Licensing or
25directly from the patent owners, and therefore FDK AAC Codec software may
26already be covered under those patent licenses when it is used for those
27licensed purposes only.
28
29Commercially-licensed AAC software libraries, including floating-point versions
30with enhanced sound quality, are also available from Fraunhofer. Users are
31encouraged to check the Fraunhofer website for additional applications
32information and documentation.
33
342.    COPYRIGHT LICENSE
35
36Redistribution and use in source and binary forms, with or without modification,
37are permitted without payment of copyright license fees provided that you
38satisfy the following conditions:
39
40You must retain the complete text of this software license in redistributions of
41the FDK AAC Codec or your modifications thereto in source code form.
42
43You must retain the complete text of this software license in the documentation
44and/or other materials provided with redistributions of the FDK AAC Codec or
45your modifications thereto in binary form. You must make available free of
46charge copies of the complete source code of the FDK AAC Codec and your
47modifications thereto to recipients of copies in binary form.
48
49The name of Fraunhofer may not be used to endorse or promote products derived
50from this library without prior written permission.
51
52You may not charge copyright license fees for anyone to use, copy or distribute
53the FDK AAC Codec software or your modifications thereto.
54
55Your modified versions of the FDK AAC Codec must carry prominent notices stating
56that you changed the software and the date of any change. For modified versions
57of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
58must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
59AAC Codec Library for Android."
60
613.    NO PATENT LICENSE
62
63NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
64limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
65Fraunhofer provides no warranty of patent non-infringement with respect to this
66software.
67
68You may use this FDK AAC Codec software or modifications thereto only for
69purposes that are authorized by appropriate patent licenses.
70
714.    DISCLAIMER
72
73This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
74holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
75including but not limited to the implied warranties of merchantability and
76fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
77CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
78or consequential damages, including but not limited to procurement of substitute
79goods or services; loss of use, data, or profits, or business interruption,
80however caused and on any theory of liability, whether in contract, strict
81liability, or tort (including negligence), arising in any way out of the use of
82this software, even if advised of the possibility of such damage.
83
845.    CONTACT INFORMATION
85
86Fraunhofer Institute for Integrated Circuits IIS
87Attention: Audio and Multimedia Departments - FDK AAC LL
88Am Wolfsmantel 33
8991058 Erlangen, Germany
90
91www.iis.fraunhofer.de/amm
92amm-info@iis.fraunhofer.de
93----------------------------------------------------------------------------- */
94
95/******************* Library for basic calculation routines ********************
96
97   Author(s):   M. Lohwasser
98
99   Description: common bitbuffer read/write routines
100
101*******************************************************************************/
102
103#ifndef FDK_BITBUFFER_H
104#define FDK_BITBUFFER_H
105
106#include "FDK_archdef.h"
107#include "machine_type.h"
108
109/* leave 3 bits headroom so MAX_BUFSIZE can be represented in bits as well. */
110#define MAX_BUFSIZE_BYTES (0x10000000)
111
112typedef struct {
113  UINT ValidBits;
114  UINT ReadOffset;
115  UINT WriteOffset;
116  UINT BitCnt;
117  UINT BitNdx;
118
119  UCHAR *Buffer;
120  UINT bufSize;
121  UINT bufBits;
122} FDK_BITBUF;
123
124typedef FDK_BITBUF *HANDLE_FDK_BITBUF;
125
126#ifdef __cplusplus
127extern "C" {
128#endif
129
130extern const UINT BitMask[32 + 1];
131
132/**  The BitBuffer Functions are called straight from FDK_bitstream Interface.
133     For Functions functional survey look there.
134*/
135
136void FDK_CreateBitBuffer(HANDLE_FDK_BITBUF *hBitBuffer, UCHAR *pBuffer,
137                         UINT bufSize);
138
139void FDK_InitBitBuffer(HANDLE_FDK_BITBUF hBitBuffer, UCHAR *pBuffer,
140                       UINT bufSize, UINT validBits);
141
142void FDK_ResetBitBuffer(HANDLE_FDK_BITBUF hBitBuffer);
143
144void FDK_DeleteBitBuffer(HANDLE_FDK_BITBUF hBitBuffer);
145
146INT FDK_get(HANDLE_FDK_BITBUF hBitBuffer, const UINT numberOfBits);
147
148INT FDK_get32(HANDLE_FDK_BITBUF hBitBuf);
149
150void FDK_put(HANDLE_FDK_BITBUF hBitBuffer, UINT value, const UINT numberOfBits);
151
152INT FDK_getBwd(HANDLE_FDK_BITBUF hBitBuffer, const UINT numberOfBits);
153void FDK_putBwd(HANDLE_FDK_BITBUF hBitBuffer, UINT value,
154                const UINT numberOfBits);
155
156void FDK_pushBack(HANDLE_FDK_BITBUF hBitBuffer, const UINT numberOfBits,
157                  UCHAR config);
158
159void FDK_pushForward(HANDLE_FDK_BITBUF hBitBuffer, const UINT numberOfBits,
160                     UCHAR config);
161
162void FDK_byteAlign(HANDLE_FDK_BITBUF hBitBuffer, UCHAR config);
163
164UINT FDK_getValidBits(HANDLE_FDK_BITBUF hBitBuffer);
165
166INT FDK_getFreeBits(HANDLE_FDK_BITBUF hBitBuffer);
167
168void FDK_setBitCnt(HANDLE_FDK_BITBUF hBitBuffer, const UINT value);
169INT FDK_getBitCnt(HANDLE_FDK_BITBUF hBitBuffer);
170
171void FDK_Feed(HANDLE_FDK_BITBUF hBitBuffer, const UCHAR inputBuffer[],
172              const UINT bufferSize, UINT *bytesValid);
173
174void FDK_Copy(HANDLE_FDK_BITBUF hBitBufDst, HANDLE_FDK_BITBUF hBitBufSrc,
175              UINT *bytesValid);
176
177void FDK_Fetch(HANDLE_FDK_BITBUF hBitBuffer, UCHAR outBuf[], UINT *writeBytes);
178
179#ifdef __cplusplus
180}
181#endif
182
183#endif
184