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/*********************** MPEG surround encoder library *************************
96
97   Author(s):   Max Neuendorf
98
99   Description: Encoder Library Interface
100                Tree Structure for Space Encoder
101
102*******************************************************************************/
103
104#ifndef SACENC_TREE_H
105#define SACENC_TREE_H
106
107/* Includes ******************************************************************/
108#include "sacenc_framewindowing.h"
109#include "sacenc_lib.h"
110#include "sacenc_bitstream.h"
111
112/* Defines *******************************************************************/
113
114/* Data Types ****************************************************************/
115typedef enum {
116  SPACETREE_INVALID_MODE = 0,
117  SPACETREE_212 = 8
118
119} SPACETREE_MODE;
120
121typedef struct SPACE_TREE *HANDLE_SPACE_TREE;
122
123typedef struct {
124  UCHAR nParamBands;
125  UCHAR bUseCoarseQuantTtoCld;
126  UCHAR bUseCoarseQuantTtoIcc;
127  QUANTMODE quantMode;
128  SPACETREE_MODE mode;
129
130  UCHAR nChannelsInMax;
131  UCHAR nHybridBandsMax;
132
133} SPACE_TREE_SETUP;
134
135typedef struct {
136  UCHAR nOttBoxes;
137  UCHAR nInChannels;
138  UCHAR nOutChannels;
139
140} SPACE_TREE_DESCRIPTION;
141
142/* Constants *****************************************************************/
143
144/* Function / Class Declarations *********************************************/
145FDK_SACENC_ERROR fdk_sacenc_spaceTree_Open(HANDLE_SPACE_TREE *phSpaceTree);
146
147FDK_SACENC_ERROR fdk_sacenc_spaceTree_Init(
148    HANDLE_SPACE_TREE hST, const SPACE_TREE_SETUP *const hSetup,
149    UCHAR *pParameterBand2HybridBandOffset, const INT bFrameKeep);
150
151FDK_SACENC_ERROR fdk_sacenc_spaceTree_Apply(
152    HANDLE_SPACE_TREE hST, const INT paramSet, const INT nChannelsIn,
153    const INT nTimeSlots, const INT startTimeSlot, const INT nHybridBands,
154    FIXP_WIN *pFrameWindowAna__FDK,
155    FIXP_DPK *const *const *const pppHybrid__FDK,
156    FIXP_DPK *const *const *const pppHybridIn__FDK, SPATIALFRAME *const hSTOut,
157    const INT avoid_keep, INT *pEncoderInputChScale);
158
159FDK_SACENC_ERROR fdk_sacenc_spaceTree_Close(HANDLE_SPACE_TREE *phSpaceTree);
160
161FDK_SACENC_ERROR fdk_sacenc_spaceTree_GetDescription(
162    const HANDLE_SPACE_TREE hSpaceTree,
163    SPACE_TREE_DESCRIPTION *pSpaceTreeDescription);
164
165INT fdk_sacenc_spaceTree_Hybrid2ParamBand(const INT nParamBands,
166                                          const INT nHybridBand);
167
168#endif /* SACENC_TREE_H */
169