Home | History | Annotate | Download | only in src
      1 
      2 /* -----------------------------------------------------------------------------------------------------------
      3 Software License for The Fraunhofer FDK AAC Codec Library for Android
      4 
      5  Copyright  1995 - 2012 Fraunhofer-Gesellschaft zur Frderung 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 (at) iis.fraunhofer.de
     82 ----------------------------------------------------------------------------------------------------------- */
     83 
     84 /******************************** MPEG Audio Encoder **************************
     85 
     86    Initial author:       M. Werner
     87    contents/description: Quantizing & coding data
     88 
     89 ******************************************************************************/
     90 
     91 #ifndef _QC_DATA_H
     92 #define _QC_DATA_H
     93 
     94 
     95 #include "psy_const.h"
     96 #include "dyn_bits.h"
     97 #include "adj_thr_data.h"
     98 #include "line_pe.h"
     99 #include "FDK_audio.h"
    100 #include "interface.h"
    101 
    102 
    103 typedef enum {
    104   QCDATA_BR_MODE_INVALID = -1,
    105   QCDATA_BR_MODE_CBR     =  0,
    106   QCDATA_BR_MODE_VBR_1   =  1, /* 32 kbps/channel */
    107   QCDATA_BR_MODE_VBR_2   =  2, /* 40 kbps/channel */
    108   QCDATA_BR_MODE_VBR_3   =  3, /* 48 kbps/channel */
    109   QCDATA_BR_MODE_VBR_4   =  4, /* 64 kbps/channel */
    110   QCDATA_BR_MODE_VBR_5   =  5, /* 96 kbps/channel */
    111   QCDATA_BR_MODE_FF      =  6,  /* Fixed frame mode. */
    112   QCDATA_BR_MODE_SFR     =  7  /* Superframe mode. */
    113 
    114 
    115 } QCDATA_BR_MODE;
    116 
    117 typedef struct {
    118   MP4_ELEMENT_ID elType;
    119   INT instanceTag;
    120   INT nChannelsInEl;
    121   INT ChannelIndex[2];
    122   FIXP_DBL relativeBits;
    123 } ELEMENT_INFO;
    124 
    125 typedef struct {
    126   CHANNEL_MODE encMode;
    127   INT nChannels;
    128   INT nChannelsEff;
    129   INT nElements;
    130   ELEMENT_INFO elInfo[(6)];
    131 } CHANNEL_MAPPING;
    132 
    133 typedef struct {
    134   INT paddingRest;
    135 } PADDING;
    136 
    137 
    138 /* Quantizing & coding stage */
    139 
    140 struct QC_INIT{
    141   CHANNEL_MAPPING* channelMapping;
    142   INT sceCpe;      /* not used yet                         */
    143   INT maxBits;     /* maximum number of bits in reservoir  */
    144   INT averageBits; /* average number of bits we should use */
    145   INT bitRes;
    146   INT staticBits;  /* Bits per frame consumed by transport layers. */
    147   QCDATA_BR_MODE bitrateMode;
    148   INT meanPe;
    149   INT chBitrate;
    150   INT invQuant;
    151   INT maxIterations; /* Maximum number of allowed iterations before FDKaacEnc_crashRecovery() is applied. */
    152   FIXP_DBL maxBitFac;
    153   INT bitrate;
    154   INT nSubFrames; /* helper variable */
    155   INT minBits;    /* minimal number of bits in one frame*/
    156 
    157   PADDING padding;
    158 };
    159 
    160 typedef struct
    161 {
    162   FIXP_DBL      mdctSpectrum[(1024)];
    163 
    164   SHORT         quantSpec[(1024)];
    165 
    166   UINT          maxValueInSfb[MAX_GROUPED_SFB];
    167   INT           scf[MAX_GROUPED_SFB];
    168   INT           globalGain;
    169   SECTION_DATA  sectionData;
    170 
    171   FIXP_DBL      sfbFormFactorLdData[MAX_GROUPED_SFB];
    172 
    173   FIXP_DBL      sfbThresholdLdData[MAX_GROUPED_SFB];
    174   FIXP_DBL      sfbMinSnrLdData[MAX_GROUPED_SFB];
    175   FIXP_DBL      sfbEnergyLdData[MAX_GROUPED_SFB];
    176   FIXP_DBL      sfbEnergy[MAX_GROUPED_SFB];
    177   FIXP_DBL      sfbWeightedEnergyLdData[MAX_GROUPED_SFB];
    178 
    179   FIXP_DBL      sfbEnFacLd[MAX_GROUPED_SFB];
    180 
    181   FIXP_DBL      sfbSpreadEnergy[MAX_GROUPED_SFB];
    182 
    183 } QC_OUT_CHANNEL;
    184 
    185 
    186 typedef struct
    187 {
    188   EXT_PAYLOAD_TYPE  type;  /* type of the extension payload */
    189   INT    nPayloadBits;     /* size of the payload */
    190   UCHAR *pPayload;         /* pointer to payload */
    191 
    192 } QC_OUT_EXTENSION;
    193 
    194 
    195 typedef struct
    196 {
    197   INT          staticBitsUsed; /* for verification purposes */
    198   INT          dynBitsUsed;    /* for verification purposes */
    199 
    200   INT          extBitsUsed;    /* bit consumption of extended fill elements */
    201   INT          nExtensions;    /* number of extension payloads for this element */
    202   QC_OUT_EXTENSION extension[(1)];  /* reffering extension payload */
    203 
    204   INT          grantedDynBits;
    205 
    206   INT          grantedPe;
    207   INT          grantedPeCorr;
    208 
    209   PE_DATA      peData;
    210 
    211   QC_OUT_CHANNEL *qcOutChannel[(2)];
    212 
    213 
    214 } QC_OUT_ELEMENT;
    215 
    216 typedef struct
    217 {
    218   QC_OUT_ELEMENT    *qcElement[(6)];
    219   QC_OUT_CHANNEL    *pQcOutChannels[(6)];
    220   QC_OUT_EXTENSION   extension[(2+2)];  /* global extension payload */
    221   INT          nExtensions;       /* number of extension payloads for this AU */
    222   INT          maxDynBits;        /* maximal allowed dynamic bits in frame */
    223   INT          grantedDynBits;    /* granted dynamic bits in frame */
    224   INT          totFillBits;       /* fill bits */
    225   INT          elementExtBits;    /* element associated extension payload bits, e.g. sbr, drc ... */
    226   INT          globalExtBits;     /* frame/au associated extension payload bits (anc data ...) */
    227   INT          staticBits;        /* aac side info bits */
    228 
    229   INT          totalNoRedPe;
    230   INT          totalGrantedPeCorr;
    231 
    232   INT          usedDynBits;       /* number of dynamic bits in use */
    233   INT          alignBits;         /* AU alignment bits */
    234   INT          totalBits;         /* sum of static, dyn, sbr, fill, align and dse bits */
    235 
    236 } QC_OUT;
    237 
    238 typedef struct {
    239   INT chBitrateEl;                    /* channel bitrate in element (totalbitrate*el_relativeBits/el_channels) */
    240   INT maxBitsEl;                      /* used in crash recovery */
    241   INT bitResLevelEl;                  /* update bitreservoir level in each call of FDKaacEnc_QCMain */
    242   INT maxBitResBitsEl;                /* nEffChannels*6144 - averageBitsInFrame */
    243   FIXP_DBL relativeBitsEl;            /* Bits relative to total Bits*/
    244 } ELEMENT_BITS;
    245 
    246 typedef struct
    247 {
    248   /* this is basically struct QC_INIT */
    249 
    250   INT globHdrBits;
    251   INT maxBitsPerFrame;   /* maximal allowed bits per frame, 6144*nChannelsEff */
    252   INT minBitsPerFrame;   /* minimal allowd bits per fram, superframing - DRM */
    253   INT nElements;
    254   QCDATA_BR_MODE bitrateMode;
    255   INT bitDistributenMode; /* 0: full bitreservoir, 1: reduced bitreservoir, 2: disabled bitreservoir */
    256   INT bitResTot;
    257   INT bitResTotMax;
    258   INT maxIterations;      /* Maximum number of allowed iterations before FDKaacEnc_crashRecovery() is applied. */
    259   INT invQuant;
    260 
    261   FIXP_DBL vbrQualFactor;
    262   FIXP_DBL maxBitFac;
    263 
    264   PADDING padding;
    265 
    266   ELEMENT_BITS  *elementBits[(6)];
    267   BITCNTR_STATE *hBitCounter;
    268   ADJ_THR_STATE *hAdjThr;
    269 
    270 } QC_STATE;
    271 
    272 #endif /* _QC_DATA_H */
    273 
    274 
    275 
    276 
    277