Adds 3rd clause to CELT license
[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    - Neither the name of Internet Society, IETF or IETF Trust, nor the
16    names of specific contributors, may be used to endorse or promote
17    products derived from this software without specific prior written
18    permission.
19
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
24    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /*Some common macros for potential platform-specific optimization.*/
34 #include "opus_types.h"
35 #include <math.h>
36 #include <limits.h>
37 #include "arch.h"
38 #if !defined(_ecintrin_H)
39 # define _ecintrin_H (1)
40
41 /*Some specific platforms may have optimized intrinsic or inline assembly
42    versions of these functions which can substantially improve performance.
43   We define macros for them to allow easy incorporation of these non-ANSI
44    features.*/
45
46 /*Modern gcc (4.x) can compile the naive versions of min and max with cmov if
47    given an appropriate architecture, but the branchless bit-twiddling versions
48    are just as fast, and do not require any special target architecture.
49   Earlier gcc versions (3.x) compiled both code to the same assembly
50    instructions, because of the way they represented ((_b)>(_a)) internally.*/
51 # define EC_MINI(_a,_b)      ((_a)+(((_b)-(_a))&-((_b)<(_a))))
52
53 /*Count leading zeros.
54   This macro should only be used for implementing ec_ilog(), if it is defined.
55   All other code should use EC_ILOG() instead.*/
56 #if defined(_MSC_VER)
57 # include <intrin.h>
58 /*In _DEBUG mode this is not an intrinsic by default.*/
59 # pragma intrinsic(_BitScanReverse)
60
61 static __inline int ec_bsr(unsigned long _x){
62   unsigned long ret;
63   _BitScanReverse(&ret,_x);
64   return (int)ret;
65 }
66 # define EC_CLZ0    (1)
67 # define EC_CLZ(_x) (-ec_bsr(_x))
68 #elif defined(ENABLE_TI_DSPLIB)
69 # include "dsplib.h"
70 # define EC_CLZ0    (31)
71 # define EC_CLZ(_x) (_lnorm(_x))
72 #elif __GNUC_PREREQ(3,4)
73 # if INT_MAX>=2147483647
74 #  define EC_CLZ0    ((int)sizeof(unsigned)*CHAR_BIT)
75 #  define EC_CLZ(_x) (__builtin_clz(_x))
76 # elif LONG_MAX>=2147483647L
77 #  define EC_CLZ0    ((int)sizeof(unsigned long)*CHAR_BIT)
78 #  define EC_CLZ(_x) (__builtin_clzl(_x))
79 # endif
80 #endif
81
82 #if defined(EC_CLZ)
83 /*Note that __builtin_clz is not defined when _x==0, according to the gcc
84    documentation (and that of the BSR instruction that implements it on x86).
85   The majority of the time we can never pass it zero.
86   When we need to, it can be special cased.*/
87 # define EC_ILOG(_x) (EC_CLZ0-EC_CLZ(_x))
88 #else
89 int ec_ilog(opus_uint32 _v);
90 # define EC_ILOG(_x) (ec_ilog(_x))
91 #endif
92 #endif