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/******************* MPEG transport format encoder library *********************
96
97   Author(s):   Alex Groeschel
98
99   Description: ADTS Transport writer
100
101*******************************************************************************/
102
103#ifndef TPENC_ADTS_H
104#define TPENC_ADTS_H
105
106#include "tp_data.h"
107
108#include "FDK_crc.h"
109
110typedef struct {
111  INT sample_freq;
112  CHANNEL_MODE channel_mode;
113  UCHAR decoderCanDoMpeg4;
114  UCHAR mpeg_id;
115  UCHAR layer;
116  UCHAR protection_absent;
117  UCHAR profile;
118  UCHAR sample_freq_index;
119  UCHAR private_bit;
120  UCHAR original;
121  UCHAR home;
122  UCHAR copyright_id;
123  UCHAR copyright_start;
124  USHORT frame_length;
125  UCHAR num_raw_blocks;
126  UCHAR BufferFullnesStartFlag;
127  UCHAR channel_config_zero;
128  int headerBits;       /*!< Header bit demand for the current raw data block */
129  int currentBlock;     /*!< Index of current raw data block */
130  int subFrameStartBit; /*!< Bit position where the current raw data block
131                           begins */
132  FDK_CRCINFO crcInfo;
133} STRUCT_ADTS;
134
135typedef STRUCT_ADTS *HANDLE_ADTS;
136
137/**
138 * \brief Initialize ADTS data structure
139 *
140 * \param hAdts ADTS data handle
141 * \param config a valid CODER_CONFIG struct from where the required
142 *        information for the ADTS header is extrated from
143 *
144 * \return 0 in case of success.
145 */
146INT adtsWrite_Init(HANDLE_ADTS hAdts, CODER_CONFIG *config);
147
148/**
149 * \brief Get the total bit overhead caused by ADTS
150 *
151 * \hAdts handle to ADTS data
152 *
153 * \return Amount of additional bits required for the current raw data block
154 */
155int adtsWrite_GetHeaderBits(HANDLE_ADTS hAdts);
156
157/**
158 * \brief Write an ADTS header into the given bitstream. May not write a header
159 *        in case of multiple raw data blocks.
160 *
161 * \param hAdts ADTS data handle
162 * \param hBitStream bitstream handle into which the ADTS may be written into
163 * \param buffer_fullness the buffer fullness value for the ADTS header
164 * \param the current raw data block length
165 *
166 * \return 0 in case of success.
167 */
168INT adtsWrite_EncodeHeader(HANDLE_ADTS hAdts, HANDLE_FDK_BITSTREAM hBitStream,
169                           int bufferFullness, int frame_length);
170/**
171 * \brief Finish a ADTS raw data block
172 *
173 * \param hAdts ADTS data handle
174 * \param hBs bitstream handle into which the ADTS may be written into
175 * \param pBits a pointer to a integer holding the current bitstream buffer bit
176 * count, which is corrected to the current raw data block boundary.
177 *
178 */
179void adtsWrite_EndRawDataBlock(HANDLE_ADTS hAdts, HANDLE_FDK_BITSTREAM hBs,
180                               int *bits);
181
182/**
183 * \brief Start CRC region with a maximum number of bits
184 *        If mBits is positive zero padding will be used for CRC calculation, if
185 * there are less than mBits bits available. If mBits is negative no zero
186 * padding is done. If mBits is zero the memory for the buffer is
187 * allocated dynamically, the number of bits is not limited.
188 *
189 * \param pAdts ADTS data handle
190 * \param hBs bitstream handle of which the CRC region ends
191 * \param mBits limit of number of bits to be considered for the requested CRC
192 * region
193 *
194 * \return ID for the created region, -1 in case of an error
195 */
196int adtsWrite_CrcStartReg(HANDLE_ADTS pAdts, HANDLE_FDK_BITSTREAM hBs,
197                          int mBits);
198
199/**
200 * \brief Ends CRC region identified by reg
201 *
202 * \param pAdts ADTS data handle
203 * \param hBs bitstream handle of which the CRC region ends
204 * \param reg a CRC region ID returned previously by adtsWrite_CrcStartReg()
205 */
206void adtsWrite_CrcEndReg(HANDLE_ADTS pAdts, HANDLE_FDK_BITSTREAM hBs, int reg);
207
208#endif /* TPENC_ADTS_H */
209