libAACdec/src/aacdec_drc_types.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) global data types
  88
  89 ******************************************************************************/
  90
  91 #ifndef AACDEC_DRC_TYPES_H
  92 #define AACDEC_DRC_TYPES_H
  93
  94
  95
  96 #include "common_fix.h"
  97
  98  #define MAX_DRC_THREADS      (   3 )        /* Heavy compression value is handled just like MPEG DRC data */
  99 #define MAX_DRC_BANDS         (  16 )        /* 2^LEN_DRC_BAND_INCR (LEN_DRC_BAND_INCR = 4) */
 100
 101 /**
 102  * \brief DRC module global data types
 103  */
 104 typedef enum
 105 {
 106   UNKNOWN_PAYLOAD   =  0,
 107   MPEG_DRC_EXT_DATA =  1,
 108   DVB_DRC_ANC_DATA  =  2
 109
 110 } AACDEC_DRC_PAYLOAD_TYPE;
 111
 112 typedef struct
 113 {
 114   UINT    expiryCount;
 115   UINT    numBands;
 116   USHORT  bandTop[MAX_DRC_BANDS];
 117   SHORT   drcInterpolationScheme;
 118   UCHAR   drcValue[MAX_DRC_BANDS];
 119   SCHAR   drcDataType;
 120
 121 } CDrcChannelData;
 122
 123 typedef struct
 124 {
 125   UINT   excludedChnsMask;
 126   SCHAR  progRefLevel;
 127   SCHAR  pceInstanceTag;
 128
 129   CDrcChannelData channelData;
 130
 131 } CDrcPayload;
 132
 133 typedef struct
 134 {
 135   FIXP_DBL  cut;       /* The attenuation scale factor currently used.     */
 136   FIXP_DBL  usrCut;    /* The latest attenuation scale factor set by user. */
 137   FIXP_DBL  boost;     /* The boost scale factor currently used.           */
 138   FIXP_DBL  usrBoost;  /* The latest boost scale factor set by user.       */
 139
 140   UINT   expiryFrame;
 141   SCHAR  targetRefLevel;
 142   UCHAR  bsDelayEnable;
 143   UCHAR  applyHeavyCompression;
 144
 145 } CDrcParams;
 146
 147
 148 typedef struct
 149 {
 150   CDrcParams params;                         /* Module parameters that can be set by user (via SetParam API function) */
 151
 152   UCHAR  enable;                             /* Switch that controls dynamic range processing */
 153   UCHAR  digitalNorm;                        /* Switch to en-/disable reference level normalization in digital domain */
 154
 155   USHORT numPayloads;                        /* The number of DRC data payload elements found within frame */
 156   USHORT numThreads;                         /* The number of DRC data threads extracted from the found payload elements */
 157   SCHAR  progRefLevel;                       /* Program reference level for all channels */
 158
 159   UINT   prlExpiryCount;                     /* Counter that can be used to monitor the life time of the program reference level. */
 160
 161   UCHAR  dvbAncDataAvailable;                  /* Flag that indicates whether DVB ancillary data is present or not */
 162   UINT   dvbAncDataPosition;                   /* Used to store the DVB ancillary data payload position in the bitstream (only one per frame) */
 163   UINT   drcPayloadPosition[MAX_DRC_THREADS];  /* Used to store the DRC payload positions in the bitstream */
 164
 165 } CDrcInfo;
 166
 167 typedef CDrcInfo *HANDLE_AAC_DRC;
 168
 169 #endif /* AACDEC_DRC_TYPES_H */
 170