make len==0 return OPUS_INVALID_PACKET rather than OPUS_BAD_ARG for opus_packet_parse...
[opus.git] / silk / macros.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, are permitted provided that the following conditions
5 are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Internet Society, IETF or IETF Trust, nor the
12 names of specific contributors, may be used to endorse or promote
13 products derived from this software without specific prior written
14 permission.
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifndef SILK_MACROS_H
29 #define SILK_MACROS_H
30
31 #ifdef HAVE_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #include "opus_types.h"
36 #include "opus_defines.h"
37 #include "arch.h"
38
39 #if OPUS_GNUC_PREREQ(3, 0)
40 #define opus_likely(x)       (__builtin_expect(!!(x), 1))
41 #define opus_unlikely(x)     (__builtin_expect(!!(x), 0))
42 #else
43 #define opus_likely(x)       (!!(x))
44 #define opus_unlikely(x)     (!!(x))
45 #endif
46
47 /* This is an OPUS_INLINE header file for general platform. */
48
49 /* (a32 * (opus_int32)((opus_int16)(b32))) >> 16 output have to be 32bit int */
50 #if OPUS_FAST_INT64
51 #define silk_SMULWB(a32, b32)            ((opus_int32)(((a32) * (opus_int64)((opus_int16)(b32))) >> 16))
52 #else
53 #define silk_SMULWB(a32, b32)            ((((a32) >> 16) * (opus_int32)((opus_int16)(b32))) + ((((a32) & 0x0000FFFF) * (opus_int32)((opus_int16)(b32))) >> 16))
54 #endif
55
56 /* a32 + (b32 * (opus_int32)((opus_int16)(c32))) >> 16 output have to be 32bit int */
57 #if OPUS_FAST_INT64
58 #define silk_SMLAWB(a32, b32, c32)       ((opus_int32)((a32) + (((b32) * (opus_int64)((opus_int16)(c32))) >> 16)))
59 #else
60 #define silk_SMLAWB(a32, b32, c32)       ((a32) + ((((b32) >> 16) * (opus_int32)((opus_int16)(c32))) + ((((b32) & 0x0000FFFF) * (opus_int32)((opus_int16)(c32))) >> 16)))
61 #endif
62
63 /* (a32 * (b32 >> 16)) >> 16 */
64 #if OPUS_FAST_INT64
65 #define silk_SMULWT(a32, b32)            ((opus_int32)(((a32) * (opus_int64)((b32) >> 16)) >> 16))
66 #else
67 #define silk_SMULWT(a32, b32)            (((a32) >> 16) * ((b32) >> 16) + ((((a32) & 0x0000FFFF) * ((b32) >> 16)) >> 16))
68 #endif
69
70 /* a32 + (b32 * (c32 >> 16)) >> 16 */
71 #if OPUS_FAST_INT64
72 #define silk_SMLAWT(a32, b32, c32)       ((opus_int32)((a32) + (((b32) * ((opus_int64)(c32) >> 16)) >> 16)))
73 #else
74 #define silk_SMLAWT(a32, b32, c32)       ((a32) + (((b32) >> 16) * ((c32) >> 16)) + ((((b32) & 0x0000FFFF) * ((c32) >> 16)) >> 16))
75 #endif
76
77 /* (opus_int32)((opus_int16)(a3))) * (opus_int32)((opus_int16)(b32)) output have to be 32bit int */
78 #define silk_SMULBB(a32, b32)            ((opus_int32)((opus_int16)(a32)) * (opus_int32)((opus_int16)(b32)))
79
80 /* a32 + (opus_int32)((opus_int16)(b32)) * (opus_int32)((opus_int16)(c32)) output have to be 32bit int */
81 #define silk_SMLABB(a32, b32, c32)       ((a32) + ((opus_int32)((opus_int16)(b32))) * (opus_int32)((opus_int16)(c32)))
82
83 /* (opus_int32)((opus_int16)(a32)) * (b32 >> 16) */
84 #define silk_SMULBT(a32, b32)            ((opus_int32)((opus_int16)(a32)) * ((b32) >> 16))
85
86 /* a32 + (opus_int32)((opus_int16)(b32)) * (c32 >> 16) */
87 #define silk_SMLABT(a32, b32, c32)       ((a32) + ((opus_int32)((opus_int16)(b32))) * ((c32) >> 16))
88
89 /* a64 + (b32 * c32) */
90 #define silk_SMLAL(a64, b32, c32)        (silk_ADD64((a64), ((opus_int64)(b32) * (opus_int64)(c32))))
91
92 /* (a32 * b32) >> 16 */
93 #if OPUS_FAST_INT64
94 #define silk_SMULWW(a32, b32)            ((opus_int32)(((opus_int64)(a32) * (b32)) >> 16))
95 #else
96 #define silk_SMULWW(a32, b32)            silk_MLA(silk_SMULWB((a32), (b32)), (a32), silk_RSHIFT_ROUND((b32), 16))
97 #endif
98
99 /* a32 + ((b32 * c32) >> 16) */
100 #if OPUS_FAST_INT64
101 #define silk_SMLAWW(a32, b32, c32)       ((opus_int32)((a32) + (((opus_int64)(b32) * (c32)) >> 16)))
102 #else
103 #define silk_SMLAWW(a32, b32, c32)       silk_MLA(silk_SMLAWB((a32), (b32), (c32)), (b32), silk_RSHIFT_ROUND((c32), 16))
104 #endif
105
106 /* add/subtract with output saturated */
107 #define silk_ADD_SAT32(a, b)             ((((opus_uint32)(a) + (opus_uint32)(b)) & 0x80000000) == 0 ?                              \
108                                         ((((a) & (b)) & 0x80000000) != 0 ? silk_int32_MIN : (a)+(b)) :   \
109                                         ((((a) | (b)) & 0x80000000) == 0 ? silk_int32_MAX : (a)+(b)) )
110
111 #define silk_SUB_SAT32(a, b)             ((((opus_uint32)(a)-(opus_uint32)(b)) & 0x80000000) == 0 ?                                        \
112                                         (( (a) & ((b)^0x80000000) & 0x80000000) ? silk_int32_MIN : (a)-(b)) :    \
113                                         ((((a)^0x80000000) & (b)  & 0x80000000) ? silk_int32_MAX : (a)-(b)) )
114
115 #if defined(MIPSr1_ASM)
116 #include "mips/macros_mipsr1.h"
117 #endif
118
119 #include "ecintrin.h"
120 #ifndef OVERRIDE_silk_CLZ16
121 static OPUS_INLINE opus_int32 silk_CLZ16(opus_int16 in16)
122 {
123     return 32 - EC_ILOG(in16<<16|0x8000);
124 }
125 #endif
126
127 #ifndef OVERRIDE_silk_CLZ32
128 static OPUS_INLINE opus_int32 silk_CLZ32(opus_int32 in32)
129 {
130     return in32 ? 32 - EC_ILOG(in32) : 32;
131 }
132 #endif
133
134 /* Row based */
135 #define matrix_ptr(Matrix_base_adr, row, column, N) \
136     (*((Matrix_base_adr) + ((row)*(N)+(column))))
137 #define matrix_adr(Matrix_base_adr, row, column, N) \
138       ((Matrix_base_adr) + ((row)*(N)+(column)))
139
140 /* Column based */
141 #ifndef matrix_c_ptr
142 #   define matrix_c_ptr(Matrix_base_adr, row, column, M) \
143     (*((Matrix_base_adr) + ((row)+(M)*(column))))
144 #endif
145
146 #ifdef OPUS_ARM_INLINE_ASM
147 #include "arm/macros_armv4.h"
148 #endif
149
150 #ifdef OPUS_ARM_INLINE_EDSP
151 #include "arm/macros_armv5e.h"
152 #endif
153
154 #ifdef OPUS_ARM_PRESUME_AARCH64_NEON_INTR
155 #include "arm/macros_arm64.h"
156 #endif
157
158 #endif /* SILK_MACROS_H */
159