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/**************************** AAC encoder library ******************************
96
97   Author(s):   M. Werner
98
99   Description: Bitstream encoder
100
101*******************************************************************************/
102
103#ifndef BITENC_H
104#define BITENC_H
105
106#include "qc_data.h"
107#include "aacenc_tns.h"
108#include "channel_map.h"
109#include "interface.h" /* obsolete, when PSY_OUT is thrown out of the WritBS-call! */
110#include "FDK_audio.h"
111#include "aacenc.h"
112
113#include "tpenc_lib.h"
114
115typedef enum {
116  MAX_ENCODER_CHANNELS = 9,
117  MAX_BLOCK_TYPES = 4,
118  MAX_AAC_LAYERS = 9,
119  MAX_LAYERS = MAX_AAC_LAYERS, /* only one core layer if present */
120  FIRST_LAY = 1                /* default layer number for AAC nonscalable */
121} _MAX_CONST;
122
123#define BUFFER_MX_HUFFCB_SIZE \
124  (32 * sizeof(INT)) /* our FDK_bitbuffer needs size of power 2 */
125
126#define EL_ID_BITS (3)
127
128/**
129 * \brief Arbitrary order bitstream writer. This function can either assemble a
130 * bit stream and write into the bit buffer of hTpEnc or calculate the number of
131 * static bits (signal independent) TpEnc handle must be NULL in this
132 * case. Or also Calculate the minimum possible number of static bits
133 * which by disabling all tools e.g. MS, TNS and sbfCnt=0. The minCnt
134 * parameter has to be 1 in this latter case.
135 * \param hTpEnc Transport encoder handle. If NULL, the number of static bits
136 * will be returned into *pBitDemand.
137 * \param pElInfo
138 * \param qcOutChannel
139 * \param hReorderInfo
140 * \param psyOutElement
141 * \param psyOutChannel
142 * \param syntaxFlags Bit stream syntax flags as defined in FDK_audio.h (Audio
143 * Codec flags).
144 * \param aot
145 * \param epConfig
146 * \param pBitDemand Pointer to an int where the amount of bits is returned
147 * into. The returned value depends on if hTpEnc is NULL and minCnt.
148 * \param minCnt If non-zero the value returned into *pBitDemand is the absolute
149 * minimum required amount of static bits in order to write a valid bit stream.
150 * \return AAC_ENCODER_ERROR error code
151 */
152AAC_ENCODER_ERROR FDKaacEnc_ChannelElementWrite(
153    HANDLE_TRANSPORTENC hTpEnc, ELEMENT_INFO *pElInfo,
154    QC_OUT_CHANNEL *qcOutChannel[(2)], PSY_OUT_ELEMENT *psyOutElement,
155    PSY_OUT_CHANNEL *psyOutChannel[(2)], UINT syntaxFlags,
156    AUDIO_OBJECT_TYPE aot, SCHAR epConfig, INT *pBitDemand, UCHAR minCnt);
157/**
158 * \brief Write bit stream or account static bits
159 * \param hTpEnc transport encoder handle. If NULL, the function will
160 *        not write any bit stream data but only count the amount
161 *        of static (signal independent) bits
162 * \param channelMapping Channel mapping info
163 * \param qcOut
164 * \param psyOut
165 * \param qcKernel
166 * \param hBSE
167 * \param aot Audio Object Type being encoded
168 * \param syntaxFlags Flags indicating format specific detail
169 * \param epConfig Error protection config
170 */
171AAC_ENCODER_ERROR FDKaacEnc_WriteBitstream(HANDLE_TRANSPORTENC hTpEnc,
172                                           CHANNEL_MAPPING *channelMapping,
173                                           QC_OUT *qcOut, PSY_OUT *psyOut,
174                                           QC_STATE *qcKernel,
175                                           AUDIO_OBJECT_TYPE aot,
176                                           UINT syntaxFlags, SCHAR epConfig);
177
178INT FDKaacEnc_writeExtensionData(HANDLE_TRANSPORTENC hTpEnc,
179                                 QC_OUT_EXTENSION *pExtension,
180                                 INT elInstanceTag, UINT alignAnchor,
181                                 UINT syntaxFlags, AUDIO_OBJECT_TYPE aot,
182                                 SCHAR epConfig);
183
184#endif /* BITENC_H */
185