FDK_matrixCalloc.h revision 6cfabd35363c3ef5e3b209b867169a500b3ccc3c
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/******************* Library for basic calculation routines ********************
96
97   Author(s):
98
99   Description: matrix memory allocation
100
101*******************************************************************************/
102
103#ifndef FDK_MATRIXCALLOC_H
104#define FDK_MATRIXCALLOC_H
105
106#include "machine_type.h"
107#include "genericStds.h"
108
109/* It is recommended to use FDK_ALLOCATE_MEMORY_1D instead of fdkCallocMatrix1D
110 */
111void* fdkCallocMatrix1D(UINT dim1, UINT size);
112void* fdkCallocMatrix1D_aligned(UINT dim1, UINT size);
113/* It is recommended to use FDK_ALLOCATE_MEMORY_1D_INT instead of
114 * fdkCallocMatrix1D_int */
115void* fdkCallocMatrix1D_int(UINT dim1, UINT size, MEMORY_SECTION s);
116void* fdkCallocMatrix1D_int_aligned(UINT dim1, UINT size, MEMORY_SECTION s);
117/* It is recommended to use FDK_FREE_MEMORY_1D instead of fdkFreeMatrix1D */
118void fdkFreeMatrix1D(void* p);
119void fdkFreeMatrix1D_aligned(void* p);
120
121/* It is recommended to use FDK_ALLOCATE_MEMORY_2D instead of fdkCallocMatrix2D
122 */
123void** fdkCallocMatrix2D(UINT dim1, UINT dim2, UINT size);
124void** fdkCallocMatrix2D_aligned(UINT dim1, UINT dim2, UINT size);
125/* It is recommended to use FDK_ALLOCATE_MEMORY_2D_INT instead of
126 * fdkCallocMatrix2D_int */
127void** fdkCallocMatrix2D_int(UINT dim1, UINT dim2, UINT size, MEMORY_SECTION s);
128/* It is recommended to use FDK_ALLOCATE_MEMORY_2D_INT_ALIGNED instead of
129 * fdkCallocMatrix2D_int_aligned */
130void** fdkCallocMatrix2D_int_aligned(UINT dim1, UINT dim2, UINT size,
131                                     MEMORY_SECTION s);
132/* It is recommended to use FDK_FREE_MEMORY_2D instead of fdkFreeMatrix2D */
133void fdkFreeMatrix2D(void** p);
134/* It is recommended to use FDK_FREE_MEMORY_2D_ALIGNED instead of
135 * fdkFreeMatrix2D_aligned */
136void fdkFreeMatrix2D_aligned(void** p);
137
138/* It is recommended to use FDK_ALLOCATE_MEMORY_3D instead of fdkCallocMatrix3D
139 */
140void*** fdkCallocMatrix3D(UINT dim1, UINT dim2, UINT dim3, UINT size);
141/* It is recommended to use FDK_ALLOCATE_MEMORY_3D_INT instead of
142 * fdkCallocMatrix3D_int */
143void*** fdkCallocMatrix3D_int(UINT dim1, UINT dim2, UINT dim3, UINT size,
144                              MEMORY_SECTION s);
145/* It is recommended to use FDK_FREE_MEMORY_3D instead of fdkFreeMatrix3D */
146void fdkFreeMatrix3D(void*** p);
147
148#define FDK_ALLOCATE_MEMORY_1D(a, dim1, type)                           \
149  if (((a) = (type*)fdkCallocMatrix1D((dim1), sizeof(type))) == NULL) { \
150    goto bail;                                                          \
151  }
152
153#define FDK_ALLOCATE_MEMORY_1D_ALIGNED(a, dim1, type)                   \
154  if (((a) = (type*)fdkCallocMatrix1D_aligned((dim1), sizeof(type))) == \
155      NULL) {                                                           \
156    goto bail;                                                          \
157  }
158
159#define FDK_ALLOCATE_MEMORY_1D_P(a, dim1, type, ptype)                  \
160  if (((a) = (ptype)fdkCallocMatrix1D((dim1), sizeof(type))) == NULL) { \
161    goto bail;                                                          \
162  }
163
164#define FDK_ALLOCATE_MEMORY_1D_INT(a, dim1, type, s)                     \
165  if (((a) = (type*)fdkCallocMatrix1D_int((dim1), sizeof(type), (s))) == \
166      NULL) {                                                            \
167    goto bail;                                                           \
168  }
169
170#define FDK_FREE_MEMORY_1D(a)    \
171  do {                           \
172    fdkFreeMatrix1D((void*)(a)); \
173    (a) = NULL;                  \
174  } while (0)
175
176#define FDK_FREE_MEMORY_1D_ALIGNED(a)    \
177  do {                                   \
178    fdkFreeMatrix1D_aligned((void*)(a)); \
179    (a) = NULL;                          \
180  } while (0)
181
182#define FDK_ALLOCATE_MEMORY_2D(a, dim1, dim2, type)                      \
183  if (((a) = (type**)fdkCallocMatrix2D((dim1), (dim2), sizeof(type))) == \
184      NULL) {                                                            \
185    goto bail;                                                           \
186  }
187
188#define FDK_ALLOCATE_MEMORY_2D_INT(a, dim1, dim2, type, s)               \
189  if (((a) = (type**)fdkCallocMatrix2D_int((dim1), (dim2), sizeof(type), \
190                                           (s))) == NULL) {              \
191    goto bail;                                                           \
192  }
193
194#define FDK_ALLOCATE_MEMORY_2D_INT_ALIGNED(a, dim1, dim2, type, s) \
195  if (((a) = (type**)fdkCallocMatrix2D_int_aligned(                \
196           (dim1), (dim2), sizeof(type), (s))) == NULL) {          \
197    goto bail;                                                     \
198  }
199
200#define FDK_FREE_MEMORY_2D(a)     \
201  do {                            \
202    fdkFreeMatrix2D((void**)(a)); \
203    (a) = NULL;                   \
204  } while (0)
205
206#define FDK_FREE_MEMORY_2D_ALIGNED(a)     \
207  do {                                    \
208    fdkFreeMatrix2D_aligned((void**)(a)); \
209    (a) = NULL;                           \
210  } while (0)
211
212#define FDK_ALLOCATE_MEMORY_3D(a, dim1, dim2, dim3, type)         \
213  if (((a) = (type***)fdkCallocMatrix3D((dim1), (dim2), (dim3),   \
214                                        sizeof(type))) == NULL) { \
215    goto bail;                                                    \
216  }
217
218#define FDK_ALLOCATE_MEMORY_3D_INT(a, dim1, dim2, dim3, type, s)           \
219  if (((a) = (type***)fdkCallocMatrix3D_int((dim1), (dim2), (dim3),        \
220                                            sizeof(type), (s))) == NULL) { \
221    goto bail;                                                             \
222  }
223
224#define FDK_FREE_MEMORY_3D(a)      \
225  do {                             \
226    fdkFreeMatrix3D((void***)(a)); \
227    (a) = NULL;                    \
228  } while (0)
229
230#endif /* FDK_MATRIXCALLOC_H */
231