Home | History | Annotate | Download | only in src
      1 /* -----------------------------------------------------------------------------
      2 Software License for The Fraunhofer FDK AAC Codec Library for Android
      3 
      4  Copyright  1995 - 2018 Fraunhofer-Gesellschaft zur Frderung der angewandten
      5 Forschung e.V. All rights reserved.
      6 
      7  1.    INTRODUCTION
      8 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
      9 that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
     10 scheme for digital audio. This FDK AAC Codec software is intended to be used on
     11 a wide variety of Android devices.
     12 
     13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
     14 general perceptual audio codecs. AAC-ELD is considered the best-performing
     15 full-bandwidth communications codec by independent studies and is widely
     16 deployed. AAC has been standardized by ISO and IEC as part of the MPEG
     17 specifications.
     18 
     19 Patent licenses for necessary patent claims for the FDK AAC Codec (including
     20 those of Fraunhofer) may be obtained through Via Licensing
     21 (www.vialicensing.com) or through the respective patent owners individually for
     22 the purpose of encoding or decoding bit streams in products that are compliant
     23 with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
     24 Android devices already license these patent claims through Via Licensing or
     25 directly from the patent owners, and therefore FDK AAC Codec software may
     26 already be covered under those patent licenses when it is used for those
     27 licensed purposes only.
     28 
     29 Commercially-licensed AAC software libraries, including floating-point versions
     30 with enhanced sound quality, are also available from Fraunhofer. Users are
     31 encouraged to check the Fraunhofer website for additional applications
     32 information and documentation.
     33 
     34 2.    COPYRIGHT LICENSE
     35 
     36 Redistribution and use in source and binary forms, with or without modification,
     37 are permitted without payment of copyright license fees provided that you
     38 satisfy the following conditions:
     39 
     40 You must retain the complete text of this software license in redistributions of
     41 the FDK AAC Codec or your modifications thereto in source code form.
     42 
     43 You must retain the complete text of this software license in the documentation
     44 and/or other materials provided with redistributions of the FDK AAC Codec or
     45 your modifications thereto in binary form. You must make available free of
     46 charge copies of the complete source code of the FDK AAC Codec and your
     47 modifications thereto to recipients of copies in binary form.
     48 
     49 The name of Fraunhofer may not be used to endorse or promote products derived
     50 from this library without prior written permission.
     51 
     52 You may not charge copyright license fees for anyone to use, copy or distribute
     53 the FDK AAC Codec software or your modifications thereto.
     54 
     55 Your modified versions of the FDK AAC Codec must carry prominent notices stating
     56 that you changed the software and the date of any change. For modified versions
     57 of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
     58 must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
     59 AAC Codec Library for Android."
     60 
     61 3.    NO PATENT LICENSE
     62 
     63 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
     64 limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
     65 Fraunhofer provides no warranty of patent non-infringement with respect to this
     66 software.
     67 
     68 You may use this FDK AAC Codec software or modifications thereto only for
     69 purposes that are authorized by appropriate patent licenses.
     70 
     71 4.    DISCLAIMER
     72 
     73 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
     74 holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
     75 including but not limited to the implied warranties of merchantability and
     76 fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     77 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
     78 or consequential damages, including but not limited to procurement of substitute
     79 goods or services; loss of use, data, or profits, or business interruption,
     80 however caused and on any theory of liability, whether in contract, strict
     81 liability, or tort (including negligence), arising in any way out of the use of
     82 this software, even if advised of the possibility of such damage.
     83 
     84 5.    CONTACT INFORMATION
     85 
     86 Fraunhofer Institute for Integrated Circuits IIS
     87 Attention: Audio and Multimedia Departments - FDK AAC LL
     88 Am Wolfsmantel 33
     89 91058 Erlangen, Germany
     90 
     91 www.iis.fraunhofer.de/amm
     92 amm-info (at) iis.fraunhofer.de
     93 ----------------------------------------------------------------------------- */
     94 
     95 /******************* MPEG transport format encoder library *********************
     96 
     97    Author(s):   Alex Groeschel
     98 
     99    Description: ADTS Transport writer
    100 
    101 *******************************************************************************/
    102 
    103 #ifndef TPENC_ADTS_H
    104 #define TPENC_ADTS_H
    105 
    106 #include "tp_data.h"
    107 
    108 #include "FDK_crc.h"
    109 
    110 typedef struct {
    111   INT sample_freq;
    112   CHANNEL_MODE channel_mode;
    113   UCHAR decoderCanDoMpeg4;
    114   UCHAR mpeg_id;
    115   UCHAR layer;
    116   UCHAR protection_absent;
    117   UCHAR profile;
    118   UCHAR sample_freq_index;
    119   UCHAR private_bit;
    120   UCHAR original;
    121   UCHAR home;
    122   UCHAR copyright_id;
    123   UCHAR copyright_start;
    124   USHORT frame_length;
    125   UCHAR num_raw_blocks;
    126   UCHAR BufferFullnesStartFlag;
    127   UCHAR channel_config_zero;
    128   int headerBits;       /*!< Header bit demand for the current raw data block */
    129   int currentBlock;     /*!< Index of current raw data block */
    130   int subFrameStartBit; /*!< Bit position where the current raw data block
    131                            begins */
    132   FDK_CRCINFO crcInfo;
    133 } STRUCT_ADTS;
    134 
    135 typedef STRUCT_ADTS *HANDLE_ADTS;
    136 
    137 /**
    138  * \brief Initialize ADTS data structure
    139  *
    140  * \param hAdts ADTS data handle
    141  * \param config a valid CODER_CONFIG struct from where the required
    142  *        information for the ADTS header is extrated from
    143  *
    144  * \return 0 in case of success.
    145  */
    146 INT adtsWrite_Init(HANDLE_ADTS hAdts, CODER_CONFIG *config);
    147 
    148 /**
    149  * \brief Get the total bit overhead caused by ADTS
    150  *
    151  * \hAdts handle to ADTS data
    152  *
    153  * \return Amount of additional bits required for the current raw data block
    154  */
    155 int adtsWrite_GetHeaderBits(HANDLE_ADTS hAdts);
    156 
    157 /**
    158  * \brief Write an ADTS header into the given bitstream. May not write a header
    159  *        in case of multiple raw data blocks.
    160  *
    161  * \param hAdts ADTS data handle
    162  * \param hBitStream bitstream handle into which the ADTS may be written into
    163  * \param buffer_fullness the buffer fullness value for the ADTS header
    164  * \param the current raw data block length
    165  *
    166  * \return 0 in case of success.
    167  */
    168 INT adtsWrite_EncodeHeader(HANDLE_ADTS hAdts, HANDLE_FDK_BITSTREAM hBitStream,
    169                            int bufferFullness, int frame_length);
    170 /**
    171  * \brief Finish a ADTS raw data block
    172  *
    173  * \param hAdts ADTS data handle
    174  * \param hBs bitstream handle into which the ADTS may be written into
    175  * \param pBits a pointer to a integer holding the current bitstream buffer bit
    176  * count, which is corrected to the current raw data block boundary.
    177  *
    178  */
    179 void adtsWrite_EndRawDataBlock(HANDLE_ADTS hAdts, HANDLE_FDK_BITSTREAM hBs,
    180                                int *bits);
    181 
    182 /**
    183  * \brief Start CRC region with a maximum number of bits
    184  *        If mBits is positive zero padding will be used for CRC calculation, if
    185  * there are less than mBits bits available. If mBits is negative no zero
    186  * padding is done. If mBits is zero the memory for the buffer is
    187  * allocated dynamically, the 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
    192  * region
    193  *
    194  * \return ID for the created region, -1 in case of an error
    195  */
    196 int adtsWrite_CrcStartReg(HANDLE_ADTS pAdts, HANDLE_FDK_BITSTREAM hBs,
    197                           int mBits);
    198 
    199 /**
    200  * \brief Ends CRC region identified by reg
    201  *
    202  * \param pAdts ADTS data handle
    203  * \param hBs bitstream handle of which the CRC region ends
    204  * \param reg a CRC region ID returned previously by adtsWrite_CrcStartReg()
    205  */
    206 void adtsWrite_CrcEndReg(HANDLE_ADTS pAdts, HANDLE_FDK_BITSTREAM hBs, int reg);
    207 
    208 #endif /* TPENC_ADTS_H */
    209