The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 1 | |
| 2 | /* ----------------------------------------------------------------------------------------------------------- |
| 3 | Software License for The Fraunhofer FDK AAC Codec Library for Android |
| 4 | |
Jean-Michel Trivi | 4f0d970 | 2013-08-08 17:26:40 -0700 | [diff] [blame] | 5 | © Copyright 1995 - 2013 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 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 SysLib ********************** |
| 85 | |
| 86 | Author(s): Manuel Jander |
| 87 | |
| 88 | ******************************************************************************/ |
| 89 | |
| 90 | /** \file FDK_audio.h |
| 91 | * \brief Global audio struct and constant definitions. |
| 92 | */ |
| 93 | |
| 94 | #ifndef FDK_AUDIO_H |
| 95 | #define FDK_AUDIO_H |
| 96 | |
| 97 | #include "machine_type.h" |
| 98 | #include "genericStds.h" |
| 99 | |
| 100 | #ifdef __cplusplus |
| 101 | extern "C" |
| 102 | { |
| 103 | #endif |
| 104 | |
| 105 | /** |
| 106 | * File format identifiers. |
| 107 | */ |
| 108 | typedef enum |
| 109 | { |
| 110 | FF_UNKNOWN = -1, /**< Unknown format. */ |
| 111 | FF_RAW = 0, /**< No container, bit stream data conveyed "as is". */ |
| 112 | |
| 113 | FF_MP4_3GPP = 3, /**< 3GPP file format. */ |
| 114 | FF_MP4_MP4F = 4, /**< MPEG-4 File format. */ |
| 115 | |
| 116 | FF_RAWPACKETS = 5, /**< Proprietary raw packet file. */ |
| 117 | |
| 118 | FF_DRMCT = 12 /**< Digital Radio Mondial (DRM30/DRM+) CT proprietary file format. */ |
| 119 | |
| 120 | } FILE_FORMAT; |
| 121 | |
| 122 | /** |
| 123 | * Transport type identifiers. |
| 124 | */ |
| 125 | typedef enum |
| 126 | { |
| 127 | TT_UNKNOWN = -1, /**< Unknown format. */ |
| 128 | TT_MP4_RAW = 0, /**< "as is" access units (packet based since there is obviously no sync layer) */ |
| 129 | TT_MP4_ADIF = 1, /**< ADIF bitstream format. */ |
| 130 | TT_MP4_ADTS = 2, /**< ADTS bitstream format. */ |
| 131 | |
| 132 | TT_MP4_LATM_MCP1 = 6, /**< Audio Mux Elements with muxConfigPresent = 1 */ |
| 133 | TT_MP4_LATM_MCP0 = 7, /**< Audio Mux Elements with muxConfigPresent = 0, out of band StreamMuxConfig */ |
| 134 | |
| 135 | TT_MP4_LOAS = 10, /**< Audio Sync Stream. */ |
| 136 | |
| 137 | TT_DRM = 12, /**< Digital Radio Mondial (DRM30/DRM+) bitstream format. */ |
| 138 | |
| 139 | TT_MP1_L1 = 16, /**< MPEG 1 Audio Layer 1 audio bitstream. */ |
| 140 | TT_MP1_L2 = 17, /**< MPEG 1 Audio Layer 2 audio bitstream. */ |
| 141 | TT_MP1_L3 = 18, /**< MPEG 1 Audio Layer 3 audio bitstream. */ |
| 142 | |
| 143 | TT_RSVD50 = 50 /**< */ |
| 144 | |
| 145 | } TRANSPORT_TYPE; |
| 146 | |
Jean-Michel Trivi | 5016eb7 | 2013-08-27 16:28:09 -0700 | [diff] [blame] | 147 | #define TT_IS_PACKET(x) \ |
| 148 | ( ((x) == TT_MP4_RAW) \ |
| 149 | || ((x) == TT_DRM) \ |
| 150 | || ((x) == TT_MP4_LATM_MCP0) \ |
| 151 | || ((x) == TT_MP4_LATM_MCP1) ) |
| 152 | |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 153 | /** |
| 154 | * Audio Object Type definitions. |
| 155 | */ |
| 156 | typedef enum |
| 157 | { |
| 158 | AOT_NONE = -1, |
| 159 | AOT_NULL_OBJECT = 0, |
| 160 | AOT_AAC_MAIN = 1, /**< Main profile */ |
| 161 | AOT_AAC_LC = 2, /**< Low Complexity object */ |
| 162 | AOT_AAC_SSR = 3, |
| 163 | AOT_AAC_LTP = 4, |
| 164 | AOT_SBR = 5, |
| 165 | AOT_AAC_SCAL = 6, |
| 166 | AOT_TWIN_VQ = 7, |
| 167 | AOT_CELP = 8, |
| 168 | AOT_HVXC = 9, |
| 169 | AOT_RSVD_10 = 10, /**< (reserved) */ |
| 170 | AOT_RSVD_11 = 11, /**< (reserved) */ |
| 171 | AOT_TTSI = 12, /**< TTSI Object */ |
| 172 | AOT_MAIN_SYNTH = 13, /**< Main Synthetic object */ |
| 173 | AOT_WAV_TAB_SYNTH = 14, /**< Wavetable Synthesis object */ |
| 174 | AOT_GEN_MIDI = 15, /**< General MIDI object */ |
| 175 | AOT_ALG_SYNTH_AUD_FX = 16, /**< Algorithmic Synthesis and Audio FX object */ |
| 176 | AOT_ER_AAC_LC = 17, /**< Error Resilient(ER) AAC Low Complexity */ |
| 177 | AOT_RSVD_18 = 18, /**< (reserved) */ |
| 178 | AOT_ER_AAC_LTP = 19, /**< Error Resilient(ER) AAC LTP object */ |
| 179 | AOT_ER_AAC_SCAL = 20, /**< Error Resilient(ER) AAC Scalable object */ |
| 180 | AOT_ER_TWIN_VQ = 21, /**< Error Resilient(ER) TwinVQ object */ |
| 181 | AOT_ER_BSAC = 22, /**< Error Resilient(ER) BSAC object */ |
| 182 | AOT_ER_AAC_LD = 23, /**< Error Resilient(ER) AAC LowDelay object */ |
| 183 | AOT_ER_CELP = 24, /**< Error Resilient(ER) CELP object */ |
| 184 | AOT_ER_HVXC = 25, /**< Error Resilient(ER) HVXC object */ |
| 185 | AOT_ER_HILN = 26, /**< Error Resilient(ER) HILN object */ |
| 186 | AOT_ER_PARA = 27, /**< Error Resilient(ER) Parametric object */ |
| 187 | AOT_RSVD_28 = 28, /**< might become SSC */ |
| 188 | AOT_PS = 29, /**< PS, Parametric Stereo (includes SBR) */ |
| 189 | AOT_MPEGS = 30, /**< MPEG Surround */ |
| 190 | |
| 191 | AOT_ESCAPE = 31, /**< Signal AOT uses more than 5 bits */ |
| 192 | |
| 193 | AOT_MP3ONMP4_L1 = 32, /**< MPEG-Layer1 in mp4 */ |
| 194 | AOT_MP3ONMP4_L2 = 33, /**< MPEG-Layer2 in mp4 */ |
| 195 | AOT_MP3ONMP4_L3 = 34, /**< MPEG-Layer3 in mp4 */ |
| 196 | AOT_RSVD_35 = 35, /**< might become DST */ |
| 197 | AOT_RSVD_36 = 36, /**< might become ALS */ |
| 198 | AOT_AAC_SLS = 37, /**< AAC + SLS */ |
| 199 | AOT_SLS = 38, /**< SLS */ |
| 200 | AOT_ER_AAC_ELD = 39, /**< AAC Enhanced Low Delay */ |
| 201 | |
| 202 | AOT_USAC = 42, /**< USAC */ |
| 203 | AOT_SAOC = 43, /**< SAOC */ |
| 204 | AOT_LD_MPEGS = 44, /**< Low Delay MPEG Surround */ |
| 205 | |
| 206 | AOT_RSVD50 = 50, /**< Interim AOT for Rsvd50 */ |
| 207 | |
| 208 | /* Pseudo AOTs */ |
| 209 | AOT_MP2_AAC_MAIN = 128, /**< Virtual AOT MP2 Main profile */ |
| 210 | AOT_MP2_AAC_LC = 129, /**< Virtual AOT MP2 Low Complexity profile */ |
| 211 | AOT_MP2_AAC_SSR = 130, /**< Virtual AOT MP2 Scalable Sampling Rate profile */ |
| 212 | |
| 213 | AOT_MP2_SBR = 132, /**< Virtual AOT MP2 Low Complexity Profile with SBR */ |
| 214 | |
| 215 | AOT_DAB = 134, /**< Virtual AOT for DAB (Layer2 with scalefactor CRC) */ |
| 216 | AOT_DABPLUS_AAC_LC = 135, /**< Virtual AOT for DAB plus AAC-LC */ |
| 217 | AOT_DABPLUS_SBR = 136, /**< Virtual AOT for DAB plus HE-AAC */ |
| 218 | AOT_DABPLUS_PS = 137, /**< Virtual AOT for DAB plus HE-AAC v2 */ |
| 219 | |
| 220 | AOT_PLAIN_MP1 = 140, /**< Virtual AOT for plain mp1 */ |
| 221 | AOT_PLAIN_MP2 = 141, /**< Virtual AOT for plain mp2 */ |
| 222 | AOT_PLAIN_MP3 = 142, /**< Virtual AOT for plain mp3 */ |
| 223 | |
| 224 | AOT_DRM_AAC = 143, /**< Virtual AOT for DRM (ER-AAC-SCAL without SBR) */ |
| 225 | AOT_DRM_SBR = 144, /**< Virtual AOT for DRM (ER-AAC-SCAL with SBR) */ |
| 226 | AOT_DRM_MPEG_PS = 145, /**< Virtual AOT for DRM (ER-AAC-SCAL with SBR and MPEG-PS) */ |
| 227 | AOT_DRM_SURROUND = 146, /**< Virtual AOT for DRM Surround (ER-AAC-SCAL (+SBR) +MPS) */ |
| 228 | |
| 229 | AOT_MP2_PS = 156, /**< Virtual AOT MP2 Low Complexity Profile with SBR and PS */ |
| 230 | |
| 231 | AOT_MPEGS_RESIDUALS = 256 /**< Virtual AOT for MPEG Surround residuals */ |
| 232 | |
| 233 | } AUDIO_OBJECT_TYPE; |
| 234 | |
Jean-Michel Trivi | 6792cf6 | 2014-05-20 17:39:03 -0700 | [diff] [blame^] | 235 | #define IS_USAC(aot) \ |
| 236 | ((aot) == AOT_USAC \ |
| 237 | || (aot) == AOT_RSVD50) |
| 238 | |
| 239 | #define IS_LOWDELAY(aot) \ |
| 240 | ((aot) == AOT_ER_AAC_LD \ |
| 241 | || (aot) == AOT_ER_AAC_ELD) |
| 242 | |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 243 | /** Channel Mode ( 1-7 equals MPEG channel configurations, others are arbitrary). */ |
| 244 | typedef enum { |
Jean-Michel Trivi | fa3eba1 | 2013-08-29 16:05:22 -0700 | [diff] [blame] | 245 | MODE_INVALID = -1, |
| 246 | MODE_UNKNOWN = 0, |
| 247 | MODE_1 = 1, /**< C */ |
| 248 | MODE_2 = 2, /**< L+R */ |
| 249 | MODE_1_2 = 3, /**< C, L+R */ |
| 250 | MODE_1_2_1 = 4, /**< C, L+R, Rear */ |
| 251 | MODE_1_2_2 = 5, /**< C, L+R, LS+RS */ |
| 252 | MODE_1_2_2_1 = 6, /**< C, L+R, LS+RS, LFE */ |
| 253 | MODE_1_2_2_2_1 = 7, /**< C, LC+RC, L+R, LS+RS, LFE */ |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 254 | |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 255 | |
Jean-Michel Trivi | fa3eba1 | 2013-08-29 16:05:22 -0700 | [diff] [blame] | 256 | MODE_1_1 = 16, /**< 2 SCEs (dual mono) */ |
| 257 | MODE_1_1_1_1 = 17, /**< 4 SCEs */ |
| 258 | MODE_1_1_1_1_1_1 = 18, /**< 6 SCEs */ |
| 259 | MODE_1_1_1_1_1_1_1_1 = 19, /**< 8 SCEs */ |
| 260 | MODE_1_1_1_1_1_1_1_1_1_1_1_1 = 20, /**< 12 SCEs */ |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 261 | |
Jean-Michel Trivi | fa3eba1 | 2013-08-29 16:05:22 -0700 | [diff] [blame] | 262 | MODE_2_2 = 21, /**< 2 CPEs */ |
| 263 | MODE_2_2_2 = 22, /**< 3 CPEs */ |
| 264 | MODE_2_2_2_2 = 23, /**< 4 CPEs */ |
| 265 | MODE_2_2_2_2_2_2 = 24, /**< 6 CPEs */ |
| 266 | |
| 267 | MODE_2_1 = 30, /**< CPE,SCE (ARIB standard B32) */ |
| 268 | |
| 269 | MODE_7_1_REAR_SURROUND = 33, /**< C, L+R, LS+RS, Lrear+Rrear, LFE */ |
| 270 | MODE_7_1_FRONT_CENTER = 34 /**< C, LC+RC, L+R, LS+RS, LFE */ |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 271 | |
| 272 | } CHANNEL_MODE; |
| 273 | |
Jean-Michel Trivi | 47c680c | 2013-12-27 16:13:22 -0800 | [diff] [blame] | 274 | /** |
| 275 | * Speaker description tags. |
| 276 | * Do not change the enumeration values unless it keeps the following segmentation: |
| 277 | * - Bit 0-3: Horizontal postion (0: none, 1: front, 2: side, 3: back, 4: lfe) |
| 278 | * - Bit 4-7: Vertical position (0: normal, 1: top, 2: bottom) |
| 279 | */ |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 280 | typedef enum { |
Jean-Michel Trivi | 47c680c | 2013-12-27 16:13:22 -0800 | [diff] [blame] | 281 | ACT_NONE = 0x00, |
| 282 | ACT_FRONT = 0x01, /*!< Front speaker position (at normal height) */ |
| 283 | ACT_SIDE = 0x02, /*!< Side speaker position (at normal height) */ |
| 284 | ACT_BACK = 0x03, /*!< Back speaker position (at normal height) */ |
| 285 | ACT_LFE = 0x04, /*!< Low frequency effect speaker postion (front) */ |
| 286 | |
| 287 | ACT_TOP = 0x10, /*!< Top speaker area (for combination with speaker positions) */ |
| 288 | ACT_FRONT_TOP = 0x11, /*!< Top front speaker = (ACT_FRONT|ACT_TOP) */ |
| 289 | ACT_SIDE_TOP = 0x12, /*!< Top side speaker = (ACT_SIDE |ACT_TOP) */ |
| 290 | ACT_BACK_TOP = 0x13, /*!< Top back speaker = (ACT_BACK |ACT_TOP) */ |
| 291 | |
| 292 | ACT_BOTTOM = 0x20, /*!< Bottom speaker area (for combination with speaker positions) */ |
| 293 | ACT_FRONT_BOTTOM = 0x21, /*!< Bottom front speaker = (ACT_FRONT|ACT_BOTTOM) */ |
| 294 | ACT_SIDE_BOTTOM = 0x22, /*!< Bottom side speaker = (ACT_SIDE |ACT_BOTTOM) */ |
| 295 | ACT_BACK_BOTTOM = 0x23 /*!< Bottom back speaker = (ACT_BACK |ACT_BOTTOM) */ |
| 296 | |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 297 | } AUDIO_CHANNEL_TYPE; |
| 298 | |
Jean-Michel Trivi | dbf9680 | 2013-08-29 12:29:46 -0700 | [diff] [blame] | 299 | typedef enum |
| 300 | { |
| 301 | SIG_UNKNOWN = -1, |
| 302 | SIG_IMPLICIT = 0, |
| 303 | SIG_EXPLICIT_BW_COMPATIBLE = 1, |
| 304 | SIG_EXPLICIT_HIERARCHICAL = 2 |
| 305 | |
| 306 | } SBR_PS_SIGNALING; |
| 307 | |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 308 | /** |
| 309 | * Audio Codec flags. |
| 310 | */ |
| 311 | #define AC_ER_VCB11 0x000001 /*!< aacSectionDataResilienceFlag flag (from ASC): 1 means use virtual codebooks */ |
| 312 | #define AC_ER_RVLC 0x000002 /*!< aacSpectralDataResilienceFlag flag (from ASC): 1 means use huffman codeword reordering */ |
| 313 | #define AC_ER_HCR 0x000004 /*!< aacSectionDataResilienceFlag flag (from ASC): 1 means use virtual codebooks */ |
| 314 | #define AC_SCALABLE 0x000008 /*!< AAC Scalable*/ |
| 315 | #define AC_ELD 0x000010 /*!< AAC-ELD */ |
| 316 | #define AC_LD 0x000020 /*!< AAC-LD */ |
| 317 | #define AC_ER 0x000040 /*!< ER syntax */ |
| 318 | #define AC_BSAC 0x000080 /*!< BSAC */ |
| 319 | #define AC_USAC 0x000100 /*!< USAC */ |
| 320 | #define AC_USAC_TW 0x000200 /*!< USAC time warped filter bank is active */ |
| 321 | #define AC_USAC_NOISE 0x000400 /*!< USAC noise filling is active */ |
| 322 | #define AC_USAC_HBE 0x000800 /*!< USAC harmonic bandwidth extension is active */ |
| 323 | #define AC_RSVD50 0x001000 /*!< Rsvd50 */ |
| 324 | #define AC_SBR_PRESENT 0x002000 /*!< SBR present flag (from ASC) */ |
| 325 | #define AC_SBRCRC 0x004000 /*!< SBR CRC present flag. Only relevant for AAC-ELD for now. */ |
| 326 | #define AC_PS_PRESENT 0x008000 /*!< PS present flag (from ASC or implicit) */ |
| 327 | #define AC_MPS_PRESENT 0x010000 /*!< MPS present flag (from ASC or implicit) */ |
| 328 | #define AC_DRM 0x020000 /*!< DRM bit stream syntax */ |
| 329 | #define AC_INDEP 0x040000 /*!< Independency flag */ |
| 330 | #define AC_MPS_RES 0x080000 /*!< MPS residual individual channel data. */ |
| 331 | #define AC_DAB 0x800000 /*!< DAB bit stream syntax */ |
| 332 | #define AC_LD_MPS 0x01000000 /*!< Low Delay MPS. */ |
| 333 | |
| 334 | |
| 335 | /* CODER_CONFIG::flags */ |
| 336 | #define CC_MPEG_ID 0x00100000 |
| 337 | #define CC_IS_BASELAYER 0x00200000 |
| 338 | #define CC_PROTECTION 0x00400000 |
| 339 | #define CC_SBR 0x00800000 |
| 340 | #define CC_SBRCRC 0x00010000 |
| 341 | #define CC_RVLC 0x01000000 |
| 342 | #define CC_VCB11 0x02000000 |
| 343 | #define CC_HCR 0x04000000 |
| 344 | #define CC_PSEUDO_SURROUND 0x08000000 |
| 345 | #define CC_USAC_NOISE 0x10000000 |
| 346 | #define CC_USAC_TW 0x20000000 |
| 347 | #define CC_USAC_HBE 0x40000000 |
| 348 | |
| 349 | /** Generic audio coder configuration structure. */ |
| 350 | typedef struct { |
| 351 | AUDIO_OBJECT_TYPE aot; /**< Audio Object Type (AOT). */ |
| 352 | AUDIO_OBJECT_TYPE extAOT; /**< Extension Audio Object Type (SBR). */ |
| 353 | CHANNEL_MODE channelMode; /**< Channel mode. */ |
| 354 | INT samplingRate; /**< Sampling rate. */ |
| 355 | INT extSamplingRate; /**< Extended samplerate (SBR). */ |
| 356 | INT bitRate; /**< Average bitrate. */ |
| 357 | int samplesPerFrame; /**< Number of PCM samples per codec frame and audio channel. */ |
| 358 | int noChannels; /**< Number of audio channels. */ |
| 359 | int bitsFrame; |
| 360 | int nSubFrames; /**< Amount of encoder subframes. 1 means no subframing. */ |
| 361 | int BSACnumOfSubFrame; /**< The number of the sub-frames which are grouped and transmitted in a super-frame (BSAC). */ |
| 362 | int BSAClayerLength; /**< The average length of the large-step layers in bytes (BSAC). */ |
| 363 | UINT flags; /**< flags */ |
| 364 | UCHAR matrixMixdownA; /**< Matrix mixdown index to put into PCE. Default value 0 means no mixdown coefficient, |
| 365 | valid values are 1-4 which correspond to matrix_mixdown_idx 0-3. */ |
| 366 | UCHAR headerPeriod; /**< Frame period for sending in band configuration buffers in the transport layer. */ |
| 367 | |
| 368 | UCHAR stereoConfigIndex; /**< USAC MPS stereo mode */ |
| 369 | UCHAR sbrMode; /**< USAC SBR mode */ |
Jean-Michel Trivi | dbf9680 | 2013-08-29 12:29:46 -0700 | [diff] [blame] | 370 | SBR_PS_SIGNALING sbrSignaling;/**< 0: implicit signaling, 1: backwards compatible explicit signaling, 2: hierarcical explicit signaling */ |
| 371 | |
| 372 | UCHAR sbrPresent; |
| 373 | UCHAR psPresent; |
The Android Open Source Project | 2228e36 | 2012-07-11 10:15:24 -0700 | [diff] [blame] | 374 | } CODER_CONFIG; |
| 375 | |
| 376 | /** MP4 Element IDs. */ |
| 377 | typedef enum |
| 378 | { |
| 379 | ID_NONE = -1, /**< Invalid Element helper ID. */ |
| 380 | ID_SCE = 0, /**< Single Channel Element. */ |
| 381 | ID_CPE = 1, /**< Channel Pair Element. */ |
| 382 | ID_CCE = 2, /**< Coupling Channel Element. */ |
| 383 | ID_LFE = 3, /**< LFE Channel Element. */ |
| 384 | ID_DSE = 4, /**< Currently one Data Stream Element for ancillary data is supported. */ |
| 385 | ID_PCE = 5, /**< Program Config Element. */ |
| 386 | ID_FIL = 6, /**< Fill Element. */ |
| 387 | ID_END = 7, /**< Arnie (End Element = Terminator). */ |
| 388 | ID_EXT = 8, /**< Extension Payload (ER only). */ |
| 389 | ID_SCAL = 9, /**< AAC scalable element (ER only). */ |
| 390 | ID_LAST |
| 391 | } MP4_ELEMENT_ID; |
| 392 | |
| 393 | #define IS_CHANNEL_ELEMENT(elementId) \ |
| 394 | ((elementId) == ID_SCE \ |
| 395 | || (elementId) == ID_CPE \ |
| 396 | || (elementId) == ID_LFE) |
| 397 | |
| 398 | #define EXT_ID_BITS 4 /**< Size in bits of extension payload type tags. */ |
| 399 | |
| 400 | /** Extension payload types. */ |
| 401 | typedef enum { |
| 402 | EXT_FIL = 0x00, |
| 403 | EXT_FILL_DATA = 0x01, |
| 404 | EXT_DATA_ELEMENT = 0x02, |
| 405 | EXT_DATA_LENGTH = 0x03, |
| 406 | EXT_LDSAC_DATA = 0x09, |
| 407 | EXT_SAOC_DATA = 0x0a, |
| 408 | EXT_DYNAMIC_RANGE = 0x0b, |
| 409 | EXT_SAC_DATA = 0x0c, |
| 410 | EXT_SBR_DATA = 0x0d, |
| 411 | EXT_SBR_DATA_CRC = 0x0e |
| 412 | } EXT_PAYLOAD_TYPE; |
| 413 | |
| 414 | |
| 415 | /** |
| 416 | * Proprietary raw packet file configuration data type identifier. |
| 417 | */ |
| 418 | typedef enum |
| 419 | { |
| 420 | TC_NOTHING = 0, /* No configuration available -> in-band configuration. */ |
| 421 | TC_RAW_ASC, /* Configuration data field is a raw AudioSpecificConfig. */ |
| 422 | TC_RAW_SMC, /* Configuration data field is a raw StreamMuxConfig. */ |
| 423 | TC_RAW_SDC /* Configuration data field is a raw Drm SDC. */ |
| 424 | |
| 425 | } TP_CONFIG_TYPE; |
| 426 | |
| 427 | /* |
| 428 | * ############################################################################################## |
| 429 | * Library identification and error handling |
| 430 | * ############################################################################################## |
| 431 | */ |
| 432 | /* \cond */ |
| 433 | #define MODULE_ID_MASK (0x000000ff) |
| 434 | #define MODULE_ID_SHIFT (24) |
| 435 | |
| 436 | typedef enum { |
| 437 | FDK_NONE = 0, |
| 438 | FDK_TOOLS = 1, |
| 439 | FDK_SYSLIB = 2, |
| 440 | FDK_AACDEC = 3, |
| 441 | FDK_AACENC = 4, |
| 442 | FDK_SBRDEC = 5, |
| 443 | FDK_SBRENC = 6, |
| 444 | FDK_TPDEC = 7, |
| 445 | FDK_TPENC = 8, |
| 446 | FDK_MPSDEC = 9, |
| 447 | FDK_MPEGFILEREAD = 10, |
| 448 | FDK_MPEGFILEWRITE = 11, |
| 449 | FDK_MP2DEC = 12, |
| 450 | FDK_DABDEC = 13, |
| 451 | FDK_DABPARSE = 14, |
| 452 | FDK_DRMDEC = 15, |
| 453 | FDK_DRMPARSE = 16, |
| 454 | FDK_AACLDENC = 17, |
| 455 | FDK_MP2ENC = 18, |
| 456 | FDK_MP3ENC = 19, |
| 457 | FDK_MP3DEC = 20, |
| 458 | FDK_MP3HEADPHONE = 21, |
| 459 | FDK_MP3SDEC = 22, |
| 460 | FDK_MP3SENC = 23, |
| 461 | FDK_EAEC = 24, |
| 462 | FDK_DABENC = 25, |
| 463 | FDK_DMBDEC = 26, |
| 464 | FDK_FDREVERB = 27, |
| 465 | FDK_DRMENC = 28, |
| 466 | FDK_METADATATRANSCODER = 29, |
| 467 | FDK_AC3DEC = 30, |
| 468 | FDK_PCMDMX = 31, |
| 469 | |
| 470 | FDK_MODULE_LAST |
| 471 | |
| 472 | } FDK_MODULE_ID; |
| 473 | |
| 474 | /* AAC capability flags */ |
| 475 | #define CAPF_AAC_LC 0x00000001 /**< Support flag for AAC Low Complexity. */ |
| 476 | #define CAPF_ER_AAC_LD 0x00000002 /**< Support flag for AAC Low Delay with Error Resilience tools. */ |
| 477 | #define CAPF_ER_AAC_SCAL 0x00000004 /**< Support flag for AAC Scalable. */ |
| 478 | #define CAPF_ER_AAC_LC 0x00000008 /**< Support flag for AAC Low Complexity with Error Resilience tools. */ |
| 479 | #define CAPF_AAC_480 0x00000010 /**< Support flag for AAC with 480 framelength. */ |
| 480 | #define CAPF_AAC_512 0x00000020 /**< Support flag for AAC with 512 framelength. */ |
| 481 | #define CAPF_AAC_960 0x00000040 /**< Support flag for AAC with 960 framelength. */ |
| 482 | #define CAPF_AAC_1024 0x00000080 /**< Support flag for AAC with 1024 framelength. */ |
| 483 | #define CAPF_AAC_HCR 0x00000100 /**< Support flag for AAC with Huffman Codeword Reordering. */ |
| 484 | #define CAPF_AAC_VCB11 0x00000200 /**< Support flag for AAC Virtual Codebook 11. */ |
| 485 | #define CAPF_AAC_RVLC 0x00000400 /**< Support flag for AAC Reversible Variable Length Coding. */ |
| 486 | #define CAPF_AAC_MPEG4 0x00000800 /**< Support flag for MPEG file format. */ |
| 487 | #define CAPF_AAC_DRC 0x00001000 /**< Support flag for AAC Dynamic Range Control. */ |
| 488 | #define CAPF_AAC_CONCEALMENT 0x00002000 /**< Support flag for AAC concealment. */ |
| 489 | #define CAPF_AAC_DRM_BSFORMAT 0x00004000 /**< Support flag for AAC DRM bistream format. */ |
| 490 | #define CAPF_ER_AAC_ELD 0x00008000 /**< Support flag for AAC Enhanced Low Delay with Error Resilience tools. */ |
| 491 | #define CAPF_ER_AAC_BSAC 0x00010000 /**< Support flag for AAC BSAC. */ |
| 492 | #define CAPF_AAC_SUPERFRAMING 0x00020000 /**< Support flag for AAC Superframing. */ |
| 493 | |
| 494 | /* Transport capability flags */ |
| 495 | #define CAPF_ADTS 0x00000001 /**< Support flag for ADTS transport format. */ |
| 496 | #define CAPF_ADIF 0x00000002 /**< Support flag for ADIF transport format. */ |
| 497 | #define CAPF_LATM 0x00000004 /**< Support flag for LATM transport format. */ |
| 498 | #define CAPF_LOAS 0x00000008 /**< Support flag for LOAS transport format. */ |
| 499 | #define CAPF_RAWPACKETS 0x00000010 /**< Support flag for RAW PACKETS transport format. */ |
| 500 | #define CAPF_DRM 0x00000020 /**< Support flag for DRM/DRM+ transport format. */ |
| 501 | #define CAPF_RSVD50 0x00000040 /**< Support flag for RSVD50 transport format */ |
| 502 | |
| 503 | /* SBR capability flags */ |
| 504 | #define CAPF_SBR_LP 0x00000001 /**< Support flag for SBR Low Power mode. */ |
| 505 | #define CAPF_SBR_HQ 0x00000002 /**< Support flag for SBR High Quality mode. */ |
| 506 | #define CAPF_SBR_DRM_BS 0x00000004 /**< Support flag for */ |
| 507 | #define CAPF_SBR_CONCEALMENT 0x00000008 /**< Support flag for SBR concealment. */ |
| 508 | #define CAPF_SBR_DRC 0x00000010 /**< Support flag for SBR Dynamic Range Control. */ |
| 509 | #define CAPF_SBR_PS_MPEG 0x00000020 /**< Support flag for MPEG Parametric Stereo. */ |
| 510 | #define CAPF_SBR_PS_DRM 0x00000040 /**< Support flag for DRM Parametric Stereo. */ |
| 511 | |
| 512 | /* MP2 encoder capability flags */ |
| 513 | #define CAPF_MP2ENC_SS 0x00000001 /**< Support flag for Seamless Switching. */ |
| 514 | #define CAPF_MP2ENC_DAB 0x00000002 /**< Support flag for Layer2 DAB. */ |
| 515 | |
| 516 | /* DAB capability flags */ |
| 517 | #define CAPF_DAB_MP2 0x00000001 /**< Support flag for Layer2 DAB. */ |
| 518 | #define CAPF_DAB_AAC 0x00000002 /**< Support flag for DAB+ (HE-AAC v2). */ |
| 519 | #define CAPF_DAB_PAD 0x00000004 /**< Support flag for PAD extraction. */ |
| 520 | #define CAPF_DAB_DRC 0x00000008 /**< Support flag for Dynamic Range Control. */ |
| 521 | #define CAPF_DAB_SURROUND 0x00000010 /**< Support flag for DAB Surround (MPS). */ |
| 522 | |
| 523 | /* DMB capability flags */ |
| 524 | #define CAPF_DMB_BSAC 0x00000001 /**< Support flag for ER AAC BSAC. */ |
| 525 | #define CAPF_DMB_DRC 0x00000008 /**< Support flag for Dynamic Range Control. */ |
| 526 | #define CAPF_DMB_SURROUND 0x00000010 /**< Support flag for DMB Surround (MPS). */ |
| 527 | |
| 528 | /* PCM up/downmmix capability flags */ |
| 529 | #define CAPF_DMX_BLIND 0x00000001 /**< Support flag for blind downmixing. */ |
| 530 | #define CAPF_DMX_PCE 0x00000002 /**< Support flag for guided downmix with data from MPEG-2/4 Program Config Elements (PCE). */ |
| 531 | #define CAPF_DMX_ARIB 0x00000004 /**< Support flag for PCE guided downmix with slightly different equations and levels to fulfill ARIB standard. */ |
| 532 | #define CAPF_DMX_DVB 0x00000008 /**< Support flag for guided downmix with data from DVB ancillary data fields. */ |
| 533 | #define CAPF_DMX_CH_EXP 0x00000010 /**< Support flag for simple upmixing by dublicating channels or adding zero channels. */ |
| 534 | /* \endcond */ |
| 535 | |
| 536 | |
| 537 | /* |
| 538 | * ############################################################################################## |
| 539 | * Library versioning |
| 540 | * ############################################################################################## |
| 541 | */ |
| 542 | |
| 543 | /** |
| 544 | * Convert each member of version numbers to one single numeric version representation. |
| 545 | * \param lev0 1st level of version number. |
| 546 | * \param lev1 2nd level of version number. |
| 547 | * \param lev2 3rd level of version number. |
| 548 | */ |
| 549 | #define LIB_VERSION(lev0, lev1, lev2) ((lev0<<24 & 0xff000000) | \ |
| 550 | (lev1<<16 & 0x00ff0000) | \ |
| 551 | (lev2<<8 & 0x0000ff00)) |
| 552 | |
| 553 | /** |
| 554 | * Build text string of version. |
| 555 | */ |
| 556 | #define LIB_VERSION_STRING(info) FDKsprintf((info)->versionStr, "%d.%d.%d", (((info)->version >> 24) & 0xff), (((info)->version >> 16) & 0xff), (((info)->version >> 8 ) & 0xff)) |
| 557 | |
| 558 | /** |
| 559 | * Library information. |
| 560 | */ |
| 561 | typedef struct LIB_INFO |
| 562 | { |
| 563 | const char* title; |
| 564 | const char* build_date; |
| 565 | const char* build_time; |
| 566 | FDK_MODULE_ID module_id; |
| 567 | INT version; |
| 568 | UINT flags; |
| 569 | char versionStr[32]; |
| 570 | } LIB_INFO; |
| 571 | |
| 572 | /** Initialize library info. */ |
| 573 | static inline void FDKinitLibInfo( LIB_INFO* info ) |
| 574 | { |
| 575 | int i; |
| 576 | |
| 577 | for (i = 0; i < FDK_MODULE_LAST; i++) { |
| 578 | info[i].module_id = FDK_NONE; |
| 579 | } |
| 580 | } |
| 581 | |
| 582 | /** Aquire supported features of library. */ |
| 583 | static inline UINT FDKlibInfo_getCapabilities( const LIB_INFO* info, FDK_MODULE_ID module_id ) |
| 584 | { |
| 585 | int i; |
| 586 | |
| 587 | for (i=0; i<FDK_MODULE_LAST; i++) { |
| 588 | if (info[i].module_id == module_id) { |
| 589 | return info[i].flags; |
| 590 | } |
| 591 | } |
| 592 | return 0; |
| 593 | } |
| 594 | |
| 595 | /** Search for next free tab. */ |
| 596 | static inline INT FDKlibInfo_lookup( const LIB_INFO* info, FDK_MODULE_ID module_id ) |
| 597 | { |
| 598 | int i = -1; |
| 599 | |
| 600 | for (i = 0; i < FDK_MODULE_LAST; i++) { |
| 601 | if (info[i].module_id == module_id) |
| 602 | return -1; |
| 603 | if (info[i].module_id == FDK_NONE) |
| 604 | break; |
| 605 | } |
| 606 | if (i == FDK_MODULE_LAST) |
| 607 | return -1; |
| 608 | |
| 609 | return i; |
| 610 | } |
| 611 | |
| 612 | |
| 613 | /* |
| 614 | * ############################################################################################## |
| 615 | * Buffer description |
| 616 | * ############################################################################################## |
| 617 | */ |
| 618 | |
| 619 | /** |
| 620 | * I/O buffer descriptor. |
| 621 | */ |
| 622 | typedef struct FDK_bufDescr |
| 623 | { |
| 624 | void **ppBase; /*!< Pointer to an array containing buffer base addresses. |
| 625 | Set to NULL for buffer requirement info. */ |
| 626 | UINT *pBufSize; /*!< Pointer to an array containing the number of elements that can |
| 627 | be placed in the specific buffer. */ |
| 628 | UINT *pEleSize; /*!< Pointer to an array containing the element size for each buffer |
| 629 | in bytes. That is mostly the number returned by the sizeof() |
| 630 | operator for the data type used for the specific buffer. */ |
| 631 | UINT *pBufType; /*!< Pointer to an array of bit fields containing a description |
| 632 | for each buffer. See XXX below for more details. */ |
| 633 | UINT numBufs; /*!< Total number of buffers. */ |
| 634 | |
| 635 | } FDK_bufDescr; |
| 636 | |
| 637 | /** |
| 638 | * Buffer type description field. |
| 639 | */ |
| 640 | #define FDK_BUF_TYPE_MASK_IO ( 0x03 << 30 ) |
| 641 | #define FDK_BUF_TYPE_MASK_DESCR ( 0x3F << 16 ) |
| 642 | #define FDK_BUF_TYPE_MASK_ID ( 0xFF ) |
| 643 | |
| 644 | #define FDK_BUF_TYPE_INPUT ( 0x1 << 30 ) |
| 645 | #define FDK_BUF_TYPE_OUTPUT ( 0x2 << 30 ) |
| 646 | |
| 647 | #define FDK_BUF_TYPE_PCM_DATA ( 0x1 << 16 ) |
| 648 | #define FDK_BUF_TYPE_ANC_DATA ( 0x2 << 16 ) |
| 649 | #define FDK_BUF_TYPE_BS_DATA ( 0x4 << 16 ) |
| 650 | |
| 651 | #ifdef __cplusplus |
| 652 | } |
| 653 | #endif |
| 654 | |
| 655 | #endif /* FDK_AUDIO_H */ |