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/*****************************  MPEG-4 AAC Decoder  ***************************
85
86   Author(s):   Robert Weidner (DSP Solutions)
87   Description: HCR Decoder: Defines of state-constants, masks and
88                state-prototypes
89
90*******************************************************************************/
91
92#ifndef _AACDEC_HCRS_H_
93#define _AACDEC_HCRS_H_
94
95
96
97#include "FDK_bitstream.h"
98#include "aacdec_hcr_types.h"
99                                                    /* The four different kinds of types of states are:                     */
100/* different states are defined as constants */     /* start   middle=self   next   stop                                    */
101#define  STOP_THIS_STATE             0              /*                                                                      */
102#define  BODY_ONLY                   1              /*   X          X                X                                      */
103#define  BODY_SIGN__BODY             2              /*   X          X         X      X [stop if no sign]                    */
104#define  BODY_SIGN__SIGN             3              /*              X                X [stop if sign bits decoded]          */
105#define  BODY_SIGN_ESC__BODY         4              /*   X          X         X      X [stop if no sign]                    */
106#define  BODY_SIGN_ESC__SIGN         5              /*              X         X      X [stop if no escape sequence]         */
107#define  BODY_SIGN_ESC__ESC_PREFIX   6              /*              X         X                                             */
108#define  BODY_SIGN_ESC__ESC_WORD     7              /*              X         X      X [stop if abs(second qsc) != 16]      */
109
110/* examples: */
111
112/* BODY_ONLY                    means only the codeword body will be decoded; no sign bits will follow and no escapesequence will follow */
113
114/* BODY_SIGN__BODY              means that the codeword consists of two parts; body and sign part. The part '__BODY' after the two underscores shows */
115/*                              that the bits which are currently decoded belong to the '__BODY' of the codeword and not to the sign part. */
116
117/* BODY_SIGN_ESC__ESC_PB        means that the codeword consists of three parts; body, sign and (here: two) escape sequences;  */
118/*                              P = Prefix = ones */
119/*                              W = Escape Word */
120/*                              A = first possible (of two) Escape sequeces */
121/*                              B = second possible (of two) Escape sequeces */
122/*                              The part after the two underscores shows that the current bits which are decoded belong to the '__ESC_PB' - part of the */
123/*                              codeword. That means the body and the sign bits are decoded completely and the bits which are decoded now belong to */
124/*                              the escape sequence [P = prefix; B=second possible escape sequence] */
125
126
127#define   MSB_31_MASK                       0x80000000              /* masks MSB (= Bit 31) in a 32 bit word */
128#define   DIMENSION_OF_ESCAPE_CODEBOOK      2                       /* for cb >= 11 is dimension 2 */
129#define   ESCAPE_CODEBOOK                   11
130
131#define   MASK_ESCAPE_PREFIX_UP             0x000F0000
132#define   LSB_ESCAPE_PREFIX_UP              16
133
134#define   MASK_ESCAPE_PREFIX_DOWN           0x0000F000
135#define   LSB_ESCAPE_PREFIX_DOWN            12
136
137#define   MASK_ESCAPE_WORD                  0x00000FFF
138#define   MASK_FLAG_A                       0x00200000
139#define   MASK_FLAG_B                       0x00100000
140
141
142extern void DecodeNonPCWs(HANDLE_FDK_BITSTREAM bs, H_HCR_INFO hHcr);
143
144UINT Hcr_State_BODY_ONLY                 (HANDLE_FDK_BITSTREAM, void*);
145UINT Hcr_State_BODY_SIGN__BODY           (HANDLE_FDK_BITSTREAM, void*);
146UINT Hcr_State_BODY_SIGN__SIGN           (HANDLE_FDK_BITSTREAM, void*);
147UINT Hcr_State_BODY_SIGN_ESC__BODY       (HANDLE_FDK_BITSTREAM, void*);
148UINT Hcr_State_BODY_SIGN_ESC__SIGN       (HANDLE_FDK_BITSTREAM, void*);
149UINT Hcr_State_BODY_SIGN_ESC__ESC_PREFIX (HANDLE_FDK_BITSTREAM, void*);
150UINT Hcr_State_BODY_SIGN_ESC__ESC_WORD   (HANDLE_FDK_BITSTREAM, void*);
151
152#endif /* _AACDEC_HCRS_H_ */
153
154