Add GCC specific optimisation for log base 2 operations.
[flac.git] / src / libFLAC / bitmath.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2001,2002,2003,2004,2005,2006,2007,2008,2009  Josh Coalson
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 #if HAVE_CONFIG_H
33 #  include <config.h>
34 #endif
35
36 #include "private/bitmath.h"
37 #include "FLAC/assert.h"
38
39 /* An example of what FLAC__bitmath_ilog2() computes:
40  *
41  * ilog2( 0) = assertion failure
42  * ilog2( 1) = 0
43  * ilog2( 2) = 1
44  * ilog2( 3) = 1
45  * ilog2( 4) = 2
46  * ilog2( 5) = 2
47  * ilog2( 6) = 2
48  * ilog2( 7) = 2
49  * ilog2( 8) = 3
50  * ilog2( 9) = 3
51  * ilog2(10) = 3
52  * ilog2(11) = 3
53  * ilog2(12) = 3
54  * ilog2(13) = 3
55  * ilog2(14) = 3
56  * ilog2(15) = 3
57  * ilog2(16) = 4
58  * ilog2(17) = 4
59  * ilog2(18) = 4
60  */
61
62 #ifndef __GNUC__
63
64 /* For GNUC, use static inline version in include/private/bitmath.h. */
65
66 unsigned FLAC__bitmath_ilog2(FLAC__uint32 v)
67 {
68         unsigned l = 0;
69     if (v == 0)
70                 return 0;
71         while(v >>= 1)
72                 l++;
73         return l;
74 }
75
76 unsigned FLAC__bitmath_ilog2_wide(FLAC__uint64 v)
77 {
78         unsigned l = 0;
79     if (v == 0)
80                 return 0;
81         while(v >>= 1)
82                 l++;
83         return l;
84 }
85 #endif
86
87 /* An example of what FLAC__bitmath_silog2() computes:
88  *
89  * silog2(-10) = 5
90  * silog2(- 9) = 5
91  * silog2(- 8) = 4
92  * silog2(- 7) = 4
93  * silog2(- 6) = 4
94  * silog2(- 5) = 4
95  * silog2(- 4) = 3
96  * silog2(- 3) = 3
97  * silog2(- 2) = 2
98  * silog2(- 1) = 2
99  * silog2(  0) = 0
100  * silog2(  1) = 2
101  * silog2(  2) = 3
102  * silog2(  3) = 3
103  * silog2(  4) = 4
104  * silog2(  5) = 4
105  * silog2(  6) = 4
106  * silog2(  7) = 4
107  * silog2(  8) = 5
108  * silog2(  9) = 5
109  * silog2( 10) = 5
110  */
111 unsigned FLAC__bitmath_silog2(int v)
112 {
113         while(1) {
114                 if(v == 0) {
115                         return 0;
116                 }
117                 else if(v > 0) {
118                         unsigned l = 0;
119                         while(v) {
120                                 l++;
121                                 v >>= 1;
122                         }
123                         return l+1;
124                 }
125                 else if(v == -1) {
126                         return 2;
127                 }
128                 else {
129                         v++;
130                         v = -v;
131                 }
132         }
133 }
134
135 unsigned FLAC__bitmath_silog2_wide(FLAC__int64 v)
136 {
137         while(1) {
138                 if(v == 0) {
139                         return 0;
140                 }
141                 else if(v > 0) {
142                         unsigned l = 0;
143                         while(v) {
144                                 l++;
145                                 v >>= 1;
146                         }
147                         return l+1;
148                 }
149                 else if(v == -1) {
150                         return 2;
151                 }
152                 else {
153                         v++;
154                         v = -v;
155                 }
156         }
157 }