libSBRdec/src/env_calc.h

   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  Envelope calculation prototypes
  87 */
  88 #ifndef __ENV_CALC_H
  89 #define __ENV_CALC_H
  90
  91 #include "sbrdecoder.h"
  92 #include "env_extr.h"  /* for HANDLE_SBR_HEADER_DATA */
  93 #include "sbr_scale.h"
  94
  95
  96 typedef struct
  97 {
  98   FIXP_DBL  filtBuffer[MAX_FREQ_COEFFS];          /*!< previous gains (required for smoothing) */
  99   FIXP_DBL  filtBufferNoise[MAX_FREQ_COEFFS];     /*!< previous noise levels (required for smoothing) */
 100   SCHAR     filtBuffer_e[MAX_FREQ_COEFFS];        /*!< Exponents of previous gains */
 101   SCHAR     filtBufferNoise_e;                    /*!< Common exponent of previous noise levels */
 102
 103   int startUp;               /*!< flag to signal initial conditions in buffers */
 104   int phaseIndex;            /*!< Index for randomPase array */
 105   int prevTranEnv;           /*!< The transient envelope of the previous frame. */
 106
 107   int harmFlagsPrev[(MAX_FREQ_COEFFS+15)/16];
 108   /*!< Words with 16 flags each indicating where a sine was added in the previous frame.*/
 109   UCHAR harmIndex;            /*!< Current phase of synthetic sine */
 110
 111 }
 112 SBR_CALCULATE_ENVELOPE;
 113
 114 typedef SBR_CALCULATE_ENVELOPE *HANDLE_SBR_CALCULATE_ENVELOPE;
 115
 116
 117
 118 void
 119 calculateSbrEnvelope (QMF_SCALE_FACTOR  *sbrScaleFactor,
 120                       HANDLE_SBR_CALCULATE_ENVELOPE h_sbr_cal_env,
 121                       HANDLE_SBR_HEADER_DATA hHeaderData,
 122                       HANDLE_SBR_FRAME_DATA hFrameData,
 123                       FIXP_DBL **analysBufferReal,
 124                       FIXP_DBL **analysBufferImag,                 /*!< Imag part of subband samples to be processed */
 125                       const int useLP,
 126                       FIXP_DBL *degreeAlias,                       /*!< Estimated aliasing for each QMF channel */
 127                       const UINT flags,
 128                       const int frameErrorFlag
 129                       );
 130
 131 SBR_ERROR
 132 createSbrEnvelopeCalc (HANDLE_SBR_CALCULATE_ENVELOPE hSbrCalculateEnvelope,
 133                        HANDLE_SBR_HEADER_DATA hHeaderData,
 134                        const int chan,
 135                        const UINT flags);
 136
 137 int
 138 deleteSbrEnvelopeCalc (HANDLE_SBR_CALCULATE_ENVELOPE hSbrCalculateEnvelope);
 139
 140 void
 141 resetSbrEnvelopeCalc (HANDLE_SBR_CALCULATE_ENVELOPE hCalEnv);
 142
 143 SBR_ERROR
 144 ResetLimiterBands ( UCHAR *limiterBandTable,
 145                     UCHAR *noLimiterBands,
 146                     UCHAR *freqBandTable,
 147                     int noFreqBands,
 148                     const PATCH_PARAM *patchParam,
 149                     int noPatches,
 150                     int limiterBands);
 151
 152 void rescaleSubbandSamples( FIXP_DBL ** re,
 153                             FIXP_DBL ** im,
 154                             int lowSubband, int noSubbands,
 155                             int start_pos,  int next_pos,
 156                             int shift);
 157
 158 FIXP_DBL maxSubbandSample( FIXP_DBL ** analysBufferReal_m,
 159                            FIXP_DBL ** analysBufferImag_m,
 160                            int lowSubband,
 161                            int highSubband,
 162                            int start_pos,
 163                            int stop_pos);
 164
 165 #endif // __ENV_CALC_H