decoder excitation now in 16-bit precision (was 32), which saves quite a bit
[speexdsp.git] / libspeex / stack_alloc.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file stack_alloc.h
4    @brief Temporary memory allocation on stack
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef STACK_ALLOC_H
36 #define STACK_ALLOC_H
37
38 #ifdef USE_ALLOCA
39 #ifdef WIN32
40 #include <malloc.h>
41 #else
42 #include <alloca.h>
43 #endif
44 #endif
45
46 /**
47  * @def ALIGN(stack, size)
48  *
49  * Aligns the stack to a 'size' boundary
50  *
51  * @param stack Stack
52  * @param size  New size boundary
53  */
54
55 /**
56  * @def PUSH(stack, size, type)
57  *
58  * Allocates 'size' elements of type 'type' on the stack
59  *
60  * @param stack Stack
61  * @param size  Number of elements
62  * @param type  Type of element
63  */
64
65 /**
66  * @def PUSHS(stack, type)
67  *
68  * Allocates a struct stack 
69  *
70  * @param stack Stack
71  * @param type  Struct type
72  */
73
74 /**
75  * @def VARDECL(var)
76  *
77  * Declare variable on stack
78  *
79  * @param var Variable to declare
80  */
81
82 /**
83  * @def ALLOC(var, size, type)
84  *
85  * Allocate 'size' elements of 'type' on stack
86  *
87  * @param var  Name of variable to allocate
88  * @param size Number of elements
89  * @param type Type of element
90  */
91
92 #ifdef ENABLE_VALGRIND
93
94 #include <valgrind/memcheck.h>
95
96 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
97
98 #define PUSH(stack, size, type) (VALGRIND_MAKE_NOACCESS(stack, 1000),ALIGN((stack),sizeof(type)),VALGRIND_MAKE_WRITABLE(stack, ((size)*sizeof(type))),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type))))
99
100 #define PUSHS(stack, type) (VALGRIND_MAKE_NOACCESS(stack, 1000),ALIGN((stack),sizeof(long)),VALGRIND_MAKE_WRITABLE(stack, (sizeof(type))),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type))))
101
102 #else
103
104 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
105
106 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type))))
107
108 #define PUSHS(stack, type) (ALIGN((stack),sizeof(long)),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type))))
109
110 #endif
111
112 #if defined(VAR_ARRAYS)
113 #define VARDECL(var) 
114 #define ALLOC(var, size, type) type var[size]
115 #elif defined(USE_ALLOCA)
116 #define VARDECL(var) var
117 #define ALLOC(var, size, type) var = alloca(sizeof(type)*size)
118 #else
119 #define VARDECL(var) var
120 #define ALLOC(var, size, type) var = PUSH(stack, size, type)
121 #endif
122
123
124 #endif