michael@0: /* Copyright (C) 2003 Jean-Marc Valin */
michael@0: /**
michael@0:    @file arch.h
michael@0:    @brief Various architecture definitions Speex
michael@0: */
michael@0: /*
michael@0:    Redistribution and use in source and binary forms, with or without
michael@0:    modification, are permitted provided that the following conditions
michael@0:    are met:
michael@0:    
michael@0:    - Redistributions of source code must retain the above copyright
michael@0:    notice, this list of conditions and the following disclaimer.
michael@0:    
michael@0:    - Redistributions in binary form must reproduce the above copyright
michael@0:    notice, this list of conditions and the following disclaimer in the
michael@0:    documentation and/or other materials provided with the distribution.
michael@0:    
michael@0:    - Neither the name of the Xiph.org Foundation nor the names of its
michael@0:    contributors may be used to endorse or promote products derived from
michael@0:    this software without specific prior written permission.
michael@0:    
michael@0:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
michael@0:    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: */
michael@0: 
michael@0: #ifndef ARCH_H
michael@0: #define ARCH_H
michael@0: 
michael@0: #ifndef SPEEX_VERSION
michael@0: #define SPEEX_MAJOR_VERSION 1         /**< Major Speex version. */
michael@0: #define SPEEX_MINOR_VERSION 1         /**< Minor Speex version. */
michael@0: #define SPEEX_MICRO_VERSION 15        /**< Micro Speex version. */
michael@0: #define SPEEX_EXTRA_VERSION ""        /**< Extra Speex version. */
michael@0: #define SPEEX_VERSION "speex-1.2beta3"  /**< Speex version string. */
michael@0: #endif
michael@0: 
michael@0: /* A couple test to catch stupid option combinations */
michael@0: #ifdef FIXED_POINT
michael@0: 
michael@0: #ifdef FLOATING_POINT
michael@0: #error You cannot compile as floating point and fixed point at the same time
michael@0: #endif
michael@0: #ifdef _USE_SSE
michael@0: #error SSE is only for floating-point
michael@0: #endif
michael@0: #if ((defined (ARM4_ASM)||defined (ARM4_ASM)) && defined(BFIN_ASM)) || (defined (ARM4_ASM)&&defined(ARM5E_ASM))
michael@0: #error Make up your mind. What CPU do you have?
michael@0: #endif
michael@0: #ifdef VORBIS_PSYCHO
michael@0: #error Vorbis-psy model currently not implemented in fixed-point
michael@0: #endif
michael@0: 
michael@0: #else
michael@0: 
michael@0: #ifndef FLOATING_POINT
michael@0: #error You now need to define either FIXED_POINT or FLOATING_POINT
michael@0: #endif
michael@0: #if defined (ARM4_ASM) || defined(ARM5E_ASM) || defined(BFIN_ASM)
michael@0: #error I suppose you can have a [ARM4/ARM5E/Blackfin] that has float instructions?
michael@0: #endif
michael@0: #ifdef FIXED_POINT_DEBUG
michael@0: #error "Don't you think enabling fixed-point is a good thing to do if you want to debug that?"
michael@0: #endif
michael@0: 
michael@0: 
michael@0: #endif
michael@0: 
michael@0: #ifndef OUTSIDE_SPEEX
michael@0: #include "../include/speex/speex_types.h"
michael@0: #endif
michael@0: 
michael@0: #define ABS(x) ((x) < 0 ? (-(x)) : (x))      /**< Absolute integer value. */
michael@0: #define ABS16(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 16-bit value.  */
michael@0: #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
michael@0: #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
michael@0: #define ABS32(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 32-bit value.  */
michael@0: #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
michael@0: #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
michael@0: 
michael@0: #ifdef FIXED_POINT
michael@0: 
michael@0: typedef spx_int16_t spx_word16_t;
michael@0: typedef spx_int32_t spx_word32_t;
michael@0: typedef spx_word32_t spx_mem_t;
michael@0: typedef spx_word16_t spx_coef_t;
michael@0: typedef spx_word16_t spx_lsp_t;
michael@0: typedef spx_word32_t spx_sig_t;
michael@0: 
michael@0: #define Q15ONE 32767
michael@0: 
michael@0: #define LPC_SCALING  8192
michael@0: #define SIG_SCALING  16384
michael@0: #define LSP_SCALING  8192.
michael@0: #define GAMMA_SCALING 32768.
michael@0: #define GAIN_SCALING 64
michael@0: #define GAIN_SCALING_1 0.015625
michael@0: 
michael@0: #define LPC_SHIFT    13
michael@0: #define LSP_SHIFT    13
michael@0: #define SIG_SHIFT    14
michael@0: #define GAIN_SHIFT   6
michael@0: 
michael@0: #define VERY_SMALL 0
michael@0: #define VERY_LARGE32 ((spx_word32_t)2147483647)
michael@0: #define VERY_LARGE16 ((spx_word16_t)32767)
michael@0: #define Q15_ONE ((spx_word16_t)32767)
michael@0: 
michael@0: 
michael@0: #ifdef FIXED_DEBUG
michael@0: #include "fixed_debug.h"
michael@0: #else
michael@0: 
michael@0: #include "fixed_generic.h"
michael@0: 
michael@0: #ifdef ARM5E_ASM
michael@0: #include "fixed_arm5e.h"
michael@0: #elif defined (ARM4_ASM)
michael@0: #include "fixed_arm4.h"
michael@0: #elif defined (BFIN_ASM)
michael@0: #include "fixed_bfin.h"
michael@0: #endif
michael@0: 
michael@0: #endif
michael@0: 
michael@0: 
michael@0: #else
michael@0: 
michael@0: typedef float spx_mem_t;
michael@0: typedef float spx_coef_t;
michael@0: typedef float spx_lsp_t;
michael@0: typedef float spx_sig_t;
michael@0: typedef float spx_word16_t;
michael@0: typedef float spx_word32_t;
michael@0: 
michael@0: #define Q15ONE 1.0f
michael@0: #define LPC_SCALING  1.f
michael@0: #define SIG_SCALING  1.f
michael@0: #define LSP_SCALING  1.f
michael@0: #define GAMMA_SCALING 1.f
michael@0: #define GAIN_SCALING 1.f
michael@0: #define GAIN_SCALING_1 1.f
michael@0: 
michael@0: 
michael@0: #define VERY_SMALL 1e-15f
michael@0: #define VERY_LARGE32 1e15f
michael@0: #define VERY_LARGE16 1e15f
michael@0: #define Q15_ONE ((spx_word16_t)1.f)
michael@0: 
michael@0: #define QCONST16(x,bits) (x)
michael@0: #define QCONST32(x,bits) (x)
michael@0: 
michael@0: #define NEG16(x) (-(x))
michael@0: #define NEG32(x) (-(x))
michael@0: #define EXTRACT16(x) (x)
michael@0: #define EXTEND32(x) (x)
michael@0: #define SHR16(a,shift) (a)
michael@0: #define SHL16(a,shift) (a)
michael@0: #define SHR32(a,shift) (a)
michael@0: #define SHL32(a,shift) (a)
michael@0: #define PSHR16(a,shift) (a)
michael@0: #define PSHR32(a,shift) (a)
michael@0: #define VSHR32(a,shift) (a)
michael@0: #define SATURATE16(x,a) (x)
michael@0: #define SATURATE32(x,a) (x)
michael@0: 
michael@0: #define PSHR(a,shift)       (a)
michael@0: #define SHR(a,shift)       (a)
michael@0: #define SHL(a,shift)       (a)
michael@0: #define SATURATE(x,a) (x)
michael@0: 
michael@0: #define ADD16(a,b) ((a)+(b))
michael@0: #define SUB16(a,b) ((a)-(b))
michael@0: #define ADD32(a,b) ((a)+(b))
michael@0: #define SUB32(a,b) ((a)-(b))
michael@0: #define MULT16_16_16(a,b)     ((a)*(b))
michael@0: #define MULT16_16(a,b)     ((spx_word32_t)(a)*(spx_word32_t)(b))
michael@0: #define MAC16_16(c,a,b)     ((c)+(spx_word32_t)(a)*(spx_word32_t)(b))
michael@0: 
michael@0: #define MULT16_32_Q11(a,b)     ((a)*(b))
michael@0: #define MULT16_32_Q13(a,b)     ((a)*(b))
michael@0: #define MULT16_32_Q14(a,b)     ((a)*(b))
michael@0: #define MULT16_32_Q15(a,b)     ((a)*(b))
michael@0: #define MULT16_32_P15(a,b)     ((a)*(b))
michael@0: 
michael@0: #define MAC16_32_Q11(c,a,b)     ((c)+(a)*(b))
michael@0: #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
michael@0: 
michael@0: #define MAC16_16_Q11(c,a,b)     ((c)+(a)*(b))
michael@0: #define MAC16_16_Q13(c,a,b)     ((c)+(a)*(b))
michael@0: #define MAC16_16_P13(c,a,b)     ((c)+(a)*(b))
michael@0: #define MULT16_16_Q11_32(a,b)     ((a)*(b))
michael@0: #define MULT16_16_Q13(a,b)     ((a)*(b))
michael@0: #define MULT16_16_Q14(a,b)     ((a)*(b))
michael@0: #define MULT16_16_Q15(a,b)     ((a)*(b))
michael@0: #define MULT16_16_P15(a,b)     ((a)*(b))
michael@0: #define MULT16_16_P13(a,b)     ((a)*(b))
michael@0: #define MULT16_16_P14(a,b)     ((a)*(b))
michael@0: 
michael@0: #define DIV32_16(a,b)     (((spx_word32_t)(a))/(spx_word16_t)(b))
michael@0: #define PDIV32_16(a,b)     (((spx_word32_t)(a))/(spx_word16_t)(b))
michael@0: #define DIV32(a,b)     (((spx_word32_t)(a))/(spx_word32_t)(b))
michael@0: #define PDIV32(a,b)     (((spx_word32_t)(a))/(spx_word32_t)(b))
michael@0: 
michael@0: 
michael@0: #endif
michael@0: 
michael@0: 
michael@0: #if defined (CONFIG_TI_C54X) || defined (CONFIG_TI_C55X)
michael@0: 
michael@0: /* 2 on TI C5x DSP */
michael@0: #define BYTES_PER_CHAR 2 
michael@0: #define BITS_PER_CHAR 16
michael@0: #define LOG2_BITS_PER_CHAR 4
michael@0: 
michael@0: #else 
michael@0: 
michael@0: #define BYTES_PER_CHAR 1
michael@0: #define BITS_PER_CHAR 8
michael@0: #define LOG2_BITS_PER_CHAR 3
michael@0: 
michael@0: #endif
michael@0: 
michael@0: 
michael@0: 
michael@0: #ifdef FIXED_DEBUG
michael@0: extern long long spx_mips;
michael@0: #endif
michael@0: 
michael@0: 
michael@0: #endif