1 /* -----------------------------------------------------------------------------
2 Software License for The Fraunhofer FDK AAC Codec Library for Android
3 
4 © Copyright  1995 - 2018 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):
98 
99    Description:
100 
101 *******************************************************************************/
102 
103 /*!
104   \file
105   \brief  Defines structures for RVLC
106   \author Robert Weidner
107 */
108 #ifndef RVLC_INFO_H
109 #define RVLC_INFO_H
110 
111 #define FWD 0 /* bitstream decoding direction forward (RVL coded part) */
112 #define BWD 1 /* bitstream decoding direction backward (RVL coded part) */
113 
114 #define MAX_RVL 7  /* positive RVLC escape */
115 #define MIN_RVL -7 /* negative RVLC escape */
116 #define MAX_ALLOWED_DPCM_INDEX                                    \
117   14 /* the maximum allowed index of a decoded dpcm value (offset \
118         'TABLE_OFFSET' incl --> must be subtracted) */
119 #define TABLE_OFFSET                                                           \
120   7 /* dpcm offset of valid output values of rvl table decoding, the rvl table \
121        ouly returns positive values, therefore the offset */
122 #define MAX_LEN_RVLC_CODE_WORD 9 /* max length of a RVL codeword in bits */
123 #define MAX_LEN_RVLC_ESCAPE_WORD \
124   20 /* max length of huffman coded RVLC escape word in bits */
125 
126 #define DPCM_NOISE_NRG_BITS 9
127 #define SF_OFFSET 100 /* offset for correcting scf value */
128 
129 #define CONCEAL_MAX_INIT 1311  /* arbitrary value */
130 #define CONCEAL_MIN_INIT -1311 /* arbitrary value */
131 
132 #define RVLC_MAX_SFB ((8) * (16))
133 
134 /* sideinfo of RVLC */
135 typedef struct {
136   /* ------- ESC 1 Data: --------- */ /* order of RVLC-bitstream components in
137                                          bitstream (RVLC-initialization), every
138                                          component appears only once in
139                                          bitstream */
140   INT sf_concealment;                 /* 1          */
141   INT rev_global_gain;                /* 2          */
142   SHORT length_of_rvlc_sf; /* 3          */ /* original value, gets modified
143                                                (subtract 9) in case of noise
144                                                (PNS); is kept for later use */
145   INT dpcm_noise_nrg;                       /* 4 optional */
146   INT sf_escapes_present;                   /* 5          */
147   SHORT length_of_rvlc_escapes;             /* 6 optional */
148   INT dpcm_noise_last_position;             /* 7 optional */
149 
150   INT dpcm_is_last_position;
151 
152   SHORT length_of_rvlc_sf_fwd; /* length_of_rvlc_sf used for forward decoding */
153   SHORT
154   length_of_rvlc_sf_bwd; /* length_of_rvlc_sf used for backward decoding */
155 
156   /* for RVL-Codeword decoder to distinguish between fwd and bwd decoding */
157   SHORT *pRvlBitCnt_RVL;
158   INT *pBitstrIndxRvl_RVL;
159 
160   UCHAR numWindowGroups;
161   UCHAR maxSfbTransmitted;
162   UCHAR first_noise_group;
163   UCHAR first_noise_band;
164   UCHAR direction;
165 
166   /* bitstream indices */
167   INT bitstreamIndexRvlFwd; /* base address of RVL-coded-scalefactor data (ESC
168                                2) for forward  decoding */
169   INT bitstreamIndexRvlBwd; /* base address of RVL-coded-scalefactor data (ESC
170                                2) for backward decoding */
171   INT bitstreamIndexEsc;    /* base address where RVLC-escapes start (ESC 2) */
172 
173   /* decoding trees */
174   const UINT *pHuffTreeRvlCodewds;
175   const UINT *pHuffTreeRvlcEscape;
176 
177   /* escape counters */
178   UCHAR numDecodedEscapeWordsFwd; /* when decoding RVL-codes forward  */
179   UCHAR numDecodedEscapeWordsBwd; /* when decoding RVL-codes backward */
180   UCHAR numDecodedEscapeWordsEsc; /* when decoding the escape-Words */
181 
182   SCHAR noise_used;
183   SCHAR intensity_used;
184   SCHAR sf_used;
185 
186   SHORT firstScf;
187   SHORT lastScf;
188   SHORT firstNrg;
189   SHORT lastNrg;
190   SHORT firstIs;
191   SHORT lastIs;
192 
193   /* ------ RVLC error detection ------ */
194   UINT errorLogRvlc;     /* store RVLC errors  */
195   SHORT conceal_min;     /* is set at backward decoding  */
196   SHORT conceal_max;     /* is set at forward  decoding  */
197   SHORT conceal_min_esc; /* is set at backward decoding  */
198   SHORT conceal_max_esc; /* is set at forward  decoding  */
199 } CErRvlcInfo;
200 
201 typedef CErRvlcInfo RVLC_INFO; /* temp */
202 
203 #endif /* RVLC_INFO_H */
204