• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 /************************* System integration library **************************
96 
97    Author(s):   Thomas Dietzen
98 
99    Description:
100 
101 *******************************************************************************/
102 
103 /** \file   syslib_channelMapDescr.h
104  *  \brief  Function and structure declarations for the channel map descriptor implementation.
105  */
106 
107 #ifndef SYSLIB_CHANNELMAPDESCR_H
108 #define SYSLIB_CHANNELMAPDESCR_H
109 
110 #include "machine_type.h"
111 
112 /**
113  * \brief  Contains information needed for a single channel map.
114  */
115 typedef struct {
116   const UCHAR*
117       pChannelMap; /*!< Actual channel mapping for one single configuration. */
118   UCHAR numChannels; /*!< The number of channels for the channel map which is
119                         the maximum used channel index+1. */
120 } CHANNEL_MAP_INFO;
121 
122 /**
123  * \brief   This is the main data struct. It contains the mapping for all
124  * channel configurations such as administration information.
125  *
126  * CAUTION: Do not access this structure directly from a algorithm specific
127  * library. Always use one of the API access functions below!
128  */
129 typedef struct {
130   const CHANNEL_MAP_INFO* pMapInfoTab; /*!< Table of channel maps. */
131   UINT mapInfoTabLen; /*!< Length of the channel map table array. */
132   UINT fPassThrough;  /*!< Flag that defines whether the specified mapping shall
133                          be applied  (value: 0) or the input just gets passed
134                          through (MPEG mapping). */
135 } FDK_channelMapDescr;
136 
137 #ifdef __cplusplus
138 extern "C" {
139 #endif
140 
141 /**
142  * \brief  Initialize a given channel map descriptor.
143  *
144  * \param  pMapDescr      Pointer to a channel map descriptor to be initialized.
145  * \param  pMapInfoTab    Table of channel maps to initizalize the descriptor
146  with.
147  *                        If a NULL pointer is given a default table for
148  WAV-like mapping will be used.
149  * \param  mapInfoTabLen  Length of the channel map table array (pMapInfoTab).
150  If a zero length is given a default table for WAV-like mapping will be used.
151  * \param  fPassThrough   If the flag is set the reordering (given by
152  pMapInfoTab) will be bypassed.
153  */
154 void FDK_chMapDescr_init(FDK_channelMapDescr* const pMapDescr,
155                          const CHANNEL_MAP_INFO* const pMapInfoTab,
156                          const UINT mapInfoTabLen, const UINT fPassThrough);
157 
158 /**
159  * \brief  Change the channel reordering state of a given channel map
160  * descriptor.
161  *
162  * \param  pMapDescr     Pointer to a (initialized) channel map descriptor.
163  * \param  fPassThrough  If the flag is set the reordering (given by
164  * pMapInfoTab) will be bypassed.
165  * \return               Value unequal to zero if set operation was not
166  * successful. And zero on success.
167  */
168 int FDK_chMapDescr_setPassThrough(FDK_channelMapDescr* const pMapDescr,
169                                   UINT fPassThrough);
170 
171 /**
172  * \brief  Get the mapping value for a specific channel and map index.
173  *
174  * \param  pMapDescr  Pointer to channel map descriptor.
175  * \param  chIdx      Channel index.
176  * \param  mapIdx     Mapping index (corresponding to the channel configuration
177  * index).
178  * \return            Mapping value.
179  */
180 UCHAR FDK_chMapDescr_getMapValue(const FDK_channelMapDescr* const pMapDescr,
181                                  const UCHAR chIdx, const UINT mapIdx);
182 
183 /**
184  * \brief  Evaluate whether channel map descriptor is reasonable or not.
185  *
186  * \param  pMapDescr Pointer to channel map descriptor.
187  * \return           Value unequal to zero if descriptor is valid, otherwise
188  * zero.
189  */
190 int FDK_chMapDescr_isValid(const FDK_channelMapDescr* const pMapDescr);
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 
196 #endif /* !defined(SYSLIB_CHANNELMAPDESCR_H) */
197