Mercurial > libavutil.hg
annotate mathematics.h @ 961:64a8e85b50be libavutil
Improve GET_UTF{8,16} documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:48 +0000 |
parents | e34e8d654ded |
children | f9e8cd74a5f4 |
rev | line source |
---|---|
108
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
1 /* |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
2 * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at> |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
3 * |
116
d76a36742464
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
108
diff
changeset
|
4 * This file is part of FFmpeg. |
d76a36742464
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
108
diff
changeset
|
5 * |
d76a36742464
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
108
diff
changeset
|
6 * FFmpeg is free software; you can redistribute it and/or |
108
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
7 * modify it under the terms of the GNU Lesser General Public |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
8 * License as published by the Free Software Foundation; either |
116
d76a36742464
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
108
diff
changeset
|
9 * version 2.1 of the License, or (at your option) any later version. |
108
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
10 * |
116
d76a36742464
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
108
diff
changeset
|
11 * FFmpeg is distributed in the hope that it will be useful, |
108
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
14 * Lesser General Public License for more details. |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
15 * |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
16 * You should have received a copy of the GNU Lesser General Public |
116
d76a36742464
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
108
diff
changeset
|
17 * License along with FFmpeg; if not, write to the Free Software |
108
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
19 */ |
11be8e0d1344
Add official LGPL license headers to the files that were missing them.
diego
parents:
0
diff
changeset
|
20 |
567 | 21 #ifndef AVUTIL_MATHEMATICS_H |
22 #define AVUTIL_MATHEMATICS_H | |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
23 |
468
b76b4c3a5dde
Add missing stdint.h #include to headers that use it.
diego
parents:
392
diff
changeset
|
24 #include <stdint.h> |
547
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
25 #include <math.h> |
873
4d9ad0ed07d0
Replace many includes of libavutil/common.h with what is actually needed
mru
parents:
845
diff
changeset
|
26 #include "attributes.h" |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
27 #include "rational.h" |
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
28 |
547
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
29 #ifndef M_E |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
30 #define M_E 2.7182818284590452354 /* e */ |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
31 #endif |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
32 #ifndef M_LN2 |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
33 #define M_LN2 0.69314718055994530942 /* log_e 2 */ |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
34 #endif |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
35 #ifndef M_LN10 |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
36 #define M_LN10 2.30258509299404568402 /* log_e 10 */ |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
37 #endif |
844 | 38 #ifndef M_LOG2_10 |
845 | 39 #define M_LOG2_10 3.32192809488736234787 /* log_2 10 */ |
844 | 40 #endif |
548
8d46104adf83
move M_PI definition along with other math definitions
aurel
parents:
547
diff
changeset
|
41 #ifndef M_PI |
8d46104adf83
move M_PI definition along with other math definitions
aurel
parents:
547
diff
changeset
|
42 #define M_PI 3.14159265358979323846 /* pi */ |
8d46104adf83
move M_PI definition along with other math definitions
aurel
parents:
547
diff
changeset
|
43 #endif |
547
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
44 #ifndef M_SQRT1_2 |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
45 #define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */ |
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
46 #endif |
897 | 47 #ifndef M_SQRT2 |
48 #define M_SQRT2 1.41421356237309504880 /* sqrt(2) */ | |
49 #endif | |
762 | 50 #ifndef NAN |
51 #define NAN (0.0/0.0) | |
52 #endif | |
53 #ifndef INFINITY | |
54 #define INFINITY (1.0/0.0) | |
55 #endif | |
547
3f9f807b86a4
define some math constants so as not to depend on _XOPEN_SOURCE
aurel
parents:
481
diff
changeset
|
56 |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
57 enum AVRounding { |
633 | 58 AV_ROUND_ZERO = 0, ///< Round toward zero. |
59 AV_ROUND_INF = 1, ///< Round away from zero. | |
60 AV_ROUND_DOWN = 2, ///< Round toward -infinity. | |
61 AV_ROUND_UP = 3, ///< Round toward +infinity. | |
62 AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero. | |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
63 }; |
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
64 |
802 | 65 /** |
957 | 66 * Return the greatest common divisor of a and b. |
803 | 67 * If both a and b are 0 or either or both are <0 then behavior is |
802 | 68 * undefined. |
69 */ | |
607 | 70 int64_t av_const av_gcd(int64_t a, int64_t b); |
71 | |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
72 /** |
957 | 73 * Rescale a 64-bit integer with rounding to nearest. |
633 | 74 * A simple a*b/c isn't possible as it can overflow. |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
75 */ |
481
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
76 int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const; |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
77 |
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
78 /** |
957 | 79 * Rescale a 64-bit integer with specified rounding. |
633 | 80 * A simple a*b/c isn't possible as it can overflow. |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
81 */ |
481
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
82 int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding) av_const; |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
83 |
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
84 /** |
957 | 85 * Rescale a 64-bit integer by 2 rational numbers. |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
86 */ |
481
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
87 int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const; |
0
ee8f44bb7c4d
libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff
changeset
|
88 |
830 | 89 /** |
957 | 90 * Compare 2 timestamps each in its own timebases. |
830 | 91 * The result of the function is undefined if one of the timestamps |
92 * is outside the int64_t range when represented in the others timebase. | |
893 | 93 * @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 |
830 | 94 */ |
95 int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b); | |
96 | |
933 | 97 /** |
957 | 98 * Compare 2 integers modulo mod. |
939 | 99 * That is we compare integers a and b for which only the least |
100 * significant log2(mod) bits are known. | |
101 * | |
933 | 102 * @param mod must be a power of 2 |
939 | 103 * @return a negative value if a is smaller than b |
104 * a positive value if a is greater than b | |
105 * 0 if a equals b | |
933 | 106 */ |
107 int64_t av_compare_mod(uint64_t a, uint64_t b, uint64_t mod); | |
830 | 108 |
567 | 109 #endif /* AVUTIL_MATHEMATICS_H */ |