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 /*********************** MPEG surround decoder library *************************
96 
97    Author(s):   Matthias Hildenbrand
98 
99    Description: USAC MPS212 Transient Steering Decorrelator (TSD)
100 
101 *******************************************************************************/
102 
103 #ifndef SAC_TSD_H
104 #define SAC_TSD_H
105 
106 #include "FDK_bitstream.h"
107 #include "common_fix.h"
108 
109 #define MAX_TSD_TIME_SLOTS (64)
110 
111 /** Structure which holds the data needed to apply TSD to current frame. */
112 typedef struct {
113   UCHAR bsTsdEnable; /**< for current frame TSD is (0:disabled, 1:enabled) */
114   UCHAR numSlots;    /**< total number of QMF slots per frame */
115   SCHAR
116   bsTsdTrPhaseData[MAX_TSD_TIME_SLOTS]; /**< -1 => TsdSepData[ts]=0; 0-7:
117                                            values of bsTsdTrPhaseData[ts]
118                                            and TsdSepData[ts]=1 */
119 } TSD_DATA;
120 
isTsdActive(const TSD_DATA * pTsdData)121 FDK_INLINE int isTsdActive(const TSD_DATA *pTsdData) {
122   return (int)pTsdData->bsTsdEnable;
123 }
124 
125 /**
126  * \brief Parse and Decode TSD data.
127  * \param[in] hBs bitstream handle to read data from.
128  * \param[in] numSlots number of QMF slots per frame.
129  * \param[out] pTsdData pointer to TSD data structure.
130  * \return 0 on succes, 1 on error.
131  */
132 int TsdRead(HANDLE_FDK_BITSTREAM hBs, const int numSlots, TSD_DATA *pTsdData);
133 
134 /**
135  * \brief Perform transient seperation (v_{x,nonTr} signal).
136  * \param[in] numHybridBands number of hybrid bands.
137  * \param[in] pTsdData pointer to TSD data structure.
138  * \param[in] pVdirectReal pointer to array with direct signal.
139  * \param[in] pVdirectImag pointer to array with direct signal.
140  * \param[out] pVnonTrReal pointer to array with nonTr signal.
141  * \param[out] pVnonTrImag pointer to array with nonTr signal.
142  * \param[out] ppDecorrInReal handle to array where allpass based decorrelator
143  * should read from (modified by this function).
144  * \param[out] ppDecorrInImag handle to array where allpass based decorrelator
145  * should read from (modified by this function).
146  */
147 void TsdGenerateNonTr(const int numHybridBands, const TSD_DATA *pTsdData,
148                       const int ts, FIXP_DBL *pVdirectReal,
149                       FIXP_DBL *pVdirectImag, FIXP_DBL *pVnonTrReal,
150                       FIXP_DBL *pVnonTrImag, FIXP_DBL **ppDecorrInReal,
151                       FIXP_DBL **ppDecorrInImag);
152 
153 /**
154  * \brief Generate d_{x,Tr} signal and add to d_{x,nonTr} signal
155  * \param[in] numHybridBands
156  * \param[in,out] pTsdData
157  * \param pTsdTs pointer to persistent time slot counter
158  * \param[in] pVdirectReal
159  * \param[in] pVdirectImag
160  * \param[out] pDnonTrReal
161  * \param[out] pDnonTrImag
162  */
163 void TsdApply(const int numHybridBands, const TSD_DATA *pTsdData, int *pTsdTs,
164               const FIXP_DBL *pVdirectReal, const FIXP_DBL *pVdirectImag,
165               FIXP_DBL *pDnonTrReal, FIXP_DBL *pDnonTrImag);
166 
167 #endif /* #ifndef SAC_TSD_H */
168