libAACdec/src/aacdec_drc.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-4 AAC Decoder  **************************
  85
  86    Author(s):   Christian Griebel
  87    Description: Dynamic range control (DRC) decoder tool for AAC
  88
  89 ******************************************************************************/
  90
  91 #ifndef AACDEC_DRC_H
  92 #define AACDEC_DRC_H
  93
  94 #include "tp_data.h"            /* for program config element support */
  95
  96
  97 #include "aacdec_drc_types.h"
  98 #include "channel.h"
  99 #include "FDK_bitstream.h"
 100
 101 #define AACDEC_DRC_DEFAULT_REF_LEVEL  ( 108 )   /* -27 dB below full scale (typical for movies) */
 102 #define AACDEC_DRC_DFLT_EXPIRY_FRAMES (  50 )   /* Default DRC data expiry time in AAC frames   */
 103
 104 /**
 105  * \brief DRC module setting parameters
 106  */
 107 typedef enum
 108 {
 109   DRC_CUT_SCALE = 0,
 110   DRC_BOOST_SCALE,
 111   TARGET_REF_LEVEL,
 112   DRC_BS_DELAY,
 113   DRC_DATA_EXPIRY_FRAME,
 114   APPLY_HEAVY_COMPRESSION
 115
 116 } AACDEC_DRC_PARAM;
 117
 118
 119 /**
 120  * \brief DRC module interface functions
 121  */
 122 void aacDecoder_drcInit (
 123         HANDLE_AAC_DRC  self );
 124
 125 void aacDecoder_drcInitChannelData (
 126         CDrcChannelData *pDrcChannel );
 127
 128 AAC_DECODER_ERROR aacDecoder_drcSetParam (
 129         HANDLE_AAC_DRC    self,
 130         AACDEC_DRC_PARAM  param,
 131         INT               value );
 132
 133 int aacDecoder_drcMarkPayload (
 134         HANDLE_AAC_DRC  self,
 135         HANDLE_FDK_BITSTREAM  hBs,
 136         AACDEC_DRC_PAYLOAD_TYPE  type );
 137
 138 int aacDecoder_drcProlog (
 139         HANDLE_AAC_DRC  self,
 140         HANDLE_FDK_BITSTREAM hBs,
 141         CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo[],
 142         UCHAR  pceInstanceTag,
 143         UCHAR  channelMapping[],
 144         int    numChannels );
 145
 146 /**
 147  * \brief Apply DRC. If SBR is present, DRC data is handed over to the SBR decoder.
 148  * \param self AAC decoder instance
 149  * \param pSbrDec pointer to SBR decoder instance
 150  * \param pAacDecoderChannelInfo AAC decoder channel instance to be processed
 151  * \param pDrcDat DRC channel data
 152  * \param ch channel index
 153  * \param aacFrameSize AAC frame size
 154  * \param bSbrPresent flag indicating that SBR is present, in which case DRC is handed over to the SBR instance pSbrDec
 155  */
 156 void aacDecoder_drcApply (
 157         HANDLE_AAC_DRC          self,
 158         void                   *pSbrDec,
 159         CAacDecoderChannelInfo *pAacDecoderChannelInfo,
 160         CDrcChannelData        *pDrcDat,
 161         int  ch,
 162         int  aacFrameSize,
 163         int  bSbrPresent );
 164
 165 int aacDecoder_drcEpilog (
 166         HANDLE_AAC_DRC  self,
 167         HANDLE_FDK_BITSTREAM hBs,
 168         CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo[],
 169         UCHAR  pceInstanceTag,
 170         UCHAR  channelMapping[],
 171         int    validChannels );
 172
 173
 174 #endif  /* AACDEC_DRC_H */