restore proper difference calculation (bug #4746)
[asterisk/asterisk.git] / include / asterisk / time.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Time-related functions and macros
5  *
6  * Copyright (C) 2004 - 2005, Digium, Inc.
7  *
8  * This program is free software, distributed under the terms of
9  * the GNU General Public License
10  */
11
12 #ifndef _ASTERISK_TIME_H
13 #define _ASTERISK_TIME_H
14
15 #include <sys/time.h>
16
17 #include "asterisk/inline_api.h"
18
19 /* We have to let the compiler learn what types to use for the elements of a
20    struct timeval since on linux, it's time_t and suseconds_t, but on *BSD,
21    they are just a long. */
22 extern struct timeval tv;
23 typedef typeof(tv.tv_sec) ast_time_t;
24 typedef typeof(tv.tv_usec) ast_suseconds_t;
25
26 /*!
27  * \brief Computes the difference (in milliseconds) between two \c struct \c timeval instances.
28  * \param end the beginning of the time period
29  * \param start the end of the time period
30  * \return the difference in milliseconds
31  */
32 AST_INLINE_API(
33 int ast_tvdiff_ms(struct timeval end, struct timeval start),
34 {
35         /* the offset by 1,000,000 below is intentional...
36            it avoids differences in the way that division
37            is handled for positive and negative numbers, by ensuring
38            that the divisor is always positive
39         */
40         return  ((end.tv_sec - start.tv_sec) * 1000) +
41                 (((1000000 + end.tv_usec - start.tv_usec) / 1000) - 1000);
42 }
43 )
44
45 /*!
46  * \brief Returns true if the argument is 0,0
47  */
48 AST_INLINE_API(
49 int ast_tvzero(const struct timeval t),
50 {
51         return (t.tv_sec == 0 && t.tv_usec == 0);
52 }
53 )
54
55 /*!
56  * \brief Compres two \c struct \c timeval instances returning
57  * -1, 0, 1 if the first arg is smaller, equal or greater to the second.
58  */
59 AST_INLINE_API(
60 int ast_tvcmp(struct timeval _a, struct timeval _b),
61 {
62         if (_a.tv_sec < _b.tv_sec)
63                 return -1;
64         if (_a.tv_sec > _b.tv_sec)
65                 return 1;
66         /* now seconds are equal */
67         if (_a.tv_usec < _b.tv_usec)
68                 return -1;
69         if (_a.tv_usec > _b.tv_usec)
70                 return 1;
71         return 0;
72 }
73 )
74
75 /*!
76  * \brief Returns true if the two \c struct \c timeval arguments are equal.
77  */
78 AST_INLINE_API(
79 int ast_tveq(struct timeval _a, struct timeval _b),
80 {
81         return (_a.tv_sec == _b.tv_sec && _a.tv_usec == _b.tv_usec);
82 }
83 )
84
85 /*!
86  * \brief Returns current timeval. Meant to replace calls to gettimeofday().
87  */
88 AST_INLINE_API(
89 struct timeval ast_tvnow(void),
90 {
91         struct timeval t;
92         gettimeofday(&t, NULL);
93         return t;
94 }
95 )
96
97 /*!
98  * \brief Returns the sum of two timevals a + b
99  */
100 struct timeval ast_tvadd(struct timeval a, struct timeval b);
101
102 /*!
103  * \brief Returns the difference of two timevals a - b
104  */
105 struct timeval ast_tvsub(struct timeval a, struct timeval b);
106
107 /*!
108  * \brief Returns a timeval from sec, usec
109  */
110 #if 0
111 AST_INLINE_API(
112 struct timeval ast_tv(int sec, int usec),
113 {
114         struct timeval t = { sec, usec};
115         return t;
116 }
117 )
118 #endif
119 AST_INLINE_API(
120 struct timeval ast_tv(ast_time_t sec, ast_suseconds_t usec),
121 {
122         struct timeval t;
123         t.tv_sec = sec;
124         t.tv_usec = usec;
125         return t;
126 }
127 )
128
129 /*!
130  * \brief Returns a timeval corresponding to the duration of n samples at rate r.
131  * Useful to convert samples to timevals, or even milliseconds to timevals
132  * in the form ast_samp2tv(milliseconds, 1000)
133  */
134 AST_INLINE_API(
135 struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate),
136 {
137         return ast_tv(_nsamp / _rate, (_nsamp % _rate) * (1000000 / _rate));
138 }
139 )
140
141 #endif /* _ASTERISK_TIME_H */