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