1/* Copyright (C) 2003 Jean-Marc Valin */
2/**
3   @file arch.h
4   @brief Various architecture definitions 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 ARCH_H
36#define ARCH_H
37
38#define FLOATING_POINT
39
40/* A couple test to catch stupid option combinations */
41#ifdef FIXED_POINT
42
43#ifdef FLOATING_POINT
44#error You cannot compile as floating point and fixed point at the same time
45#endif
46#ifdef USE_SSE
47#error SSE is only for floating-point
48#endif
49#if ((defined (ARM4_ASM)||defined (ARM4_ASM)) && defined(BFIN_ASM)) || (defined (ARM4_ASM)&&defined(ARM5E_ASM))
50#error Make up your mind. What CPU do you have?
51#endif
52#ifdef VORBIS_PSYCHO
53#error Vorbis-psy model currently not implemented in fixed-point
54#endif
55
56#else
57
58#ifndef FLOATING_POINT
59#error You now need to define either FIXED_POINT or FLOATING_POINT
60#endif
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#ifndef OUTSIDE_SPEEX
72#include "speex/speexdsp_types.h"
73#endif
74
75#define ABS(x) ((x) < 0 ? (-(x)) : (x))      /**< Absolute integer value. */
76#define ABS16(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 16-bit value.  */
77#define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
78#define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
79#define ABS32(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 32-bit value.  */
80#define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
81#define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
82
83#ifdef FIXED_POINT
84
85typedef spx_int16_t spx_word16_t;
86typedef spx_int32_t spx_word32_t;
87typedef spx_word32_t spx_mem_t;
88typedef spx_word16_t spx_coef_t;
89typedef spx_word16_t spx_lsp_t;
90typedef spx_word32_t spx_sig_t;
91
92#define Q15ONE 32767
93
94#define LPC_SCALING  8192
95#define SIG_SCALING  16384
96#define LSP_SCALING  8192.
97#define GAMMA_SCALING 32768.
98#define GAIN_SCALING 64
99#define GAIN_SCALING_1 0.015625
100
101#define LPC_SHIFT    13
102#define LSP_SHIFT    13
103#define SIG_SHIFT    14
104#define GAIN_SHIFT   6
105
106#define WORD2INT(x) ((x) < -32767 ? -32768 : ((x) > 32766 ? 32767 : (x)))
107
108#define VERY_SMALL 0
109#define VERY_LARGE32 ((spx_word32_t)2147483647)
110#define VERY_LARGE16 ((spx_word16_t)32767)
111#define Q15_ONE ((spx_word16_t)32767)
112
113
114#ifdef FIXED_DEBUG
115#include "fixed_debug.h"
116#else
117
118#include "fixed_generic.h"
119
120#ifdef ARM5E_ASM
121#include "fixed_arm5e.h"
122#elif defined (ARM4_ASM)
123#include "fixed_arm4.h"
124#elif defined (BFIN_ASM)
125#include "fixed_bfin.h"
126#endif
127
128#endif
129
130
131#else
132
133typedef float spx_mem_t;
134typedef float spx_coef_t;
135typedef float spx_lsp_t;
136typedef float spx_sig_t;
137typedef float spx_word16_t;
138typedef float spx_word32_t;
139
140#define Q15ONE 1.0f
141#define LPC_SCALING  1.f
142#define SIG_SCALING  1.f
143#define LSP_SCALING  1.f
144#define GAMMA_SCALING 1.f
145#define GAIN_SCALING 1.f
146#define GAIN_SCALING_1 1.f
147
148
149#define VERY_SMALL 1e-15f
150#define VERY_LARGE32 1e15f
151#define VERY_LARGE16 1e15f
152#define Q15_ONE ((spx_word16_t)1.f)
153
154#define QCONST16(x,bits) (x)
155#define QCONST32(x,bits) (x)
156
157#define NEG16(x) (-(x))
158#define NEG32(x) (-(x))
159#define EXTRACT16(x) (x)
160#define EXTEND32(x) (x)
161#define SHR16(a,shift) (a)
162#define SHL16(a,shift) (a)
163#define SHR32(a,shift) (a)
164#define SHL32(a,shift) (a)
165#define PSHR16(a,shift) (a)
166#define PSHR32(a,shift) (a)
167#define VSHR32(a,shift) (a)
168#define SATURATE16(x,a) (x)
169#define SATURATE32(x,a) (x)
170#define SATURATE32PSHR(x,shift,a) (x)
171
172#define PSHR(a,shift)       (a)
173#define SHR(a,shift)       (a)
174#define SHL(a,shift)       (a)
175#define SATURATE(x,a) (x)
176
177#define ADD16(a,b) ((a)+(b))
178#define SUB16(a,b) ((a)-(b))
179#define ADD32(a,b) ((a)+(b))
180#define SUB32(a,b) ((a)-(b))
181#define MULT16_16_16(a,b)     ((a)*(b))
182#define MULT16_16(a,b)     ((spx_word32_t)(a)*(spx_word32_t)(b))
183#define MAC16_16(c,a,b)     ((c)+(spx_word32_t)(a)*(spx_word32_t)(b))
184
185#define MULT16_32_Q11(a,b)     ((a)*(b))
186#define MULT16_32_Q13(a,b)     ((a)*(b))
187#define MULT16_32_Q14(a,b)     ((a)*(b))
188#define MULT16_32_Q15(a,b)     ((a)*(b))
189#define MULT16_32_P15(a,b)     ((a)*(b))
190
191#define MAC16_32_Q11(c,a,b)     ((c)+(a)*(b))
192#define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
193
194#define MAC16_16_Q11(c,a,b)     ((c)+(a)*(b))
195#define MAC16_16_Q13(c,a,b)     ((c)+(a)*(b))
196#define MAC16_16_P13(c,a,b)     ((c)+(a)*(b))
197#define MULT16_16_Q11_32(a,b)     ((a)*(b))
198#define MULT16_16_Q13(a,b)     ((a)*(b))
199#define MULT16_16_Q14(a,b)     ((a)*(b))
200#define MULT16_16_Q15(a,b)     ((a)*(b))
201#define MULT16_16_P15(a,b)     ((a)*(b))
202#define MULT16_16_P13(a,b)     ((a)*(b))
203#define MULT16_16_P14(a,b)     ((a)*(b))
204
205#define DIV32_16(a,b)     (((spx_word32_t)(a))/(spx_word16_t)(b))
206#define PDIV32_16(a,b)     (((spx_word32_t)(a))/(spx_word16_t)(b))
207#define DIV32(a,b)     (((spx_word32_t)(a))/(spx_word32_t)(b))
208#define PDIV32(a,b)     (((spx_word32_t)(a))/(spx_word32_t)(b))
209
210#define WORD2INT(x) ((x) < -32767.5f ? -32768 : \
211                    ((x) > 32766.5f ? 32767 : (spx_int16_t)floor(.5 + (x))))
212#endif
213
214
215#if defined (CONFIG_TI_C54X) || defined (CONFIG_TI_C55X)
216
217/* 2 on TI C5x DSP */
218#define BYTES_PER_CHAR 2
219#define BITS_PER_CHAR 16
220#define LOG2_BITS_PER_CHAR 4
221
222#else
223
224#define BYTES_PER_CHAR 1
225#define BITS_PER_CHAR 8
226#define LOG2_BITS_PER_CHAR 3
227
228#endif
229
230
231
232#ifdef FIXED_DEBUG
233extern long long spx_mips;
234#endif
235
236
237#endif
238