Adds 3rd clause to CELT license
[opus.git] / celt / 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    - Neither the name of Internet Society, IETF or IETF Trust, nor the
19    names of specific contributors, may be used to endorse or promote
20    products derived from this software without specific prior written
21    permission.
22
23    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26    DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
27    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33    POSSIBILITY OF SUCH DAMAGE.
34 */
35
36 #ifndef OS_SUPPORT_H
37 #define OS_SUPPORT_H
38
39 #ifdef CUSTOM_SUPPORT
40 #  include "custom_support.h"
41 #endif
42
43 #include <string.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46
47 /** Opus wrapper for malloc(). To do your own dynamic allocation, all you need to do is replace this function and opus_free */
48 #ifndef OVERRIDE_OPUS_ALLOC
49 static inline void *opus_alloc (size_t size)
50 {
51    return malloc(size);
52 }
53 #endif
54
55 /** Same as celt_alloc(), except that the area is only needed inside a CELT call (might cause problem with wideband though) */
56 #ifndef OVERRIDE_OPUS_ALLOC_SCRATCH
57 static inline void *opus_alloc_scratch (size_t size)
58 {
59    /* Scratch space doesn't need to be cleared */
60    return opus_alloc(size);
61 }
62 #endif
63
64 /** Opus wrapper for free(). To do your own dynamic allocation, all you need to do is replace this function and opus_alloc */
65 #ifndef OVERRIDE_OPUS_FREE
66 static inline void opus_free (void *ptr)
67 {
68    free(ptr);
69 }
70 #endif
71
72 /** Copy n bytes of memory from src to dst. The 0* term provides compile-time type checking  */
73 #ifndef OVERRIDE_OPUS_COPY
74 #define OPUS_COPY(dst, src, n) (memcpy((dst), (src), (n)*sizeof(*(dst)) + 0*((dst)-(src)) ))
75 #endif
76
77 /** Copy n bytes of memory from src to dst, allowing overlapping regions. The 0* term
78     provides compile-time type checking */
79 #ifndef OVERRIDE_OPUS_MOVE
80 #define OPUS_MOVE(dst, src, n) (memmove((dst), (src), (n)*sizeof(*(dst)) + 0*((dst)-(src)) ))
81 #endif
82
83 /** Set n elements of dst to zero, starting at address s */
84 #ifndef OVERRIDE_OPUS_CLEAR
85 #define OPUS_CLEAR(dst, n) (memset((dst), 0, (n)*sizeof(*(dst))))
86 #endif
87
88 /*#ifdef __GNUC__
89 #pragma GCC poison printf sprintf
90 #pragma GCC poison malloc free realloc calloc
91 #endif*/
92
93 #endif /* OS_SUPPORT_H */
94