let the compiler learn the types for the elements of a struct timeval to fix
[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         return ((end.tv_sec - start.tv_sec) * 1000) + ((end.tv_usec - start.tv_usec) / 1000);
36 }
37 )
38
39 /*!
40  * \brief Returns true if the argument is 0,0
41  */
42 AST_INLINE_API(
43 int ast_tvzero(const struct timeval t),
44 {
45         return (t.tv_sec == 0 && t.tv_usec == 0);
46 }
47 )
48
49 /*!
50  * \brief Compres two \c struct \c timeval instances returning
51  * -1, 0, 1 if the first arg is smaller, equal or greater to the second.
52  */
53 AST_INLINE_API(
54 int ast_tvcmp(struct timeval _a, struct timeval _b),
55 {
56         if (_a.tv_sec < _b.tv_sec)
57                 return -1;
58         if (_a.tv_sec > _b.tv_sec)
59                 return 1;
60         /* now seconds are equal */
61         if (_a.tv_usec < _b.tv_usec)
62                 return -1;
63         if (_a.tv_usec > _b.tv_usec)
64                 return 1;
65         return 0;
66 }
67 )
68
69 /*!
70  * \brief Returns true if the two \c struct \c timeval arguments are equal.
71  */
72 AST_INLINE_API(
73 int ast_tveq(struct timeval _a, struct timeval _b),
74 {
75         return (_a.tv_sec == _b.tv_sec && _a.tv_usec == _b.tv_usec);
76 }
77 )
78
79 /*!
80  * \brief Returns current timeval. Meant to replace calls to gettimeofday().
81  */
82 AST_INLINE_API(
83 struct timeval ast_tvnow(void),
84 {
85         struct timeval t;
86         gettimeofday(&t, NULL);
87         return t;
88 }
89 )
90
91 /*!
92  * \brief Returns the sum of two timevals a + b
93  */
94 struct timeval ast_tvadd(struct timeval a, struct timeval b);
95
96 /*!
97  * \brief Returns the difference of two timevals a - b
98  */
99 struct timeval ast_tvsub(struct timeval a, struct timeval b);
100
101 /*!
102  * \brief Returns a timeval from sec, usec
103  */
104 #if 0
105 AST_INLINE_API(
106 struct timeval ast_tv(int sec, int usec),
107 {
108         struct timeval t = { sec, usec};
109         return t;
110 }
111 )
112 #endif
113 AST_INLINE_API(
114 struct timeval ast_tv(ast_time_t sec, ast_suseconds_t usec),
115 {
116         struct timeval t;
117         t.tv_sec = sec;
118         t.tv_usec = usec;
119         return t;
120 }
121 )
122
123 /*!
124  * \brief Returns a timeval corresponding to the duration of n samples at rate r.
125  * Useful to convert samples to timevals, or even milliseconds to timevals
126  * in the form ast_samp2tv(milliseconds, 1000)
127  */
128 AST_INLINE_API(
129 struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate),
130 {
131         return ast_tv(_nsamp / _rate, (_nsamp % _rate) * (1000000 / _rate));
132 }
133 )
134
135 #endif /* _ASTERISK_TIME_H */