libSBRenc/src/mh_det.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  missing harmonics detection header file
  87 */
  88
  89 #ifndef __MH_DETECT_H
  90 #define __MH_DETECT_H
  91
  92 #include "sbr_encoder.h"
  93 #include "fram_gen.h"
  94
  95 typedef struct
  96 {
  97   FIXP_DBL thresHoldDiff;      /*!< threshold for tonality difference */
  98   FIXP_DBL thresHoldDiffGuide; /*!< threshold for tonality difference for the guide */
  99   FIXP_DBL thresHoldTone;      /*!< threshold for tonality for a sine */
 100   FIXP_DBL invThresHoldTone;
 101   FIXP_DBL thresHoldToneGuide; /*!< threshold for tonality for a sine for the guide */
 102   FIXP_DBL sfmThresSbr;        /*!< tonality flatness measure threshold for the SBR signal.*/
 103   FIXP_DBL sfmThresOrig;       /*!< tonality flatness measure threshold for the original signal.*/
 104   FIXP_DBL decayGuideOrig;     /*!< decay value of the tonality value of the guide for the tone. */
 105   FIXP_DBL decayGuideDiff;     /*!< decay value of the tonality value of the guide for the tonality difference. */
 106   FIXP_DBL derivThresMaxLD64;      /*!< threshold for detecting LP character in a signal. */
 107   FIXP_DBL derivThresBelowLD64;    /*!< threshold for detecting LP character in a signal. */
 108   FIXP_DBL derivThresAboveLD64;    /*!< threshold for detecting LP character in a signal. */
 109 }THRES_HOLDS;
 110
 111 typedef struct
 112 {
 113   INT deltaTime;            /*!< maximum allowed transient distance (from frame border in number of qmf subband sample)
 114                                  for a frame to be considered a transient frame.*/
 115   THRES_HOLDS thresHolds;   /*!< the thresholds used for detection. */
 116   INT maxComp;              /*!< maximum alllowed compensation factor for the envelope data. */
 117 }DETECTOR_PARAMETERS_MH;
 118
 119 typedef struct
 120 {
 121   FIXP_DBL *guideVectorDiff;
 122   FIXP_DBL *guideVectorOrig;
 123   UCHAR* guideVectorDetected;
 124 }GUIDE_VECTORS;
 125
 126
 127 typedef struct
 128 {
 129   INT qmfNoChannels;
 130   INT nSfb;
 131   INT sampleFreq;
 132   INT previousTransientFlag;
 133   INT previousTransientFrame;
 134   INT previousTransientPos;
 135
 136   INT noVecPerFrame;
 137   INT transientPosOffset;
 138
 139   INT move;
 140   INT totNoEst;
 141   INT noEstPerFrame;
 142   INT timeSlots;
 143
 144   UCHAR *guideScfb;
 145   UCHAR *prevEnvelopeCompensation;
 146   UCHAR *detectionVectors[MAX_NO_OF_ESTIMATES];
 147   FIXP_DBL tonalityDiff[MAX_NO_OF_ESTIMATES/2][MAX_FREQ_COEFFS];
 148   FIXP_DBL sfmOrig[MAX_NO_OF_ESTIMATES/2][MAX_FREQ_COEFFS];
 149   FIXP_DBL sfmSbr[MAX_NO_OF_ESTIMATES/2][MAX_FREQ_COEFFS];
 150   const DETECTOR_PARAMETERS_MH *mhParams;
 151   GUIDE_VECTORS guideVectors[MAX_NO_OF_ESTIMATES];
 152 }
 153 SBR_MISSING_HARMONICS_DETECTOR;
 154
 155 typedef SBR_MISSING_HARMONICS_DETECTOR *HANDLE_SBR_MISSING_HARMONICS_DETECTOR;
 156
 157 void
 158 FDKsbrEnc_SbrMissingHarmonicsDetectorQmf(HANDLE_SBR_MISSING_HARMONICS_DETECTOR h_sbrMissingHarmonicsDetector,
 159                                FIXP_DBL ** pQuotaBuffer,
 160                                INT ** pSignBuffer,
 161                                SCHAR *indexVector,
 162                                const SBR_FRAME_INFO *pFrameInfo,
 163                                const UCHAR* pTranInfo,
 164                                INT* pAddHarmonicsFlag,
 165                                UCHAR* pAddHarmonicsScaleFactorBands,
 166                                const UCHAR* freqBandTable,
 167                                INT nSfb,
 168                                UCHAR * envelopeCompensation,
 169                                FIXP_DBL *pNrgVector);
 170
 171 INT
 172 FDKsbrEnc_CreateSbrMissingHarmonicsDetector (
 173                                    HANDLE_SBR_MISSING_HARMONICS_DETECTOR hSbrMHDet,
 174                                    INT chan);
 175
 176 INT
 177 FDKsbrEnc_InitSbrMissingHarmonicsDetector(
 178                                   HANDLE_SBR_MISSING_HARMONICS_DETECTOR h_sbrMissingHarmonicsDetector,
 179                                   INT sampleFreq,
 180                                   INT frameSize,
 181                                   INT nSfb,
 182                                   INT qmfNoChannels,
 183                                   INT totNoEst,
 184                                   INT move,
 185                                   INT noEstPerFrame,
 186                                   UINT sbrSyntaxFlags);
 187
 188 void
 189 FDKsbrEnc_DeleteSbrMissingHarmonicsDetector (HANDLE_SBR_MISSING_HARMONICS_DETECTOR h_sbrMissingHarmonicsDetector);
 190
 191
 192 INT
 193 FDKsbrEnc_ResetSbrMissingHarmonicsDetector (HANDLE_SBR_MISSING_HARMONICS_DETECTOR hSbrMissingHarmonicsDetector,
 194                                    INT nSfb);
 195
 196 #endif