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):   Christian Griebel
98 
99    Description: Dynamic range control (DRC) decoder tool for AAC
100 
101 *******************************************************************************/
102 
103 #ifndef AACDEC_DRC_H
104 #define AACDEC_DRC_H
105 
106 #include "tp_data.h" /* for program config element support */
107 
108 #include "aacdec_drc_types.h"
109 #include "channel.h"
110 #include "FDK_bitstream.h"
111 
112 #define AACDEC_DRC_DFLT_EXPIRY_FRAMES \
113   (0) /* Default DRC data expiry time in AAC frames   */
114 
115 /* #define AACDEC_DRC_IGNORE_FRAMES_WITH_MULTIPLE_CH_THREADS */ /* The name says
116                                                                    it all. */
117 /* #define AACDEC_DRC_DEBUG */
118 
119 /**
120  * \brief DRC module setting parameters
121  */
122 typedef enum {
123   DRC_CUT_SCALE = 0,
124   DRC_BOOST_SCALE,
125   TARGET_REF_LEVEL,
126   DRC_BS_DELAY,
127   DRC_DATA_EXPIRY_FRAME,
128   APPLY_NORMALIZATION,
129   APPLY_HEAVY_COMPRESSION,
130   DEFAULT_PRESENTATION_MODE,
131   ENCODER_TARGET_LEVEL,
132   MAX_OUTPUT_CHANNELS,
133   UNIDRC_PRECEDENCE
134 } AACDEC_DRC_PARAM;
135 
136 /**
137  * \brief DRC module interface functions
138  */
139 void aacDecoder_drcInit(HANDLE_AAC_DRC self);
140 
141 void aacDecoder_drcInitChannelData(CDrcChannelData *pDrcChannel);
142 
143 AAC_DECODER_ERROR aacDecoder_drcSetParam(HANDLE_AAC_DRC self,
144                                          AACDEC_DRC_PARAM param, INT value);
145 
146 int aacDecoder_drcMarkPayload(HANDLE_AAC_DRC self, HANDLE_FDK_BITSTREAM hBs,
147                               AACDEC_DRC_PAYLOAD_TYPE type);
148 
149 int aacDecoder_drcProlog(
150     HANDLE_AAC_DRC self, HANDLE_FDK_BITSTREAM hBs,
151     CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo[],
152     UCHAR pceInstanceTag, UCHAR channelMapping[], int validChannels);
153 
154 /**
155  * \brief Apply DRC. If SBR is present, DRC data is handed over to the SBR
156  * decoder.
157  * \param self AAC decoder instance
158  * \param pSbrDec pointer to SBR decoder instance
159  * \param pAacDecoderChannelInfo AAC decoder channel instance to be processed
160  * \param pDrcDat DRC channel data
161  * \param extGain Pointer to a FIXP_DBL where a externally applyable gain will
162  * be stored into (independently on whether it will be apply internally or not).
163  *                At function call the buffer must hold the scale (0 >= scale <
164  * DFRACT_BITS) to be applied on the gain value.
165  * \param ch channel index
166  * \param aacFrameSize AAC frame size
167  * \param bSbrPresent flag indicating that SBR is present, in which case DRC is
168  * handed over to the SBR instance pSbrDec
169  */
170 void aacDecoder_drcApply(HANDLE_AAC_DRC self, void *pSbrDec,
171                          CAacDecoderChannelInfo *pAacDecoderChannelInfo,
172                          CDrcChannelData *pDrcDat, FIXP_DBL *extGain, int ch,
173                          int aacFrameSize, int bSbrPresent);
174 
175 int aacDecoder_drcEpilog(
176     HANDLE_AAC_DRC self, HANDLE_FDK_BITSTREAM hBs,
177     CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo[],
178     UCHAR pceInstanceTag, UCHAR channelMapping[], int validChannels);
179 
180 /**
181  * \brief Get metadata information found in bitstream.
182  * \param self DRC module instance handle.
183  * \param pPresMode Pointer to field where the presentation mode will be written
184  * to.
185  * \param pProgRefLevel Pointer to field where the program reference level will
186  * be written to.
187  * \return Nothing.
188  */
189 void aacDecoder_drcGetInfo(HANDLE_AAC_DRC self, SCHAR *pPresMode,
190                            SCHAR *pProgRefLevel);
191 
192 #endif /* AACDEC_DRC_H */
193