libAACenc/src/metadata_main.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): V. Bacigalupo
  87    Description: Metadata Encoder library interface functions
  88
  89 ******************************************************************************/
  90
  91 #ifndef _METADATA_MAIN_H
  92 #define _METADATA_MAIN_H
  93
  94
  95 /* Includes ******************************************************************/
  96 #include "aacenc_lib.h"
  97 #include "aacenc.h"
  98
  99
 100 /* Defines *******************************************************************/
 101
 102 /* Data Types ****************************************************************/
 103
 104 typedef enum {
 105     METADATA_OK                    = 0x0000,   /*!< No error happened. All fine. */
 106     METADATA_INVALID_HANDLE        = 0x0020,   /*!< Handle passed to function call was invalid. */
 107     METADATA_MEMORY_ERROR          = 0x0021,   /*!< Memory allocation failed. */
 108     METADATA_INIT_ERROR            = 0x0040,   /*!< General initialization error. */
 109     METADATA_ENCODE_ERROR          = 0x0060    /*!< The encoding process was interrupted by an unexpected error. */
 110
 111 } FDK_METADATA_ERROR;
 112
 113 /**
 114  *  Meta Data handle.
 115  */
 116 typedef struct FDK_METADATA_ENCODER *HANDLE_FDK_METADATA_ENCODER;
 117
 118
 119 /**
 120  * \brief  Open a Meta Data instance.
 121  *
 122  * \param phMetadataEnc         A pointer to a Meta Data handle to be allocated. Initialized on return.
 123  *
 124  * \return
 125  *          - METADATA_OK, on succes.
 126  *          - METADATA_INVALID_HANDLE, METADATA_MEMORY_ERROR, on failure.
 127  */
 128 FDK_METADATA_ERROR FDK_MetadataEnc_Open(
 129         HANDLE_FDK_METADATA_ENCODER     *phMetadataEnc
 130         );
 131
 132
 133 /**
 134  * \brief  Initialize a Meta Data instance.
 135  *
 136  * \param hMetadataEnc          Meta Data handle.
 137  * \param resetStates           Indication for full reset of all states.
 138  * \param metadataMode          Configures metat data output format (0,1,2).
 139  * \param audioDelay            Delay cause by the audio encoder.
 140  * \param frameLength           Number of samples to be processes within one frame.
 141  * \param sampleRate            Sampling rat in Hz of audio input signal.
 142  * \param nChannels             Number of audio input channels.
 143  * \param channelMode           Channel configuration which is used by the encoder.
 144  * \param channelOrder          Channel order of the input data. (WAV, MPEG)
 145  *
 146  * \return
 147  *          - METADATA_OK, on succes.
 148  *          - METADATA_INVALID_HANDLE, METADATA_INIT_ERROR, on failure.
 149  */
 150 FDK_METADATA_ERROR FDK_MetadataEnc_Init(
 151         HANDLE_FDK_METADATA_ENCODER      hMetadataEnc,
 152         const INT                        resetStates,
 153         const INT                        metadataMode,
 154         const INT                        audioDelay,
 155         const UINT                       frameLength,
 156         const UINT                       sampleRate,
 157         const UINT                       nChannels,
 158         const CHANNEL_MODE               channelMode,
 159         const CHANNEL_ORDER              channelOrder
 160         );
 161
 162
 163 /**
 164  * \brief  Calculate Meta Data processing.
 165  *
 166  * This function treats all step necessary for meta data processing.
 167  * - Receive new meta data and make usable.
 168  * - Calculate DRC compressor and extract meta data info.
 169  * - Make meta data available for extern use.
 170  * - Apply audio data and meta data delay compensation.
 171  *
 172  * \param hMetadataEnc          Meta Data handle.
 173  * \param pAudioSamples         Pointer to audio input data. Existing function overwrites audio data with delayed audio samples.
 174  * \param nAudioSamples         Number of input audio samples to be prcessed.
 175  * \param pMetadata             Pointer to Metat Data input.
 176  * \param ppMetaDataExtPayload  Pointer to extension payload array. Filled on return.
 177  * \param nMetaDataExtensions   Pointer to variable to describe number of available extension payloads. Filled on return.
 178  * \param matrix_mixdown_idx    Pointer to variable for matrix mixdown coefficient. Filled on return.
 179  *
 180  * \return
 181  *          - METADATA_OK, on succes.
 182  *          - METADATA_INVALID_HANDLE, METADATA_ENCODE_ERROR, on failure.
 183  */
 184 FDK_METADATA_ERROR FDK_MetadataEnc_Process(
 185         HANDLE_FDK_METADATA_ENCODER      hMetadataEnc,
 186         INT_PCM * const                  pAudioSamples,
 187         const INT                        nAudioSamples,
 188         const AACENC_MetaData * const    pMetadata,
 189         AACENC_EXT_PAYLOAD **            ppMetaDataExtPayload,
 190         UINT *                           nMetaDataExtensions,
 191         INT *                            matrix_mixdown_idx
 192         );
 193
 194
 195 /**
 196  * \brief  Close the Meta Data instance.
 197  *
 198  * Deallocate instance and free whole memory.
 199  *
 200  * \param phMetaData            Pointer to the Meta Data handle to be deallocated.
 201  *
 202  * \return
 203  *          - METADATA_OK, on succes.
 204  *          - METADATA_INVALID_HANDLE, on failure.
 205  */
 206 FDK_METADATA_ERROR FDK_MetadataEnc_Close(
 207         HANDLE_FDK_METADATA_ENCODER     *phMetaData
 208         );
 209
 210
 211 /**
 212  * \brief  Get Meta Data Encoder delay.
 213  *
 214  * \param hMetadataEnc          Meta Data Encoder handle.
 215  *
 216  * \return  Delay caused by Meta Data module.
 217  */
 218 INT FDK_MetadataEnc_GetDelay(
 219         HANDLE_FDK_METADATA_ENCODER      hMetadataEnc
 220         );
 221
 222
 223 #endif /* _METADATA_MAIN_H */
 224