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