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): Markus Lohwasser 98 99 Description: Mpeg Surround library interface functions 100 101 *******************************************************************************/ 102 103 #ifndef MPS_MAIN_H 104 #define MPS_MAIN_H 105 106 /* Includes ******************************************************************/ 107 #include "aacenc.h" 108 #include "FDK_audio.h" 109 #include "machine_type.h" 110 111 /* Defines *******************************************************************/ 112 typedef enum { 113 MPS_ENCODER_OK = 0x0000, /*!< No error happened. All fine. */ 114 MPS_ENCODER_INVALID_HANDLE = 115 0x0020, /*!< Handle passed to function call was invalid. */ 116 MPS_ENCODER_MEMORY_ERROR = 0x0021, /*!< Memory allocation failed. */ 117 MPS_ENCODER_INIT_ERROR = 0x0040, /*!< General initialization error. */ 118 MPS_ENCODER_ENCODE_ERROR = 119 0x0060 /*!< The encoding process was interrupted by an unexpected error. 120 */ 121 122 } MPS_ENCODER_ERROR; 123 124 /* Data Types ****************************************************************/ 125 126 /** 127 * MPEG Surround Encoder interface handle. 128 */ 129 typedef struct MPS_ENCODER MPS_ENCODER, *HANDLE_MPS_ENCODER; 130 131 /* Function / Class Declarations *********************************************/ 132 133 /** 134 * \brief Open a Mpeg Surround Encoder instance. 135 * 136 * \phMpsEnc A pointer to a MPS handle to be allocated. 137 * Initialized on return. 138 * 139 * \return 140 * - MPS_ENCODER_OK, on succes. 141 * - MPS_ENCODER_INVALID_HANDLE, MPS_ENCODER_MEMORY_ERROR, on failure. 142 */ 143 MPS_ENCODER_ERROR FDK_MpegsEnc_Open(HANDLE_MPS_ENCODER *phMpsEnc); 144 145 /** 146 * \brief Close the Mpeg Surround Encoder instance. 147 * 148 * Deallocate instance and free whole memory. 149 * 150 * \param phMpsEnc Pointer to the MPS handle to be deallocated. 151 * 152 * \return 153 * - MPS_ENCODER_OK, on succes. 154 * - MPS_ENCODER_INVALID_HANDLE, on failure. 155 */ 156 MPS_ENCODER_ERROR FDK_MpegsEnc_Close(HANDLE_MPS_ENCODER *phMpsEnc); 157 158 /** 159 * \brief Initialize a Mpeg Surround Encoder instance. 160 * 161 * \param hMpsEnc MPS Encoder handle. 162 * \param audioObjectType Audio object type. 163 * \param samplingrate Sampling rate in Hz of audio input signal. 164 * \param bitrate Encder target bitrate. 165 * \param sbrRatio SBR sampling rate ratio. 166 * \param framelength Number of samples to be processes within one 167 * frame. 168 * \param inputBufferSizePerChannel Size of input buffer per channel. 169 * \param coreCoderDelay Core coder delay. 170 * 171 * \return 172 * - MPS_ENCODER_OK, on succes. 173 * - MPS_ENCODER_INVALID_HANDLE, MPS_ENCODER_ENCODE_ERROR, on failure. 174 */ 175 MPS_ENCODER_ERROR FDK_MpegsEnc_Init(HANDLE_MPS_ENCODER hMpsEnc, 176 const AUDIO_OBJECT_TYPE audioObjectType, 177 const UINT samplingrate, const UINT bitrate, 178 const UINT sbrRatio, const UINT framelength, 179 const UINT inputBufferSizePerChannel, 180 const UINT coreCoderDelay); 181 182 /** 183 * \brief Calculate Mpeg Surround processing. 184 * 185 * This fuction applies the MPS processing. The MPS side info will be written to 186 * extension payload. The input audio data will be overwritten by the calculated 187 * downmix. 188 * 189 * \param hMpsEnc MPS Encoder handle. 190 * \param pAudioSamples Pointer to audio input/output data. 191 * \param nAudioSamples Number of input audio samples to be prcessed. 192 * \param pMpsExtPayload Pointer to extension payload to be filled on 193 * return. 194 * 195 * \return 196 * - MPS_ENCODER_OK, on succes. 197 * - MPS_ENCODER_INVALID_HANDLE, MPS_ENCODER_ENCODE_ERROR, on failure. 198 */ 199 MPS_ENCODER_ERROR FDK_MpegsEnc_Process(HANDLE_MPS_ENCODER hMpsEnc, 200 INT_PCM *const pAudioSamples, 201 const INT nAudioSamples, 202 AACENC_EXT_PAYLOAD *pMpsExtPayload); 203 204 /** 205 * \brief Write Spatial Specific Config. 206 * 207 * This function can be called via call back from the transport library to write 208 * the Spatial Specific Config to given bitstream buffer. 209 * 210 * \param hMpsEnc MPS Encoder handle. 211 * \param hBs Bitstream buffer handle. 212 * 213 * \return Number of written bits. 214 */ 215 INT FDK_MpegsEnc_WriteSpatialSpecificConfig(HANDLE_MPS_ENCODER hMpsEnc, 216 HANDLE_FDK_BITSTREAM hBs); 217 218 /** 219 * \brief Get closest valid bitrate supported by given config. 220 * 221 * \param audioObjectType Audio object type. 222 * \param channelMode Encoder channel mode. 223 * \param samplingrate Sampling rate in Hz of audio input signal. 224 * \param sbrRatio SBR sampling rate ratio. 225 * \param bitrate The desired target bitrate. 226 * 227 * \return Closest valid bitrate to given bitrate.. 228 */ 229 INT FDK_MpegsEnc_GetClosestBitRate(const AUDIO_OBJECT_TYPE audioObjectType, 230 const CHANNEL_MODE channelMode, 231 const UINT samplingrate, const UINT sbrRatio, 232 const UINT bitrate); 233 234 /** 235 * \brief Get codec delay. 236 * 237 * This function returns delay of the whole en-/decoded signal, including 238 * corecoder delay. 239 * 240 * \param hMpsEnc MPS Encoder handle. 241 * 242 * \return Codec delay in samples. 243 */ 244 INT FDK_MpegsEnc_GetDelay(HANDLE_MPS_ENCODER hMpsEnc); 245 246 /** 247 * \brief Get Mpeg Surround Decoder delay. 248 * 249 * This function returns delay of the Mpeg Surround decoder. 250 * 251 * \param hMpsEnc MPS Encoder handle. 252 * 253 * \return Mpeg Surround Decoder delay in samples. 254 */ 255 INT FDK_MpegsEnc_GetDecDelay(HANDLE_MPS_ENCODER hMpsEnc); 256 257 /** 258 * \brief Get information about encoder library build. 259 * 260 * Fill a given LIB_INFO structure with library version information. 261 * 262 * \param info Pointer to an allocated LIB_INFO struct. 263 * 264 * \return 265 * - MPS_ENCODER_OK, on succes. 266 * - MPS_ENCODER_INVALID_HANDLE, MPS_ENCODER_INIT_ERROR, on failure. 267 */ 268 MPS_ENCODER_ERROR FDK_MpegsEnc_GetLibInfo(LIB_INFO *info); 269 270 #endif /* MPS_MAIN_H */ 271
