libAACenc/src/bitenc.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: Bitstream encoder
  88
  89 ******************************************************************************/
  90
  91 #ifndef _BITENC_H
  92 #define _BITENC_H
  93
  94
  95 #include "qc_data.h"
  96 #include "aacenc_tns.h"
  97 #include "channel_map.h"
  98 #include "interface.h"    /* obsolete, when PSY_OUT is thrown out of the WritBS-call! */
  99 #include "FDK_audio.h"
 100 #include "aacenc.h"
 101
 102 #include "tpenc_lib.h"
 103
 104 typedef enum{
 105   MAX_ENCODER_CHANNELS  = 9,
 106   MAX_BLOCK_TYPES       = 4,
 107   MAX_AAC_LAYERS        = 9,
 108   MAX_LAYERS            = MAX_AAC_LAYERS  , /* only one core layer if present */
 109   FIRST_LAY             = 1   /* default layer number for AAC nonscalable */
 110 } _MAX_CONST;
 111
 112 #define BUFFER_MX_HUFFCB_SIZE (32*sizeof(INT))  /* our FDK_bitbuffer needs size of power 2 */
 113
 114 #define EL_ID_BITS  ( 3 )
 115
 116
 117 /**
 118  * \brief Arbitrary order bitstream writer. This function can either assemble a bit stream
 119  *        and write into the bit buffer of hTpEnc or calculate the number of static bits (signal independent)
 120  *        TpEnc handle must be NULL in this case. Or also Calculate the minimum possible number of
 121  *        static bits which by disabling all tools e.g. MS, TNS and sbfCnt=0. The minCnt parameter
 122  *        has to be 1 in this latter case.
 123  * \param hTpEnc Transport encoder handle. If NULL, the number of static bits will be returned into
 124  *        *pBitDemand.
 125  * \param pElInfo
 126  * \param qcOutChannel
 127  * \param hReorderInfo
 128  * \param psyOutElement
 129  * \param psyOutChannel
 130  * \param syntaxFlags Bit stream syntax flags as defined in FDK_audio.h (Audio Codec flags).
 131  * \param aot
 132  * \param epConfig
 133  * \param pBitDemand Pointer to an int where the amount of bits is returned into. The returned value
 134  *        depends on if hTpEnc is NULL and minCnt.
 135  * \param minCnt If non-zero the value returned into *pBitDemand is the absolute minimum required amount of
 136  *        static bits in order to write a valid bit stream.
 137  * \return AAC_ENCODER_ERROR error code
 138  */
 139 AAC_ENCODER_ERROR FDKaacEnc_ChannelElementWrite( HANDLE_TRANSPORTENC  hTpEnc,
 140                                                  ELEMENT_INFO        *pElInfo,
 141                                                  QC_OUT_CHANNEL      *qcOutChannel[(2)],
 142                                                  PSY_OUT_ELEMENT     *psyOutElement,
 143                                                  PSY_OUT_CHANNEL     *psyOutChannel[(2)],
 144                                                  UINT                 syntaxFlags,
 145                                                  AUDIO_OBJECT_TYPE    aot,
 146                                                  SCHAR                epConfig,
 147                                                  INT                 *pBitDemand,
 148                                                  UCHAR                minCnt
 149                                                );
 150 /**
 151  * \brief Write bit stream or account static bits
 152  * \param hTpEnc transport encoder handle. If NULL, the function will
 153  *        not write any bit stream data but only count the amount
 154  *        of static (signal independent) bits
 155  * \param channelMapping Channel mapping info
 156  * \param qcOut
 157  * \param psyOut
 158  * \param qcKernel
 159  * \param hBSE
 160  * \param aot Audio Object Type being encoded
 161  * \param syntaxFlags Flags indicating format specific detail
 162  * \param epConfig Error protection config
 163  */
 164 AAC_ENCODER_ERROR FDKaacEnc_WriteBitstream (HANDLE_TRANSPORTENC hTpEnc,
 165                                             CHANNEL_MAPPING *channelMapping,
 166                                             QC_OUT* qcOut,
 167                                             PSY_OUT* psyOut,
 168                                             QC_STATE* qcKernel,
 169                                             AUDIO_OBJECT_TYPE  aot,
 170                                             UINT  syntaxFlags,
 171                                             SCHAR  epConfig
 172                                            );
 173
 174 INT FDKaacEnc_writeExtensionData( HANDLE_TRANSPORTENC  hTpEnc,
 175                                   QC_OUT_EXTENSION    *pExtension,
 176                                   INT                  elInstanceTag,
 177                                   UINT                 alignAnchor,
 178                                   UINT                 syntaxFlags,
 179                                   AUDIO_OBJECT_TYPE    aot,
 180                                   SCHAR                epConfig
 181                                 );
 182
 183 #endif /* _BITENC_H */