TI DSP (C5x and C6x) patch by Jim Crichton
[speexdsp.git] / ti / user_misc.h
1 /* Copyright (C) 2005 Psi Systems, Inc.
2    Author:  Jean-Marc Valin 
3    File: user_misc.h
4    Memory Allocation overrides to allow user control rather than C alloc/free.
5
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9    
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12    
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16    
17    - Neither the name of the Xiph.org Foundation nor the names of its
18    contributors may be used to endorse or promote products derived from
19    this software without specific prior written permission.
20    
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
25    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33 \r
34 #ifdef MANUAL_ALLOC\r
35 \r
36 /* To avoid changing the Speex call model, this file relies on four static variables \r
37    The user main creates two linear buffers, and initializes spxGlobalHeap/ScratchPtr \r
38    to point to the start of the two buffers, and initializes spxGlobalHeap/ScratchEnd \r
39    to point to the first address following the last byte of the two buffers.\r
40    \r
41    This mechanism allows, for example, data caching for multichannel applications, \r
42    where the Speex state is swapped from a large slow memory to a small fast memory \r
43    each time the codec runs.\r
44    \r
45    Persistent data is allocated in spxGlobalHeap (instead of calloc), while scratch\r
46    data is allocated in spxGlobalScratch.\r
47 */\r
48 \r
49 extern char *spxGlobalHeapPtr, *spxGlobalHeapEnd; \r
50 extern char *spxGlobalScratchPtr, *spxGlobalScratchEnd;\r
51 \r
52 /* Make sure that all structures are aligned to largest type */\r
53 #define BLOCK_MASK      (sizeof(long double)-1)\r
54 \r
55 #define OVERRIDE_SPEEX_ALLOC\r
56 void *speex_alloc (int size)\r
57 {\r
58     void *ptr;\r
59     \r
60     ptr = (void *) (((int)spxGlobalHeapPtr + BLOCK_MASK) & ~BLOCK_MASK);  //Start on 8 boundary\r
61 \r
62     spxGlobalHeapPtr = (char *)((int)ptr + size);       // Update pointer to next free location\r
63 \r
64     if (spxGlobalHeapPtr > spxGlobalHeapEnd ) \r
65     {\r
66 #ifdef VERBOSE_ALLOC\r
67             fprintf (stderr, "insufficient space for persistent alloc request %d bytes\n", size);\r
68 #endif\r
69        return 0;\r
70     }\r
71    \r
72 #ifdef VERBOSE_ALLOC\r
73     fprintf (stderr, "Persist Allocated %d chars at %x, %d remaining\n", size, ptr, ((int)spxGlobalHeapEnd - (int)spxGlobalHeapPtr));\r
74 #endif\r
75     memset(ptr, 0, size);\r
76     return ptr;\r
77 }\r
78 \r
79 #define OVERRIDE_SPEEX_ALLOC_SCRATCH\r
80 void *speex_alloc_scratch (int size)\r
81 {\r
82     void *ptr;\r
83 \r
84     ptr = (void *) (((int)spxGlobalScratchPtr + BLOCK_MASK) & ~BLOCK_MASK);  //Start on 8 boundary\r
85 \r
86     spxGlobalScratchPtr = (char *)((int)ptr + size);    // Update pointer to next free location\r
87 \r
88     if (spxGlobalScratchPtr > spxGlobalScratchEnd ) \r
89     {\r
90 #ifdef VERBOSE_ALLOC\r
91             fprintf (stderr, "insufficient space for scratch alloc request %d bytes\n", size);\r
92 #endif\r
93        return 0;\r
94     }\r
95    \r
96 #ifdef VERBOSE_ALLOC\r
97     fprintf (stderr, "Scratch Allocated %d chars at %x, %d remaining\n", size, ptr, ((int)spxGlobalScratchEnd - (int)spxGlobalScratchPtr));\r
98 #endif\r
99     memset(ptr, 0, size);\r
100     return ptr;\r
101 }\r
102 \r
103 #define OVERRIDE_SPEEX_REALLOC\r
104 void *speex_realloc (void *ptr, int size)\r
105 {\r
106 #ifdef VERBOSE_ALLOC\r
107    speex_warning("realloc attempted, not allowed");\r
108 #endif\r
109    return 0;\r
110 }\r
111 \r
112 #define OVERRIDE_SPEEX_FREE\r
113 void speex_free (void *ptr)\r
114 {\r
115 #ifdef VERBOSE_ALLOC\r
116    speex_warning("at speex_free");\r
117 #endif\r
118 }\r
119 #define OVERRIDE_SPEEX_FREE_SCRATCH\r
120 void speex_free_scratch (void *ptr)\r
121 {\r
122 #ifdef VERBOSE_ALLOC\r
123    speex_warning("at speex_free_scratch");\r
124 #endif\r
125 }\r
126 \r
127 #endif    /* !MANUAL_ALLOC */\r