annotate lib/libavutil/mathematics.h @ 2202:44d956d4f838

Merge
author Grumpy7
date Mon, 03 Feb 2014 23:07:15 +0100
parents 992d2e6f907d
children
rev   line source
2134
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
1 /*
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
2 * copyright (c) 2005-2012 Michael Niedermayer <michaelni@gmx.at>
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
3 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
4 * This file is part of FFmpeg.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
5 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
8 * License as published by the Free Software Foundation; either
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
10 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
14 * Lesser General Public License for more details.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
15 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
19 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
20
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
21 #ifndef AVUTIL_MATHEMATICS_H
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
22 #define AVUTIL_MATHEMATICS_H
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
23
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
24 #include <stdint.h>
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
25 #include <math.h>
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
26 #include "attributes.h"
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
27 #include "rational.h"
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
28 #include "intfloat.h"
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
29
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
30 #ifndef M_E
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
31 #define M_E 2.7182818284590452354 /* e */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
32 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
33 #ifndef M_LN2
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
34 #define M_LN2 0.69314718055994530942 /* log_e 2 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
35 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
36 #ifndef M_LN10
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
37 #define M_LN10 2.30258509299404568402 /* log_e 10 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
38 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
39 #ifndef M_LOG2_10
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
40 #define M_LOG2_10 3.32192809488736234787 /* log_2 10 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
41 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
42 #ifndef M_PHI
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
43 #define M_PHI 1.61803398874989484820 /* phi / golden ratio */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
44 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
45 #ifndef M_PI
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
46 #define M_PI 3.14159265358979323846 /* pi */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
47 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
48 #ifndef M_SQRT1_2
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
49 #define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
50 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
51 #ifndef M_SQRT2
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
52 #define M_SQRT2 1.41421356237309504880 /* sqrt(2) */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
53 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
54 #ifndef NAN
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
55 #define NAN av_int2float(0x7fc00000)
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
56 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
57 #ifndef INFINITY
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
58 #define INFINITY av_int2float(0x7f800000)
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
59 #endif
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
60
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
61 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
62 * @addtogroup lavu_math
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
63 * @{
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
64 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
65
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
66
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
67 enum AVRounding {
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
68 AV_ROUND_ZERO = 0, ///< Round toward zero.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
69 AV_ROUND_INF = 1, ///< Round away from zero.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
70 AV_ROUND_DOWN = 2, ///< Round toward -infinity.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
71 AV_ROUND_UP = 3, ///< Round toward +infinity.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
72 AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
73 AV_ROUND_PASS_MINMAX = 8192, ///< Flag to pass INT64_MIN/MAX through instead of rescaling, this avoids special cases for AV_NOPTS_VALUE
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
74 };
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
75
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
76 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
77 * Return the greatest common divisor of a and b.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
78 * If both a and b are 0 or either or both are <0 then behavior is
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
79 * undefined.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
80 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
81 int64_t av_const av_gcd(int64_t a, int64_t b);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
82
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
83 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
84 * Rescale a 64-bit integer with rounding to nearest.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
85 * A simple a*b/c isn't possible as it can overflow.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
86 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
87 int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const;
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
88
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
89 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
90 * Rescale a 64-bit integer with specified rounding.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
91 * A simple a*b/c isn't possible as it can overflow.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
92 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
93 * @return rescaled value a, or if AV_ROUND_PASS_MINMAX is set and a is
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
94 * INT64_MIN or INT64_MAX then a is passed through unchanged.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
95 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
96 int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding) av_const;
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
97
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
98 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
99 * Rescale a 64-bit integer by 2 rational numbers.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
100 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
101 int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const;
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
102
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
103 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
104 * Rescale a 64-bit integer by 2 rational numbers with specified rounding.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
105 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
106 * @return rescaled value a, or if AV_ROUND_PASS_MINMAX is set and a is
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
107 * INT64_MIN or INT64_MAX then a is passed through unchanged.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
108 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
109 int64_t av_rescale_q_rnd(int64_t a, AVRational bq, AVRational cq,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
110 enum AVRounding) av_const;
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
111
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
112 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
113 * Compare 2 timestamps each in its own timebases.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
114 * The result of the function is undefined if one of the timestamps
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
115 * is outside the int64_t range when represented in the others timebase.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
116 * @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
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
117 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
118 int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
119
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
120 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
121 * Compare 2 integers modulo mod.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
122 * That is we compare integers a and b for which only the least
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
123 * significant log2(mod) bits are known.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
124 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
125 * @param mod must be a power of 2
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
126 * @return a negative value if a is smaller than b
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
127 * a positive value if a is greater than b
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
128 * 0 if a equals b
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
129 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
130 int64_t av_compare_mod(uint64_t a, uint64_t b, uint64_t mod);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
131
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
132 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
133 * Rescale a timestamp while preserving known durations.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
134 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
135 * @param in_ts Input timestamp
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
136 * @param in_tb Input timesbase
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
137 * @param fs_tb Duration and *last timebase
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
138 * @param duration duration till the next call
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
139 * @param out_tb Output timesbase
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
140 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
141 int64_t av_rescale_delta(AVRational in_tb, int64_t in_ts, AVRational fs_tb, int duration, int64_t *last, AVRational out_tb);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
142
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
143 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
144 * @}
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
145 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
146
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
147 #endif /* AVUTIL_MATHEMATICS_H */