1
2/* -----------------------------------------------------------------------------------------------------------
3Software 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
9The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16of the MPEG specifications.
17
18Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20individually for the purpose of encoding or decoding bit streams in products that are compliant with
21the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27applications information and documentation.
28
292.    COPYRIGHT LICENSE
30
31Redistribution and use in source and binary forms, with or without modification, are permitted without
32payment of copyright license fees provided that you satisfy the following conditions:
33
34You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35your modifications thereto in source code form.
36
37You must retain the complete text of this software license in the documentation and/or other materials
38provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40modifications thereto to recipients of copies in binary form.
41
42The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43prior written permission.
44
45You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46software or your modifications thereto.
47
48Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49and 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
533.    NO PATENT LICENSE
54
55NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57respect to this software.
58
59You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60by appropriate patent licenses.
61
624.    DISCLAIMER
63
64This 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
66of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69or business interruption, however caused and on any theory of liability, whether in contract, strict
70liability, or tort (including negligence), arising in any way out of the use of this software, even if
71advised of the possibility of such damage.
72
735.    CONTACT INFORMATION
74
75Fraunhofer Institute for Integrated Circuits IIS
76Attention: Audio and Multimedia Departments - FDK AAC LL
77Am Wolfsmantel 33
7891058 Erlangen, Germany
79
80www.iis.fraunhofer.de/amm
81amm-info@iis.fraunhofer.de
82----------------------------------------------------------------------------------------------------------- */
83
84/*!
85  \file
86  \brief  Defines structures for RVLC
87  \author Robert Weidner
88*/
89#ifndef RVLC_INFO_H
90#define RVLC_INFO_H
91
92
93
94#define FWD                           0     /* bitstream decoding direction forward (RVL coded part) */
95#define BWD                           1     /* bitstream decoding direction backward (RVL coded part) */
96
97#define MAX_RVL                       7     /* positive RVLC escape */
98#define MIN_RVL                      -7     /* negative RVLC escape */
99#define MAX_ALLOWED_DPCM_INDEX       14     /* the maximum allowed index of a decoded dpcm value (offset 'TABLE_OFFSET' incl --> must be subtracted) */
100#define TABLE_OFFSET                  7     /* dpcm offset of valid output values of rvl table decoding, the rvl table ouly returns positive values, therefore the offset */
101#define MAX_LEN_RVLC_CODE_WORD        9     /* max length of a RVL codeword in bits */
102#define MAX_LEN_RVLC_ESCAPE_WORD     20     /* max length of huffman coded RVLC escape word in bits */
103
104#define DPCM_NOISE_NRG_BITS           9
105#define SF_OFFSET                   100     /* offset for correcting scf value */
106
107#define CONCEAL_MAX_INIT           1311     /* arbitrary value */
108#define CONCEAL_MIN_INIT          -1311     /* arbitrary value */
109
110#define RVLC_MAX_SFB              ((8) * (16))
111
112/* sideinfo of RVLC */
113typedef struct
114{
115  /* ------- ESC 1 Data: --------- */     /* order of RVLC-bitstream components in bitstream (RVLC-initialization), every component appears only once in bitstream */
116  INT        sf_concealment;              /* 1          */
117  INT        rev_global_gain;             /* 2          */
118  SHORT      length_of_rvlc_sf;           /* 3          */  /* original value, gets modified (subtract 9) in case of noise (PNS); is kept for later use */
119  INT        dpcm_noise_nrg;              /* 4 optional */
120  INT        sf_escapes_present;          /* 5          */
121  SHORT      length_of_rvlc_escapes;      /* 6 optional */
122  INT        dpcm_noise_last_position;    /* 7 optional */
123
124  INT        dpcm_is_last_position;
125
126  SHORT      length_of_rvlc_sf_fwd;       /* length_of_rvlc_sf used for forward decoding */
127  SHORT      length_of_rvlc_sf_bwd;       /* length_of_rvlc_sf used for backward decoding */
128
129  /* for RVL-Codeword decoder to distinguish between fwd and bwd decoding */
130  SHORT     *pRvlBitCnt_RVL;
131  USHORT    *pBitstrIndxRvl_RVL;
132
133  UCHAR      numWindowGroups;
134  UCHAR      maxSfbTransmitted;
135  UCHAR      first_noise_group;
136  UCHAR      first_noise_band;
137  UCHAR      direction;
138
139  /* bitstream indices */
140  USHORT     bitstreamIndexRvlFwd;        /* base address of RVL-coded-scalefactor data (ESC 2) for forward  decoding */
141  USHORT     bitstreamIndexRvlBwd;        /* base address of RVL-coded-scalefactor data (ESC 2) for backward decoding */
142  USHORT     bitstreamIndexEsc;           /* base address where RVLC-escapes start (ESC 2) */
143
144  /* decoding trees */
145  const UINT *pHuffTreeRvlCodewds;
146  const UINT *pHuffTreeRvlcEscape;
147
148  /* escape counters */
149  UCHAR      numDecodedEscapeWordsFwd;    /* when decoding RVL-codes forward  */
150  UCHAR      numDecodedEscapeWordsBwd;    /* when decoding RVL-codes backward */
151  UCHAR      numDecodedEscapeWordsEsc;    /* when decoding the escape-Words */
152
153  SCHAR      noise_used;
154  SCHAR      intensity_used;
155  SCHAR      sf_used;
156
157  SHORT      firstScf;
158  SHORT      lastScf;
159  SHORT      firstNrg;
160  SHORT      lastNrg;
161  SHORT      firstIs;
162  SHORT      lastIs;
163
164  /* ------ RVLC error detection ------ */
165  UINT       errorLogRvlc;                /* store RVLC errors  */
166  SHORT      conceal_min;                 /* is set at backward decoding  */
167  SHORT      conceal_max;                 /* is set at forward  decoding  */
168  SHORT      conceal_min_esc;             /* is set at backward decoding  */
169  SHORT      conceal_max_esc;             /* is set at forward  decoding  */
170} CErRvlcInfo;
171
172typedef CErRvlcInfo RVLC_INFO; /* temp */
173
174
175
176#endif /* RVLC_INFO_H */
177