libSBRenc/src/env_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  Envelope estimation structs and prototypes
  87 */
  88 #ifndef __ENV_EST_H
  89 #define __ENV_EST_H
  90
  91 #include "sbr_def.h"
  92 #include "sbr_encoder.h" /* SBR econfig structs */
  93 #include "ps_main.h"
  94 #include "bit_sbr.h"
  95 #include "fram_gen.h"
  96 #include "tran_det.h"
  97 #include "code_env.h"
  98 #include "ton_corr.h"
  99
 100 typedef struct
 101 {
 102   FIXP_DBL  *rBuffer[QMF_MAX_TIME_SLOTS];
 103   FIXP_DBL  *iBuffer[QMF_MAX_TIME_SLOTS];
 104
 105   FIXP_DBL  *p_YBuffer;
 106
 107   FIXP_DBL  *YBuffer[QMF_MAX_TIME_SLOTS];
 108   int        YBufferScale[2];
 109
 110   UCHAR envelopeCompensation[MAX_FREQ_COEFFS];
 111   UCHAR pre_transient_info[2];
 112
 113
 114   int YBufferWriteOffset;
 115   int YBufferSzShift;
 116   int rBufferReadOffset;
 117
 118   int no_cols;
 119   int no_rows;
 120   int start_index;
 121
 122   int time_slots;
 123   int time_step;
 124 }
 125 SBR_EXTRACT_ENVELOPE;
 126 typedef SBR_EXTRACT_ENVELOPE *HANDLE_SBR_EXTRACT_ENVELOPE;
 127
 128 struct ENV_CHANNEL
 129 {
 130   SBR_TRANSIENT_DETECTOR sbrTransientDetector;
 131   SBR_CODE_ENVELOPE sbrCodeEnvelope;
 132   SBR_CODE_ENVELOPE sbrCodeNoiseFloor;
 133   SBR_EXTRACT_ENVELOPE sbrExtractEnvelope;
 134
 135
 136   SBR_ENVELOPE_FRAME SbrEnvFrame;
 137   SBR_TON_CORR_EST   TonCorr;
 138
 139   struct SBR_ENV_DATA encEnvData;
 140
 141   int qmfScale;
 142   UCHAR fLevelProtect;
 143 };
 144 typedef struct ENV_CHANNEL *HANDLE_ENV_CHANNEL;
 145
 146 /************  Function Declarations ***************/
 147
 148 INT
 149 FDKsbrEnc_CreateExtractSbrEnvelope (HANDLE_SBR_EXTRACT_ENVELOPE  hSbrCut,
 150                                     INT channel
 151                                    ,INT chInEl
 152                                    ,UCHAR* dynamic_RAM
 153                          );
 154
 155
 156 INT
 157 FDKsbrEnc_InitExtractSbrEnvelope (
 158                           HANDLE_SBR_EXTRACT_ENVELOPE hSbr,
 159                           int no_cols,
 160                           int no_rows,
 161                           int start_index,
 162                           int time_slots, int time_step, int tran_off,
 163                           ULONG statesInitFlag
 164                          ,int chInEl
 165                          ,UCHAR* dynamic_RAM
 166                          ,UINT sbrSyntaxFlags
 167                          );
 168
 169 void FDKsbrEnc_deleteExtractSbrEnvelope (HANDLE_SBR_EXTRACT_ENVELOPE hSbrCut);
 170
 171 typedef struct {
 172     FREQ_RES res[MAX_NUM_NOISE_VALUES];
 173     int maxQuantError;
 174
 175 } SBR_FRAME_TEMP_DATA;
 176
 177 typedef struct {
 178     const SBR_FRAME_INFO *frame_info;
 179     FIXP_DBL noiseFloor[MAX_NUM_NOISE_VALUES];
 180     SCHAR sfb_nrg_coupling[MAX_NUM_ENVELOPE_VALUES]; /* only used if stereomode = SWITCH_L_R_C */
 181     SCHAR sfb_nrg[MAX_NUM_ENVELOPE_VALUES];
 182     SCHAR noise_level_coupling[MAX_NUM_NOISE_VALUES]; /* only used if stereomode = SWITCH_L_R_C */
 183     SCHAR noise_level[MAX_NUM_NOISE_VALUES];
 184     UCHAR transient_info[3];
 185     UCHAR nEnvelopes;
 186 } SBR_ENV_TEMP_DATA;
 187
 188 /*
 189  * Extract features from QMF data. Afterwards, the QMF data is not required anymore.
 190  */
 191 void
 192 FDKsbrEnc_extractSbrEnvelope1(
 193                    HANDLE_SBR_CONFIG_DATA    h_con,
 194                    HANDLE_SBR_HEADER_DATA    sbrHeaderData,
 195                    HANDLE_SBR_BITSTREAM_DATA sbrBitstreamData,
 196                    HANDLE_ENV_CHANNEL        h_envChan,
 197                    HANDLE_COMMON_DATA        cmonData,
 198                    SBR_ENV_TEMP_DATA   *eData,
 199                    SBR_FRAME_TEMP_DATA *fData
 200                     );
 201
 202
 203 /*
 204  * Process the previously features extracted by FDKsbrEnc_extractSbrEnvelope1
 205  * and create/encode SBR envelopes.
 206  */
 207 void
 208 FDKsbrEnc_extractSbrEnvelope2(
 209                    HANDLE_SBR_CONFIG_DATA     h_con,
 210                    HANDLE_SBR_HEADER_DATA     sbrHeaderData,
 211                    HANDLE_PARAMETRIC_STEREO   hParametricStereo,
 212                    HANDLE_SBR_BITSTREAM_DATA  sbrBitstreamData,
 213                    HANDLE_ENV_CHANNEL         sbrEnvChannel0,
 214                    HANDLE_ENV_CHANNEL         sbrEnvChannel1,
 215                    HANDLE_COMMON_DATA         cmonData,
 216                    SBR_ENV_TEMP_DATA         *eData,
 217                    SBR_FRAME_TEMP_DATA       *fData,
 218                    int                        clearOutput
 219                    );
 220
 221 INT
 222 FDKsbrEnc_GetEnvEstDelay(HANDLE_SBR_EXTRACT_ENVELOPE hSbr);
 223
 224 #endif