blob: 8ceab5fe10e934113592ade9339939771f4a2a01 [file] [log] [blame]
Jean-Marc Valin8b2ff0d2009-10-17 21:40:10 -04001/* Copyright (c) 2003-2008 Jean-Marc Valin
2 Copyright (c) 2007-2008 CSIRO
3 Copyright (c) 2007-2009 Xiph.Org Foundation
4 Written by Jean-Marc Valin */
Jean-Marc Valin63590892007-11-29 17:01:16 +11005/**
6 @file arch.h
Jean-Marc Valinc7e0b762008-03-16 07:55:29 +11007 @brief Various architecture definitions for CELT
Jean-Marc Valin63590892007-11-29 17:01:16 +11008*/
9/*
10 Redistribution and use in source and binary forms, with or without
11 modification, are permitted provided that the following conditions
12 are met:
Gregory Maxwell71d39ad2011-07-30 00:00:29 -040013
Jean-Marc Valin63590892007-11-29 17:01:16 +110014 - Redistributions of source code must retain the above copyright
15 notice, this list of conditions and the following disclaimer.
Gregory Maxwell71d39ad2011-07-30 00:00:29 -040016
Jean-Marc Valin63590892007-11-29 17:01:16 +110017 - Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
Gregory Maxwell71d39ad2011-07-30 00:00:29 -040020
Jean-Marc Valin63590892007-11-29 17:01:16 +110021 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Jean-Marc Valincb05e7c2012-04-20 16:40:24 -040024 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
Jean-Marc Valin63590892007-11-29 17:01:16 +110026 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32*/
33
34#ifndef ARCH_H
35#define ARCH_H
36
Jean-Marc Valind77d6a52011-07-29 17:33:06 -040037#include "opus_types.h"
Gregory Maxwell7830cf12013-10-17 15:56:52 -070038#include "opus_defines.h"
Jean-Marc Valinc7e0b762008-03-16 07:55:29 +110039
Timothy B. Terriberry1a458862011-05-04 15:03:30 -070040# if !defined(__GNUC_PREREQ)
41# if defined(__GNUC__)&&defined(__GNUC_MINOR__)
42# define __GNUC_PREREQ(_maj,_min) \
43 ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
44# else
45# define __GNUC_PREREQ(_maj,_min) 0
46# endif
47# endif
48
Jean-Marc Valin628c0252010-04-16 20:57:56 -040049#define CELT_SIG_SCALE 32768.f
Jean-Marc Valinc7e0b762008-03-16 07:55:29 +110050
51#define celt_fatal(str) _celt_fatal(str, __FILE__, __LINE__);
52#ifdef ENABLE_ASSERTIONS
Jean-Marc Valin6d3829f2010-08-27 17:52:38 -040053#include <stdio.h>
54#include <stdlib.h>
Gregory Maxwell5d5875a2011-10-03 21:07:39 -040055#ifdef __GNUC__
56__attribute__((noreturn))
57#endif
Gregory Maxwell7830cf12013-10-17 15:56:52 -070058static OPUS_INLINE void _celt_fatal(const char *str, const char *file, int line)
Jean-Marc Valin6d3829f2010-08-27 17:52:38 -040059{
60 fprintf (stderr, "Fatal (internal) error in %s, line %d: %s\n", file, line, str);
61 abort();
62}
Jean-Marc Valinc7e0b762008-03-16 07:55:29 +110063#define celt_assert(cond) {if (!(cond)) {celt_fatal("assertion failed: " #cond);}}
64#define celt_assert2(cond, message) {if (!(cond)) {celt_fatal("assertion failed: " #cond "\n" message);}}
65#else
66#define celt_assert(cond)
67#define celt_assert2(cond, message)
68#endif
69
Jean-Marc Valin821945d2008-04-10 13:24:48 +100070#define IMUL32(a,b) ((a)*(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +110071
Gregory Maxwell8842fde2009-05-04 15:58:40 -040072#define MIN16(a,b) ((a) < (b) ? (a) : (b)) /**< Minimum 16-bit value. */
Jean-Marc Valin63590892007-11-29 17:01:16 +110073#define MAX16(a,b) ((a) > (b) ? (a) : (b)) /**< Maximum 16-bit value. */
Gregory Maxwell8842fde2009-05-04 15:58:40 -040074#define MIN32(a,b) ((a) < (b) ? (a) : (b)) /**< Minimum 32-bit value. */
Jean-Marc Valin63590892007-11-29 17:01:16 +110075#define MAX32(a,b) ((a) > (b) ? (a) : (b)) /**< Maximum 32-bit value. */
Gregory Maxwell8842fde2009-05-04 15:58:40 -040076#define IMIN(a,b) ((a) < (b) ? (a) : (b)) /**< Minimum int value. */
Jean-Marc Valinc24b5182008-09-19 16:49:26 -040077#define IMAX(a,b) ((a) > (b) ? (a) : (b)) /**< Maximum int value. */
Jean-Marc Valin453ccd82008-09-12 20:52:27 -040078#define UADD32(a,b) ((a)+(b))
79#define USUB32(a,b) ((a)-(b))
80
Jonathan Lennox8da4f842015-11-20 23:03:52 -050081/* Set this if opus_int64 is a native type of the CPU. */
82/* Assume that all LP64 architectures have fast 64-bit types; also x86_64
83 (which can be ILP32 for x32) and Win64 (which is LLP64). */
84#if defined(__x86_64__) || defined(__LP64__) || defined(_WIN64)
85#define OPUS_FAST_INT64 1
86#else
87#define OPUS_FAST_INT64 0
88#endif
89
Jean-Marc Valin453ccd82008-09-12 20:52:27 -040090#define PRINT_MIPS(file)
Jean-Marc Valin63590892007-11-29 17:01:16 +110091
92#ifdef FIXED_POINT
93
Jean-Marc Valinff5f7222011-07-29 18:59:12 -040094typedef opus_int16 opus_val16;
95typedef opus_int32 opus_val32;
Jean-Marc Valin63590892007-11-29 17:01:16 +110096
Jean-Marc Valinff5f7222011-07-29 18:59:12 -040097typedef opus_val32 celt_sig;
98typedef opus_val16 celt_norm;
99typedef opus_val32 celt_ener;
Jean-Marc Valin49ca99e2008-02-25 14:05:10 +1100100
Jean-Marc Valin63590892007-11-29 17:01:16 +1100101#define Q15ONE 32767
102
Jean-Marc Valin5c3bc672008-08-28 23:34:24 -0400103#define SIG_SHIFT 12
Jean-Marc Valin42074382008-02-27 11:08:53 +1100104
Jean-Marc Valin03892c12008-03-07 17:25:47 +1100105#define NORM_SCALING 16384
Jean-Marc Valin63590892007-11-29 17:01:16 +1100106
Jean-Marc Valinbd0610d2010-03-13 10:04:19 -0500107#define DB_SHIFT 10
Jean-Marc Valin5d561832008-02-27 11:59:05 +1100108
Jean-Marc Valinff74e392008-02-27 15:35:43 +1100109#define EPSILON 1
Jean-Marc Valin260474f2013-07-12 01:22:09 -0400110#define VERY_SMALL 0
Jean-Marc Valinff5f7222011-07-29 18:59:12 -0400111#define VERY_LARGE16 ((opus_val16)32767)
112#define Q15_ONE ((opus_val16)32767)
Jean-Marc Valin63590892007-11-29 17:01:16 +1100113
Ralph Gilesda025d52011-10-26 20:24:49 -0700114#define SCALEIN(a) (a)
115#define SCALEOUT(a) (a)
Jean-Marc Valin63590892007-11-29 17:01:16 +1100116
Jean-Marc Valin0f869cb2013-12-08 03:54:18 -0500117#define ABS16(x) ((x) < 0 ? (-(x)) : (x))
118#define ABS32(x) ((x) < 0 ? (-(x)) : (x))
119
Jean-Marc Valin4d07b132014-01-06 17:43:20 -0500120static OPUS_INLINE opus_int16 SAT16(opus_int32 x) {
121 return x > 32767 ? 32767 : x < -32768 ? -32768 : (opus_int16)x;
122}
123
Jean-Marc Valin63590892007-11-29 17:01:16 +1100124#ifdef FIXED_DEBUG
125#include "fixed_debug.h"
126#else
127
128#include "fixed_generic.h"
129
Jonathan Lennox05d3e792015-11-20 23:03:59 -0500130#ifdef OPUS_ARM_PRESUME_AARCH64_NEON_INTR
131#include "arm/fixed_arm64.h"
132#elif OPUS_ARM_INLINE_EDSP
Timothy B. Terriberrye095c3e2013-05-21 12:53:33 -0700133#include "arm/fixed_armv5e.h"
Timothy B. Terriberry39386e02013-11-18 13:30:13 -0500134#elif defined (OPUS_ARM_INLINE_ASM)
Timothy B. Terriberrye095c3e2013-05-21 12:53:33 -0700135#include "arm/fixed_armv4.h"
Jean-Marc Valin63590892007-11-29 17:01:16 +1100136#elif defined (BFIN_ASM)
137#include "fixed_bfin.h"
Jean-Marc Valin72e80032008-03-12 10:16:26 +1100138#elif defined (TI_C5X_ASM)
139#include "fixed_c5x.h"
Jean-Marc Valineac99702008-04-15 21:31:42 +1000140#elif defined (TI_C6X_ASM)
141#include "fixed_c6x.h"
Jean-Marc Valin63590892007-11-29 17:01:16 +1100142#endif
143
144#endif
145
Jean-Marc Valin18ddc022008-02-22 14:24:50 +1100146#else /* FIXED_POINT */
Jean-Marc Valin63590892007-11-29 17:01:16 +1100147
Jean-Marc Valinff5f7222011-07-29 18:59:12 -0400148typedef float opus_val16;
149typedef float opus_val32;
Jean-Marc Valin63590892007-11-29 17:01:16 +1100150
Jean-Marc Valin234969c2009-10-17 22:12:42 -0400151typedef float celt_sig;
152typedef float celt_norm;
153typedef float celt_ener;
Jean-Marc Valin18ddc022008-02-22 14:24:50 +1100154
Jean-Marc Valin15edb782013-12-09 21:56:21 -0500155#ifdef FLOAT_APPROX
156/* This code should reliably detect NaN/inf even when -ffast-math is used.
157 Assumes IEEE 754 format. */
Jean-Marc Valin122971b2013-12-10 13:55:35 -0500158static OPUS_INLINE int celt_isnan(float x)
Jean-Marc Valin15edb782013-12-09 21:56:21 -0500159{
160 union {float f; opus_uint32 i;} in;
161 in.f = x;
162 return ((in.i>>23)&0xFF)==0xFF && (in.i&0x007FFFFF)!=0;
163}
164#else
165#ifdef __FAST_MATH__
166#error Cannot build libopus with -ffast-math unless FLOAT_APPROX is defined. This could result in crashes on extreme (e.g. NaN) input
167#endif
168#define celt_isnan(x) ((x)!=(x))
169#endif
170
Jean-Marc Valin63590892007-11-29 17:01:16 +1100171#define Q15ONE 1.0f
Jean-Marc Valinb60340f2008-02-26 15:41:51 +1100172
Jean-Marc Valinb4dfce42008-02-25 17:41:30 +1100173#define NORM_SCALING 1.f
Jean-Marc Valin63590892007-11-29 17:01:16 +1100174
Jean-Marc Valind9584db2008-03-26 00:00:18 +1100175#define EPSILON 1e-15f
Jean-Marc Valin260474f2013-07-12 01:22:09 -0400176#define VERY_SMALL 1e-30f
Jean-Marc Valin63590892007-11-29 17:01:16 +1100177#define VERY_LARGE16 1e15f
Jean-Marc Valinff5f7222011-07-29 18:59:12 -0400178#define Q15_ONE ((opus_val16)1.f)
Jean-Marc Valin63590892007-11-29 17:01:16 +1100179
Jean-Marc Valin0f869cb2013-12-08 03:54:18 -0500180/* This appears to be the same speed as C99's fabsf() but it's more portable. */
181#define ABS16(x) ((float)fabs(x))
182#define ABS32(x) ((float)fabs(x))
183
Jean-Marc Valin63590892007-11-29 17:01:16 +1100184#define QCONST16(x,bits) (x)
185#define QCONST32(x,bits) (x)
186
187#define NEG16(x) (-(x))
188#define NEG32(x) (-(x))
189#define EXTRACT16(x) (x)
190#define EXTEND32(x) (x)
191#define SHR16(a,shift) (a)
192#define SHL16(a,shift) (a)
193#define SHR32(a,shift) (a)
194#define SHL32(a,shift) (a)
Jean-Marc Valin63590892007-11-29 17:01:16 +1100195#define PSHR32(a,shift) (a)
196#define VSHR32(a,shift) (a)
Jean-Marc Valin63590892007-11-29 17:01:16 +1100197
Jean-Marc Valinc209c342008-03-07 17:50:45 +1100198#define PSHR(a,shift) (a)
199#define SHR(a,shift) (a)
200#define SHL(a,shift) (a)
201#define SATURATE(x,a) (x)
Jean-Marc Valin02fed472013-08-29 15:29:02 -0400202#define SATURATE16(x) (x)
Jean-Marc Valin63590892007-11-29 17:01:16 +1100203
Jean-Marc Valinf5b05872008-03-21 10:46:17 +1100204#define ROUND16(a,shift) (a)
Jean-Marc Valin21b11342011-05-13 17:41:33 -0400205#define HALF16(x) (.5f*(x))
Jean-Marc Valinc209c342008-03-07 17:50:45 +1100206#define HALF32(x) (.5f*(x))
Jean-Marc Valina02ca1e2008-02-28 11:33:22 +1100207
Jean-Marc Valin63590892007-11-29 17:01:16 +1100208#define ADD16(a,b) ((a)+(b))
209#define SUB16(a,b) ((a)-(b))
210#define ADD32(a,b) ((a)+(b))
211#define SUB32(a,b) ((a)-(b))
212#define MULT16_16_16(a,b) ((a)*(b))
Jean-Marc Valinff5f7222011-07-29 18:59:12 -0400213#define MULT16_16(a,b) ((opus_val32)(a)*(opus_val32)(b))
214#define MAC16_16(c,a,b) ((c)+(opus_val32)(a)*(opus_val32)(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100215
Jean-Marc Valin63590892007-11-29 17:01:16 +1100216#define MULT16_32_Q15(a,b) ((a)*(b))
Jean-Marc Valinef0d5f12008-04-22 09:49:22 +1000217#define MULT16_32_Q16(a,b) ((a)*(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100218
Jean-Marc Valind857ac42008-03-12 13:26:37 +1100219#define MULT32_32_Q31(a,b) ((a)*(b))
220
Jean-Marc Valin63590892007-11-29 17:01:16 +1100221#define MAC16_32_Q15(c,a,b) ((c)+(a)*(b))
Jean-Marc Valin17b19782014-01-21 11:07:57 -0500222#define MAC16_32_Q16(c,a,b) ((c)+(a)*(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100223
Jean-Marc Valin63590892007-11-29 17:01:16 +1100224#define MULT16_16_Q11_32(a,b) ((a)*(b))
Jean-Marc Valin3ab03e02013-09-06 16:00:39 -0400225#define MULT16_16_Q11(a,b) ((a)*(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100226#define MULT16_16_Q13(a,b) ((a)*(b))
227#define MULT16_16_Q14(a,b) ((a)*(b))
228#define MULT16_16_Q15(a,b) ((a)*(b))
229#define MULT16_16_P15(a,b) ((a)*(b))
230#define MULT16_16_P13(a,b) ((a)*(b))
231#define MULT16_16_P14(a,b) ((a)*(b))
Gregory Maxwell28b41ae2012-07-11 00:04:24 -0400232#define MULT16_32_P16(a,b) ((a)*(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100233
Jean-Marc Valinff5f7222011-07-29 18:59:12 -0400234#define DIV32_16(a,b) (((opus_val32)(a))/(opus_val16)(b))
Jean-Marc Valinff5f7222011-07-29 18:59:12 -0400235#define DIV32(a,b) (((opus_val32)(a))/(opus_val32)(b))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100236
Ralph Gilesda025d52011-10-26 20:24:49 -0700237#define SCALEIN(a) ((a)*CELT_SIG_SCALE)
238#define SCALEOUT(a) ((a)*(1/CELT_SIG_SCALE))
Jean-Marc Valin63590892007-11-29 17:01:16 +1100239
Jean-Marc Valin2e6876c2014-01-22 19:22:05 -0500240#define SIG2WORD16(x) (x)
241
Jean-Marc Valin18ddc022008-02-22 14:24:50 +1100242#endif /* !FIXED_POINT */
Jean-Marc Valin63590892007-11-29 17:01:16 +1100243
Gregory Maxwell71d39ad2011-07-30 00:00:29 -0400244#ifndef GLOBAL_STACK_SIZE
Gregory Maxwell242eee32009-02-03 16:07:01 -0500245#ifdef FIXED_POINT
Jean-Marc Valin43dd8a52009-07-13 17:50:59 -0400246#define GLOBAL_STACK_SIZE 100000
Gregory Maxwell242eee32009-02-03 16:07:01 -0500247#else
Jean-Marc Valin43dd8a52009-07-13 17:50:59 -0400248#define GLOBAL_STACK_SIZE 100000
Gregory Maxwell242eee32009-02-03 16:07:01 -0500249#endif
Gregory Maxwell71d39ad2011-07-30 00:00:29 -0400250#endif
Jean-Marc Valin63590892007-11-29 17:01:16 +1100251
Jean-Marc Valin18ddc022008-02-22 14:24:50 +1100252#endif /* ARCH_H */