libSBRenc/src/ps_encode.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 /*****************************  MPEG Audio Encoder  ***************************
  85
  86    Initial author:       M. Neuendorf, N. Rettelbach, M. Multrus
  87    contents/description: PS Parameter extraction, encoding
  88
  89 ******************************************************************************/
  90 /*!
  91   \file
  92   \brief  PS parameter extraction, encoding functions
  93 */
  94
  95 #ifndef __INCLUDED_PS_ENCODE_H
  96 #define __INCLUDED_PS_ENCODE_H
  97
  98 #include "ps_const.h"
  99 #include "ps_bitenc.h"
 100
 101
 102 #define IID_SCALE_FT      (64.f)    /* maxVal in Quant tab is +/- 50 */
 103 #define IID_SCALE         6         /* maxVal in Quant tab is +/- 50 */
 104 #define IID_MAXVAL        (1<<IID_SCALE)
 105
 106 #define PS_QUANT_SCALE_FT (64.f)     /* error smaller (64-25)/64 * 20 bands * 4 env -> QuantScale 64 */
 107 #define PS_QUANT_SCALE    6          /* error smaller (64-25)/64 * 20 bands * 4 env -> QuantScale 6 bit */
 108
 109
 110 #define QMF_GROUPS_LO_RES      12
 111 #define SUBQMF_GROUPS_LO_RES   10
 112 #define QMF_GROUPS_HI_RES      18
 113 #define SUBQMF_GROUPS_HI_RES   30
 114
 115
 116 typedef struct T_PS_DATA {
 117
 118   INT iidEnable;
 119   INT iidEnableLast;
 120   INT iidQuantMode;
 121   INT iidQuantModeLast;
 122   INT iidDiffMode[PS_MAX_ENVELOPES];
 123   INT iidIdx     [PS_MAX_ENVELOPES][PS_MAX_BANDS];
 124   INT iidIdxLast [PS_MAX_BANDS];
 125
 126   INT iccEnable;
 127   INT iccEnableLast;
 128   INT iccQuantMode;
 129   INT iccQuantModeLast;
 130   INT iccDiffMode[PS_MAX_ENVELOPES];
 131   INT iccIdx     [PS_MAX_ENVELOPES][PS_MAX_BANDS];
 132   INT iccIdxLast [PS_MAX_BANDS];
 133
 134   INT nEnvelopesLast;
 135
 136   INT headerCnt;
 137   INT iidTimeCnt;
 138   INT iccTimeCnt;
 139   INT noEnvCnt;
 140
 141 } PS_DATA, *HANDLE_PS_DATA;
 142
 143
 144 typedef struct T_PS_ENCODE{
 145
 146   PS_DATA         psData;
 147
 148   PS_BANDS        psEncMode;
 149   INT             nQmfIidGroups;
 150   INT             nSubQmfIidGroups;
 151   INT             iidGroupBorders[QMF_GROUPS_HI_RES + SUBQMF_GROUPS_HI_RES + 1];
 152   INT             subband2parameterIndex[QMF_GROUPS_HI_RES + SUBQMF_GROUPS_HI_RES];
 153   UCHAR           iidGroupWidthLd[QMF_GROUPS_HI_RES + SUBQMF_GROUPS_HI_RES];
 154   FIXP_DBL        iidQuantErrorThreshold;
 155
 156   UCHAR           psBandNrgScale [PS_MAX_BANDS];
 157
 158 } PS_ENCODE;
 159
 160
 161 typedef struct T_PS_ENCODE *HANDLE_PS_ENCODE;
 162
 163 FDK_PSENC_ERROR FDKsbrEnc_CreatePSEncode(
 164         HANDLE_PS_ENCODE         *phPsEncode
 165         );
 166
 167 FDK_PSENC_ERROR FDKsbrEnc_InitPSEncode(
 168         HANDLE_PS_ENCODE          hPsEncode,
 169         const PS_BANDS            psEncMode,
 170         const FIXP_DBL            iidQuantErrorThreshold
 171         );
 172
 173 FDK_PSENC_ERROR FDKsbrEnc_DestroyPSEncode(
 174         HANDLE_PS_ENCODE         *phPsEncode
 175         );
 176
 177 FDK_PSENC_ERROR FDKsbrEnc_PSEncode(
 178         HANDLE_PS_ENCODE          hPsEncode,
 179         HANDLE_PS_OUT             hPsOut,
 180         UCHAR                    *dynBandScale,
 181         UINT                      maxEnvelopes,
 182         FIXP_DBL                 *hybridData[HYBRID_FRAMESIZE][MAX_PS_CHANNELS][2],
 183         const INT                 frameSize,
 184         const INT                 sendHeader
 185         );
 186
 187 #endif