• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 /**************************** 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 
115 typedef 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  */
152 AAC_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  */
171 AAC_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 
178 INT 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