avutil/x86/bswap: Add msvc bswap instrinsics.
[ffmpeg.git] / libavutil / rational.h
index b00e3a4..2897469 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Rational numbers
+ * rational numbers
  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
  *
  * This file is part of FFmpeg.
  */
 
 /**
- * @file rational.h
- * Rational numbers.
+ * @file
+ * rational numbers
  * @author Michael Niedermayer <michaelni@gmx.at>
  */
 
-#ifndef RATIONAL_H
-#define RATIONAL_H
+#ifndef AVUTIL_RATIONAL_H
+#define AVUTIL_RATIONAL_H
 
 #include <stdint.h>
+#include <limits.h>
+#include "attributes.h"
 
 /**
- * Rational number num/den.
+ * @addtogroup lavu_math
+ * @{
+ */
+
+/**
+ * rational number numerator/denominator
  */
 typedef struct AVRational{
     int num; ///< numerator
     int den; ///< denominator
 } AVRational;
 
+/**
+ * Create a rational.
+ * Useful for compilers that do not support compound literals.
+ * @note  The return value is not reduced.
+ */
+static inline AVRational av_make_q(int num, int den)
+{
+    AVRational r = { num, den };
+    return r;
+}
+
 /**
  * Compare two rationals.
  * @param a first rational
  * @param b second rational
- * @return 0 if a==b, 1 if a>b and -1 if a<b.
+ * @return 0 if a==b, 1 if a>b, -1 if a<b, and INT_MIN if one of the
+ * values is of the form 0/0
  */
 static inline int av_cmp_q(AVRational a, AVRational b){
     const int64_t tmp= a.num * (int64_t)b.den - b.num * (int64_t)a.den;
 
-    if(tmp) return (tmp>>63)|1;
-    else    return 0;
+    if(tmp) return (int)((tmp ^ a.den ^ b.den)>>63)|1;
+    else if(b.den && a.den) return 0;
+    else if(a.num && b.num) return (a.num>>31) - (b.num>>31);
+    else                    return INT_MIN;
 }
 
 /**
- * Rational to double conversion.
+ * Convert rational to double.
  * @param a rational to convert
  * @return (double) a
  */
@@ -63,53 +84,90 @@ static inline double av_q2d(AVRational a){
 /**
  * Reduce a fraction.
  * This is useful for framerate calculations.
- * @param dst_nom destination numerator
+ * @param dst_num destination numerator
  * @param dst_den destination denominator
- * @param nom source numerator
+ * @param num source numerator
  * @param den source denominator
- * @param max the maximum allowed for dst_nom & dst_den
+ * @param max the maximum allowed for dst_num & dst_den
  * @return 1 if exact, 0 otherwise
  */
-int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
+int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max);
 
 /**
- * Multiplies two rationals.
- * @param b first rational.
- * @param c second rational.
- * @return b*c.
+ * Multiply two rationals.
+ * @param b first rational
+ * @param c second rational
+ * @return b*c
  */
-AVRational av_mul_q(AVRational b, AVRational c);
+AVRational av_mul_q(AVRational b, AVRational c) av_const;
 
 /**
- * Divides one rational by another.
- * @param b first rational.
- * @param c second rational.
- * @return b/c.
+ * Divide one rational by another.
+ * @param b first rational
+ * @param c second rational
+ * @return b/c
  */
-AVRational av_div_q(AVRational b, AVRational c);
+AVRational av_div_q(AVRational b, AVRational c) av_const;
 
 /**
- * Adds two rationals.
- * @param b first rational.
- * @param c second rational.
- * @return b+c.
+ * Add two rationals.
+ * @param b first rational
+ * @param c second rational
+ * @return b+c
  */
-AVRational av_add_q(AVRational b, AVRational c);
+AVRational av_add_q(AVRational b, AVRational c) av_const;
 
 /**
- * Subtracts one rational from another.
- * @param b first rational.
- * @param c second rational.
- * returns b-c.
+ * Subtract one rational from another.
+ * @param b first rational
+ * @param c second rational
+ * @return b-c
  */
-AVRational av_sub_q(AVRational b, AVRational c);
+AVRational av_sub_q(AVRational b, AVRational c) av_const;
 
 /**
- * Converts a double precision floating point number to a rational.
+ * Invert a rational.
+ * @param q value
+ * @return 1 / q
+ */
+static av_always_inline AVRational av_inv_q(AVRational q)
+{
+    AVRational r = { q.den, q.num };
+    return r;
+}
+
+/**
+ * Convert a double precision floating point number to a rational.
+ * inf is expressed as {1,0} or {-1,0} depending on the sign.
+ *
  * @param d double to convert
  * @param max the maximum allowed numerator and denominator
- * @return (AVRational) d.
+ * @return (AVRational) d
+ */
+AVRational av_d2q(double d, int max) av_const;
+
+/**
+ * @return 1 if q1 is nearer to q than q2, -1 if q2 is nearer
+ * than q1, 0 if they have the same distance.
+ */
+int av_nearer_q(AVRational q, AVRational q1, AVRational q2);
+
+/**
+ * Find the nearest value in q_list to q.
+ * @param q_list an array of rationals terminated by {0, 0}
+ * @return the index of the nearest value found in the array
+ */
+int av_find_nearest_q_idx(AVRational q, const AVRational* q_list);
+
+/**
+ * Converts a AVRational to a IEEE 32bit float.
+ *
+ * The float is returned in a uint32_t and its value is platform indepenant.
+ */
+uint32_t av_q2intfloat(AVRational q);
+
+/**
+ * @}
  */
-AVRational av_d2q(double d, int max);
 
-#endif // RATIONAL_H
+#endif /* AVUTIL_RATIONAL_H */