1/* -----------------------------------------------------------------------------
2Software License for The Fraunhofer FDK AAC Codec Library for Android
3
4© Copyright  1995 - 2018 Fraunhofer-Gesellschaft zur Förderung der angewandten
5Forschung e.V. All rights reserved.
6
7 1.    INTRODUCTION
8The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
9that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
10scheme for digital audio. This FDK AAC Codec software is intended to be used on
11a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
14general perceptual audio codecs. AAC-ELD is considered the best-performing
15full-bandwidth communications codec by independent studies and is widely
16deployed. AAC has been standardized by ISO and IEC as part of the MPEG
17specifications.
18
19Patent licenses for necessary patent claims for the FDK AAC Codec (including
20those of Fraunhofer) may be obtained through Via Licensing
21(www.vialicensing.com) or through the respective patent owners individually for
22the purpose of encoding or decoding bit streams in products that are compliant
23with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
24Android devices already license these patent claims through Via Licensing or
25directly from the patent owners, and therefore FDK AAC Codec software may
26already be covered under those patent licenses when it is used for those
27licensed purposes only.
28
29Commercially-licensed AAC software libraries, including floating-point versions
30with enhanced sound quality, are also available from Fraunhofer. Users are
31encouraged to check the Fraunhofer website for additional applications
32information and documentation.
33
342.    COPYRIGHT LICENSE
35
36Redistribution and use in source and binary forms, with or without modification,
37are permitted without payment of copyright license fees provided that you
38satisfy the following conditions:
39
40You must retain the complete text of this software license in redistributions of
41the FDK AAC Codec or your modifications thereto in source code form.
42
43You must retain the complete text of this software license in the documentation
44and/or other materials provided with redistributions of the FDK AAC Codec or
45your modifications thereto in binary form. You must make available free of
46charge copies of the complete source code of the FDK AAC Codec and your
47modifications thereto to recipients of copies in binary form.
48
49The name of Fraunhofer may not be used to endorse or promote products derived
50from this library without prior written permission.
51
52You may not charge copyright license fees for anyone to use, copy or distribute
53the FDK AAC Codec software or your modifications thereto.
54
55Your modified versions of the FDK AAC Codec must carry prominent notices stating
56that you changed the software and the date of any change. For modified versions
57of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
58must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
59AAC Codec Library for Android."
60
613.    NO PATENT LICENSE
62
63NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
64limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
65Fraunhofer provides no warranty of patent non-infringement with respect to this
66software.
67
68You may use this FDK AAC Codec software or modifications thereto only for
69purposes that are authorized by appropriate patent licenses.
70
714.    DISCLAIMER
72
73This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
74holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
75including but not limited to the implied warranties of merchantability and
76fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
77CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
78or consequential damages, including but not limited to procurement of substitute
79goods or services; loss of use, data, or profits, or business interruption,
80however caused and on any theory of liability, whether in contract, strict
81liability, or tort (including negligence), arising in any way out of the use of
82this software, even if advised of the possibility of such damage.
83
845.    CONTACT INFORMATION
85
86Fraunhofer Institute for Integrated Circuits IIS
87Attention: Audio and Multimedia Departments - FDK AAC LL
88Am Wolfsmantel 33
8991058 Erlangen, Germany
90
91www.iis.fraunhofer.de/amm
92amm-info@iis.fraunhofer.de
93----------------------------------------------------------------------------- */
94
95/**************************** AAC decoder library ******************************
96
97   Author(s):   Manuel Jander
98
99   Description: USAC Linear Prediction Domain coding
100
101*******************************************************************************/
102
103#ifndef USACDEC_LPD_H
104#define USACDEC_LPD_H
105
106#include "channelinfo.h"
107
108#define OPTIMIZE_AVG_PERFORMANCE
109
110/**
111 * \brief read a lpd_channel_stream.
112 * \param hBs a bit stream handle, where the lpd_channel_stream is located.
113 * \param pAacDecoderChannelInfo the channel context structure for storing read
114 * data.
115 * \param flags bit stream syntax flags.
116 * \return AAC_DECODER_ERROR error code.
117 */
118AAC_DECODER_ERROR CLpdChannelStream_Read(
119    HANDLE_FDK_BITSTREAM hBs, CAacDecoderChannelInfo *pAacDecoderChannelInfo,
120    CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo,
121    const SamplingRateInfo *pSamplingRateInfo, UINT flags);
122
123/**
124 * \brief decode one lpd_channel_stream and render the audio output.
125 * \param pAacDecoderChannelInfo struct holding the channel information to be
126 * rendered.
127 * \param pAacDecoderStaticChannelInfo struct holding the persistent channel
128 * information to be rendered.
129 * \param pSamplingRateInfo holds the sampling rate information
130 * \param elFlags holds the internal decoder flags
131 */
132void CLpdChannelStream_Decode(
133    CAacDecoderChannelInfo *pAacDecoderChannelInfo,
134    CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo, UINT flags);
135
136/**
137 * \brief generate time domain output signal for LPD channel streams
138 * \param pAacDecoderStaticChannelInfo
139 * \param pAacDecoderChannelInfo
140 * \param pTimeData pointer to output buffer
141 * \param samplesPerFrame amount of output samples
142 * \param pSamplingRateInfo holds the sampling rate information
143 * \param pWorkBuffer1 pointer to work buffer for temporal data
144 */
145AAC_DECODER_ERROR CLpd_RenderTimeSignal(
146    CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo,
147    CAacDecoderChannelInfo *pAacDecoderChannelInfo, FIXP_PCM *pTimeData,
148    INT samplesPerFrame, SamplingRateInfo *pSamplingRateInfo, UINT frameOk,
149    UINT flags, UINT strmFlags);
150
151static inline INT CLpd_FAC_getLength(int fNotShortBlock, int fac_length_long) {
152  if (fNotShortBlock) {
153    return (fac_length_long);
154  } else {
155    return fac_length_long / 2;
156  }
157}
158
159void filtLP(const FIXP_DBL *syn, FIXP_PCM *syn_out, FIXP_DBL *noise,
160            const FIXP_SGL *filt, INT stop, int len);
161
162/**
163 * \brief perform a low-frequency pitch enhancement on time domain signal
164 * \param[in] syn pointer to time domain input signal
165 * \param[in] synFB pointer to time domain input signal
166 * \param[in] upsampling factor
167 * \param[in] T_sf array with past decoded pitch period values for each subframe
168 * \param[in] non_zero_gain_flags indicates whether pitch gains of past
169 * subframes are zero or not, msb -> [1 BPF_DELAY subfr][7 SYN_DELAY subfr][16
170 * new subfr] <- lsb
171 * \param[in] l_frame length of filtering, must be multiple of L_SUBFR
172 * \param[in] l_next length of allowed look ahead on syn[i], i < l_frame+l_next
173 * \param[out] synth_out pointer to time domain output signal
174 * \param[in,out] mem_bpf pointer to filter memory (L_FILT+L_SUBFR)
175 */
176
177void bass_pf_1sf_delay(FIXP_DBL syn[], const INT T_sf[], FIXP_DBL *pit_gain,
178                       const int frame_length, const INT l_frame,
179                       const INT l_next, FIXP_PCM *synth_out,
180                       FIXP_DBL mem_bpf[]);
181
182/**
183 * \brief random sign generator for FD and TCX noise filling
184 * \param[in,out] seed pointer to random seed
185 * \return if return value is zero use positive sign
186 * \Note: This code is also implemented as a copy in block.cpp, grep for
187 * "UsacRandomSign"
188 */
189FDK_INLINE
190int UsacRandomSign(ULONG *seed) {
191  *seed = (ULONG)((UINT64)(*seed) * 69069 + 5);
192
193  return (int)((*seed) & 0x10000);
194}
195
196void CFdp_Reset(CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo);
197
198#endif /* USACDEC_LPD_H */
199