aarch64: Add assembly support for -fsanitize=hwaddress tagged globals.
[libav.git] / libavutil / mathematics.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
04d7f601
DB
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
2912e87a 17 * License along with Libav; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
98790382
SS
21#ifndef AVUTIL_MATHEMATICS_H
22#define AVUTIL_MATHEMATICS_H
c11c2bc2 23
6ef29128 24#include <stdint.h>
d1a12956 25#include <math.h>
2ed6f399 26#include "attributes.h"
c11c2bc2 27#include "rational.h"
a1245d5c 28#include "intfloat.h"
c11c2bc2 29
e4a35244 30#ifndef M_LOG2_10
94a5218c 31#define M_LOG2_10 3.32192809488736234787 /* log_2 10 */
e4a35244 32#endif
44852477
SS
33#ifndef M_PHI
34#define M_PHI 1.61803398874989484820 /* phi / golden ratio */
35#endif
bd41c06f 36#ifndef NAN
a1245d5c 37#define NAN av_int2float(0x7fc00000)
bd41c06f
MR
38#endif
39#ifndef INFINITY
a1245d5c 40#define INFINITY av_int2float(0x7f800000)
bd41c06f 41#endif
d1a12956 42
757cd8d8
LB
43/**
44 * @addtogroup lavu_math
45 * @{
46 */
47
48
c11c2bc2 49enum AVRounding {
89c9ff50
DB
50 AV_ROUND_ZERO = 0, ///< Round toward zero.
51 AV_ROUND_INF = 1, ///< Round away from zero.
52 AV_ROUND_DOWN = 2, ///< Round toward -infinity.
53 AV_ROUND_UP = 3, ///< Round toward +infinity.
54 AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero.
c11c2bc2
AS
55};
56
03703cb3 57/**
49bd8e4b 58 * Return the greatest common divisor of a and b.
bac24dd2 59 * If both a and b are 0 or either or both are <0 then behavior is
03703cb3
MN
60 * undefined.
61 */
9ce6c138
AJ
62int64_t av_const av_gcd(int64_t a, int64_t b);
63
c11c2bc2 64/**
49bd8e4b 65 * Rescale a 64-bit integer with rounding to nearest.
89c9ff50 66 * A simple a*b/c isn't possible as it can overflow.
c11c2bc2 67 */
85074d3c 68int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const;
c11c2bc2
AS
69
70/**
49bd8e4b 71 * Rescale a 64-bit integer with specified rounding.
89c9ff50 72 * A simple a*b/c isn't possible as it can overflow.
c11c2bc2 73 */
85074d3c 74int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding) av_const;
c11c2bc2
AS
75
76/**
49bd8e4b 77 * Rescale a 64-bit integer by 2 rational numbers.
c11c2bc2 78 */
85074d3c 79int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const;
c11c2bc2 80
78b01823 81/**
0b42a938
JR
82 * Rescale a 64-bit integer by 2 rational numbers with specified rounding.
83 */
84int64_t av_rescale_q_rnd(int64_t a, AVRational bq, AVRational cq,
85 enum AVRounding) av_const;
86
87/**
49bd8e4b 88 * Compare 2 timestamps each in its own timebases.
78b01823
MN
89 * The result of the function is undefined if one of the timestamps
90 * is outside the int64_t range when represented in the others timebase.
32e543f8 91 * @return -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position
78b01823
MN
92 */
93int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
94
65db0587 95/**
49bd8e4b 96 * Compare 2 integers modulo mod.
29708427
SS
97 * That is we compare integers a and b for which only the least
98 * significant log2(mod) bits are known.
99 *
65db0587 100 * @param mod must be a power of 2
29708427
SS
101 * @return a negative value if a is smaller than b
102 * a positive value if a is greater than b
103 * 0 if a equals b
65db0587
MN
104 */
105int64_t av_compare_mod(uint64_t a, uint64_t b, uint64_t mod);
78b01823 106
757cd8d8
LB
107/**
108 * @}
109 */
110
98790382 111#endif /* AVUTIL_MATHEMATICS_H */