A bit of vlc/libvlc cleanup:
[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 #if !defined( __LIBVLC__ )
33   #error You are not libvlc or one of its plugins. You cannot include this file
34 #endif
35
36 /*****************************************************************************
37  * LAST_MDATE: date which will never happen
38  *****************************************************************************
39  * This date can be used as a 'never' date, to mark missing events in a function
40  * supposed to return a date, such as nothing to display in a function
41  * returning the date of the first image to be displayed. It can be used in
42  * comparaison with other values: all existing dates will be earlier.
43  *****************************************************************************/
44 #define LAST_MDATE ((mtime_t)((uint64_t)(-1)/2))
45
46 /*****************************************************************************
47  * MSTRTIME_MAX_SIZE: maximum possible size of mstrtime
48  *****************************************************************************
49  * This values is the maximal possible size of the string returned by the
50  * mstrtime() function, including '-' and the final '\0'. It should be used to
51  * allocate the buffer.
52  *****************************************************************************/
53 #define MSTRTIME_MAX_SIZE 22
54
55 /* Well, Duh? But it does clue us in that we are converting from
56    millisecond quantity to a second quantity or vice versa.
57 */
58 #define MILLISECONDS_PER_SEC 1000
59
60 #define msecstotimestr(psz_buffer, msecs) \
61   secstotimestr( psz_buffer, (msecs / (int) MILLISECONDS_PER_SEC) )
62
63 /*****************************************************************************
64  * Prototypes
65  *****************************************************************************/
66 VLC_EXPORT( char *,  mstrtime, ( char *psz_buffer, mtime_t date ) );
67 VLC_EXPORT( mtime_t, mdate,    ( void ) );
68 VLC_EXPORT( void,    mwait,    ( mtime_t date ) );
69 VLC_EXPORT( void,    msleep,   ( mtime_t delay ) );
70 VLC_EXPORT( char *,  secstotimestr, ( char *psz_buffer, int secs ) );
71
72 /*****************************************************************************
73  * date_t: date incrementation without long-term rounding errors
74  *****************************************************************************/
75 struct date_t
76 {
77     mtime_t  date;
78     uint32_t i_divider_num;
79     uint32_t i_divider_den;
80     uint32_t i_remainder;
81 };
82
83 VLC_EXPORT( void,    date_Init,      ( date_t *, uint32_t, uint32_t ) );
84 VLC_EXPORT( void,    date_Change,    ( date_t *, uint32_t, uint32_t ) );
85 VLC_EXPORT( void,    date_Set,       ( date_t *, mtime_t ) );
86 VLC_EXPORT( mtime_t, date_Get,       ( const date_t * ) );
87 VLC_EXPORT( void,    date_Move,      ( date_t *, mtime_t ) );
88 VLC_EXPORT( mtime_t, date_Increment, ( date_t *, uint32_t ) );