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