Re-ordered the parameters in the stream: [energy, pitch index, pitch gains]
[opus.git] / libcelt / ecintrin.h
1 /*Some common macros for potential platform-specific optimization.*/
2 #include <math.h>
3 #include <limits.h>
4 #if !defined(_ecintrin_H)
5 # define _ecintrin_H (1)
7 /*Some specific platforms may have optimized intrinsic or inline assembly
8    versions of these functions which can substantially improve performance.
9   We define macros for them to allow easy incorporation of these non-ANSI
10    features.*/
12 /*Note that we do not provide a macro for abs(), because it is provided as a
13    library function, which we assume is translated into an intrinsic to avoid
14    the function call overhead and then implemented in the smartest way for the
15    target platform.
16   With modern gcc (4.x), this is true: it uses cmov instructions if the
17    architecture supports it and branchless bit-twiddling if it does not (the
18    speed difference between the two approaches is not measurable).
19   Interestingly, the bit-twiddling method was patented in 2000 (US 6,073,150)
20    by Sun Microsystems, despite prior art dating back to at least 1996:
22   On gcc 3.x, however, our assumption is not true, as abs() is translated to a
23    conditional jump, which is horrible on deeply piplined architectures (e.g.,
24    all consumer architectures for the past decade or more) when the sign cannot
25    be reliably predicted.*/
27 /*Modern gcc (4.x) can compile the naive versions of min and max with cmov if
28    given an appropriate architecture, but the branchless bit-twiddling versions
29    are just as fast, and do not require any special target architecture.
30   Earlier gcc versions (3.x) compiled both code to the same assembly
31    instructions, because of the way they represented ((_b)>(_a)) internally.*/
32 #define EC_MAXI(_a,_b)      ((_a)-((_a)-(_b)&-((_b)>(_a))))
33 #define EC_MINI(_a,_b)      ((_a)+((_b)-(_a)&-((_b)<(_a))))
34 /*This has a chance of compiling branchless, and is just as fast as the
35    bit-twiddling method, which is slightly less portable, since it relies on a
36    sign-extended rightshift, which is not guaranteed by ANSI (but present on
37    every relevant platform).*/
38 #define EC_SIGNI(_a)        (((_a)>0)-((_a)<0))
39 /*Slightly more portable than relying on a sign-extended right-shift (which is
40    not guaranteed by ANSI), and just as fast, since gcc (3.x and 4.x both)
41    compile it into the right-shift anyway.*/
42 #define EC_SIGNMASK(_a)     (-((_a)<0))
43 /*Clamps an integer into the given range.
44   If _a>_c, then the lower bound _a is respected over the upper bound _c (this
45    behavior is required to meet our documented API behavior).
46   _a: The lower bound.
47   _b: The value to clamp.
48   _c: The upper boud.*/
49 #define EC_CLAMPI(_a,_b,_c) (EC_MAXI(_a,EC_MINI(_b,_c)))
50 /*Count leading zeros.
51   This macro should only be used for implementing ec_ilog(), if it is defined.
52   All other code should use EC_ILOG() instead.*/
53 #if __GNUC_PREREQ(3,4)
54 # if INT_MAX>=2147483647
55 #  define EC_CLZ0 sizeof(unsigned)*CHAR_BIT
56 #  define EC_CLZ(_x) (__builtin_clz(_x))
57 # elif LONG_MAX>=2147483647L
58 #  define EC_CLZ0 sizeof(unsigned long)*CHAR_BIT
59 #  define EC_CLZ(_x) (__builtin_clzl(_x))
60 # endif
61 #endif
62 #if defined(EC_CLZ)
63 /*Note that __builtin_clz is not defined when _x==0, according to the gcc
64    documentation (and that of the BSR instruction that implements it on x86).
65   The majority of the time we can never pass it zero.
66   When we need to, it can be special cased.*/
67 # define EC_ILOG(_x) (EC_CLZ0-EC_CLZ(_x))
68 #else
69 # define EC_ILOG(_x) (ec_ilog(_x))
70 #endif
71 #if __GNUC_PREREQ(3,4)
72 # if INT_MAX>=9223372036854775807
73 #  define EC_CLZ64_0 sizeof(unsigned)*CHAR_BIT
74 #  define EC_CLZ64(_x) (__builtin_clz(_x))
75 # elif LONG_MAX>=9223372036854775807L
76 #  define EC_CLZ64_0 sizeof(unsigned long)*CHAR_BIT
77 #  define EC_CLZ64(_x) (__builtin_clzl(_x))
78 # elif LLONG_MAX>=9223372036854775807LL
79 #  define EC_CLZ64_0 sizeof(unsigned long long)*CHAR_BIT
80 #  define EC_CLZ64(_x) (__builtin_clzll(_x))
81 # endif
82 #endif
83 #if defined(EC_CLZ64)
84 /*Note that __builtin_clz is not defined when _x==0, according to the gcc
85    documentation (and that of the BSR instruction that implements it on x86).
86   The majority of the time we can never pass it zero.
87   When we need to, it can be special cased.*/
88 # define EC_ILOG64(_x) (EC_CLZ64_0-EC_CLZ64(_x))
89 #else
90 # define EC_ILOG64(_x) (ec_ilog64(_x))
91 #endif
93 #endif