libavutil/mathematics.h
04d7f601
 /*
90d4b070
  * copyright (c) 2005-2012 Michael Niedermayer <michaelni@gmx.at>
04d7f601
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
04d7f601
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
04d7f601
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
04d7f601
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
04d7f601
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
98790382
 #ifndef AVUTIL_MATHEMATICS_H
 #define AVUTIL_MATHEMATICS_H
c11c2bc2
 
6ef29128
 #include <stdint.h>
d1a12956
 #include <math.h>
2ed6f399
 #include "attributes.h"
c11c2bc2
 #include "rational.h"
a1245d5c
 #include "intfloat.h"
c11c2bc2
 
15bde060
 #ifndef M_E
 #define M_E            2.7182818284590452354   /* e */
 #endif
 #ifndef M_LN2
 #define M_LN2          0.69314718055994530942  /* log_e 2 */
 #endif
 #ifndef M_LN10
 #define M_LN10         2.30258509299404568402  /* log_e 10 */
 #endif
e4a35244
 #ifndef M_LOG2_10
94a5218c
 #define M_LOG2_10      3.32192809488736234787  /* log_2 10 */
e4a35244
 #endif
44852477
 #ifndef M_PHI
 #define M_PHI          1.61803398874989484820   /* phi / golden ratio */
 #endif
15bde060
 #ifndef M_PI
 #define M_PI           3.14159265358979323846  /* pi */
 #endif
3e309c5d
 #ifndef M_PI_2
 #define M_PI_2         1.57079632679489661923  /* pi/2 */
 #endif
15bde060
 #ifndef M_SQRT1_2
 #define M_SQRT1_2      0.70710678118654752440  /* 1/sqrt(2) */
 #endif
 #ifndef M_SQRT2
 #define M_SQRT2        1.41421356237309504880  /* sqrt(2) */
 #endif
bd41c06f
 #ifndef NAN
a1245d5c
 #define NAN            av_int2float(0x7fc00000)
bd41c06f
 #endif
 #ifndef INFINITY
a1245d5c
 #define INFINITY       av_int2float(0x7f800000)
bd41c06f
 #endif
d1a12956
 
757cd8d8
 /**
  * @addtogroup lavu_math
  * @{
  */
 
 
c11c2bc2
 enum AVRounding {
89c9ff50
     AV_ROUND_ZERO     = 0, ///< Round toward zero.
     AV_ROUND_INF      = 1, ///< Round away from zero.
     AV_ROUND_DOWN     = 2, ///< Round toward -infinity.
     AV_ROUND_UP       = 3, ///< Round toward +infinity.
     AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero.
740e7408
     AV_ROUND_PASS_MINMAX = 8192, ///< Flag to pass INT64_MIN/MAX through instead of rescaling, this avoids special cases for AV_NOPTS_VALUE
c11c2bc2
 };
 
03703cb3
 /**
20a30077
  * Compute the greatest common divisor of a and b.
  *
  * @return gcd of a and b up to sign; if a >= 0 and b >= 0, return value is >= 0;
  * if a == 0 and b == 0, returns 0.
03703cb3
  */
9ce6c138
 int64_t av_const av_gcd(int64_t a, int64_t b);
 
c11c2bc2
 /**
49bd8e4b
  * Rescale a 64-bit integer with rounding to nearest.
89c9ff50
  * A simple a*b/c isn't possible as it can overflow.
c11c2bc2
  */
85074d3c
 int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const;
c11c2bc2
 
 /**
49bd8e4b
  * Rescale a 64-bit integer with specified rounding.
89c9ff50
  * A simple a*b/c isn't possible as it can overflow.
740e7408
  *
f263426e
  * @return rescaled value a, or if AV_ROUND_PASS_MINMAX is set and a is
  *         INT64_MIN or INT64_MAX then a is passed through unchanged.
c11c2bc2
  */
85074d3c
 int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding) av_const;
c11c2bc2
 
 /**
49bd8e4b
  * Rescale a 64-bit integer by 2 rational numbers.
c11c2bc2
  */
85074d3c
 int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const;
c11c2bc2
 
78b01823
 /**
0b42a938
  * Rescale a 64-bit integer by 2 rational numbers with specified rounding.
740e7408
  *
f263426e
  * @return rescaled value a, or if AV_ROUND_PASS_MINMAX is set and a is
  *         INT64_MIN or INT64_MAX then a is passed through unchanged.
0b42a938
  */
 int64_t av_rescale_q_rnd(int64_t a, AVRational bq, AVRational cq,
                          enum AVRounding) av_const;
 
 /**
49bd8e4b
  * Compare 2 timestamps each in its own timebases.
78b01823
  * The result of the function is undefined if one of the timestamps
  * is outside the int64_t range when represented in the others timebase.
32e543f8
  * @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
  */
 int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
 
65db0587
 /**
49bd8e4b
  * Compare 2 integers modulo mod.
29708427
  * That is we compare integers a and b for which only the least
  * significant log2(mod) bits are known.
  *
65db0587
  * @param mod must be a power of 2
29708427
  * @return a negative value if a is smaller than b
  *         a positive value if a is greater than b
  *         0                if a equals          b
65db0587
  */
 int64_t av_compare_mod(uint64_t a, uint64_t b, uint64_t mod);
78b01823
 
757cd8d8
 /**
8766ad9e
  * Rescale a timestamp while preserving known durations.
2bcbdd84
  *
  * @param in_ts Input timestamp
9c5260e7
  * @param in_tb Input timebase
2bcbdd84
  * @param fs_tb Duration and *last timebase
  * @param duration duration till the next call
9c5260e7
  * @param out_tb Output timebase
8766ad9e
  */
 int64_t av_rescale_delta(AVRational in_tb, int64_t in_ts,  AVRational fs_tb, int duration, int64_t *last, AVRational out_tb);
 
 /**
b317f945
  * Add a value to a timestamp.
  *
88f2586a
  * This function guarantees that when the same value is repeatly added that
b317f945
  * no accumulation of rounding errors occurs.
  *
  * @param ts Input timestamp
  * @param ts_tb Input timestamp timebase
  * @param inc value to add to ts
  * @param inc_tb inc timebase
  */
 int64_t av_add_stable(AVRational ts_tb, int64_t ts, AVRational inc_tb, int64_t inc);
 
 
     /**
757cd8d8
  * @}
  */
 
98790382
 #endif /* AVUTIL_MATHEMATICS_H */