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