Home | History | Annotate | Download | only in src
      1 
      2 /* -----------------------------------------------------------------------------------------------------------
      3 Software License for The Fraunhofer FDK AAC Codec Library for Android
      4 
      5  Copyright  1995 - 2012 Fraunhofer-Gesellschaft zur Frderung 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 (at) iis.fraunhofer.de
     82 ----------------------------------------------------------------------------------------------------------- */
     83 
     84 /*!
     85   \file
     86   \brief  Low Power Profile Transposer,
     87 */
     88 
     89 #ifndef _LPP_TRANS_H
     90 #define _LPP_TRANS_H
     91 
     92 #include "sbrdecoder.h"
     93 #include "qmf.h"
     94 
     95 /*
     96   Common
     97 */
     98 #define QMF_OUT_SCALE            8
     99 
    100 /*
    101   Env-Adjust
    102 */
    103 #define MAX_NOISE_ENVELOPES      2
    104 #define MAX_NOISE_COEFFS         5
    105 #define MAX_NUM_NOISE_VALUES     (MAX_NOISE_ENVELOPES * MAX_NOISE_COEFFS)
    106 #define MAX_NUM_LIMITERS         12
    107 
    108 /* Set MAX_ENVELOPES to the largest value of all supported BSFORMATs
    109    by overriding MAX_ENVELOPES in the correct order: */
    110 #define MAX_ENVELOPES_HEAAC      5
    111 #define MAX_ENVELOPES            MAX_ENVELOPES_HEAAC
    112 
    113 #define MAX_FREQ_COEFFS          48
    114 #define MAX_FREQ_COEFFS_FS44100  35
    115 #define MAX_FREQ_COEFFS_FS48000  32
    116 
    117 
    118 #define MAX_NUM_ENVELOPE_VALUES  (MAX_ENVELOPES * MAX_FREQ_COEFFS)
    119 
    120 #define MAX_GAIN_EXP             34
    121 /* Maximum gain will be sqrt(0.5 * 2^MAX_GAIN_EXP)
    122    example: 34=99dB   */
    123 #define MAX_GAIN_CONCEAL_EXP     1
    124 /* Maximum gain will be sqrt(0.5 * 2^MAX_GAIN_CONCEAL_EXP) in concealment case (0dB) */
    125 
    126 /*
    127   LPP Transposer
    128 */
    129 #define LPC_ORDER                2
    130 
    131 #define MAX_INVF_BANDS           MAX_NOISE_COEFFS
    132 
    133 #define MAX_NUM_PATCHES          6
    134 #define SHIFT_START_SB           1              /*!< lowest subband of source range */
    135 
    136 typedef enum
    137 {
    138   INVF_OFF = 0,
    139   INVF_LOW_LEVEL,
    140   INVF_MID_LEVEL,
    141   INVF_HIGH_LEVEL,
    142   INVF_SWITCHED /* not a real choice but used here to control behaviour */
    143 }
    144 INVF_MODE;
    145 
    146 
    147 /** parameter set for one single patch */
    148 typedef struct {
    149   UCHAR  sourceStartBand;   /*!< first band in lowbands where to take the samples from */
    150   UCHAR  sourceStopBand;    /*!< first band in lowbands which is not included in the patch anymore */
    151   UCHAR  guardStartBand;    /*!< first band in highbands to be filled with zeros in order to
    152                                          reduce interferences between patches */
    153   UCHAR  targetStartBand;   /*!< first band in highbands to be filled with whitened lowband signal */
    154   UCHAR  targetBandOffs;    /*!< difference between 'startTargetBand' and 'startSourceBand' */
    155   UCHAR  numBandsInPatch;   /*!< number of consecutive bands in this one patch */
    156 } PATCH_PARAM;
    157 
    158 
    159 /** whitening factors for different levels of whitening
    160     need to be initialized corresponding to crossover frequency */
    161 typedef struct {
    162   FIXP_DBL  off;                       /*!< bw factor for signal OFF */
    163   FIXP_DBL  transitionLevel;
    164   FIXP_DBL  lowLevel;                  /*!< bw factor for signal LOW_LEVEL */
    165   FIXP_DBL  midLevel;                  /*!< bw factor for signal MID_LEVEL */
    166   FIXP_DBL  highLevel;                 /*!< bw factor for signal HIGH_LEVEL */
    167 } WHITENING_FACTORS;
    168 
    169 
    170 /*! The transposer settings are calculated on a header reset and are shared by both channels. */
    171 typedef struct {
    172   UCHAR  nCols;                       /*!< number subsamples of a codec frame */
    173   UCHAR  noOfPatches;                 /*!< number of patches */
    174   UCHAR  lbStartPatching;             /*!< first band of lowbands that will be patched */
    175   UCHAR  lbStopPatching;              /*!< first band that won't be patched anymore*/
    176   UCHAR  bwBorders[MAX_NUM_NOISE_VALUES]; /*!< spectral bands with different inverse filtering levels */
    177 
    178   PATCH_PARAM    patchParam[MAX_NUM_PATCHES]; /*!< new parameter set for patching */
    179   WHITENING_FACTORS whFactors;                /*!< the pole moving factors for certain whitening levels as indicated
    180                                                    in the bitstream depending on the crossover frequency */
    181   UCHAR  overlap;                             /*!< Overlap size */
    182 } TRANSPOSER_SETTINGS;
    183 
    184 
    185 typedef struct
    186 {
    187   TRANSPOSER_SETTINGS *pSettings;                /*!< Common settings for both channels */
    188   FIXP_DBL  bwVectorOld[MAX_NUM_PATCHES];        /*!< pole moving factors of past frame */
    189   FIXP_DBL  lpcFilterStatesReal[LPC_ORDER][(32)];     /*!< pointer array to save filter states */
    190   FIXP_DBL  lpcFilterStatesImag[LPC_ORDER][(32)];     /*!< pointer array to save filter states */
    191 }
    192 SBR_LPP_TRANS;
    193 
    194 typedef SBR_LPP_TRANS *HANDLE_SBR_LPP_TRANS;
    195 
    196 
    197 void lppTransposer (HANDLE_SBR_LPP_TRANS hLppTrans,
    198                     QMF_SCALE_FACTOR  *sbrScaleFactor,
    199                     FIXP_DBL **qmfBufferReal,
    200 
    201                     FIXP_DBL *degreeAlias,
    202                     FIXP_DBL **qmfBufferImag,
    203                     const int useLP,
    204                     const int timeStep,
    205                     const int firstSlotOffset,
    206                     const int lastSlotOffset,
    207                     const int nInvfBands,
    208                     INVF_MODE *sbr_invf_mode,
    209                     INVF_MODE *sbr_invf_mode_prev
    210                     );
    211 
    212 
    213 SBR_ERROR
    214 createLppTransposer (HANDLE_SBR_LPP_TRANS hLppTrans,
    215                      TRANSPOSER_SETTINGS *pSettings,
    216                      const int  highBandStartSb,
    217                      UCHAR *v_k_master,
    218                      const int  numMaster,
    219                      const int  usb,
    220                      const int  timeSlots,
    221                      const int  nCols,
    222                      UCHAR *noiseBandTable,
    223                      const int  noNoiseBands,
    224                      UINT   fs,
    225                      const int  chan,
    226                      const int overlap);
    227 
    228 
    229 SBR_ERROR
    230 resetLppTransposer (HANDLE_SBR_LPP_TRANS hLppTrans,
    231                     UCHAR  highBandStartSb,
    232                     UCHAR *v_k_master,
    233                     UCHAR  numMaster,
    234                     UCHAR *noiseBandTable,
    235                     UCHAR  noNoiseBands,
    236                     UCHAR  usb,
    237                     UINT   fs);
    238 
    239 
    240 
    241 #endif /* _LPP_TRANS_H */
    242 
    243