Move av_cmp_i()'s unaltered comment to the header file.
[ffmpeg.git] / libavutil / integer.c
1 /*
2  * arbitrary precision integers
3  * Copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  */
22
23 /**
24  * @file integer.c
25  * arbitrary precision integers.
26  * @author Michael Niedermayer <michaelni@gmx.at>
27  */
28
29 #include "common.h"
30 #include "integer.h"
31
32 AVInteger av_add_i(AVInteger a, AVInteger b){
33     int i, carry=0;
34
35     for(i=0; i<AV_INTEGER_SIZE; i++){
36         carry= (carry>>16) + a.v[i] + b.v[i];
37         a.v[i]= carry;
38     }
39     return a;
40 }
41
42 AVInteger av_sub_i(AVInteger a, AVInteger b){
43     int i, carry=0;
44
45     for(i=0; i<AV_INTEGER_SIZE; i++){
46         carry= (carry>>16) + a.v[i] - b.v[i];
47         a.v[i]= carry;
48     }
49     return a;
50 }
51
52 /**
53  * returns the rounded down value of the logarithm of base 2 of the given AVInteger.
54  * this is simply the index of the most significant bit which is 1. Or 0 of all bits are 0
55  */
56 int av_log2_i(AVInteger a){
57     int i;
58
59     for(i=AV_INTEGER_SIZE-1; i>=0; i--){
60         if(a.v[i])
61             return av_log2_16bit(a.v[i]) + 16*i;
62     }
63     return -1;
64 }
65
66 AVInteger av_mul_i(AVInteger a, AVInteger b){
67     AVInteger out;
68     int i, j;
69     int na= (av_log2_i(a)+16) >> 4;
70     int nb= (av_log2_i(b)+16) >> 4;
71
72     memset(&out, 0, sizeof(out));
73
74     for(i=0; i<na; i++){
75         unsigned int carry=0;
76
77         if(a.v[i])
78             for(j=i; j<AV_INTEGER_SIZE && j-i<=nb; j++){
79                 carry= (carry>>16) + out.v[j] + a.v[i]*b.v[j-i];
80                 out.v[j]= carry;
81             }
82     }
83
84     return out;
85 }
86
87 int av_cmp_i(AVInteger a, AVInteger b){
88     int i;
89     int v= (int16_t)a.v[AV_INTEGER_SIZE-1] - (int16_t)b.v[AV_INTEGER_SIZE-1];
90     if(v) return (v>>16)|1;
91
92     for(i=AV_INTEGER_SIZE-2; i>=0; i--){
93         int v= a.v[i] - b.v[i];
94         if(v) return (v>>16)|1;
95     }
96     return 0;
97 }
98
99 AVInteger av_shr_i(AVInteger a, int s){
100     AVInteger out;
101     int i;
102
103     for(i=0; i<AV_INTEGER_SIZE; i++){
104         int index= i + (s>>4);
105         unsigned int v=0;
106         if(index+1<AV_INTEGER_SIZE && index+1>=0) v = a.v[index+1]<<16;
107         if(index  <AV_INTEGER_SIZE && index  >=0) v+= a.v[index  ];
108         out.v[i]= v >> (s&15);
109     }
110     return out;
111 }
112
113 AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b){
114     int i= av_log2_i(a) - av_log2_i(b);
115     AVInteger quot_temp;
116     if(!quot) quot = &quot_temp;
117
118     assert((int16_t)a[AV_INTEGER_SIZE-1] >= 0 && (int16_t)b[AV_INTEGER_SIZE-1] >= 0);
119     assert(av_log2(b)>=0);
120
121     if(i > 0)
122         b= av_shr_i(b, -i);
123
124     memset(quot, 0, sizeof(AVInteger));
125
126     while(i-- >= 0){
127         *quot= av_shr_i(*quot, -1);
128         if(av_cmp_i(a, b) >= 0){
129             a= av_sub_i(a, b);
130             quot->v[0] += 1;
131         }
132         b= av_shr_i(b, 1);
133     }
134     return a;
135 }
136
137 AVInteger av_div_i(AVInteger a, AVInteger b){
138     AVInteger quot;
139     av_mod_i(&quot, a, b);
140     return quot;
141 }
142
143 /**
144  * converts the given int64_t to an AVInteger.
145  */
146 AVInteger av_int2i(int64_t a){
147     AVInteger out;
148     int i;
149
150     for(i=0; i<AV_INTEGER_SIZE; i++){
151         out.v[i]= a;
152         a>>=16;
153     }
154     return out;
155 }
156
157 /**
158  * converts the given AVInteger to an int64_t.
159  * if the AVInteger is too large to fit into an int64_t,
160  * then only the least significant 64bit will be used
161  */
162 int64_t av_i2int(AVInteger a){
163     int i;
164     int64_t out=(int8_t)a.v[AV_INTEGER_SIZE-1];
165
166     for(i= AV_INTEGER_SIZE-2; i>=0; i--){
167         out = (out<<16) + a.v[i];
168     }
169     return out;
170 }
171
172 #if 0
173 #undef NDEBUG
174 #include <assert.h>
175
176 const uint8_t ff_log2_tab[256]={
177         0,0,1,1,2,2,2,2,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,4,4,4,4,4,4,4,4,
178         5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,
179         6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
180         6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
181         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
182         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
183         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
184         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7
185 };
186
187 main(){
188     int64_t a,b;
189
190     for(a=7; a<256*256*256; a+=13215){
191         for(b=3; b<256*256*256; b+=27118){
192             AVInteger ai= av_int2i(a);
193             AVInteger bi= av_int2i(b);
194
195             assert(av_i2int(ai) == a);
196             assert(av_i2int(bi) == b);
197             assert(av_i2int(av_add_i(ai,bi)) == a+b);
198             assert(av_i2int(av_sub_i(ai,bi)) == a-b);
199             assert(av_i2int(av_mul_i(ai,bi)) == a*b);
200             assert(av_i2int(av_shr_i(ai, 9)) == a>>9);
201             assert(av_i2int(av_shr_i(ai,-9)) == a<<9);
202             assert(av_i2int(av_shr_i(ai, 17)) == a>>17);
203             assert(av_i2int(av_shr_i(ai,-17)) == a<<17);
204             assert(av_log2_i(ai) == av_log2(a));
205             assert(av_i2int(av_div_i(ai,bi)) == a/b);
206         }
207     }
208 }
209 #endif