Use _BitScanReverse for EC_ILOG with MSVC.
[opus.git] / libcelt / ecintrin.h
1 /* Copyright (c) 2003-2008 Timothy B. Terriberry
2    Copyright (c) 2008 Xiph.Org Foundation */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*Some common macros for potential platform-specific optimization.*/
33 #include <math.h>
34 #include <limits.h>
35 #if !defined(_ecintrin_H)
36 # define _ecintrin_H (1)
37
38 /*Some specific platforms may have optimized intrinsic or inline assembly
39    versions of these functions which can substantially improve performance.
40   We define macros for them to allow easy incorporation of these non-ANSI
41    features.*/
42
43 /*Note that we do not provide a macro for abs(), because it is provided as a
44    library function, which we assume is translated into an intrinsic to avoid
45    the function call overhead and then implemented in the smartest way for the
46    target platform.
47   With modern gcc (4.x), this is true: it uses cmov instructions if the
48    architecture supports it and branchless bit-twiddling if it does not (the
49    speed difference between the two approaches is not measurable).
50   Interestingly, the bit-twiddling method was patented in 2000 (US 6,073,150)
51    by Sun Microsystems, despite prior art dating back to at least 1996:
52    http://web.archive.org/web/19961201174141/www.x86.org/ftp/articles/pentopt/PENTOPT.TXT
53   On gcc 3.x, however, our assumption is not true, as abs() is translated to a
54    conditional jump, which is horrible on deeply piplined architectures (e.g.,
55    all consumer architectures for the past decade or more) when the sign cannot
56    be reliably predicted.*/
57
58 /*Modern gcc (4.x) can compile the naive versions of min and max with cmov if
59    given an appropriate architecture, but the branchless bit-twiddling versions
60    are just as fast, and do not require any special target architecture.
61   Earlier gcc versions (3.x) compiled both code to the same assembly
62    instructions, because of the way they represented ((_b)>(_a)) internally.*/
63 #define EC_MAXI(_a,_b)      ((_a)-((_a)-(_b)&-((_b)>(_a))))
64 #define EC_MINI(_a,_b)      ((_a)+((_b)-(_a)&-((_b)<(_a))))
65 /*This has a chance of compiling branchless, and is just as fast as the
66    bit-twiddling method, which is slightly less portable, since it relies on a
67    sign-extended rightshift, which is not guaranteed by ANSI (but present on
68    every relevant platform).*/
69 #define EC_SIGNI(_a)        (((_a)>0)-((_a)<0))
70 /*Slightly more portable than relying on a sign-extended right-shift (which is
71    not guaranteed by ANSI), and just as fast, since gcc (3.x and 4.x both)
72    compile it into the right-shift anyway.*/
73 #define EC_SIGNMASK(_a)     (-((_a)<0))
74 /*Clamps an integer into the given range.
75   If _a>_c, then the lower bound _a is respected over the upper bound _c (this
76    behavior is required to meet our documented API behavior).
77   _a: The lower bound.
78   _b: The value to clamp.
79   _c: The upper boud.*/
80 #define EC_CLAMPI(_a,_b,_c) (EC_MAXI(_a,EC_MINI(_b,_c)))
81
82
83 /*Count leading zeros.
84   This macro should only be used for implementing ec_ilog(), if it is defined.
85   All other code should use EC_ILOG() instead.*/
86 #if defined(_MSC_VER)
87 # include <intrin.h>
88 static __inline int ec_bsr(unsigned long _x){
89   unsigned long ret;
90   _BitScanReverse(&ret,_x);
91   return (int)ret;
92 }
93 # define EC_CLZ0    (1)
94 # define EC_CLZ(_x) (-ec_bsr(_x))
95 #elif defined(ENABLE_TI_DSPLIB)
96 # include "dsplib.h"
97 # define EC_CLZ0    (31)
98 # define EC_CLZ(_x) (_lnorm(x))
99 #elif defined(__GNUC_PREREQ)
100 # if __GNUC_PREREQ(3,4)
101 #  if INT_MAX>=2147483647
102 #   define EC_CLZ0    ((int)sizeof(unsigned)*CHAR_BIT)
103 #   define EC_CLZ(_x) (__builtin_clz(_x))
104 #  elif LONG_MAX>=2147483647L
105 #   define EC_CLZ0    ((int)sizeof(unsigned long)*CHAR_BIT)
106 #   define EC_CLZ(_x) (__builtin_clzl(_x))
107 #  endif
108 # endif
109 #endif
110
111 #if defined(EC_CLZ)
112 /*Note that __builtin_clz is not defined when _x==0, according to the gcc
113    documentation (and that of the BSR instruction that implements it on x86).
114   The majority of the time we can never pass it zero.
115   When we need to, it can be special cased.*/
116 # define EC_ILOG(_x) (EC_CLZ0-EC_CLZ(_x))
117 #else
118 # define EC_ILOG(_x) (ec_ilog(_x))
119 #endif
120
121 #endif