Imported Debian version 0.1.3.1
[deb_fdk-aac.git] / libAACdec / src / conceal_types.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-4 AAC Decoder **************************
85
86 Author(s): Christian Griebel
87 Description: Error concealment structs and types
88
89 ******************************************************************************/
90
91 #ifndef CONCEAL_TYPES_H
92 #define CONCEAL_TYPES_H
93
94
95
96 #include "machine_type.h"
97 #include "common_fix.h"
98
99 #include "rvlc_info.h"
100
101
102 #define CONCEAL_MAX_NUM_FADE_FACTORS ( 16 )
103
104 #define FIXP_CNCL FIXP_DBL
105 #define FL2FXCONST_CNCL FL2FXCONST_DBL
106 #define FX_DBL2FX_CNCL
107 #define FX_CNCL2FX_DBL
108 #define CNCL_FRACT_BITS DFRACT_BITS
109
110 /* Warning: Do not ever change these values. */
111 typedef enum
112 {
113 ConcealMethodNone = -1,
114 ConcealMethodMute = 0,
115 ConcealMethodNoise = 1,
116 ConcealMethodInter = 2,
117 ConcealMethodTonal = 3
118
119 } CConcealmentMethod;
120
121
122 typedef enum
123 {
124 ConcealState_Ok,
125 ConcealState_Single,
126 ConcealState_FadeIn,
127 ConcealState_Mute,
128 ConcealState_FadeOut
129
130 } CConcealmentState;
131
132
133 typedef struct
134 {
135 FIXP_SGL fadeOutFactor[CONCEAL_MAX_NUM_FADE_FACTORS];
136 FIXP_SGL fadeInFactor [CONCEAL_MAX_NUM_FADE_FACTORS];
137
138 CConcealmentMethod method;
139
140 int numFadeOutFrames;
141 int numFadeInFrames;
142 int numMuteReleaseFrames;
143 int comfortNoiseLevel;
144
145 } CConcealParams;
146
147
148
149 typedef struct
150 {
151 CConcealParams *pConcealParams;
152
153 FIXP_CNCL spectralCoefficient[1024];
154 SHORT specScale[8];
155
156 INT iRandomPhase;
157 INT prevFrameOk[2];
158 INT cntFadeFrames;
159 INT cntValidFrames;
160
161 SHORT aRvlcPreviousScaleFactor[RVLC_MAX_SFB]; /* needed once per channel */
162 UCHAR aRvlcPreviousCodebook[RVLC_MAX_SFB]; /* needed once per channel */
163 SCHAR rvlcPreviousScaleFactorOK;
164 SCHAR rvlcPreviousBlockType;
165
166
167 SCHAR lastRenderMode;
168
169 UCHAR windowShape;
170 UCHAR windowSequence;
171 UCHAR lastWinGrpLen;
172
173 CConcealmentState concealState;
174
175 } CConcealmentInfo;
176
177
178 #endif /* #ifndef CONCEAL_TYPES_H */