1
2/* -----------------------------------------------------------------------------------------------------------
3Software License for The Fraunhofer FDK AAC Codec Library for Android
4
5� Copyright  1995 - 2013 Fraunhofer-Gesellschaft zur F�rderung der angewandten Forschung e.V.
6  All rights reserved.
7
8 1.    INTRODUCTION
9The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16of the MPEG specifications.
17
18Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20individually for the purpose of encoding or decoding bit streams in products that are compliant with
21the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27applications information and documentation.
28
292.    COPYRIGHT LICENSE
30
31Redistribution and use in source and binary forms, with or without modification, are permitted without
32payment of copyright license fees provided that you satisfy the following conditions:
33
34You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35your modifications thereto in source code form.
36
37You must retain the complete text of this software license in the documentation and/or other materials
38provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40modifications thereto to recipients of copies in binary form.
41
42The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43prior written permission.
44
45You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46software or your modifications thereto.
47
48Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49and the date of any change. For modified versions of the FDK AAC Codec, the term
50"Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
51"Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
52
533.    NO PATENT LICENSE
54
55NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57respect to this software.
58
59You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60by appropriate patent licenses.
61
624.    DISCLAIMER
63
64This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
65"AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
66of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69or business interruption, however caused and on any theory of liability, whether in contract, strict
70liability, or tort (including negligence), arising in any way out of the use of this software, even if
71advised of the possibility of such damage.
72
735.    CONTACT INFORMATION
74
75Fraunhofer Institute for Integrated Circuits IIS
76Attention: Audio and Multimedia Departments - FDK AAC LL
77Am Wolfsmantel 33
7891058 Erlangen, Germany
79
80www.iis.fraunhofer.de/amm
81amm-info@iis.fraunhofer.de
82----------------------------------------------------------------------------------------------------------- */
83
84/******************************** MPEG Audio Encoder **************************
85
86   Initial author:       M. Werner
87   contents/description: Bitstream encoder
88
89******************************************************************************/
90
91#ifndef _BITENC_H
92#define _BITENC_H
93
94
95#include "qc_data.h"
96#include "aacenc_tns.h"
97#include "channel_map.h"
98#include "interface.h"    /* obsolete, when PSY_OUT is thrown out of the WritBS-call! */
99#include "FDK_audio.h"
100#include "aacenc.h"
101
102#include "tpenc_lib.h"
103
104typedef enum{
105  MAX_ENCODER_CHANNELS  = 9,
106  MAX_BLOCK_TYPES       = 4,
107  MAX_AAC_LAYERS        = 9,
108  MAX_LAYERS            = MAX_AAC_LAYERS  , /* only one core layer if present */
109  FIRST_LAY             = 1   /* default layer number for AAC nonscalable */
110} _MAX_CONST;
111
112#define BUFFER_MX_HUFFCB_SIZE (32*sizeof(INT))  /* our FDK_bitbuffer needs size of power 2 */
113
114#define EL_ID_BITS  ( 3 )
115
116
117/**
118 * \brief Arbitrary order bitstream writer. This function can either assemble a bit stream
119 *        and write into the bit buffer of hTpEnc or calculate the number of static bits (signal independent)
120 *        TpEnc handle must be NULL in this case. Or also Calculate the minimum possible number of
121 *        static bits which by disabling all tools e.g. MS, TNS and sbfCnt=0. The minCnt parameter
122 *        has to be 1 in this latter case.
123 * \param hTpEnc Transport encoder handle. If NULL, the number of static bits will be returned into
124 *        *pBitDemand.
125 * \param pElInfo
126 * \param qcOutChannel
127 * \param hReorderInfo
128 * \param psyOutElement
129 * \param psyOutChannel
130 * \param syntaxFlags Bit stream syntax flags as defined in FDK_audio.h (Audio Codec flags).
131 * \param aot
132 * \param epConfig
133 * \param pBitDemand Pointer to an int where the amount of bits is returned into. The returned value
134 *        depends on if hTpEnc is NULL and minCnt.
135 * \param minCnt If non-zero the value returned into *pBitDemand is the absolute minimum required amount of
136 *        static bits in order to write a valid bit stream.
137 * \return AAC_ENCODER_ERROR error code
138 */
139AAC_ENCODER_ERROR FDKaacEnc_ChannelElementWrite( HANDLE_TRANSPORTENC  hTpEnc,
140                                                 ELEMENT_INFO        *pElInfo,
141                                                 QC_OUT_CHANNEL      *qcOutChannel[(2)],
142                                                 PSY_OUT_ELEMENT     *psyOutElement,
143                                                 PSY_OUT_CHANNEL     *psyOutChannel[(2)],
144                                                 UINT                 syntaxFlags,
145                                                 AUDIO_OBJECT_TYPE    aot,
146                                                 SCHAR                epConfig,
147                                                 INT                 *pBitDemand,
148                                                 UCHAR                minCnt
149                                               );
150/**
151 * \brief Write bit stream or account static bits
152 * \param hTpEnc transport encoder handle. If NULL, the function will
153 *        not write any bit stream data but only count the amount
154 *        of static (signal independent) bits
155 * \param channelMapping Channel mapping info
156 * \param qcOut
157 * \param psyOut
158 * \param qcKernel
159 * \param hBSE
160 * \param aot Audio Object Type being encoded
161 * \param syntaxFlags Flags indicating format specific detail
162 * \param epConfig Error protection config
163 */
164AAC_ENCODER_ERROR FDKaacEnc_WriteBitstream (HANDLE_TRANSPORTENC hTpEnc,
165                                            CHANNEL_MAPPING *channelMapping,
166                                            QC_OUT* qcOut,
167                                            PSY_OUT* psyOut,
168                                            QC_STATE* qcKernel,
169                                            AUDIO_OBJECT_TYPE  aot,
170                                            UINT  syntaxFlags,
171                                            SCHAR  epConfig
172                                           );
173
174INT FDKaacEnc_writeExtensionData( HANDLE_TRANSPORTENC  hTpEnc,
175                                  QC_OUT_EXTENSION    *pExtension,
176                                  INT                  elInstanceTag,
177                                  UINT                 alignAnchor,
178                                  UINT                 syntaxFlags,
179                                  AUDIO_OBJECT_TYPE    aot,
180                                  SCHAR                epConfig
181                                );
182
183#endif /* _BITENC_H */
184