1 /* -----------------------------------------------------------------------------
2 Software License for The Fraunhofer FDK AAC Codec Library for Android
3 
4 © Copyright  1995 - 2019 Fraunhofer-Gesellschaft zur Förderung der angewandten
5 Forschung e.V. All rights reserved.
6 
7  1.    INTRODUCTION
8 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
9 that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
10 scheme for digital audio. This FDK AAC Codec software is intended to be used on
11 a wide variety of Android devices.
12 
13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
14 general perceptual audio codecs. AAC-ELD is considered the best-performing
15 full-bandwidth communications codec by independent studies and is widely
16 deployed. AAC has been standardized by ISO and IEC as part of the MPEG
17 specifications.
18 
19 Patent licenses for necessary patent claims for the FDK AAC Codec (including
20 those of Fraunhofer) may be obtained through Via Licensing
21 (www.vialicensing.com) or through the respective patent owners individually for
22 the purpose of encoding or decoding bit streams in products that are compliant
23 with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
24 Android devices already license these patent claims through Via Licensing or
25 directly from the patent owners, and therefore FDK AAC Codec software may
26 already be covered under those patent licenses when it is used for those
27 licensed purposes only.
28 
29 Commercially-licensed AAC software libraries, including floating-point versions
30 with enhanced sound quality, are also available from Fraunhofer. Users are
31 encouraged to check the Fraunhofer website for additional applications
32 information and documentation.
33 
34 2.    COPYRIGHT LICENSE
35 
36 Redistribution and use in source and binary forms, with or without modification,
37 are permitted without payment of copyright license fees provided that you
38 satisfy the following conditions:
39 
40 You must retain the complete text of this software license in redistributions of
41 the FDK AAC Codec or your modifications thereto in source code form.
42 
43 You must retain the complete text of this software license in the documentation
44 and/or other materials provided with redistributions of the FDK AAC Codec or
45 your modifications thereto in binary form. You must make available free of
46 charge copies of the complete source code of the FDK AAC Codec and your
47 modifications thereto to recipients of copies in binary form.
48 
49 The name of Fraunhofer may not be used to endorse or promote products derived
50 from this library without prior written permission.
51 
52 You may not charge copyright license fees for anyone to use, copy or distribute
53 the FDK AAC Codec software or your modifications thereto.
54 
55 Your modified versions of the FDK AAC Codec must carry prominent notices stating
56 that you changed the software and the date of any change. For modified versions
57 of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
58 must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
59 AAC Codec Library for Android."
60 
61 3.    NO PATENT LICENSE
62 
63 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
64 limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
65 Fraunhofer provides no warranty of patent non-infringement with respect to this
66 software.
67 
68 You may use this FDK AAC Codec software or modifications thereto only for
69 purposes that are authorized by appropriate patent licenses.
70 
71 4.    DISCLAIMER
72 
73 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
74 holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
75 including but not limited to the implied warranties of merchantability and
76 fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
77 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
78 or consequential damages, including but not limited to procurement of substitute
79 goods or services; loss of use, data, or profits, or business interruption,
80 however caused and on any theory of liability, whether in contract, strict
81 liability, or tort (including negligence), arising in any way out of the use of
82 this software, even if advised of the possibility of such damage.
83 
84 5.    CONTACT INFORMATION
85 
86 Fraunhofer Institute for Integrated Circuits IIS
87 Attention: Audio and Multimedia Departments - FDK AAC LL
88 Am Wolfsmantel 33
89 91058 Erlangen, Germany
90 
91 www.iis.fraunhofer.de/amm
92 amm-info@iis.fraunhofer.de
93 ----------------------------------------------------------------------------- */
94 
95 /**************************** AAC decoder library ******************************
96 
97    Author(s):   Christian Griebel
98 
99    Description: Error concealment structs and types
100 
101 *******************************************************************************/
102 
103 #ifndef CONCEAL_TYPES_H
104 #define CONCEAL_TYPES_H
105 
106 #include "machine_type.h"
107 #include "common_fix.h"
108 
109 #include "rvlc_info.h"
110 
111 #include "usacdec_lpc.h"
112 
113 #define CONCEAL_MAX_NUM_FADE_FACTORS (32)
114 
115 #define FIXP_CNCL FIXP_DBL
116 #define FL2FXCONST_CNCL FL2FXCONST_DBL
117 #define FX_DBL2FX_CNCL
118 #define FX_CNCL2FX_DBL
119 #define CNCL_FRACT_BITS DFRACT_BITS
120 
121 /* Warning: Do not ever change these values. */
122 typedef enum {
123   ConcealMethodNone = -1,
124   ConcealMethodMute = 0,
125   ConcealMethodNoise = 1,
126   ConcealMethodInter = 2,
127   ConcealMethodTonal = 3
128 
129 } CConcealmentMethod;
130 
131 typedef enum {
132   ConcealState_Ok,
133   ConcealState_Single,
134   ConcealState_FadeIn,
135   ConcealState_Mute,
136   ConcealState_FadeOut
137 
138 } CConcealmentState;
139 
140 typedef struct {
141   FIXP_SGL fadeOutFactor[CONCEAL_MAX_NUM_FADE_FACTORS];
142   FIXP_SGL fadeInFactor[CONCEAL_MAX_NUM_FADE_FACTORS];
143 
144   CConcealmentMethod method;
145 
146   int numFadeOutFrames;
147   int numFadeInFrames;
148   int numMuteReleaseFrames;
149   FIXP_DBL comfortNoiseLevel;
150 
151 } CConcealParams;
152 
153 typedef enum {
154   FADE_TIMEDOMAIN_TOSPECTRALMUTE = 1,
155   FADE_TIMEDOMAIN_FROMSPECTRALMUTE,
156   FADE_TIMEDOMAIN
157 } TDfadingType;
158 
159 typedef struct {
160   CConcealParams *pConcealParams;
161 
162   FIXP_CNCL spectralCoefficient[1024];
163   SHORT specScale[8];
164 
165   INT iRandomPhase;
166   INT prevFrameOk[2];
167   INT cntValidFrames;
168   INT cntFadeFrames; /* State for signal fade-in/out */
169   /* States for signal fade-out of frames with more than one window/subframe -
170     [0] used by Update CntFadeFrames mode of CConcealment_ApplyFadeOut, [1] used
171     by FadeOut mode */
172   int winGrpOffset[2]; /* State for signal fade-out of frames with more than one
173                           window/subframe */
174   int attGrpOffset[2]; /* State for faster signal fade-out of frames with
175                           transient signal parts */
176 
177   SCHAR lastRenderMode;
178 
179   UCHAR windowShape;
180   BLOCK_TYPE windowSequence;
181   UCHAR lastWinGrpLen;
182 
183   CConcealmentState concealState;
184   CConcealmentState concealState_old;
185   FIXP_DBL fade_old;           /* last fading factor */
186   TDfadingType lastFadingType; /* last fading type */
187 
188   SHORT aRvlcPreviousScaleFactor[RVLC_MAX_SFB]; /* needed once per channel */
189   UCHAR aRvlcPreviousCodebook[RVLC_MAX_SFB];    /* needed once per channel */
190   SCHAR rvlcPreviousScaleFactorOK;
191   SCHAR rvlcPreviousBlockType;
192 
193   FIXP_LPC lsf4[M_LP_FILTER_ORDER];
194   FIXP_DBL last_tcx_gain;
195   INT last_tcx_gain_e;
196   ULONG TDNoiseSeed;
197   PCM_DEC TDNoiseStates[3];
198   FIXP_SGL TDNoiseCoef[3];
199   FIXP_SGL TDNoiseAtt;
200 
201 } CConcealmentInfo;
202 
203 #endif /* #ifndef CONCEAL_TYPES_H */
204