libSYS/include/FDK_audio.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 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
 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
 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
 235 /** Channel Mode ( 1-7 equals MPEG channel configurations, others are arbitrary). */
 236 typedef enum {
 237   MODE_INVALID                  = -1,
 238   MODE_UNKNOWN                  =  0,
 239   MODE_1                        =  1,       /**< C */
 240   MODE_2                        =  2,       /**< L+R */
 241   MODE_1_2                      =  3,       /**< C, L+R */
 242   MODE_1_2_1                    =  4,       /**< C, L+R, Rear */
 243   MODE_1_2_2                    =  5,       /**< C, L+R, LS+RS */
 244   MODE_1_2_2_1                  =  6,       /**< C, L+R, LS+RS, LFE */
 245   MODE_1_2_2_2_1                =  7,       /**< C, LC+RC, L+R, LS+RS, LFE */
 246
 247
 248   MODE_1_1                      = 16,       /**< 2 SCEs (dual mono) */
 249   MODE_1_1_1_1                  = 17,       /**< 4 SCEs */
 250   MODE_1_1_1_1_1_1              = 18,       /**< 6 SCEs */
 251   MODE_1_1_1_1_1_1_1_1          = 19,       /**< 8 SCEs */
 252   MODE_1_1_1_1_1_1_1_1_1_1_1_1  = 20,       /**< 12 SCEs */
 253
 254   MODE_2_2                      = 21,       /**< 2 CPEs */
 255   MODE_2_2_2                    = 22,       /**< 3 CPEs */
 256   MODE_2_2_2_2                  = 23,       /**< 4 CPEs */
 257   MODE_2_2_2_2_2_2              = 24,       /**< 6 CPEs */
 258
 259   MODE_2_1                      = 30,       /**< CPE,SCE (ARIB standard B32) */
 260
 261   MODE_7_1_REAR_SURROUND        = 33,       /**< C, L+R, LS+RS, Lrear+Rrear, LFE */
 262   MODE_7_1_FRONT_CENTER         = 34        /**< C, LC+RC, L+R, LS+RS, LFE */
 263
 264 } CHANNEL_MODE;
 265
 266 /** Speaker description tags */
 267 typedef enum {
 268   ACT_NONE,
 269   ACT_FRONT,
 270   ACT_SIDE,
 271   ACT_BACK,
 272   ACT_LFE,
 273   ACT_FRONT_TOP,
 274   ACT_SIDE_TOP,
 275   ACT_BACK_TOP,
 276   ACT_TOP /* Ts */
 277 } AUDIO_CHANNEL_TYPE;
 278
 279 typedef enum
 280 {
 281   SIG_UNKNOWN                 = -1,
 282   SIG_IMPLICIT                =  0,
 283   SIG_EXPLICIT_BW_COMPATIBLE  =  1,
 284   SIG_EXPLICIT_HIERARCHICAL   =  2
 285
 286 } SBR_PS_SIGNALING;
 287
 288 /**
 289  * Audio Codec flags.
 290  */
 291 #define AC_ER_VCB11     0x000001  /*!< aacSectionDataResilienceFlag     flag (from ASC): 1 means use virtual codebooks  */
 292 #define AC_ER_RVLC      0x000002  /*!< aacSpectralDataResilienceFlag     flag (from ASC): 1 means use huffman codeword reordering */
 293 #define AC_ER_HCR       0x000004  /*!< aacSectionDataResilienceFlag     flag (from ASC): 1 means use virtual codebooks  */
 294 #define AC_SCALABLE     0x000008  /*!< AAC Scalable*/
 295 #define AC_ELD          0x000010  /*!< AAC-ELD */
 296 #define AC_LD           0x000020  /*!< AAC-LD */
 297 #define AC_ER           0x000040  /*!< ER syntax */
 298 #define AC_BSAC         0x000080  /*!< BSAC */
 299 #define AC_USAC         0x000100  /*!< USAC */
 300 #define AC_USAC_TW      0x000200  /*!< USAC time warped filter bank is active */
 301 #define AC_USAC_NOISE   0x000400  /*!< USAC noise filling is active */
 302 #define AC_USAC_HBE     0x000800  /*!< USAC harmonic bandwidth extension is active */
 303 #define AC_RSVD50       0x001000  /*!< Rsvd50 */
 304 #define AC_SBR_PRESENT  0x002000  /*!< SBR present flag (from ASC)             */
 305 #define AC_SBRCRC       0x004000  /*!< SBR CRC present flag. Only relevant for AAC-ELD for now. */
 306 #define AC_PS_PRESENT   0x008000  /*!< PS present flag (from ASC or implicit)  */
 307 #define AC_MPS_PRESENT  0x010000  /*!< MPS present flag (from ASC or implicit) */
 308 #define AC_DRM          0x020000  /*!< DRM bit stream syntax */
 309 #define AC_INDEP        0x040000  /*!< Independency flag */
 310 #define AC_MPS_RES      0x080000  /*!< MPS residual individual channel data. */
 311 #define AC_DAB          0x800000  /*!< DAB bit stream syntax */
 312 #define AC_LD_MPS     0x01000000  /*!< Low Delay MPS. */
 313
 314
 315 /* CODER_CONFIG::flags */
 316 #define CC_MPEG_ID         0x00100000
 317 #define CC_IS_BASELAYER    0x00200000
 318 #define CC_PROTECTION      0x00400000
 319 #define CC_SBR             0x00800000
 320 #define CC_SBRCRC          0x00010000
 321 #define CC_RVLC            0x01000000
 322 #define CC_VCB11           0x02000000
 323 #define CC_HCR             0x04000000
 324 #define CC_PSEUDO_SURROUND 0x08000000
 325 #define CC_USAC_NOISE      0x10000000
 326 #define CC_USAC_TW         0x20000000
 327 #define CC_USAC_HBE        0x40000000
 328
 329 /** Generic audio coder configuration structure. */
 330 typedef struct {
 331   AUDIO_OBJECT_TYPE aot;         /**< Audio Object Type (AOT).           */
 332   AUDIO_OBJECT_TYPE extAOT;      /**< Extension Audio Object Type (SBR). */
 333   CHANNEL_MODE channelMode;      /**< Channel mode.                      */
 334   INT        samplingRate;       /**< Sampling rate.                     */
 335   INT        extSamplingRate;    /**< Extended samplerate (SBR).         */
 336   INT        bitRate;            /**< Average bitrate.                   */
 337   int        samplesPerFrame;    /**< Number of PCM samples per codec frame and audio channel. */
 338   int        noChannels;         /**< Number of audio channels.          */
 339   int        bitsFrame;
 340   int        nSubFrames;         /**< Amount of encoder subframes. 1 means no subframing.                                     */
 341   int        BSACnumOfSubFrame;  /**< The number of the sub-frames which are grouped and transmitted in a super-frame (BSAC). */
 342   int        BSAClayerLength;    /**< The average length of the large-step layers in bytes (BSAC).                            */
 343   UINT       flags;              /**< flags */
 344   UCHAR      matrixMixdownA;     /**< Matrix mixdown index to put into PCE. Default value 0 means no mixdown coefficient,
 345                                       valid values are 1-4 which correspond to matrix_mixdown_idx 0-3. */
 346   UCHAR      headerPeriod;       /**< Frame period for sending in band configuration buffers in the transport layer. */
 347
 348   UCHAR      stereoConfigIndex; /**< USAC MPS stereo mode */
 349   UCHAR      sbrMode;           /**< USAC SBR mode */
 350   SBR_PS_SIGNALING sbrSignaling;/**< 0: implicit signaling, 1: backwards compatible explicit signaling, 2: hierarcical explicit signaling */
 351
 352   UCHAR      sbrPresent;
 353   UCHAR      psPresent;
 354 } CODER_CONFIG;
 355
 356 /** MP4 Element IDs. */
 357 typedef enum
 358 {
 359   ID_NONE = -1,   /**< Invalid Element helper ID.             */
 360   ID_SCE = 0,     /**< Single Channel Element.                */
 361   ID_CPE = 1,     /**< Channel Pair Element.                  */
 362   ID_CCE = 2,     /**< Coupling Channel Element.              */
 363   ID_LFE = 3,     /**< LFE Channel Element.                   */
 364   ID_DSE = 4,     /**< Currently one Data Stream Element for ancillary data is supported. */
 365   ID_PCE = 5,     /**< Program Config Element.                */
 366   ID_FIL = 6,     /**< Fill Element.                          */
 367   ID_END = 7,     /**< Arnie (End Element = Terminator).      */
 368   ID_EXT = 8,     /**< Extension Payload (ER only).           */
 369   ID_SCAL = 9,    /**< AAC scalable element (ER only).        */
 370   ID_LAST
 371 } MP4_ELEMENT_ID;
 372
 373 #define IS_CHANNEL_ELEMENT(elementId) \
 374   ((elementId) == ID_SCE \
 375 || (elementId) == ID_CPE \
 376 || (elementId) == ID_LFE)
 377
 378 #define EXT_ID_BITS 4  /**< Size in bits of extension payload type tags. */
 379
 380 /** Extension payload types. */
 381 typedef enum {
 382   EXT_FIL           = 0x00,
 383   EXT_FILL_DATA     = 0x01,
 384   EXT_DATA_ELEMENT  = 0x02,
 385   EXT_DATA_LENGTH   = 0x03,
 386   EXT_LDSAC_DATA    = 0x09,
 387   EXT_SAOC_DATA     = 0x0a,
 388   EXT_DYNAMIC_RANGE = 0x0b,
 389   EXT_SAC_DATA      = 0x0c,
 390   EXT_SBR_DATA      = 0x0d,
 391   EXT_SBR_DATA_CRC  = 0x0e
 392 } EXT_PAYLOAD_TYPE;
 393
 394
 395 /**
 396  * Proprietary raw packet file configuration data type identifier.
 397  */
 398 typedef enum
 399 {
 400   TC_NOTHING = 0,     /* No configuration available -> in-band configuration.   */
 401   TC_RAW_ASC,         /* Configuration data field is a raw AudioSpecificConfig. */
 402   TC_RAW_SMC,         /* Configuration data field is a raw StreamMuxConfig.     */
 403   TC_RAW_SDC          /* Configuration data field is a raw Drm SDC.             */
 404
 405 } TP_CONFIG_TYPE;
 406
 407 /*
 408  * ##############################################################################################
 409  * Library identification and error handling
 410  * ##############################################################################################
 411  */
 412 /* \cond */
 413 #define MODULE_ID_MASK  (0x000000ff)
 414 #define MODULE_ID_SHIFT (24)
 415
 416 typedef enum {
 417   FDK_NONE   = 0,
 418   FDK_TOOLS  = 1,
 419   FDK_SYSLIB = 2,
 420   FDK_AACDEC = 3,
 421   FDK_AACENC = 4,
 422   FDK_SBRDEC = 5,
 423   FDK_SBRENC = 6,
 424   FDK_TPDEC  = 7,
 425   FDK_TPENC  = 8,
 426   FDK_MPSDEC = 9,
 427   FDK_MPEGFILEREAD  = 10,
 428   FDK_MPEGFILEWRITE = 11,
 429   FDK_MP2DEC = 12,
 430   FDK_DABDEC = 13,
 431   FDK_DABPARSE = 14,
 432   FDK_DRMDEC = 15,
 433   FDK_DRMPARSE = 16,
 434   FDK_AACLDENC = 17,
 435   FDK_MP2ENC = 18,
 436   FDK_MP3ENC = 19,
 437   FDK_MP3DEC = 20,
 438   FDK_MP3HEADPHONE = 21,
 439   FDK_MP3SDEC = 22,
 440   FDK_MP3SENC = 23,
 441   FDK_EAEC    = 24,
 442   FDK_DABENC  = 25,
 443   FDK_DMBDEC  = 26,
 444   FDK_FDREVERB = 27,
 445   FDK_DRMENC  = 28,
 446   FDK_METADATATRANSCODER = 29,
 447   FDK_AC3DEC = 30,
 448   FDK_PCMDMX = 31,
 449
 450   FDK_MODULE_LAST
 451
 452 } FDK_MODULE_ID;
 453
 454 /* AAC capability flags */
 455 #define CAPF_AAC_LC           0x00000001  /**< Support flag for AAC Low Complexity.                             */
 456 #define CAPF_ER_AAC_LD        0x00000002  /**< Support flag for AAC Low Delay with Error Resilience tools.      */
 457 #define CAPF_ER_AAC_SCAL      0x00000004  /**< Support flag for AAC Scalable.                                   */
 458 #define CAPF_ER_AAC_LC        0x00000008  /**< Support flag for AAC Low Complexity with Error Resilience tools. */
 459 #define CAPF_AAC_480          0x00000010  /**< Support flag for AAC with 480 framelength.  */
 460 #define CAPF_AAC_512          0x00000020  /**< Support flag for AAC with 512 framelength.  */
 461 #define CAPF_AAC_960          0x00000040  /**< Support flag for AAC with 960 framelength.  */
 462 #define CAPF_AAC_1024         0x00000080  /**< Support flag for AAC with 1024 framelength. */
 463 #define CAPF_AAC_HCR          0x00000100  /**< Support flag for AAC with Huffman Codeword Reordering.    */
 464 #define CAPF_AAC_VCB11        0x00000200  /**< Support flag for AAC Virtual Codebook 11.    */
 465 #define CAPF_AAC_RVLC         0x00000400  /**< Support flag for AAC Reversible Variable Length Coding.   */
 466 #define CAPF_AAC_MPEG4        0x00000800  /**< Support flag for MPEG file format.                           */
 467 #define CAPF_AAC_DRC          0x00001000  /**< Support flag for AAC Dynamic Range Control. */
 468 #define CAPF_AAC_CONCEALMENT  0x00002000  /**< Support flag for AAC concealment.           */
 469 #define CAPF_AAC_DRM_BSFORMAT 0x00004000  /**< Support flag for AAC DRM bistream format.                         */
 470 #define CAPF_ER_AAC_ELD       0x00008000  /**< Support flag for AAC Enhanced Low Delay with Error Resilience tools.  */
 471 #define CAPF_ER_AAC_BSAC      0x00010000  /**< Support flag for AAC BSAC.                           */
 472 #define CAPF_AAC_SUPERFRAMING 0x00020000  /**< Support flag for AAC Superframing.                           */
 473
 474 /* Transport capability flags */
 475 #define CAPF_ADTS             0x00000001  /**< Support flag for ADTS transport format.        */
 476 #define CAPF_ADIF             0x00000002  /**< Support flag for ADIF transport format.        */
 477 #define CAPF_LATM             0x00000004  /**< Support flag for LATM transport format.        */
 478 #define CAPF_LOAS             0x00000008  /**< Support flag for LOAS transport format.        */
 479 #define CAPF_RAWPACKETS       0x00000010  /**< Support flag for RAW PACKETS transport format. */
 480 #define CAPF_DRM              0x00000020  /**< Support flag for DRM/DRM+ transport format.    */
 481 #define CAPF_RSVD50           0x00000040  /**< Support flag for RSVD50 transport format       */
 482
 483 /* SBR capability flags */
 484 #define CAPF_SBR_LP           0x00000001  /**< Support flag for SBR Low Power mode.           */
 485 #define CAPF_SBR_HQ           0x00000002  /**< Support flag for SBR High Quality mode.        */
 486 #define CAPF_SBR_DRM_BS       0x00000004  /**< Support flag for                               */
 487 #define CAPF_SBR_CONCEALMENT  0x00000008  /**< Support flag for SBR concealment.              */
 488 #define CAPF_SBR_DRC          0x00000010  /**< Support flag for SBR Dynamic Range Control.    */
 489 #define CAPF_SBR_PS_MPEG      0x00000020  /**< Support flag for MPEG Parametric Stereo.       */
 490 #define CAPF_SBR_PS_DRM       0x00000040  /**< Support flag for DRM Parametric Stereo.        */
 491
 492 /* MP2 encoder capability flags */
 493 #define CAPF_MP2ENC_SS        0x00000001  /**< Support flag for Seamless Switching.           */
 494 #define CAPF_MP2ENC_DAB       0x00000002  /**< Support flag for Layer2 DAB.                   */
 495
 496 /* DAB capability flags */
 497 #define CAPF_DAB_MP2          0x00000001  /**< Support flag for Layer2 DAB.                   */
 498 #define CAPF_DAB_AAC          0x00000002  /**< Support flag for DAB+ (HE-AAC v2).             */
 499 #define CAPF_DAB_PAD          0x00000004  /**< Support flag for PAD extraction.               */
 500 #define CAPF_DAB_DRC          0x00000008  /**< Support flag for Dynamic Range Control.        */
 501 #define CAPF_DAB_SURROUND     0x00000010  /**< Support flag for DAB Surround (MPS).           */
 502
 503 /* DMB capability flags */
 504 #define CAPF_DMB_BSAC         0x00000001  /**< Support flag for ER AAC BSAC.                  */
 505 #define CAPF_DMB_DRC          0x00000008  /**< Support flag for Dynamic Range Control.        */
 506 #define CAPF_DMB_SURROUND     0x00000010  /**< Support flag for DMB Surround (MPS).           */
 507
 508 /* PCM up/downmmix capability flags */
 509 #define CAPF_DMX_BLIND        0x00000001  /**< Support flag for blind downmixing.             */
 510 #define CAPF_DMX_PCE          0x00000002  /**< Support flag for guided downmix with data from MPEG-2/4 Program Config Elements (PCE). */
 511 #define CAPF_DMX_ARIB         0x00000004  /**< Support flag for PCE guided downmix with slightly different equations and levels to fulfill ARIB standard. */
 512 #define CAPF_DMX_DVB          0x00000008  /**< Support flag for guided downmix with data from DVB ancillary data fields. */
 513 #define CAPF_DMX_CH_EXP       0x00000010  /**< Support flag for simple upmixing by dublicating channels or adding zero channels. */
 514 /* \endcond */
 515
 516
 517 /*
 518  * ##############################################################################################
 519  * Library versioning
 520  * ##############################################################################################
 521  */
 522
 523 /**
 524  * Convert each member of version numbers to one single numeric version representation.
 525  * \param lev0  1st level of version number.
 526  * \param lev1  2nd level of version number.
 527  * \param lev2  3rd level of version number.
 528   */
 529 #define LIB_VERSION(lev0, lev1, lev2) ((lev0<<24 & 0xff000000) | \
 530                                        (lev1<<16 & 0x00ff0000) | \
 531                                        (lev2<<8  & 0x0000ff00))
 532
 533 /**
 534  *  Build text string of version.
 535  */
 536 #define LIB_VERSION_STRING(info) FDKsprintf((info)->versionStr, "%d.%d.%d", (((info)->version >> 24) & 0xff), (((info)->version >> 16) & 0xff), (((info)->version >> 8 ) & 0xff))
 537
 538 /**
 539  *  Library information.
 540  */
 541 typedef struct LIB_INFO
 542 {
 543   const char* title;
 544   const char* build_date;
 545   const char* build_time;
 546   FDK_MODULE_ID module_id;
 547   INT version;
 548   UINT  flags;
 549   char versionStr[32];
 550 } LIB_INFO;
 551
 552 /** Initialize library info. */
 553 static inline void FDKinitLibInfo( LIB_INFO* info )
 554 {
 555   int i;
 556
 557   for (i = 0; i < FDK_MODULE_LAST; i++) {
 558     info[i].module_id = FDK_NONE;
 559   }
 560 }
 561
 562 /** Aquire supported features of library. */
 563 static inline UINT FDKlibInfo_getCapabilities( const LIB_INFO* info, FDK_MODULE_ID module_id )
 564 {
 565   int i;
 566
 567   for (i=0; i<FDK_MODULE_LAST; i++) {
 568     if (info[i].module_id == module_id) {
 569       return info[i].flags;
 570     }
 571   }
 572   return 0;
 573 }
 574
 575 /** Search for next free tab. */
 576 static inline INT FDKlibInfo_lookup( const LIB_INFO* info, FDK_MODULE_ID module_id )
 577 {
 578   int i = -1;
 579
 580   for (i = 0; i < FDK_MODULE_LAST; i++) {
 581     if (info[i].module_id == module_id)
 582       return -1;
 583     if (info[i].module_id == FDK_NONE)
 584       break;
 585   }
 586   if (i == FDK_MODULE_LAST)
 587     return -1;
 588
 589   return i;
 590 }
 591
 592
 593 /*
 594  * ##############################################################################################
 595  * Buffer description
 596  * ##############################################################################################
 597  */
 598
 599 /**
 600  *  I/O buffer descriptor.
 601  */
 602 typedef struct FDK_bufDescr
 603 {
 604   void  **ppBase;     /*!< Pointer to an array containing buffer base addresses.
 605                            Set to NULL for buffer requirement info. */
 606   UINT   *pBufSize;   /*!< Pointer to an array containing the number of elements that can
 607                            be placed in the specific buffer. */
 608   UINT   *pEleSize;   /*!< Pointer to an array containing the element size for each buffer
 609                            in bytes. That is mostly the number returned by the sizeof()
 610                            operator for the data type used for the specific buffer. */
 611   UINT   *pBufType;   /*!< Pointer to an array of bit fields containing a description
 612                            for each buffer. See XXX below for more details.  */
 613   UINT    numBufs;    /*!< Total number of buffers. */
 614
 615 } FDK_bufDescr;
 616
 617 /**
 618  * Buffer type description field.
 619  */
 620 #define FDK_BUF_TYPE_MASK_IO     ( 0x03 << 30 )
 621 #define FDK_BUF_TYPE_MASK_DESCR  ( 0x3F << 16 )
 622 #define FDK_BUF_TYPE_MASK_ID     ( 0xFF )
 623
 624 #define FDK_BUF_TYPE_INPUT       ( 0x1 << 30 )
 625 #define FDK_BUF_TYPE_OUTPUT      ( 0x2 << 30 )
 626
 627 #define FDK_BUF_TYPE_PCM_DATA    ( 0x1 << 16 )
 628 #define FDK_BUF_TYPE_ANC_DATA    ( 0x2 << 16 )
 629 #define FDK_BUF_TYPE_BS_DATA     ( 0x4 << 16 )
 630
 631 #ifdef __cplusplus
 632 }
 633 #endif
 634
 635 #endif /* FDK_AUDIO_H */