1 /* ----------------------------------------------------------------------------- 2 Software License for The Fraunhofer FDK AAC Codec Library for Android 3 4 Copyright 1995 - 2018 Fraunhofer-Gesellschaft zur Frderung 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 (at) iis.fraunhofer.de 93 ----------------------------------------------------------------------------- */ 94 95 /******************* Library for basic calculation routines ******************** 96 97 Author(s): Manuel Jander, Josef Hoepfl, Youliy Ninov, Daniel Hagel 98 99 Description: MDCT/MDST routines 100 101 *******************************************************************************/ 102 103 #ifndef MDCT_H 104 #define MDCT_H 105 106 #include "common_fix.h" 107 108 #define MDCT_OUT_HEADROOM 2 /* Output additional headroom */ 109 #define PCM_OUT_BITS SAMPLE_BITS 110 #define PCM_OUT_HEADROOM 8 /* Must have the same values as DMXH_HEADROOM */ 111 112 #define MDCT_OUTPUT_SCALE (-MDCT_OUT_HEADROOM + (DFRACT_BITS - SAMPLE_BITS)) 113 /* Refer to "Output word length" in ISO/IEC 14496-3:2008(E) 23.2.3.6 */ 114 #define MDCT_OUTPUT_GAIN 16 115 116 #if (MDCT_OUTPUT_SCALE >= 0) 117 #define IMDCT_SCALE(x) SATURATE_RIGHT_SHIFT(x, MDCT_OUTPUT_SCALE, PCM_OUT_BITS) 118 #else 119 #define IMDCT_SCALE(x) SATURATE_LEFT_SHIFT(x, -MDCT_OUTPUT_SCALE, PCM_OUT_BITS) 120 #endif 121 #define IMDCT_SCALE_DBL(x) (FIXP_DBL)(x) 122 #define IMDCT_SCALE_DBL_LSH1(x) SATURATE_LEFT_SHIFT_ALT((x), 1, DFRACT_BITS) 123 124 #define MLT_FLAG_CURR_ALIAS_SYMMETRY 1 125 126 typedef enum { 127 BLOCK_LONG = 0, /* normal long block */ 128 BLOCK_START, /* long start block */ 129 BLOCK_SHORT, /* 8 short blocks sequence */ 130 BLOCK_STOP /* long stop block*/ 131 } BLOCK_TYPE; 132 133 typedef enum { SHAPE_SINE = 0, SHAPE_KBD, SHAPE_LOL } WINDOW_SHAPE; 134 135 /** 136 * \brief MDCT persistent data 137 */ 138 typedef struct { 139 union { 140 FIXP_DBL *freq; 141 FIXP_DBL *time; 142 } overlap; /**< Pointer to overlap memory */ 143 144 const FIXP_WTP *prev_wrs; /**< pointer to previous right window slope */ 145 int prev_tl; /**< previous transform length */ 146 int prev_nr; /**< previous right window offset */ 147 int prev_fr; /**< previous right window slope length */ 148 int ov_offset; /**< overlap time data fill level */ 149 int ov_size; /**< Overlap buffer size in words */ 150 151 int prevAliasSymmetry; 152 int prevPrevAliasSymmetry; 153 154 FIXP_DBL *pFacZir; 155 FIXP_DBL *pAsymOvlp; /**< pointer to asymmetric overlap (used for stereo LPD 156 transition) */ 157 } mdct_t; 158 159 typedef mdct_t *H_MDCT; 160 161 /** 162 * \brief Initialize as valid MDCT handle 163 * 164 * \param hMdct handle of an allocated MDCT handle. 165 * \param overlap pointer to FIXP_DBL overlap buffer. 166 * \param overlapBufferSize size in FIXP_DBLs of the given overlap buffer. 167 */ 168 void mdct_init(H_MDCT hMdct, FIXP_DBL *overlap, INT overlapBufferSize); 169 170 /** 171 * \brief perform MDCT transform (time domain to frequency domain) with given 172 * parameters. 173 * 174 * \param hMdct handle of an allocated MDCT handle. 175 * \param pTimeData pointer to input time domain signal 176 * \param noInSamples number of input samples 177 * \param mdctData pointer to where the resulting MDCT spectrum will be stored 178 * into. 179 * \param nSpec number of spectra 180 * \param pMdctData_e pointer to the input data exponent. Updated accordingly on 181 * return for output data. 182 * \return number of input samples processed. 183 */ 184 INT mdct_block(H_MDCT hMdct, const INT_PCM *pTimeData, const INT noInSamples, 185 FIXP_DBL *RESTRICT mdctData, const INT nSpec, const INT tl, 186 const FIXP_WTP *pRightWindowPart, const INT fr, 187 SHORT *pMdctData_e); 188 189 /** 190 * \brief add/multiply 2/N transform gain and MPEG4 part 3 defined output gain 191 * (see definition of MDCT_OUTPUT_GAIN) to given mantissa factor and exponent. 192 * \param pGain pointer to the mantissa of a gain factor to be applied to IMDCT 193 * data. 194 * \param pExponent pointer to the exponent of a gain factor to be applied to 195 * IMDCT data. 196 * \param tl length of the IMDCT where the gain *pGain * (2 ^ *pExponent) will 197 * be applied to. 198 */ 199 void imdct_gain(FIXP_DBL *pGain, int *pExponent, int tl); 200 201 /** 202 * \brief drain buffered output samples into given buffer. Changes the MDCT 203 * state. 204 */ 205 INT imdct_drain(H_MDCT hMdct, FIXP_DBL *pTimeData, INT nrSamplesRoom); 206 207 /** 208 * \brief Copy overlap time domain data to given buffer. Does not change the 209 * MDCT state. 210 * \return number of actually copied samples (ov + nr). 211 */ 212 INT imdct_copy_ov_and_nr(H_MDCT hMdct, FIXP_DBL *pTimeData, INT nrSamples); 213 214 /** 215 * \brief Adapt MDCT parameters for non-matching window slopes. 216 * \param hMdct handle of an allocated MDCT handle. 217 * \param pfl pointer to left overlap window side length. 218 * \param pnl pointer to length of the left n part of the window. 219 * \param tl transform length. 220 * \param wls pointer to the left side overlap window coefficients. 221 * \param noOutSamples desired number of output samples. 222 */ 223 void imdct_adapt_parameters(H_MDCT hMdct, int *pfl, int *pnl, int tl, 224 const FIXP_WTP *wls, int noOutSamples); 225 226 /** 227 * \brief perform several inverse MLT transforms (frequency domain to time 228 * domain) with given parameters. 229 * 230 * \param hMdct handle of an allocated MDCT handle. 231 * \param output pointer to where the output time domain signal will be stored 232 * into. 233 * \param spectrum pointer to the input MDCT spectra. 234 * \param scalefactors exponents of the input spectrum. 235 * \param nSpec number of MDCT spectrums. 236 * \param noOutSamples desired number of output samples. 237 * \param tl transform length. 238 * \param wls pointer to the left side overlap window coefficients. 239 * \param fl left overlap window side length. 240 * \param wrs pointer to the right side overlap window coefficients of all 241 * individual IMDCTs. 242 * \param fr right overlap window side length of all individual IMDCTs. 243 * \param gain factor to apply to output samples (if != 0). 244 * \param flags flags controlling the type of transform 245 * \return number of output samples returned. 246 */ 247 INT imlt_block(H_MDCT hMdct, FIXP_DBL *output, FIXP_DBL *spectrum, 248 const SHORT scalefactor[], const INT nSpec, 249 const INT noOutSamples, const INT tl, const FIXP_WTP *wls, 250 INT fl, const FIXP_WTP *wrs, const INT fr, FIXP_DBL gain, 251 int flags); 252 253 #endif /* MDCT_H */ 254
