decoder excitation now in 16-bit precision (was 32), which saves quite a bit
[speexdsp.git] / libspeex / misc.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file misc.h
4    @brief Various compatibility routines for Speex
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 MISC_H
36 #define MISC_H
37
38 #ifndef SPEEX_VERSION
39 #define SPEEX_MAJOR_VERSION 1         /**< Major Speex version. */
40 #define SPEEX_MINOR_VERSION 1         /**< Minor Speex version. */
41 #define SPEEX_MICRO_VERSION 13        /**< Micro Speex version. */
42 #define SPEEX_EXTRA_VERSION ""        /**< Extra Speex version. */
43 #define SPEEX_VERSION "speex-1.1.13"  /**< Speex version string. */
44 #endif
45
46 /* A couple test to catch stupid option combinations */
47 #ifdef FIXED_POINT
48
49 #ifdef _USE_SSE
50 #error SSE is only for floating-point
51 #endif
52 #if ((defined (ARM4_ASM)||defined (ARM4_ASM)) && defined(BFIN_ASM)) || (defined (ARM4_ASM)&&defined(ARM5E_ASM))
53 #error Make up your mind. What CPU do you have?
54 #endif
55 #ifdef VORBIS_PSYCHO
56 #error Vorbis-psy model currently not implemented in fixed-point
57 #endif
58
59 #else
60
61 #if defined (ARM4_ASM) || defined(ARM5E_ASM) || defined(BFIN_ASM)
62 #error I suppose you can have a [ARM4/ARM5E/Blackfin] that has float instructions?
63 #endif
64 #ifdef FIXED_POINT_DEBUG
65 #error Don't you think enabling fixed-point is a good thing to do if you want to debug that?
66 #endif
67
68
69 #endif
70
71 #include "arch.h"
72
73 #ifndef RELEASE
74 /** Print a named vector to stdout */
75 void print_vec(float *vec, int len, char *name);
76 #endif
77
78 /** Convert big endian */
79 spx_uint32_t be_int(spx_uint32_t i);
80 /** Convert little endian */
81 spx_uint32_t le_int(spx_uint32_t i);
82
83 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_free */
84 void *speex_alloc (int size);
85
86 /** Same as speex_alloc, except that the area is only needed inside a Speex call (might cause problem with wideband though) */
87 void *speex_alloc_scratch (int size);
88
89 /** Speex wrapper for realloc. To do your own dynamic allocation, all you need to do is replace this function, speex_alloc and speex_free */
90 void *speex_realloc (void *ptr, int size);
91
92 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_alloc */
93 void speex_free (void *ptr);
94
95 /** Same as speex_alloc, except that the area is only needed inside a Speex call (might cause problem with wideband though) */
96 void speex_free_scratch (void *ptr);
97
98 /** Speex wrapper for mem_move */
99 void *speex_move (void *dest, void *src, int n);
100
101 /** Speex wrapper for memcpy */
102 void speex_memcpy_bytes(char *dst, char *src, int nbytes);
103
104 /** Speex wrapper for memset */
105 void speex_memset_bytes(char *dst, char src, int nbytes);
106
107 /** Print error message to stderr */
108 void speex_error(const char *str);
109
110 /** Print warning message to stderr */
111 void speex_warning(const char *str);
112
113 /** Print warning message with integer argument to stderr */
114 void speex_warning_int(const char *str, int val);
115
116 /** Generate a random number */
117 spx_word16_t speex_rand(spx_word16_t std, spx_int32_t *seed);
118
119 /** Speex wrapper for putc */
120 void _speex_putc(int ch, void *file);
121
122 #endif