libAACenc/src/qc_main.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. Werner
  87    contents/description: Quantizing & coding
  88
  89 ******************************************************************************/
  90 #ifndef _QC_MAIN_H
  91 #define _QC_MAIN_H
  92
  93
  94 #include "aacenc.h"
  95 #include "qc_data.h"
  96 #include "interface.h"
  97 #include "psy_main.h"
  98 #include "tpenc_lib.h"
  99
 100 /* Quantizing & coding stage */
 101
 102 AAC_ENCODER_ERROR FDKaacEnc_QCOutNew(QC_OUT    **phQC,
 103                                      const INT   nElements,
 104                                      const INT   nChannels,
 105                                      const INT   nSubFrames
 106                                     ,UCHAR   *dynamic_RAM
 107                                      );
 108
 109 AAC_ENCODER_ERROR FDKaacEnc_QCOutInit(QC_OUT          *phQC[(1)],
 110                                       const INT        nSubFrames,
 111                                       const CHANNEL_MAPPING *cm);
 112
 113 AAC_ENCODER_ERROR  FDKaacEnc_QCNew(QC_STATE  **phQC,
 114                                    INT         nElements
 115                                   ,UCHAR* dynamic_RAM
 116            );
 117
 118 AAC_ENCODER_ERROR FDKaacEnc_QCInit(QC_STATE *hQC, struct QC_INIT *init);
 119
 120 AAC_ENCODER_ERROR FDKaacEnc_QCMainPrepare(
 121            ELEMENT_INFO              *elInfo,
 122            ATS_ELEMENT*  RESTRICT     adjThrStateElement,
 123            PSY_OUT_ELEMENT* RESTRICT  psyOutElement,
 124            QC_OUT_ELEMENT* RESTRICT   qcOutElement,   /* returns error code       */
 125            AUDIO_OBJECT_TYPE          aot,
 126            UINT                       syntaxFlags,
 127            SCHAR                      epConfig
 128            );
 129
 130
 131 AAC_ENCODER_ERROR FDKaacEnc_QCMain(QC_STATE* RESTRICT         hQC,
 132                                    PSY_OUT**                  psyOut,
 133                                    QC_OUT**                   qcOut,
 134                                    INT                        avgTotalBits,
 135                                    CHANNEL_MAPPING*           cm
 136                                   ,AUDIO_OBJECT_TYPE          aot,
 137                                    UINT                       syntaxFlags,
 138                                    SCHAR                      epConfig
 139                                    );
 140
 141 AAC_ENCODER_ERROR FDKaacEnc_updateFillBits(CHANNEL_MAPPING*          cm,
 142                                            QC_STATE*                 qcKernel,
 143                                            ELEMENT_BITS* RESTRICT    elBits[(8)],
 144                                            QC_OUT**                  qcOut);
 145
 146
 147 void FDKaacEnc_updateBitres(  CHANNEL_MAPPING *cm,
 148                     QC_STATE *qcKernel,
 149                     QC_OUT **qcOut);
 150
 151 AAC_ENCODER_ERROR FDKaacEnc_FinalizeBitConsumption( CHANNEL_MAPPING *cm,
 152                                                     QC_STATE *hQC,
 153                                                     QC_OUT *qcOut,
 154                                                     QC_OUT_ELEMENT** qcElement,
 155                                                     HANDLE_TRANSPORTENC hTpEnc,
 156                                                     AUDIO_OBJECT_TYPE   aot,
 157                                                     UINT                syntaxFlags,
 158                                                     SCHAR               epConfig
 159                                                   );
 160
 161 AAC_ENCODER_ERROR FDKaacEnc_AdjustBitrate(QC_STATE *RESTRICT hQC,
 162                   CHANNEL_MAPPING *RESTRICT cm,
 163                   INT *avgTotalBits,
 164                   INT bitRate,
 165                   INT sampleRate,
 166                   INT granuleLength);
 167
 168 void  FDKaacEnc_QCClose (QC_STATE  **phQCstate, QC_OUT **phQC);
 169
 170 #endif /* _QC_MAIN_H */