GNU Radio's DAB Package
neaacdec.h
Go to the documentation of this file.
1 /*
2 ** FAAD2 - Freeware Advanced Audio (AAC) Decoder including SBR decoding
3 ** Copyright (C) 2003-2005 M. Bakker, Nero AG, http://www.nero.com
4 **
5 ** This program is free software; you can redistribute it and/or modify
6 ** it under the terms of the GNU General Public License as published by
7 ** the Free Software Foundation; either version 2 of the License, or
8 ** (at your option) any later version.
9 **
10 ** This program is distributed in the hope that it will be useful,
11 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ** GNU General Public License for more details.
14 **
15 ** You should have received a copy of the GNU General Public License
16 ** along with this program; if not, write to the Free Software
17 ** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
18 ** MA 02110-1301 USA
19 **
20 ** Any non-GPL usage of this software or parts of this software is strictly
21 ** forbidden.
22 **
23 ** The "appropriate copyright message" mentioned in section 2c of the GPLv2
24 ** must read: "Code from FAAD2 is copyright (c) Nero AG, www.nero.com"
25 **
26 ** Commercial non-GPL licensing of this software is possible.
27 ** For more info contact Nero AG through Mpeg4AAClicense@nero.com.
28 **
29 ** $Id: neaacdec.h,v 1.13 2009/01/26 23:51:15 menno Exp $
30 **/
31 
32 #ifndef __NEAACDEC_H__
33 #define __NEAACDEC_H__
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif /* __cplusplus */
38 
39 
40 #if 1
41 /* MACROS FOR BACKWARDS COMPATIBILITY */
42 /* structs */
43 #define faacDecHandle NeAACDecHandle
44 #define faacDecConfiguration NeAACDecConfiguration
45 #define faacDecConfigurationPtr NeAACDecConfigurationPtr
46 #define faacDecFrameInfo NeAACDecFrameInfo
47 /* functions */
48 #define faacDecGetErrorMessage NeAACDecGetErrorMessage
49 #define faacDecSetConfiguration NeAACDecSetConfiguration
50 #define faacDecGetCurrentConfiguration NeAACDecGetCurrentConfiguration
51 #define faacDecInit NeAACDecInit
52 #define faacDecInit2 NeAACDecInit2
53 #define faacDecInitDRM NeAACDecInitDRM
54 #define faacDecInitDAB NeAACDecInitDAB
55 #define faacDecPostSeekReset NeAACDecPostSeekReset
56 #define faacDecOpen NeAACDecOpen
57 #define faacDecClose NeAACDecClose
58 #define faacDecDecode NeAACDecDecode
59 #define AudioSpecificConfig NeAACDecAudioSpecificConfig
60 #endif
61 
62 
63 #ifdef _WIN32
64  #pragma pack(push, 8)
65  #ifndef NEAACDECAPI
66  #define NEAACDECAPI __cdecl
67  #endif
68 #else
69  #ifndef NEAACDECAPI
70  #define NEAACDECAPI
71  #endif
72 #endif
73 
74 #define FAAD2_VERSION "2.7"
75 
76 /* object types for AAC */
77 #define MAIN 1
78 #define LC 2
79 #define SSR 3
80 #define LTP 4
81 #define HE_AAC 5
82 #define ER_LC 17
83 #define ER_LTP 19
84 #define LD 23
85 #define DRM_ER_LC 27 /* special object type for DRM */
86 
87 /* header types */
88 #define RAW 0
89 #define ADIF 1
90 #define ADTS 2
91 #define LATM 3
92 
93 /* SBR signalling */
94 #define NO_SBR 0
95 #define SBR_UPSAMPLED 1
96 #define SBR_DOWNSAMPLED 2
97 #define NO_SBR_UPSAMPLED 3
98 
99 /* library output formats */
100 #define FAAD_FMT_16BIT 1
101 #define FAAD_FMT_24BIT 2
102 #define FAAD_FMT_32BIT 3
103 #define FAAD_FMT_FLOAT 4
104 #define FAAD_FMT_FIXED FAAD_FMT_FLOAT
105 #define FAAD_FMT_DOUBLE 5
106 
107 /* Capabilities */
108 #define LC_DEC_CAP (1<<0) /* Can decode LC */
109 #define MAIN_DEC_CAP (1<<1) /* Can decode MAIN */
110 #define LTP_DEC_CAP (1<<2) /* Can decode LTP */
111 #define LD_DEC_CAP (1<<3) /* Can decode LD */
112 #define ERROR_RESILIENCE_CAP (1<<4) /* Can decode ER */
113 #define FIXED_POINT_CAP (1<<5) /* Fixed point */
114 
115 /* Channel definitions */
116 #define FRONT_CHANNEL_CENTER (1)
117 #define FRONT_CHANNEL_LEFT (2)
118 #define FRONT_CHANNEL_RIGHT (3)
119 #define SIDE_CHANNEL_LEFT (4)
120 #define SIDE_CHANNEL_RIGHT (5)
121 #define BACK_CHANNEL_LEFT (6)
122 #define BACK_CHANNEL_RIGHT (7)
123 #define BACK_CHANNEL_CENTER (8)
124 #define LFE_CHANNEL (9)
125 #define UNKNOWN_CHANNEL (0)
126 
127 /* DRM channel definitions */
128 #define DRMCH_MONO 1
129 #define DRMCH_STEREO 2
130 #define DRMCH_SBR_MONO 3
131 #define DRMCH_SBR_STEREO 4
132 #define DRMCH_SBR_PS_STEREO 5
133 
134 
135 /* A decode call can eat up to FAAD_MIN_STREAMSIZE bytes per decoded channel,
136  so at least so much bytes per channel should be available in this stream */
137 #define FAAD_MIN_STREAMSIZE 768 /* 6144 bits/channel */
138 
139 
140 typedef void *NeAACDecHandle;
141 
143 {
144  /* Audio Specific Info */
145  unsigned char objectTypeIndex;
146  unsigned char samplingFrequencyIndex;
147  unsigned long samplingFrequency;
148  unsigned char channelsConfiguration;
149 
150  /* GA Specific Info */
151  unsigned char frameLengthFlag;
152  unsigned char dependsOnCoreCoder;
153  unsigned short coreCoderDelay;
154  unsigned char extensionFlag;
158  unsigned char epConfig;
159 
164 
165 typedef struct NeAACDecConfiguration
166 {
167  unsigned char defObjectType;
168  unsigned long defSampleRate;
169  unsigned char outputFormat;
170  unsigned char downMatrix;
171  unsigned char useOldADTSFormat;
172  unsigned char dontUpSampleImplicitSBR;
174 
175 typedef struct NeAACDecFrameInfo
176 {
177  unsigned long bytesconsumed;
178  unsigned long samples;
179  unsigned char channels;
180  unsigned char error;
181  unsigned long samplerate;
182 
183  /* SBR: 0: off, 1: on; upsample, 2: on; downsampled, 3: off; upsampled */
184  unsigned char sbr;
185 
186  /* MPEG-4 ObjectType */
187  unsigned char object_type;
188 
189  /* AAC header type; MP4 will be signalled as RAW also */
190  unsigned char header_type;
191 
192  /* multichannel configuration */
193  unsigned char num_front_channels;
194  unsigned char num_side_channels;
195  unsigned char num_back_channels;
196  unsigned char num_lfe_channels;
197  unsigned char channel_position[64];
198 
199  /* PS: 0: off, 1: on */
200  unsigned char ps;
202 
203 char* NEAACDECAPI NeAACDecGetErrorMessage(unsigned char errcode);
204 
205 unsigned long NEAACDECAPI NeAACDecGetCapabilities(void);
206 
208 
210 
212  NeAACDecConfigurationPtr config);
213 
214 /* Init the library based on info from the AAC file (ADTS/ADIF) */
216  unsigned char *buffer,
217  unsigned long buffer_size,
218  unsigned long *samplerate,
219  unsigned char *channels);
220 
221 /* Init the library using a DecoderSpecificInfo */
223  unsigned char *pBuffer,
224  unsigned long SizeOfDecoderSpecificInfo,
225  unsigned long *samplerate,
226  unsigned char *channels);
227 
228 /* Init the library for DRM */
230  unsigned long samplerate,
231  unsigned char channels);
232 
234  unsigned long samplerate,
235  unsigned char channels,
236  unsigned char sbr);
237 
238 void NEAACDECAPI NeAACDecPostSeekReset(NeAACDecHandle hDecoder, long frame);
239 
241 
243  NeAACDecFrameInfo *hInfo,
244  unsigned char *buffer,
245  unsigned long buffer_size);
246 
248  NeAACDecFrameInfo *hInfo,
249  unsigned char *buffer,
250  unsigned long buffer_size,
251  void **sample_buffer,
252  unsigned long sample_buffer_size);
253 
254 char NEAACDECAPI NeAACDecAudioSpecificConfig(unsigned char *pBuffer,
255  unsigned long buffer_size,
256  mp4AudioSpecificConfig *mp4ASC);
257 
258 #ifdef _WIN32
259  #pragma pack(pop)
260 #endif
261 
262 #ifdef __cplusplus
263 }
264 #endif /* __cplusplus */
265 
266 #endif
void NEAACDECAPI NeAACDecClose(NeAACDecHandle hDecoder)
#define NEAACDECAPI
Definition: neaacdec.h:70
unsigned char aacSectionDataResilienceFlag
Definition: neaacdec.h:155
char *NEAACDECAPI NeAACDecGetErrorMessage(unsigned char errcode)
unsigned char channel_position[64]
Definition: neaacdec.h:197
unsigned char error
Definition: neaacdec.h:180
struct NeAACDecConfiguration * NeAACDecConfigurationPtr
unsigned char NEAACDECAPI NeAACDecSetConfiguration(NeAACDecHandle hDecoder, NeAACDecConfigurationPtr config)
struct NeAACDecFrameInfo NeAACDecFrameInfo
void * NeAACDecHandle
Definition: neaacdec.h:140
unsigned char defObjectType
Definition: neaacdec.h:167
unsigned char sbr
Definition: neaacdec.h:184
unsigned char num_back_channels
Definition: neaacdec.h:195
char forceUpSampling
Definition: neaacdec.h:161
unsigned char objectTypeIndex
Definition: neaacdec.h:145
char NEAACDECAPI NeAACDecInitDAB(NeAACDecHandle *hDecoder, unsigned long samplerate, unsigned char channels, unsigned char sbr)
char NEAACDECAPI NeAACDecInitDRM(NeAACDecHandle *hDecoder, unsigned long samplerate, unsigned char channels)
void NEAACDECAPI NeAACDecPostSeekReset(NeAACDecHandle hDecoder, long frame)
unsigned char num_side_channels
Definition: neaacdec.h:194
unsigned long NEAACDECAPI NeAACDecGetCapabilities(void)
unsigned char downMatrix
Definition: neaacdec.h:170
struct mp4AudioSpecificConfig mp4AudioSpecificConfig
NeAACDecConfigurationPtr NEAACDECAPI NeAACDecGetCurrentConfiguration(NeAACDecHandle hDecoder)
unsigned char useOldADTSFormat
Definition: neaacdec.h:171
void *NEAACDECAPI NeAACDecDecode(NeAACDecHandle hDecoder, NeAACDecFrameInfo *hInfo, unsigned char *buffer, unsigned long buffer_size)
unsigned char channels
Definition: neaacdec.h:179
unsigned long defSampleRate
Definition: neaacdec.h:168
struct NeAACDecConfiguration NeAACDecConfiguration
long NEAACDECAPI NeAACDecInit(NeAACDecHandle hDecoder, unsigned char *buffer, unsigned long buffer_size, unsigned long *samplerate, unsigned char *channels)
unsigned char object_type
Definition: neaacdec.h:187
unsigned char header_type
Definition: neaacdec.h:190
unsigned char ps
Definition: neaacdec.h:200
char sbr_present_flag
Definition: neaacdec.h:160
unsigned long samples
Definition: neaacdec.h:178
unsigned char extensionFlag
Definition: neaacdec.h:154
unsigned long bytesconsumed
Definition: neaacdec.h:177
unsigned char dependsOnCoreCoder
Definition: neaacdec.h:152
unsigned char aacScalefactorDataResilienceFlag
Definition: neaacdec.h:156
unsigned char outputFormat
Definition: neaacdec.h:169
unsigned long samplingFrequency
Definition: neaacdec.h:147
unsigned char samplingFrequencyIndex
Definition: neaacdec.h:146
unsigned char channelsConfiguration
Definition: neaacdec.h:148
unsigned long samplerate
Definition: neaacdec.h:181
char NEAACDECAPI NeAACDecAudioSpecificConfig(unsigned char *pBuffer, unsigned long buffer_size, mp4AudioSpecificConfig *mp4ASC)
NeAACDecHandle NEAACDECAPI NeAACDecOpen(void)
unsigned char epConfig
Definition: neaacdec.h:158
void *NEAACDECAPI NeAACDecDecode2(NeAACDecHandle hDecoder, NeAACDecFrameInfo *hInfo, unsigned char *buffer, unsigned long buffer_size, void **sample_buffer, unsigned long sample_buffer_size)
unsigned short coreCoderDelay
Definition: neaacdec.h:153
unsigned char num_front_channels
Definition: neaacdec.h:193
Definition: neaacdec.h:142
unsigned char num_lfe_channels
Definition: neaacdec.h:196
unsigned char dontUpSampleImplicitSBR
Definition: neaacdec.h:172
unsigned char frameLengthFlag
Definition: neaacdec.h:151
Definition: neaacdec.h:165
char NEAACDECAPI NeAACDecInit2(NeAACDecHandle hDecoder, unsigned char *pBuffer, unsigned long SizeOfDecoderSpecificInfo, unsigned long *samplerate, unsigned char *channels)
Definition: neaacdec.h:175
char downSampledSBR
Definition: neaacdec.h:162
unsigned char aacSpectralDataResilienceFlag
Definition: neaacdec.h:157