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):   Robert Weidner (DSP Solutions)
98 
99    Description: HCR Decoder: Defines of state-constants, masks and
100                 state-prototypes
101 
102 *******************************************************************************/
103 
104 #ifndef AACDEC_HCRS_H
105 #define AACDEC_HCRS_H
106 
107 #include "FDK_bitstream.h"
108 #include "aacdec_hcr_types.h"
109 /* The four different kinds of types of states are:                     */
110 /* different states are defined as constants */ /* start   middle=self   next
111                                                    stop */
112 #define STOP_THIS_STATE \
113   0 /*                                                                      */
114 #define BODY_ONLY \
115   1 /*   X          X                X                                      */
116 #define BODY_SIGN__BODY \
117   2 /*   X          X         X      X [stop if no sign]                    */
118 #define BODY_SIGN__SIGN \
119   3 /*              X                X [stop if sign bits decoded]          */
120 #define BODY_SIGN_ESC__BODY \
121   4 /*   X          X         X      X [stop if no sign]                    */
122 #define BODY_SIGN_ESC__SIGN \
123   5 /*              X         X      X [stop if no escape sequence]         */
124 #define BODY_SIGN_ESC__ESC_PREFIX \
125   6 /*              X         X                                             */
126 #define BODY_SIGN_ESC__ESC_WORD \
127   7 /*              X         X      X [stop if abs(second qsc) != 16]      */
128 
129 /* examples: */
130 
131 /* BODY_ONLY                    means only the codeword body will be decoded; no
132  * sign bits will follow and no escapesequence will follow */
133 
134 /* BODY_SIGN__BODY              means that the codeword consists of two parts;
135  * body and sign part. The part '__BODY' after the two underscores shows */
136 /*                              that the bits which are currently decoded belong
137  * to the '__BODY' of the codeword and not to the sign part. */
138 
139 /* BODY_SIGN_ESC__ESC_PB        means that the codeword consists of three parts;
140  * body, sign and (here: two) escape sequences;  */
141 /*                              P = Prefix = ones */
142 /*                              W = Escape Word */
143 /*                              A = first possible (of two) Escape sequeces */
144 /*                              B = second possible (of two) Escape sequeces */
145 /*                              The part after the two underscores shows that
146  * the current bits which are decoded belong to the '__ESC_PB' - part of the */
147 /*                              codeword. That means the body and the sign bits
148  * are decoded completely and the bits which are decoded now belong to */
149 /*                              the escape sequence [P = prefix; B=second
150  * possible escape sequence] */
151 
152 #define MSB_31_MASK 0x80000000 /* masks MSB (= Bit 31) in a 32 bit word */
153 #define DIMENSION_OF_ESCAPE_CODEBOOK 2 /* for cb >= 11 is dimension 2 */
154 #define ESCAPE_CODEBOOK 11
155 
156 #define MASK_ESCAPE_PREFIX_UP 0x000F0000
157 #define LSB_ESCAPE_PREFIX_UP 16
158 
159 #define MASK_ESCAPE_PREFIX_DOWN 0x0000F000
160 #define LSB_ESCAPE_PREFIX_DOWN 12
161 
162 #define MASK_ESCAPE_WORD 0x00000FFF
163 #define MASK_FLAG_A 0x00200000
164 #define MASK_FLAG_B 0x00100000
165 
166 extern void DecodeNonPCWs(HANDLE_FDK_BITSTREAM bs, H_HCR_INFO hHcr);
167 
168 UINT Hcr_State_BODY_ONLY(HANDLE_FDK_BITSTREAM, void*);
169 UINT Hcr_State_BODY_SIGN__BODY(HANDLE_FDK_BITSTREAM, void*);
170 UINT Hcr_State_BODY_SIGN__SIGN(HANDLE_FDK_BITSTREAM, void*);
171 UINT Hcr_State_BODY_SIGN_ESC__BODY(HANDLE_FDK_BITSTREAM, void*);
172 UINT Hcr_State_BODY_SIGN_ESC__SIGN(HANDLE_FDK_BITSTREAM, void*);
173 UINT Hcr_State_BODY_SIGN_ESC__ESC_PREFIX(HANDLE_FDK_BITSTREAM, void*);
174 UINT Hcr_State_BODY_SIGN_ESC__ESC_WORD(HANDLE_FDK_BITSTREAM, void*);
175 
176 #endif /* AACDEC_HCRS_H */
177