libMpegTPEnc/src/tpenc_adts.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:       Alex Groeschel
  87    contents/description: ADTS Transport writer
  88
  89 ******************************************************************************/
  90
  91 #ifndef TPENC_ADTS_H
  92 #define TPENC_ADTS_H
  93
  94
  95
  96 #include "tp_data.h"
  97
  98 #include "FDK_crc.h"
  99
 100 typedef struct {
 101   INT sample_freq;
 102   CHANNEL_MODE channel_mode;
 103   UCHAR decoderCanDoMpeg4;
 104   UCHAR mpeg_id;
 105   UCHAR layer;
 106   UCHAR protection_absent;
 107   UCHAR profile;
 108   UCHAR sample_freq_index;
 109   UCHAR private_bit;
 110   UCHAR original;
 111   UCHAR home;
 112   UCHAR copyright_id;
 113   UCHAR copyright_start;
 114   USHORT frame_length;
 115   UCHAR num_raw_blocks;
 116   UCHAR BufferFullnesStartFlag;
 117   int headerBits;                /*!< Header bit demand for the current raw data block */
 118   int currentBlock;              /*!< Index of current raw data block */
 119   int subFrameStartBit;          /*!< Bit position where the current raw data block begins */
 120   FDK_CRCINFO crcInfo;
 121 } STRUCT_ADTS;
 122
 123 typedef STRUCT_ADTS *HANDLE_ADTS;
 124
 125 /**
 126  * \brief Initialize ADTS data structure
 127  *
 128  * \param hAdts ADTS data handle
 129  * \param config a valid CODER_CONFIG struct from where the required
 130  *        information for the ADTS header is extrated from
 131  *
 132  * \return 0 in case of success.
 133  */
 134 INT adtsWrite_Init(
 135         HANDLE_ADTS   hAdts,
 136         CODER_CONFIG *config
 137         );
 138
 139 /**
 140  * \brief Get the total bit overhead caused by ADTS
 141  *
 142  * \hAdts handle to ADTS data
 143  *
 144  * \return Amount of additional bits required for the current raw data block
 145  */
 146 int adtsWrite_GetHeaderBits( HANDLE_ADTS hAdts );
 147
 148 /**
 149  * \brief Write an ADTS header into the given bitstream. May not write a header
 150  *        in case of multiple raw data blocks.
 151  *
 152  * \param hAdts ADTS data handle
 153  * \param hBitStream bitstream handle into which the ADTS may be written into
 154  * \param buffer_fullness the buffer fullness value for the ADTS header
 155  * \param the current raw data block length
 156  *
 157  * \return 0 in case of success.
 158  */
 159 INT adtsWrite_EncodeHeader(
 160         HANDLE_ADTS          hAdts,
 161         HANDLE_FDK_BITSTREAM hBitStream,
 162         int                  bufferFullness,
 163         int                  frame_length
 164         );
 165 /**
 166  * \brief Finish a ADTS raw data block
 167  *
 168  * \param hAdts ADTS data handle
 169  * \param hBs bitstream handle into which the ADTS may be written into
 170  * \param pBits a pointer to a integer holding the current bitstream buffer bit count,
 171  *              which is corrected to the current raw data block boundary.
 172  *
 173  */
 174 void adtsWrite_EndRawDataBlock(
 175         HANDLE_ADTS          hAdts,
 176         HANDLE_FDK_BITSTREAM hBs,
 177         int                 *bits
 178         );
 179
 180
 181 /**
 182  * \brief Start CRC region with a maximum number of bits
 183  *        If mBits is positive zero padding will be used for CRC calculation, if there
 184  *        are less than mBits bits available.
 185  *        If mBits is negative no zero padding is done.
 186  *        If mBits is zero the memory for the buffer is allocated dynamically, the
 187  *        number of bits is not limited.
 188  *
 189  * \param pAdts ADTS data handle
 190  * \param hBs bitstream handle of which the CRC region ends
 191  * \param mBits limit of number of bits to be considered for the requested CRC region
 192  *
 193  * \return ID for the created region, -1 in case of an error
 194  */
 195 int adtsWrite_CrcStartReg(
 196         HANDLE_ADTS          pAdts,
 197         HANDLE_FDK_BITSTREAM hBs,
 198         int                  mBits
 199         );
 200
 201 /**
 202  * \brief Ends CRC region identified by reg
 203  *
 204  * \param pAdts ADTS data handle
 205  * \param hBs bitstream handle of which the CRC region ends
 206  * \param reg a CRC region ID returned previously by adtsWrite_CrcStartReg()
 207  */
 208 void adtsWrite_CrcEndReg(
 209         HANDLE_ADTS          pAdts,
 210         HANDLE_FDK_BITSTREAM hBs,
 211         int                  reg
 212         );
 213
 214
 215
 216
 217 #endif /* TPENC_ADTS_H */
 218