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