Rework delay checking, use it for net_Accept, add deadline checks
[vlc.git] / include / vlc_mtime.h
1 /*****************************************************************************
2  * vlc_mtime.h: high resolution time management functions
3  *****************************************************************************
4  * This header provides portable high precision time management functions,
5  * which should be the only ones used in other segments of the program, since
6  * functions like gettimeofday() and ftime() are not always supported.
7  * Most functions are declared as inline or as macros since they are only
8  * interfaces to system calls and have to be called frequently.
9  * 'm' stands for 'micro', since maximum resolution is the microsecond.
10  * Functions prototyped are implemented in interface/mtime.c.
11  *****************************************************************************
12  * Copyright (C) 1996, 1997, 1998, 1999, 2000 the VideoLAN team
13  * $Id$
14  *
15  * Authors: Vincent Seguin <seguin@via.ecp.fr>
16  *
17  * This program is free software; you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation; either version 2 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
30  *****************************************************************************/
31
32 #ifndef __VLC_MTIME_H
33 # define __VLC_MTIME_H 1
34
35 /*****************************************************************************
36  * LAST_MDATE: date which will never happen
37  *****************************************************************************
38  * This date can be used as a 'never' date, to mark missing events in a function
39  * supposed to return a date, such as nothing to display in a function
40  * returning the date of the first image to be displayed. It can be used in
41  * comparaison with other values: all existing dates will be earlier.
42  *****************************************************************************/
43 #define LAST_MDATE ((mtime_t)((uint64_t)(-1)/2))
44
45 /*****************************************************************************
46  * MSTRTIME_MAX_SIZE: maximum possible size of mstrtime
47  *****************************************************************************
48  * This values is the maximal possible size of the string returned by the
49  * mstrtime() function, including '-' and the final '\0'. It should be used to
50  * allocate the buffer.
51  *****************************************************************************/
52 #define MSTRTIME_MAX_SIZE 22
53
54 /* Well, Duh? But it does clue us in that we are converting from
55    millisecond quantity to a second quantity or vice versa.
56 */
57 #define MILLISECONDS_PER_SEC 1000
58
59 #define msecstotimestr(psz_buffer, msecs) \
60   secstotimestr( psz_buffer, (msecs / (int) MILLISECONDS_PER_SEC) )
61
62 /*****************************************************************************
63  * Prototypes
64  *****************************************************************************/
65 VLC_EXPORT( char *,  mstrtime, ( char *psz_buffer, mtime_t date ) );
66 VLC_EXPORT( mtime_t, mdate,    ( void ) );
67 VLC_EXPORT( void,    mwait,    ( mtime_t date ) );
68 VLC_EXPORT( void,    msleep,   ( mtime_t delay ) );
69 VLC_EXPORT( char *,  secstotimestr, ( char *psz_buffer, int secs ) );
70
71 #ifdef __GNUC__
72 # ifdef __linux__
73 #  define VLC_HARD_MIN_SLEEP 1000 /* Linux has 100, 250, 300 or 1000Hz */
74 # else
75 #  define VLC_HARD_MIN_SLEEP 0
76 # endif
77 #define VLC_SOFT_MIN_SLEEP 29000000
78
79 static
80 __attribute__((unused))
81 __attribute__((noinline))
82 __attribute__((error("sorry, cannot sleep for such short a time")))
83 mtime_t impossible_delay( mtime_t delay )
84 {
85     (void) delay;
86     return VLC_HARD_MIN_SLEEP;
87 }
88
89 static
90 __attribute__((unused))
91 __attribute__((noinline))
92 __attribute__((warning("use proper event handling instead of short delay")))
93 mtime_t harmful_delay( mtime_t delay )
94 {
95     return delay;
96 }
97
98 # define check_delay( d ) \
99     ((__builtin_constant_p(d < VLC_HARD_MIN_SLEEP) \
100    && (d < VLC_HARD_MIN_SLEEP)) \
101        ? impossible_delay(d) \
102        : ((__builtin_constant_p(d < VLC_SOFT_MIN_SLEEP) \
103        && (d < VLC_SOFT_MIN_SLEEP)) \
104            ? harmful_delay(d) \
105            : d))
106
107 static
108 __attribute__((unused))
109 __attribute__((noinline))
110 __attribute__((error("deadlines can not be constant")))
111 mtime_t impossible_deadline( mtime_t deadline )
112 {
113     return deadline;
114 }
115
116 # define check_deadline( d ) \
117     (__builtin_constant_p(d) ? impossible_deadline(d) : d)
118 #else
119 # define check_delay(d) (d)
120 # define check_deadline(d) (d)
121 #endif
122
123 #define msleep(d) msleep(check_delay(d))
124 #define mwait(d) mwait(check_deadline(d))
125
126 /*****************************************************************************
127  * date_t: date incrementation without long-term rounding errors
128  *****************************************************************************/
129 struct date_t
130 {
131     mtime_t  date;
132     uint32_t i_divider_num;
133     uint32_t i_divider_den;
134     uint32_t i_remainder;
135 };
136
137 VLC_EXPORT( void,    date_Init,      ( date_t *, uint32_t, uint32_t ) );
138 VLC_EXPORT( void,    date_Change,    ( date_t *, uint32_t, uint32_t ) );
139 VLC_EXPORT( void,    date_Set,       ( date_t *, mtime_t ) );
140 VLC_EXPORT( mtime_t, date_Get,       ( const date_t * ) );
141 VLC_EXPORT( void,    date_Move,      ( date_t *, mtime_t ) );
142 VLC_EXPORT( mtime_t, date_Increment, ( date_t *, uint32_t ) );
143 VLC_EXPORT( uint64_t, NTPtime64,     ( void ) );
144 #endif /* !__VLC_MTIME_ */