1 2 /* ----------------------------------------------------------------------------------------------------------- 3 Software 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 9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements 10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio. 11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices. 12 13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual 14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by 15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part 16 of the MPEG specifications. 17 18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer) 19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners 20 individually for the purpose of encoding or decoding bit streams in products that are compliant with 21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license 22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec 23 software may already be covered under those patent licenses when it is used for those licensed purposes only. 24 25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality, 26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional 27 applications information and documentation. 28 29 2. COPYRIGHT LICENSE 30 31 Redistribution and use in source and binary forms, with or without modification, are permitted without 32 payment of copyright license fees provided that you satisfy the following conditions: 33 34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or 35 your modifications thereto in source code form. 36 37 You must retain the complete text of this software license in the documentation and/or other materials 38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form. 39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your 40 modifications thereto to recipients of copies in binary form. 41 42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without 43 prior written permission. 44 45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec 46 software or your modifications thereto. 47 48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software 49 and 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 53 3. NO PATENT LICENSE 54 55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer, 56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with 57 respect to this software. 58 59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized 60 by appropriate patent licenses. 61 62 4. DISCLAIMER 63 64 This 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 66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages, 68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits, 69 or business interruption, however caused and on any theory of liability, whether in contract, strict 70 liability, or tort (including negligence), arising in any way out of the use of this software, even if 71 advised of the possibility of such damage. 72 73 5. CONTACT INFORMATION 74 75 Fraunhofer Institute for Integrated Circuits IIS 76 Attention: Audio and Multimedia Departments - FDK AAC LL 77 Am Wolfsmantel 33 78 91058 Erlangen, Germany 79 80 www.iis.fraunhofer.de/amm 81 amm-info@iis.fraunhofer.de 82 ----------------------------------------------------------------------------------------------------------- */ 83 84 /*! 85 \file 86 \brief General tonality correction detector module. 87 */ 88 #ifndef _TON_CORR_EST_H 89 #define _TON_CORR_EST_H 90 91 #include "sbr_encoder.h" 92 #include "mh_det.h" 93 #include "nf_est.h" 94 #include "invf_est.h" 95 96 97 #define MAX_NUM_PATCHES 6 98 #define SCALE_NRGVEC 4 99 100 /** parameter set for one single patch */ 101 typedef struct { 102 INT sourceStartBand; /*!< first band in lowbands where to take the samples from */ 103 INT sourceStopBand; /*!< first band in lowbands which is not included in the patch anymore */ 104 INT guardStartBand; /*!< first band in highbands to be filled with zeros in order to 105 reduce interferences between patches */ 106 INT targetStartBand; /*!< first band in highbands to be filled with whitened lowband signal */ 107 INT targetBandOffs; /*!< difference between 'startTargetBand' and 'startSourceBand' */ 108 INT numBandsInPatch; /*!< number of consecutive bands in this one patch */ 109 } PATCH_PARAM; 110 111 112 113 114 typedef struct 115 { 116 INT switchInverseFilt; /*!< Flag to enable dynamic adaption of invf. detection */ 117 INT noQmfChannels; 118 INT bufferLength; /*!< Length of the r and i buffers. */ 119 INT stepSize; /*!< Stride for the lpc estimate. */ 120 INT numberOfEstimates; /*!< The total number of estiamtes, available in the quotaMatrix.*/ 121 INT numberOfEstimatesPerFrame; /*!< The number of estimates per frame available in the quotaMatrix.*/ 122 INT lpcLength[2]; /*!< Segment length used for second order LPC analysis.*/ 123 INT nextSample; /*!< Where to start the LPC analysis of the current frame.*/ 124 INT move; /*!< How many estimates to move in the quotaMatrix, when buffering. */ 125 INT frameStartIndex; /*!< The start index for the current frame in the r and i buffers. */ 126 INT startIndexMatrix; /*!< The start index for the current frame in the quotaMatrix. */ 127 INT frameStartIndexInvfEst; /*!< The start index of the inverse filtering, not the same as the others, 128 dependent on what decoder is used (buffer opt, or no buffer opt). */ 129 INT prevTransientFlag; /*!< The transisent flag (from the transient detector) for the previous frame. */ 130 INT transientNextFrame; /*!< Flag to indicate that the transient will show up in the next frame. */ 131 INT transientPosOffset; /*!< An offset value to match the transient pos as calculated by the transient detector 132 with the actual position in the frame.*/ 133 134 INT *signMatrix[MAX_NO_OF_ESTIMATES]; /*!< Matrix holding the sign of each channe, i.e. indicating in what 135 part of a QMF channel a possible sine is. */ 136 137 FIXP_DBL *quotaMatrix[MAX_NO_OF_ESTIMATES];/*!< Matrix holding the quota values for all estimates, all channels. */ 138 139 FIXP_DBL nrgVector[MAX_NO_OF_ESTIMATES]; /*!< Vector holding the averaged energies for every QMF band. */ 140 FIXP_DBL nrgVectorFreq[QMF_CHANNELS]; /*!< Vector holding the averaged energies for every QMF channel */ 141 142 SCHAR indexVector[QMF_CHANNELS]; /*!< Index vector poINTing to the correct lowband channel, 143 when indexing a highband channel, -1 represents a guard band */ 144 PATCH_PARAM patchParam[MAX_NUM_PATCHES]; /*!< new parameter set for patching */ 145 INT guard; /*!< number of guardbands between every patch */ 146 INT shiftStartSb; /*!< lowest subband of source range to be included in the patches */ 147 INT noOfPatches; /*!< number of patches */ 148 149 SBR_MISSING_HARMONICS_DETECTOR sbrMissingHarmonicsDetector; /*!< SBR_MISSING_HARMONICS_DETECTOR struct. */ 150 SBR_NOISE_FLOOR_ESTIMATE sbrNoiseFloorEstimate; /*!< SBR_NOISE_FLOOR_ESTIMATE struct. */ 151 SBR_INV_FILT_EST sbrInvFilt; /*!< SBR_INV_FILT_EST struct. */ 152 } 153 SBR_TON_CORR_EST; 154 155 typedef SBR_TON_CORR_EST *HANDLE_SBR_TON_CORR_EST; 156 157 void 158 FDKsbrEnc_TonCorrParamExtr(HANDLE_SBR_TON_CORR_EST hTonCorr, /*!< Handle to SBR_TON_CORR struct. */ 159 INVF_MODE* infVec, /*!< Vector where the inverse filtering levels will be stored. */ 160 FIXP_DBL * noiseLevels, /*!< Vector where the noise levels will be stored. */ 161 INT* missingHarmonicFlag, /*!< Flag set to one or zero, dependent on if any strong sines are missing.*/ 162 UCHAR* missingHarmonicsIndex, /*!< Vector indicating where sines are missing. */ 163 UCHAR* envelopeCompensation, /*!< Vector to store compensation values for the energies in. */ 164 const SBR_FRAME_INFO *frameInfo, /*!< Frame info struct, contains the time and frequency grid of the current frame.*/ 165 UCHAR* transientInfo, /*!< Transient info.*/ 166 UCHAR * freqBandTable, /*!< Frequency band tables for high-res.*/ 167 INT nSfb, /*!< Number of scalefactor bands for high-res. */ 168 XPOS_MODE xposType, /*!< Type of transposer used in the decoder.*/ 169 UINT sbrSyntaxFlags 170 ); 171 172 INT 173 FDKsbrEnc_CreateTonCorrParamExtr(HANDLE_SBR_TON_CORR_EST hTonCorr, /*!< Pointer to handle to SBR_TON_CORR struct. */ 174 INT chan); /*!< Channel index, needed for mem allocation */ 175 176 INT 177 FDKsbrEnc_InitTonCorrParamExtr(INT frameSize, /*!< Current SBR frame size. */ 178 HANDLE_SBR_TON_CORR_EST hTonCorr, /*!< Pointer to handle to SBR_TON_CORR struct. */ 179 HANDLE_SBR_CONFIG_DATA sbrCfg, /*!< Pointer to SBR configuration parameters. */ 180 INT timeSlots, /*!< Number of time-slots per frame */ 181 INT xposCtrl, /*!< Different patch modes. */ 182 INT ana_max_level, /*!< Maximum level of the adaptive noise. */ 183 INT noiseBands, /*!< Number of noise bands per octave. */ 184 INT noiseFloorOffset, /*!< Noise floor offset. */ 185 UINT useSpeechConfig /*!< Speech or music tuning. */ 186 ); 187 188 void 189 FDKsbrEnc_DeleteTonCorrParamExtr(HANDLE_SBR_TON_CORR_EST hTonCorr); /*!< Handle to SBR_TON_CORR struct. */ 190 191 192 void 193 FDKsbrEnc_CalculateTonalityQuotas(HANDLE_SBR_TON_CORR_EST hTonCorr, 194 FIXP_DBL **sourceBufferReal, 195 FIXP_DBL **sourceBufferImag, 196 INT usb, 197 INT qmfScale /*!< sclefactor of QMF subsamples */ 198 ); 199 200 INT 201 FDKsbrEnc_ResetTonCorrParamExtr(HANDLE_SBR_TON_CORR_EST hTonCorr, /*!< Handle to SBR_TON_CORR struct. */ 202 INT xposctrl, /*!< Different patch modes. */ 203 INT highBandStartSb, /*!< Start band of the SBR range. */ 204 UCHAR *v_k_master, /*!< Master frequency table from which all other table are derived.*/ 205 INT numMaster, /*!< Number of elements in the master table. */ 206 INT fs, /*!< Sampling frequency (of the SBR part). */ 207 UCHAR** freqBandTable, /*!< Frequency band table for low-res and high-res. */ 208 INT* nSfb, /*!< Number of frequency bands (hig-res and low-res). */ 209 INT noQmfChannels /*!< Number of QMF channels. */ 210 ); 211 #endif 212 213