vlc_mtime.h 3.83 KB
Newer Older
1
/*****************************************************************************
2 3
 * vlc_mtime.h: high resolution time management functions
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
4 5 6 7 8 9 10
 * This header provides portable high precision time management functions,
 * which should be the only ones used in other segments of the program, since
 * functions like gettimeofday() and ftime() are not always supported.
 * Most functions are declared as inline or as macros since they are only
 * interfaces to system calls and have to be called frequently.
 * 'm' stands for 'micro', since maximum resolution is the microsecond.
 * Functions prototyped are implemented in interface/mtime.c.
11
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
12
 * Copyright (C) 1996, 1997, 1998, 1999, 2000 VLC authors and VideoLAN
13
 * $Id$
14
 *
15
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
16
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18 19
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
20
 * (at your option) any later version.
21
 *
22 23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
24 25
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
26
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
27 28 29
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
30 31
 *****************************************************************************/

32 33 34
#ifndef __VLC_MTIME_H
# define __VLC_MTIME_H 1

35
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
36
 * LAST_MDATE: date which will never happen
37
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
38 39 40 41
 * This date can be used as a 'never' date, to mark missing events in a function
 * supposed to return a date, such as nothing to display in a function
 * returning the date of the first image to be displayed. It can be used in
 * comparaison with other values: all existing dates will be earlier.
42
 *****************************************************************************/
43
#define LAST_MDATE ((mtime_t)((uint64_t)(-1)/2))
Michel Kaempf's avatar
Michel Kaempf committed
44

45
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
46
 * MSTRTIME_MAX_SIZE: maximum possible size of mstrtime
47
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
48
 * This values is the maximal possible size of the string returned by the
Michel Kaempf's avatar
Michel Kaempf committed
49 50
 * mstrtime() function, including '-' and the final '\0'. It should be used to
 * allocate the buffer.
51
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
52
#define MSTRTIME_MAX_SIZE 22
Michel Kaempf's avatar
Michel Kaempf committed
53

54
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
55
 * Prototypes
56
 *****************************************************************************/
57
VLC_API char * secstotimestr( char *psz_buffer, int32_t secs );
Sam Hocevar's avatar
Sam Hocevar committed
58

59 60 61 62 63 64 65 66 67 68 69
/*****************************************************************************
 * date_t: date incrementation without long-term rounding errors
 *****************************************************************************/
struct date_t
{
    mtime_t  date;
    uint32_t i_divider_num;
    uint32_t i_divider_den;
    uint32_t i_remainder;
};

70 71 72 73 74 75 76 77
VLC_API void date_Init( date_t *, uint32_t, uint32_t );
VLC_API void date_Change( date_t *, uint32_t, uint32_t );
VLC_API void date_Set( date_t *, mtime_t );
VLC_API mtime_t date_Get( const date_t * );
VLC_API void date_Move( date_t *, mtime_t );
VLC_API mtime_t date_Increment( date_t *, uint32_t );
VLC_API mtime_t date_Decrement( date_t *, uint32_t );
VLC_API uint64_t NTPtime64( void );
78
#endif /* !__VLC_MTIME_ */