Move av_i2int()'s unaltered comments to the header file.
[ffmpeg.git] / libavutil / integer.h
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.h
25  * arbitrary precision integers
26  * @author Michael Niedermayer <michaelni@gmx.at>
27  */
28
29 #ifndef INTEGER_H
30 #define INTEGER_H
31
32 #define AV_INTEGER_SIZE 8
33
34 typedef struct AVInteger{
35     uint16_t v[AV_INTEGER_SIZE];
36 } AVInteger;
37
38 AVInteger av_add_i(AVInteger a, AVInteger b);
39 AVInteger av_sub_i(AVInteger a, AVInteger b);
40 int av_log2_i(AVInteger a);
41 AVInteger av_mul_i(AVInteger a, AVInteger b);
42
43 /**
44  * returns 0 if a==b, 1 if a>b and -1 if a<b.
45  */
46 int av_cmp_i(AVInteger a, AVInteger b);
47
48 /**
49  * bitwise shift.
50  * @param s the number of bits by which the value should be shifted right, may be negative for shifting left
51  */
52 AVInteger av_shr_i(AVInteger a, int s);
53
54 /**
55  * returns a % b.
56  * @param quot a/b will be stored here
57  */
58 AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b);
59
60 /**
61  * returns a/b.
62  */
63 AVInteger av_div_i(AVInteger a, AVInteger b);
64
65 /**
66  * converts the given int64_t to an AVInteger.
67  */
68 AVInteger av_int2i(int64_t a);
69
70 /**
71  * converts the given AVInteger to an int64_t.
72  * if the AVInteger is too large to fit into an int64_t,
73  * then only the least significant 64bit will be used
74  */
75 int64_t av_i2int(AVInteger a);
76
77 #endif // INTEGER_H