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