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