• 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 decoder library ******************************
96 
97    Author(s):   Manuel Jander
98 
99    Description: USAC FAC
100 
101 *******************************************************************************/
102 
103 #ifndef USACDEC_FAC_H
104 #define USACDEC_FAC_H
105 
106 #include "channelinfo.h"
107 #include "FDK_bitstream.h"
108 
109 /**
110  * \brief Get the address of a memory area of the spectral data memory were the
111  * FAC data can be stored into.
112  * \param spec SPECTRAL_PTR pointing to the current spectral data.
113  * \param mod the current LPD mod array.
114  * \param pState pointer to a private state variable which must be 0 for the
115  * first call and not changed externally.
116  * \param isFullbandLPD is 1 if fullband LPD mode is on, otherwise it is 0.
117  */
118 FIXP_DBL *CLpd_FAC_GetMemory(CAacDecoderChannelInfo *pAacDecoderChannelInfo,
119                              UCHAR mod[NB_SUBFR], int *pState);
120 
121 /**
122  * \brief read a fac bitstream data block.
123  * \param hBs a bit stream handle, where the fac bitstream data is located.
124  * \param pFac pointer to were the FAC data will be stored into.
125  * \param pFacScale pointer to were the FAC data scale value will be stored
126  * into.
127  * \param tcx_gain value to be used as FAC gain. If zero, read fac_gain from
128  * bitstream.
129  * \param tcx_gain_e exponen value of tcx_gain.
130  * \param frame the subframe to be considered from the current superframe.
131  * Always 0 for FD case.
132  * \return 0 on success, -1 on error.
133  */
134 int CLpd_FAC_Read(HANDLE_FDK_BITSTREAM hBs, FIXP_DBL *pFac, SCHAR *pFacScale,
135                   int length, int use_gain, int frame);
136 
137 /**
138  * \brief Apply TCX and ALFD gains to FAC data.
139  * \param fac_data pointer to FAC data.
140  * \param fac_length FAC length (128 or 96).
141  * \param tcx_gain TCX gain
142  * \param alfd_gains pointer to alfd gains.
143  * \param mod mod value (1,2,3) of TCX frame where the FAC signal needs to be
144  * applied.
145  */
146 void CFac_ApplyGains(FIXP_DBL fac_data[LFAC], const INT fac_length,
147                      const FIXP_DBL tcx_gain, const FIXP_DBL alfd_gains[],
148                      const INT mod);
149 
150 /**
151  * \brief Do FAC transition from frequency domain to ACELP domain.
152  */
153 INT CLpd_FAC_Mdct2Acelp(H_MDCT hMdct, FIXP_DBL *output, FIXP_DBL *pFac_data,
154                         const int fac_data_e, FIXP_LPC *A, INT A_exp,
155                         INT nrOutSamples, const INT fac_length,
156                         const INT isFdFac, UCHAR prevWindowShape);
157 
158 /**
159  * \brief Do FAC transition from ACELP domain to frequency domain.
160  * \param hMdct MDCT context.
161  * \param output pointer for time domain output.
162  * \param pSpec pointer to MDCT spectrum input.
163  * \param spec_scale MDCT spectrum exponents.
164  * \param nSpec amount of contiguos MDCT spectra.
165  * \param pFac pointer to FAC MDCT domain data.
166  * \param fac_scale exponent of FAC data.
167  * \param fac_length length of FAC data.
168  * \param nrSamples room in samples in output buffer.
169  * \param tl MDCT transform length of pSpec.
170  * \param wrs right MDCT window slope.
171  * \param fr right MDCT window slope length.
172  * \param A LP domain filter coefficients.
173  * \param deemph_mem deemphasis filter state.
174  * \param gain gain to be applied to FAC data before overlap add.
175  * \param old_syn_mem Synthesis filter state.
176  * \param isFdFac indicates fac processing from or to FD.
177  * \param pFacData fac data stored for fullband LPD.
178  * \param elFlags element specific parser guidance flags.
179  * \param isFacForFullband indicates that fac is processed for fullband LPD.
180  */
181 INT CLpd_FAC_Acelp2Mdct(H_MDCT hMdct, FIXP_DBL *output, FIXP_DBL *pSpec,
182                         const SHORT spec_scale[], const int nSpec,
183                         FIXP_DBL *pFac_data, const int fac_data_e,
184                         const INT fac_length, INT nrSamples, const INT tl,
185                         const FIXP_WTP *wrs, const INT fr, FIXP_LPC A[16],
186                         INT A_exp, CAcelpStaticMem *acelp_mem,
187                         const FIXP_DBL gain, const int last_frame_lost,
188                         const int isFdFac, const UCHAR last_lpd, const int k,
189                         int currAliasingSymmetry);
190 
191 #endif /* USACDEC_FAC_H */
192