Imported Debian version 0.1.3.1
[deb_fdk-aac.git] / libAACenc / src / interface.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 /******************************** MPEG Audio Encoder **************************
85
86 Initial author: M.Werner
87 contents/description: Interface psychoaccoustic/quantizer
88
89 ******************************************************************************/
90
91 #ifndef _INTERFACE_H
92 #define _INTERFACE_H
93
94 #include "common_fix.h"
95 #include "FDK_audio.h"
96
97 #include "psy_data.h"
98 #include "aacenc_tns.h"
99
100 enum
101 {
102 MS_NONE = 0,
103 MS_SOME = 1,
104 MS_ALL = 2
105 };
106
107 enum
108 {
109 MS_ON = 1
110 };
111
112 struct TOOLSINFO {
113 INT msDigest; /* 0 = no MS; 1 = some MS, 2 = all MS */
114 INT msMask[MAX_GROUPED_SFB];
115 };
116
117
118 typedef struct {
119 INT sfbCnt;
120 INT sfbPerGroup;
121 INT maxSfbPerGroup;
122 INT lastWindowSequence;
123 INT windowShape;
124 INT groupingMask;
125 INT sfbOffsets[MAX_GROUPED_SFB+1];
126
127 INT mdctScale; /* number of transform shifts */
128 INT groupLen[MAX_NO_OF_GROUPS];
129
130 TNS_INFO tnsInfo;
131 INT noiseNrg[MAX_GROUPED_SFB];
132 INT isBook[MAX_GROUPED_SFB];
133 INT isScale[MAX_GROUPED_SFB];
134
135 /* memory located in QC_OUT_CHANNEL */
136 FIXP_DBL *mdctSpectrum;
137 FIXP_DBL *sfbEnergy;
138 FIXP_DBL *sfbSpreadEnergy;
139 FIXP_DBL *sfbThresholdLdData;
140 FIXP_DBL *sfbMinSnrLdData;
141 FIXP_DBL *sfbEnergyLdData;
142
143
144 }PSY_OUT_CHANNEL;
145
146 typedef struct {
147
148 /* information specific to each channel */
149 PSY_OUT_CHANNEL* psyOutChannel[(2)];
150
151 /* information shared by both channels */
152 INT commonWindow;
153 struct TOOLSINFO toolsInfo;
154
155 } PSY_OUT_ELEMENT;
156
157 typedef struct {
158
159 PSY_OUT_ELEMENT* psyOutElement[(8)];
160 PSY_OUT_CHANNEL* pPsyOutChannels[(8)];
161
162 }PSY_OUT;
163
164 inline int isLowDelay( AUDIO_OBJECT_TYPE aot )
165 {
166 return (aot==AOT_ER_AAC_LD || aot==AOT_ER_AAC_ELD);
167 }
168
169 #endif /* _INTERFACE_H */