libSBRenc/src/nf_est.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  Noise floor estimation structs and prototypes
  87 */
  88
  89 #ifndef __NF_EST_H
  90 #define __NF_EST_H
  91
  92 #include "sbr_encoder.h"
  93 #include "fram_gen.h"
  94
  95 #define NF_SMOOTHING_LENGTH 4                   /*!< Smoothing length of the noise floors. */
  96
  97 typedef struct
  98 {
  99   FIXP_DBL prevNoiseLevels[NF_SMOOTHING_LENGTH][MAX_NUM_NOISE_VALUES]; /*!< The previous noise levels. */
 100   FIXP_DBL noiseFloorOffset[MAX_NUM_NOISE_VALUES];   /*!< Noise floor offset, scaled with NOISE_FLOOR_OFFSET_SCALING */
 101   const FIXP_DBL *smoothFilter;                      /*!< Smoothing filter to use. */
 102   FIXP_DBL ana_max_level;                            /*!< Max level allowed.   */
 103   FIXP_DBL weightFac;                                /*!< Weightening factor for the difference between orig and sbr. */
 104   INT freqBandTableQmf[MAX_NUM_NOISE_VALUES + 1]; /*!< Frequncy band table for the noise floor bands.*/
 105   INT noNoiseBands;                               /*!< Number of noisebands. */
 106   INT noiseBands;                                 /*!< NoiseBands switch 4 bit.*/
 107   INT timeSlots;                                  /*!< Number of timeslots in a frame. */
 108   INVF_MODE diffThres;                            /*!< Threshold value to control the inverse filtering decision */
 109 }
 110 SBR_NOISE_FLOOR_ESTIMATE;
 111
 112 typedef SBR_NOISE_FLOOR_ESTIMATE *HANDLE_SBR_NOISE_FLOOR_ESTIMATE;
 113
 114 void
 115 FDKsbrEnc_sbrNoiseFloorEstimateQmf(HANDLE_SBR_NOISE_FLOOR_ESTIMATE h_sbrNoiseFloorEstimate, /*!< Handle to SBR_NOISE_FLOOR_ESTIMATE struct */
 116                          const SBR_FRAME_INFO *frame_info,   /*!< Time frequency grid of the current frame. */
 117                          FIXP_DBL *noiseLevels,              /*!< Pointer to vector to store the noise levels in.*/
 118                          FIXP_DBL **quotaMatrixOrig,         /*!< Matrix holding the quota values of the original. */
 119                          SCHAR* indexVector,                 /*!< Index vector to obtain the patched data. */
 120                          INT missingHarmonicsFlag,           /*!< Flag indicating if a strong tonal component will be missing. */
 121                          INT startIndex,                     /*!< Start index. */
 122                          int numberOfEstimatesPerFrame,      /*!< The number of tonality estimates per frame. */
 123                          INT transientFrame,                 /*!< A flag indicating if a transient is present. */
 124                          INVF_MODE* pInvFiltLevels,          /*!< Pointer to the vector holding the inverse filtering levels. */
 125                          UINT sbrSyntaxFlags
 126                          );
 127
 128 INT
 129 FDKsbrEnc_InitSbrNoiseFloorEstimate (HANDLE_SBR_NOISE_FLOOR_ESTIMATE  h_sbrNoiseFloorEstimate,   /*!< Handle to SBR_NOISE_FLOOR_ESTIMATE struct */
 130                              INT ana_max_level,                       /*!< Maximum level of the adaptive noise. */
 131                              const UCHAR *freqBandTable,      /*!< Frequany band table. */
 132                              INT nSfb,                                /*!< Number of frequency bands. */
 133                              INT noiseBands,                          /*!< Number of noise bands per octave. */
 134                              INT noiseFloorOffset,                    /*!< Noise floor offset. */
 135                              INT timeSlots,                           /*!< Number of time slots in a frame. */
 136                              UINT useSpeechConfig             /*!< Flag: adapt tuning parameters according to speech */
 137                              );
 138
 139 INT
 140 FDKsbrEnc_resetSbrNoiseFloorEstimate (HANDLE_SBR_NOISE_FLOOR_ESTIMATE h_sbrNoiseFloorEstimate, /*!< Handle to SBR_NOISE_FLOOR_ESTIMATE struct */
 141                             const UCHAR *freqBandTable,   /*!< Frequany band table. */
 142                             INT nSfb);                            /*!< Number of bands in the frequency band table. */
 143
 144 void
 145 FDKsbrEnc_deleteSbrNoiseFloorEstimate (HANDLE_SBR_NOISE_FLOOR_ESTIMATE h_sbrNoiseFloorEstimate); /*!< Handle to SBR_NOISE_FLOOR_ESTIMATE struct */
 146
 147 #endif