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 /**************************** AAC encoder library ******************************
     96 
     97    Author(s):   M. Neusinger
     98 
     99    Description: Compressor for AAC Metadata Generator
    100 
    101 *******************************************************************************/
    102 
    103 #ifndef METADATA_COMPRESSOR_H
    104 #define METADATA_COMPRESSOR_H
    105 
    106 #include "FDK_audio.h"
    107 #include "common_fix.h"
    108 
    109 #include "aacenc.h"
    110 
    111 #define LFE_LEV_SCALE 2
    112 
    113 /**
    114  *  DRC compression profiles.
    115  */
    116 typedef enum DRC_PROFILE {
    117   DRC_NONE = 0,
    118   DRC_FILMSTANDARD = 1,
    119   DRC_FILMLIGHT = 2,
    120   DRC_MUSICSTANDARD = 3,
    121   DRC_MUSICLIGHT = 4,
    122   DRC_SPEECH = 5,
    123   DRC_DELAY_TEST = 6,
    124   DRC_NOT_PRESENT = -2
    125 
    126 } DRC_PROFILE;
    127 
    128 /**
    129  *  DRC Compressor handle.
    130  */
    131 typedef struct DRC_COMP DRC_COMP, *HDRC_COMP;
    132 
    133 /**
    134  * \brief  Open a DRC Compressor instance.
    135  *
    136  * Allocate memory for a compressor instance.
    137  *
    138  * \param phDrcComp             A pointer to a compressor handle. Initialized on
    139  * return.
    140  *
    141  * \return
    142  *          - 0, on succes.
    143  *          - unequal 0, on failure.
    144  */
    145 INT FDK_DRC_Generator_Open(HDRC_COMP *phDrcComp);
    146 
    147 /**
    148  * \brief  Close the DRC Compressor instance.
    149  *
    150  * Deallocate instance and free whole memory.
    151  *
    152  * \param phDrcComp             Pointer to the compressor handle to be
    153  * deallocated.
    154  *
    155  * \return
    156  *          - 0, on succes.
    157  *          - unequal 0, on failure.
    158  */
    159 INT FDK_DRC_Generator_Close(HDRC_COMP *phDrcComp);
    160 
    161 /**
    162  * \brief  Configure DRC Compressor.
    163  *
    164  * \param drcComp               Compressor handle.
    165  * \param profileLine           DRC profile for line mode.
    166  * \param profileRF             DRC profile for RF mode.
    167  * \param blockLength           Length of processing block in samples per
    168  * channel.
    169  * \param sampleRate            Sampling rate in Hz.
    170  * \param channelMode           Channel configuration.
    171  * \param channelOrder          Channel order, MPEG or WAV.
    172  * \param useWeighting          Use weighting filter for loudness calculation
    173  *
    174  * \return
    175  *          - 0, on success,
    176  *          - unequal 0, on failure
    177  */
    178 INT FDK_DRC_Generator_Initialize(HDRC_COMP drcComp,
    179                                  const DRC_PROFILE profileLine,
    180                                  const DRC_PROFILE profileRF,
    181                                  const INT blockLength, const UINT sampleRate,
    182                                  const CHANNEL_MODE channelMode,
    183                                  const CHANNEL_ORDER channelOrder,
    184                                  const UCHAR useWeighting);
    185 
    186 /**
    187  * \brief  Calculate DRC Compressor Gain.
    188  *
    189  * \param drcComp               Compressor handle.
    190  * \param inSamples             Pointer to interleaved input audio samples.
    191  * \param inSamplesBufSize      Size of inSamples for one channel.
    192  * \param dialnorm              Dialog Level in dB (typically -31...-1).
    193  * \param drc_TargetRefLevel
    194  * \param comp_TargetRefLevel
    195  * \param clev                  Downmix center mix factor (typically 0.707,
    196  * 0.595 or 0.5)
    197  * \param slev                  Downmix surround mix factor (typically 0.707,
    198  * 0.5, or 0)
    199  * \param ext_leva              Downmix gain factor A
    200  * \param ext_levb              Downmix gain factor B
    201  * \param lfe_lev               LFE gain factor
    202  * \param dmxGain5              Gain factor for downmix to 5 channels
    203  * \param dmxGain2              Gain factor for downmix to 2 channels
    204  * \param dynrng                Pointer to variable receiving line mode DRC gain
    205  * in dB
    206  * \param compr                 Pointer to variable receiving RF mode DRC gain
    207  * in dB
    208  *
    209  * \return
    210  *          - 0, on success,
    211  *          - unequal 0, on failure
    212  */
    213 INT FDK_DRC_Generator_Calc(HDRC_COMP drcComp, const INT_PCM *const inSamples,
    214                            const UINT inSamplesBufSize, const INT dialnorm,
    215                            const INT drc_TargetRefLevel,
    216                            const INT comp_TargetRefLevel, const FIXP_DBL clev,
    217                            const FIXP_DBL slev, const FIXP_DBL ext_leva,
    218                            const FIXP_DBL ext_levb, const FIXP_DBL lfe_lev,
    219                            const INT dmxGain5, const INT dmxGain2,
    220                            INT *const dynrng, INT *const compr);
    221 
    222 /**
    223  * \brief  Configure DRC Compressor Profile.
    224  *
    225  * \param drcComp               Compressor handle.
    226  * \param profileLine           DRC profile for line mode.
    227  * \param profileRF             DRC profile for RF mode.
    228  *
    229  * \return
    230  *          - 0, on success,
    231  *          - unequal 0, on failure
    232  */
    233 INT FDK_DRC_Generator_setDrcProfile(HDRC_COMP drcComp,
    234                                     const DRC_PROFILE profileLine,
    235                                     const DRC_PROFILE profileRF);
    236 
    237 /**
    238  * \brief  Get DRC profile for line mode.
    239  *
    240  * \param drcComp               Compressor handle.
    241  *
    242  * \return  Current Profile.
    243  */
    244 DRC_PROFILE FDK_DRC_Generator_getDrcProfile(const HDRC_COMP drcComp);
    245 
    246 /**
    247  * \brief  Get DRC profile for RF mode.
    248  *
    249  * \param drcComp               Compressor handle.
    250  *
    251  * \return  Current Profile.
    252  */
    253 DRC_PROFILE FDK_DRC_Generator_getCompProfile(const HDRC_COMP drcComp);
    254 
    255 #endif /* METADATA_COMPRESSOR_H */
    256