Imported Debian version 0.1.3.1
[deb_fdk-aac.git] / libSBRdec / src / sbr_ram.h
1
2 /* -----------------------------------------------------------------------------------------------------------
3 Software License for The Fraunhofer FDK AAC Codec Library for Android
4
5 © Copyright 1995 - 2013 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
6 All rights reserved.
7
8 1. INTRODUCTION
9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16 of the MPEG specifications.
17
18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20 individually for the purpose of encoding or decoding bit streams in products that are compliant with
21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23 software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27 applications information and documentation.
28
29 2. COPYRIGHT LICENSE
30
31 Redistribution and use in source and binary forms, with or without modification, are permitted without
32 payment of copyright license fees provided that you satisfy the following conditions:
33
34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35 your modifications thereto in source code form.
36
37 You must retain the complete text of this software license in the documentation and/or other materials
38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40 modifications thereto to recipients of copies in binary form.
41
42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43 prior written permission.
44
45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46 software or your modifications thereto.
47
48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49 and the date of any change. For modified versions of the FDK AAC Codec, the term
50 "Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
51 "Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
52
53 3. NO PATENT LICENSE
54
55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57 respect to this software.
58
59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60 by appropriate patent licenses.
61
62 4. DISCLAIMER
63
64 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
65 "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69 or business interruption, however caused and on any theory of liability, whether in contract, strict
70 liability, or tort (including negligence), arising in any way out of the use of this software, even if
71 advised of the possibility of such damage.
72
73 5. CONTACT INFORMATION
74
75 Fraunhofer Institute for Integrated Circuits IIS
76 Attention: Audio and Multimedia Departments - FDK AAC LL
77 Am Wolfsmantel 33
78 91058 Erlangen, Germany
79
80 www.iis.fraunhofer.de/amm
81 amm-info@iis.fraunhofer.de
82 ----------------------------------------------------------------------------------------------------------- */
83
84 /*!
85 \file
86 \brief Memory layout
87
88 */
89 #ifndef _SBR_RAM_H_
90 #define _SBR_RAM_H_
91
92 #include "sbrdecoder.h"
93
94 #include "env_extr.h"
95 #include "sbr_dec.h"
96
97
98
99 #define SBRDEC_MAX_CH_PER_ELEMENT (2)
100
101 typedef struct
102 {
103 SBR_CHANNEL *pSbrChannel[SBRDEC_MAX_CH_PER_ELEMENT];
104 TRANSPOSER_SETTINGS transposerSettings; /* Common transport settings for each individual channel of an element */
105 HANDLE_FDK_BITSTREAM hBs;
106
107 MP4_ELEMENT_ID elementID; /* Element ID set during initialization. Can be used for concealment */
108 int nChannels; /* Number of elements output channels (=2 in case of PS) */
109
110 UCHAR frameErrorFlag[(1)+1]; /* Frame error status (for every slot in the delay line).
111 Will be copied into header at the very beginning of decodeElement() routine. */
112
113 UCHAR useFrameSlot; /* Index which defines which slot will be decoded/filled next (used with additional delay) */
114 UCHAR useHeaderSlot[(1)+1]; /* Index array that provides the link between header and frame data
115 (important when processing with additional delay). */
116 } SBR_DECODER_ELEMENT;
117
118
119 struct SBR_DECODER_INSTANCE
120 {
121 SBR_DECODER_ELEMENT *pSbrElement[(4)];
122 SBR_HEADER_DATA sbrHeader[(4)][(1)+1]; /* Sbr header for each individual channel of an element */
123
124 FIXP_DBL *workBuffer1;
125 FIXP_DBL *workBuffer2;
126
127 HANDLE_PS_DEC hParametricStereoDec;
128
129 /* Global parameters */
130 AUDIO_OBJECT_TYPE coreCodec; /* AOT of core codec */
131 int numSbrElements;
132 int numSbrChannels;
133 INT sampleRateIn; /* SBR decoder input sampling rate; might be different than the transposer input sampling rate. */
134 INT sampleRateOut; /* Sampling rate of the SBR decoder output audio samples. */
135 USHORT codecFrameSize;
136 UCHAR synDownsampleFac;
137 UCHAR numDelayFrames; /* The current number of additional delay frames used for processing. */
138
139 UINT flags;
140
141 };
142
143 H_ALLOC_MEM(Ram_SbrDecElement, SBR_DECODER_ELEMENT)
144 H_ALLOC_MEM(Ram_SbrDecChannel, SBR_CHANNEL)
145 H_ALLOC_MEM(Ram_SbrDecoder, struct SBR_DECODER_INSTANCE)
146
147 H_ALLOC_MEM(Ram_sbr_QmfStatesSynthesis, FIXP_QSS)
148 H_ALLOC_MEM(Ram_sbr_OverlapBuffer, FIXP_DBL)
149
150
151 H_ALLOC_MEM(Ram_ps_dec, PS_DEC)
152
153
154 H_ALLOC_MEM_OVERLAY(Ram_SbrDecWorkBuffer1, FIXP_DBL)
155 H_ALLOC_MEM_OVERLAY(Ram_SbrDecWorkBuffer2, FIXP_DBL)
156
157
158 #endif /* _SBR_RAM_H_ */