rational.h 3.62 KB
Newer Older
Michael Niedermayer's avatar
Michael Niedermayer committed
1
/*
2
 * rational numbers
Michael Niedermayer's avatar
Michael Niedermayer committed
3 4
 * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
 *
5
 * This file is part of Libav.
6
 *
7
 * Libav is free software; you can redistribute it and/or
Michael Niedermayer's avatar
Michael Niedermayer committed
8 9
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
10
 * version 2.1 of the License, or (at your option) any later version.
Michael Niedermayer's avatar
Michael Niedermayer committed
11
 *
12
 * Libav is distributed in the hope that it will be useful,
Michael Niedermayer's avatar
Michael Niedermayer committed
13 14 15 16 17
 * 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
18
 * License along with Libav; if not, write to the Free Software
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Michael Niedermayer's avatar
Michael Niedermayer committed
20
 */
21

Michael Niedermayer's avatar
Michael Niedermayer committed
22
/**
23
 * @file
24
 * rational numbers
Michael Niedermayer's avatar
Michael Niedermayer committed
25 26 27
 * @author Michael Niedermayer <michaelni@gmx.at>
 */

28 29
#ifndef AVUTIL_RATIONAL_H
#define AVUTIL_RATIONAL_H
Michael Niedermayer's avatar
Michael Niedermayer committed
30

31
#include <stdint.h>
32
#include <limits.h>
33
#include "attributes.h"
34

Michael Niedermayer's avatar
Michael Niedermayer committed
35
/**
36
 * rational number numerator/denominator
Michael Niedermayer's avatar
Michael Niedermayer committed
37
 */
Michael Niedermayer's avatar
Michael Niedermayer committed
38
typedef struct AVRational{
Michael Niedermayer's avatar
Michael Niedermayer committed
39 40
    int num; ///< numerator
    int den; ///< denominator
Michael Niedermayer's avatar
Michael Niedermayer committed
41 42
} AVRational;

Michael Niedermayer's avatar
Michael Niedermayer committed
43
/**
44
 * Compare two rationals.
Dujardin Bernard's avatar
Dujardin Bernard committed
45 46
 * @param a first rational
 * @param b second rational
47 48
 * @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
Michael Niedermayer's avatar
Michael Niedermayer committed
49
 */
Michael Niedermayer's avatar
Michael Niedermayer committed
50 51 52
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;

53
    if(tmp) return ((tmp ^ a.den ^ b.den)>>63)|1;
54 55 56
    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;
Michael Niedermayer's avatar
Michael Niedermayer committed
57 58
}

Michael Niedermayer's avatar
Michael Niedermayer committed
59
/**
60
 * Convert rational to double.
Dujardin Bernard's avatar
Dujardin Bernard committed
61 62
 * @param a rational to convert
 * @return (double) a
Michael Niedermayer's avatar
Michael Niedermayer committed
63
 */
Michael Niedermayer's avatar
Michael Niedermayer committed
64 65 66 67
static inline double av_q2d(AVRational a){
    return a.num / (double) a.den;
}

68
/**
69
 * Reduce a fraction.
70
 * This is useful for framerate calculations.
71
 * @param dst_num destination numerator
Dujardin Bernard's avatar
Dujardin Bernard committed
72
 * @param dst_den destination denominator
73
 * @param num source numerator
Dujardin Bernard's avatar
Dujardin Bernard committed
74
 * @param den source denominator
75
 * @param max the maximum allowed for dst_num & dst_den
76 77
 * @return 1 if exact, 0 otherwise
 */
78
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max);
79

80
/**
81
 * Multiply two rationals.
82 83 84
 * @param b first rational
 * @param c second rational
 * @return b*c
85
 */
86
AVRational av_mul_q(AVRational b, AVRational c) av_const;
87 88

/**
89
 * Divide one rational by another.
90 91 92
 * @param b first rational
 * @param c second rational
 * @return b/c
93
 */
94
AVRational av_div_q(AVRational b, AVRational c) av_const;
95 96

/**
97
 * Add two rationals.
98 99 100
 * @param b first rational
 * @param c second rational
 * @return b+c
101
 */
102
AVRational av_add_q(AVRational b, AVRational c) av_const;
103 104

/**
105
 * Subtract one rational from another.
106 107 108
 * @param b first rational
 * @param c second rational
 * @return b-c
109
 */
110
AVRational av_sub_q(AVRational b, AVRational c) av_const;
111 112

/**
113
 * Convert a double precision floating point number to a rational.
114 115
 * inf is expressed as {1,0} or {-1,0} depending on the sign.
 *
116 117
 * @param d double to convert
 * @param max the maximum allowed numerator and denominator
118
 * @return (AVRational) d
119
 */
120
AVRational av_d2q(double d, int max) av_const;
Michael Niedermayer's avatar
Michael Niedermayer committed
121

122
/**
123 124
 * @return 1 if q1 is nearer to q than q2, -1 if q2 is nearer
 * than q1, 0 if they have the same distance.
125 126 127 128
 */
int av_nearer_q(AVRational q, AVRational q1, AVRational q2);

/**
129
 * Find the nearest value in q_list to q.
130 131 132 133 134
 * @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);

135
#endif /* AVUTIL_RATIONAL_H */