libavutil/rational.h
5ff85f1d
 /*
89c9ff50
  * rational numbers
5ff85f1d
  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
5ff85f1d
  * 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.
5ff85f1d
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
5ff85f1d
  * 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
5509bffa
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5ff85f1d
  */
115329f1
 
5ff85f1d
 /**
bad5537e
  * @file libavutil/rational.h
89c9ff50
  * rational numbers
5ff85f1d
  * @author Michael Niedermayer <michaelni@gmx.at>
  */
 
98790382
 #ifndef AVUTIL_RATIONAL_H
 #define AVUTIL_RATIONAL_H
5ff85f1d
 
99545457
 #include <stdint.h>
85074d3c
 #include "common.h"
99545457
 
5c07b9e9
 /**
89c9ff50
  * rational number numerator/denominator
5c07b9e9
  */
5ff85f1d
 typedef struct AVRational{
5c07b9e9
     int num; ///< numerator
     int den; ///< denominator
5ff85f1d
 } AVRational;
 
5c07b9e9
 /**
89c9ff50
  * Compares two rationals.
1c95ef8b
  * @param a first rational
  * @param b second rational
89c9ff50
  * @return 0 if a==b, 1 if a>b and -1 if a<b
5c07b9e9
  */
5ff85f1d
 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;
 
5c07b9e9
     if(tmp) return (tmp>>63)|1;
     else    return 0;
5ff85f1d
 }
 
5c07b9e9
 /**
89c9ff50
  * Converts rational to double.
1c95ef8b
  * @param a rational to convert
  * @return (double) a
5c07b9e9
  */
5ff85f1d
 static inline double av_q2d(AVRational a){
     return a.num / (double) a.den;
 }
 
c11c2bc2
 /**
89c9ff50
  * Reduces a fraction.
804de96a
  * This is useful for framerate calculations.
674bd4f6
  * @param dst_num destination numerator
1c95ef8b
  * @param dst_den destination denominator
674bd4f6
  * @param num source numerator
1c95ef8b
  * @param den source denominator
674bd4f6
  * @param max the maximum allowed for dst_num & dst_den
c11c2bc2
  * @return 1 if exact, 0 otherwise
  */
674bd4f6
 int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max);
c11c2bc2
 
0b006599
 /**
  * Multiplies two rationals.
89c9ff50
  * @param b first rational
  * @param c second rational
  * @return b*c
0b006599
  */
85074d3c
 AVRational av_mul_q(AVRational b, AVRational c) av_const;
0b006599
 
 /**
ca9049ef
  * Divides one rational by another.
89c9ff50
  * @param b first rational
  * @param c second rational
  * @return b/c
0b006599
  */
85074d3c
 AVRational av_div_q(AVRational b, AVRational c) av_const;
0b006599
 
 /**
  * Adds two rationals.
89c9ff50
  * @param b first rational
  * @param c second rational
  * @return b+c
0b006599
  */
85074d3c
 AVRational av_add_q(AVRational b, AVRational c) av_const;
0b006599
 
 /**
ca9049ef
  * Subtracts one rational from another.
89c9ff50
  * @param b first rational
  * @param c second rational
  * @return b-c
0b006599
  */
85074d3c
 AVRational av_sub_q(AVRational b, AVRational c) av_const;
0b006599
 
 /**
  * Converts a double precision floating point number to a rational.
  * @param d double to convert
  * @param max the maximum allowed numerator and denominator
89c9ff50
  * @return (AVRational) d
0b006599
  */
85074d3c
 AVRational av_d2q(double d, int max) av_const;
5ff85f1d
 
05b90fc0
 /**
  * @return 1 if \q1 is nearer to \p q than \p q2, -1 if \p q2 is nearer
  * than \p q1, 0 if they have the same distance.
  */
 int av_nearer_q(AVRational q, AVRational q1, AVRational q2);
 
 /**
  * Finds the nearest value in \p q_list to \p 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);
 
98790382
 #endif /* AVUTIL_RATIONAL_H */