version bump
[opus.git] / celt / 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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 /*Some common macros for potential platform-specific optimization.*/
29 #include "opus_types.h"
30 #include <math.h>
31 #include <limits.h>
32 #include "arch.h"
33 #if !defined(_ecintrin_H)
34 # define _ecintrin_H (1)
35
36 /*Some specific platforms may have optimized intrinsic or inline assembly
37    versions of these functions which can substantially improve performance.
38   We define macros for them to allow easy incorporation of these non-ANSI
39    features.*/
40
41 /*Note that we do not provide a macro for abs(), because it is provided as a
42    library function, which we assume is translated into an intrinsic to avoid
43    the function call overhead and then implemented in the smartest way for the
44    target platform.
45   With modern gcc (4.x), this is true: it uses cmov instructions if the
46    architecture supports it and branchless bit-twiddling if it does not (the
47    speed difference between the two approaches is not measurable).
48   Interestingly, the bit-twiddling method was patented in 2000 (US 6,073,150)
49    by Sun Microsystems, despite prior art dating back to at least 1996:
50    http://web.archive.org/web/19961201174141/www.x86.org/ftp/articles/pentopt/PENTOPT.TXT
51   On gcc 3.x, however, our assumption is not true, as abs() is translated to a
52    conditional jump, which is horrible on deeply piplined architectures (e.g.,
53    all consumer architectures for the past decade or more) when the sign cannot
54    be reliably predicted.*/
55
56 /*Modern gcc (4.x) can compile the naive versions of min and max with cmov if
57    given an appropriate architecture, but the branchless bit-twiddling versions
58    are just as fast, and do not require any special target architecture.
59   Earlier gcc versions (3.x) compiled both code to the same assembly
60    instructions, because of the way they represented ((_b)>(_a)) internally.*/
61 # define EC_MINI(_a,_b)      ((_a)+(((_b)-(_a))&-((_b)<(_a))))
62
63 /*Count leading zeros.
64   This macro should only be used for implementing ec_ilog(), if it is defined.
65   All other code should use EC_ILOG() instead.*/
66 #if defined(_MSC_VER)
67 # include <intrin.h>
68 /*In _DEBUG mode this is not an intrinsic by default.*/
69 # pragma intrinsic(_BitScanReverse)
70
71 static __inline int ec_bsr(unsigned long _x){
72   unsigned long ret;
73   _BitScanReverse(&ret,_x);
74   return (int)ret;
75 }
76 # define EC_CLZ0    (1)
77 # define EC_CLZ(_x) (-ec_bsr(_x))
78 #elif defined(ENABLE_TI_DSPLIB)
79 # include "dsplib.h"
80 # define EC_CLZ0    (31)
81 # define EC_CLZ(_x) (_lnorm(_x))
82 #elif __GNUC_PREREQ(3,4)
83 # if INT_MAX>=2147483647
84 #  define EC_CLZ0    ((int)sizeof(unsigned)*CHAR_BIT)
85 #  define EC_CLZ(_x) (__builtin_clz(_x))
86 # elif LONG_MAX>=2147483647L
87 #  define EC_CLZ0    ((int)sizeof(unsigned long)*CHAR_BIT)
88 #  define EC_CLZ(_x) (__builtin_clzl(_x))
89 # endif
90 #endif
91
92 #if defined(EC_CLZ)
93 /*Note that __builtin_clz is not defined when _x==0, according to the gcc
94    documentation (and that of the BSR instruction that implements it on x86).
95   The majority of the time we can never pass it zero.
96   When we need to, it can be special cased.*/
97 # define EC_ILOG(_x) (EC_CLZ0-EC_CLZ(_x))
98 #else
99 int ec_ilog(opus_uint32 _v);
100 # define EC_ILOG(_x) (ec_ilog(_x))
101 #endif
102 #endif