Updated Doxygen comments, removed an incorrectly placed LGPL header (we own
[opus.git] / libcelt / os_support.h
1 /* Copyright (C) 2007 Jean-Marc Valin
2       
3    File: os_support.h
4    This is the (tiny) OS abstraction layer. Aside from math.h, this is the
5    only place where system headers are allowed.
6
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions are
9    met:
10
11    1. Redistributions of source code must retain the above copyright notice,
12    this list of conditions and the following disclaimer.
13
14    2. 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    3. The name of the author may not be used to endorse or promote products
19    derived from this software without specific prior written permission.
20
21    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24    DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
25    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31    POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef OS_SUPPORT_H
35 #define OS_SUPPORT_H
36
37 #include <string.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40
41 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, celt_realloc and celt_free 
42     NOTE: celt_alloc needs to CLEAR THE MEMORY */
43 #ifndef OVERRIDE_CELT_ALLOC
44 static inline void *celt_alloc (int size)
45 {
46    /* WARNING: this is not equivalent to malloc(). If you want to use malloc() 
47       or your own allocator, YOU NEED TO CLEAR THE MEMORY ALLOCATED. Otherwise
48       you will experience strange bugs */
49    return calloc(size,1);
50 }
51 #endif
52
53 /** Same as celt_alloc, except that the area is only needed inside a Speex call (might cause problem with wideband though) */
54 #ifndef OVERRIDE_CELT_ALLOC_SCRATCH
55 static inline void *celt_alloc_scratch (int size)
56 {
57    /* Scratch space doesn't need to be cleared */
58    return calloc(size,1);
59 }
60 #endif
61
62 /** Speex wrapper for realloc. To do your own dynamic allocation, all you need to do is replace this function, celt_alloc and celt_free */
63 #ifndef OVERRIDE_CELT_REALLOC
64 static inline void *celt_realloc (void *ptr, int size)
65 {
66    return realloc(ptr, size);
67 }
68 #endif
69
70 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, celt_realloc and celt_alloc */
71 #ifndef OVERRIDE_CELT_FREE
72 static inline void celt_free (void *ptr)
73 {
74    free(ptr);
75 }
76 #endif
77
78 /** Same as celt_free, except that the area is only needed inside a Speex call (might cause problem with wideband though) */
79 #ifndef OVERRIDE_CELT_FREE_SCRATCH
80 static inline void celt_free_scratch (void *ptr)
81 {
82    free(ptr);
83 }
84 #endif
85
86 /** Copy n bytes of memory from src to dst. The 0* term provides compile-time type checking  */
87 #ifndef OVERRIDE_CELT_COPY
88 #define CELT_COPY(dst, src, n) (memcpy((dst), (src), (n)*sizeof(*(dst)) + 0*((dst)-(src)) ))
89 #endif
90
91 /** Copy n bytes of memory from src to dst, allowing overlapping regions. The 0* term 
92     provides compile-time type checking */
93 #ifndef OVERRIDE_CELT_MOVE
94 #define CELT_MOVE(dst, src, n) (memmove((dst), (src), (n)*sizeof(*(dst)) + 0*((dst)-(src)) ))
95 #endif
96
97 /** Set n bytes of memory to value of c, starting at address s */
98 #ifndef OVERRIDE_CELT_MEMSET
99 #define CELT_MEMSET(dst, c, n) (memset((dst), (c), (n)*sizeof(*(dst))))
100 #endif
101
102
103 #ifndef OVERRIDE_CELT_FATAL
104 static inline void _celt_fatal(const char *str, const char *file, int line)
105 {
106    fprintf (stderr, "Fatal (internal) error in %s, line %d: %s\n", file, line, str);
107    exit(1);
108 }
109 #endif
110
111 #ifndef OVERRIDE_CELT_WARNING
112 static inline void celt_warning(const char *str)
113 {
114 #ifndef DISABLE_WARNINGS
115    fprintf (stderr, "warning: %s\n", str);
116 #endif
117 }
118 #endif
119
120 #ifndef OVERRIDE_CELT_WARNING_INT
121 static inline void celt_warning_int(const char *str, int val)
122 {
123 #ifndef DISABLE_WARNINGS
124    fprintf (stderr, "warning: %s %d\n", str, val);
125 #endif
126 }
127 #endif
128
129 #ifndef OVERRIDE_CELT_NOTIFY
130 static inline void celt_notify(const char *str)
131 {
132 #ifndef DISABLE_NOTIFICATIONS
133    fprintf (stderr, "notification: %s\n", str);
134 #endif
135 }
136 #endif
137
138 #ifndef OVERRIDE_CELT_PUTC
139 /** Speex wrapper for putc */
140 static inline void _celt_putc(int ch, void *file)
141 {
142    FILE *f = (FILE *)file;
143    fprintf(f, "%c", ch);
144 }
145 #endif
146
147 #define celt_fatal(str) _celt_fatal(str, __FILE__, __LINE__);
148 #define celt_assert(cond) {if (!(cond)) {celt_fatal("assertion failed: " #cond);}}
149
150 #ifndef RELEASE
151 static inline void print_vec(float *vec, int len, char *name)
152 {
153    int i;
154    printf ("%s ", name);
155    for (i=0;i<len;i++)
156       printf (" %f", vec[i]);
157    printf ("\n");
158 }
159 #endif
160
161 #endif
162