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/**************************** SBR encoder library ******************************
96
97   Author(s):
98
99   Description:
100
101*******************************************************************************/
102
103/*!
104  \file
105  \brief  Main SBR structs definitions $Revision: 92790 $
106*/
107
108#ifndef SBR_H
109#define SBR_H
110
111#include "fram_gen.h"
112#include "bit_sbr.h"
113#include "tran_det.h"
114#include "code_env.h"
115#include "env_est.h"
116#include "cmondata.h"
117
118#include "qmf.h"
119#include "resampler.h"
120
121#include "ton_corr.h"
122
123/* SBR bitstream delay */
124#define MAX_DELAY_FRAMES 2
125
126/* sbr encoder downsampling type */
127typedef enum { SBRENC_DS_NONE, SBRENC_DS_TIME, SBRENC_DS_QMF } SBRENC_DS_TYPE;
128
129typedef struct SBR_CHANNEL {
130  struct ENV_CHANNEL hEnvChannel;
131  // INT_PCM                  *pDSOutBuffer;            /**< Pointer to
132  // downsampled audio output of SBR encoder */
133  DOWNSAMPLER downSampler;
134
135} SBR_CHANNEL;
136typedef SBR_CHANNEL* HANDLE_SBR_CHANNEL;
137
138typedef struct SBR_ELEMENT {
139  HANDLE_SBR_CHANNEL sbrChannel[2];
140  QMF_FILTER_BANK* hQmfAnalysis[2];
141  SBR_CONFIG_DATA sbrConfigData;
142  SBR_HEADER_DATA sbrHeaderData;
143  SBR_BITSTREAM_DATA sbrBitstreamData;
144  COMMON_DATA CmonData;
145  INT dynXOverFreqDelay[5]; /**< to delay a frame (I don't like it that much
146                               that way - hrc) */
147  SBR_ELEMENT_INFO elInfo;
148
149  UCHAR payloadDelayLine[1 + MAX_DELAY_FRAMES][MAX_PAYLOAD_SIZE];
150  UINT payloadDelayLineSize[1 + MAX_DELAY_FRAMES]; /* Sizes in bits */
151
152} SBR_ELEMENT, *HANDLE_SBR_ELEMENT;
153
154typedef struct SBR_ENCODER {
155  HANDLE_SBR_ELEMENT sbrElement[(8)];
156  HANDLE_SBR_CHANNEL pSbrChannel[(8)];
157  QMF_FILTER_BANK QmfAnalysis[(8)];
158  DOWNSAMPLER lfeDownSampler;
159  int lfeChIdx;     /* -1 default for no lfe, else assign channel index. */
160  int noElements;   /* Number of elements. */
161  int nChannels;    /* Total channel count across all elements. */
162  int frameSize;    /* SBR framelength. */
163  int bufferOffset; /* Offset for SBR parameter extraction in time domain input
164                       buffer. */
165  int downsampledOffset; /* Offset of downsampled/mixed output for core encoder.
166                          */
167  int downmixSize;       /* Size in samples of downsampled/mixed output for core
168                            encoder. */
169  INT downSampleFactor;  /* Sampling rate relation between the SBR and the core
170                            encoder. */
171  SBRENC_DS_TYPE
172  downsamplingMethod; /* Method of downsmapling, time-domain, QMF or none.
173                       */
174  int nBitstrDelay;   /* Amount of SBR frames to be delayed in bitstream domain.
175                       */
176  int sbrDecDelay;    /* SBR decoder delay in samples */
177  INT estimateBitrate; /* Estimate bitrate of SBR encoder. */
178  INT inputDataDelay;  /* Delay caused by downsampler, in/out buffer at
179                          sbrEncoder_EncodeFrame. */
180
181  UCHAR* dynamicRam;
182  UCHAR* pSBRdynamic_RAM;
183
184  HANDLE_PARAMETRIC_STEREO hParametricStereo;
185  QMF_FILTER_BANK qmfSynthesisPS;
186
187  /* parameters describing allocation volume of present instance */
188  INT maxElements;
189  INT maxChannels;
190  INT supportPS;
191
192} SBR_ENCODER;
193
194#endif /* SBR_H */
195