1 /*****************************************************************************
2 * mtime.c: high resolution time management functions
3 * Functions are prototyped in vlc_mtime.h.
4 *****************************************************************************
5 * Copyright (C) 1998-2007 the VideoLAN team
6 * Copyright © 2006-2007 Rémi Denis-Courmont
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 * Rémi Denis-Courmont <rem$videolan,org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
28 /*****************************************************************************
30 *****************************************************************************/
38 #include <time.h> /* clock_gettime(), clock_nanosleep() */
43 # include <unistd.h> /* select() */
46 #ifdef HAVE_KERNEL_OS_H
47 # include <kernel/OS.h>
50 #if defined( WIN32 ) || defined( UNDER_CE )
52 # include <mmsystem.h>
55 #if defined( UNDER_CE )
59 #if defined(HAVE_SYS_TIME_H)
60 # include <sys/time.h>
63 #if !defined(HAVE_STRUCT_TIMESPEC)
71 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_DECL_NANOSLEEP)
72 int nanosleep(struct timespec *, struct timespec *);
75 #if !defined (_POSIX_CLOCK_SELECTION)
76 # define _POSIX_CLOCK_SELECTION (-1)
79 # if (_POSIX_CLOCK_SELECTION < 0)
81 * We cannot use the monotonic clock is clock selection is not available,
82 * as it would screw vlc_cond_timedwait() completely. Instead, we have to
83 * stick to the realtime clock. Nevermind it screws everything when ntpdate
84 * warps the wall clock.
86 # undef CLOCK_MONOTONIC
87 # define CLOCK_MONOTONIC CLOCK_REALTIME
88 #elif !defined (HAVE_CLOCK_NANOSLEEP)
89 /* Clock selection without clock in the first place, I don't think so. */
90 # error We have quite a situation here! Fix me if it ever happens.
94 * Return a date in a readable format
96 * This function converts a mtime date into a string.
97 * psz_buffer should be a buffer long enough to store the formatted
99 * \param date to be converted
100 * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
101 * \return psz_buffer is returned so this can be used as printf parameter.
103 char *mstrtime( char *psz_buffer, mtime_t date )
105 static mtime_t ll1000 = 1000, ll60 = 60, ll24 = 24;
107 snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%02d:%02d:%02d-%03d.%03d",
108 (int) (date / (ll1000 * ll1000 * ll60 * ll60) % ll24),
109 (int) (date / (ll1000 * ll1000 * ll60) % ll60),
110 (int) (date / (ll1000 * ll1000) % ll60),
111 (int) (date / ll1000 % ll1000),
112 (int) (date % ll1000) );
113 return( psz_buffer );
117 * Convert seconds to a time in the format h:mm:ss.
119 * This function is provided for any interface function which need to print a
120 * time string in the format h:mm:ss
122 * \param secs the date to be converted
123 * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
124 * \return psz_buffer is returned so this can be used as printf parameter.
126 char *secstotimestr( char *psz_buffer, int i_seconds )
129 i_mins = i_seconds / 60;
130 i_hours = i_mins / 60 ;
133 snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%d:%2.2d:%2.2d",
136 (int) (i_seconds % 60) );
140 snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%2.2d:%2.2d",
142 (int) (i_seconds % 60) );
144 return( psz_buffer );
148 * Return a value that is no bigger than the clock precision
151 static inline unsigned mprec( void )
153 #if defined (HAVE_CLOCK_NANOSLEEP)
155 if( clock_getres( CLOCK_MONOTONIC, &ts ))
156 clock_getres( CLOCK_REALTIME, &ts );
158 return ts.tv_nsec / 1000;
163 static unsigned prec = 0;
164 static volatile mtime_t cached_time = 0;
167 * Return high precision date
169 * Use a 1 MHz clock when possible, or 1 kHz
171 * Beware ! It doesn't reflect the actual date (since epoch), but can be the machine's uptime or anything (when monotonic clock is used)
173 mtime_t mdate( void )
177 #if defined (HAVE_CLOCK_NANOSLEEP)
180 /* Try to use POSIX monotonic clock if available */
181 if( clock_gettime( CLOCK_MONOTONIC, &ts ) == EINVAL )
182 /* Run-time fallback to real-time clock (always available) */
183 (void)clock_gettime( CLOCK_REALTIME, &ts );
185 res = ((mtime_t)ts.tv_sec * (mtime_t)1000000)
186 + (mtime_t)(ts.tv_nsec / 1000);
188 #elif defined( HAVE_KERNEL_OS_H )
189 res = real_time_clock_usecs();
191 #elif defined( WIN32 ) || defined( UNDER_CE )
192 /* We don't need the real date, just the value of a high precision timer */
193 static mtime_t freq = I64C(-1);
195 if( freq == I64C(-1) )
197 /* Extract from the Tcl source code:
198 * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
200 * Some hardware abstraction layers use the CPU clock
201 * in place of the real-time clock as a performance counter
202 * reference. This results in:
203 * - inconsistent results among the processors on
204 * multi-processor systems.
205 * - unpredictable changes in performance counter frequency
206 * on "gearshift" processors such as Transmeta and
208 * There seems to be no way to test whether the performance
209 * counter is reliable, but a useful heuristic is that
210 * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
211 * derived from a colorburst crystal and is therefore
212 * the RTC rather than the TSC. If it's anything else, we
213 * presume that the performance counter is unreliable.
217 freq = ( QueryPerformanceFrequency( &buf ) &&
218 (buf.QuadPart == I64C(1193182) || buf.QuadPart == I64C(3579545) ) )
222 /* on windows 2000, XP and Vista detect if there are two
223 cores there - that makes QueryPerformanceFrequency in
224 any case not trustable?
225 (may also be true, for single cores with adaptive
226 CPU frequency and active power management?)
228 HINSTANCE h_Kernel32 = LoadLibrary(_T("kernel32.dll"));
231 void WINAPI (*pf_GetSystemInfo)(LPSYSTEM_INFO);
232 pf_GetSystemInfo = (void WINAPI (*)(LPSYSTEM_INFO))
233 GetProcAddress(h_Kernel32, _T("GetSystemInfo"));
236 SYSTEM_INFO system_info;
237 pf_GetSystemInfo(&system_info);
238 if(system_info.dwNumberOfProcessors > 1)
241 FreeLibrary(h_Kernel32);
248 LARGE_INTEGER counter;
249 QueryPerformanceCounter (&counter);
251 /* Convert to from (1/freq) to microsecond resolution */
252 /* We need to split the division to avoid 63-bits overflow */
253 lldiv_t d = lldiv (counter.QuadPart, freq);
255 res = (d.quot * 1000000) + ((d.rem * 1000000) / freq);
259 /* Fallback on timeGetTime() which has a milisecond resolution
260 * (actually, best case is about 5 ms resolution)
261 * timeGetTime() only returns a DWORD thus will wrap after
262 * about 49.7 days so we try to detect the wrapping. */
264 static CRITICAL_SECTION date_lock;
265 static mtime_t i_previous_time = I64C(-1);
266 static int i_wrap_counts = -1;
268 if( i_wrap_counts == -1 )
272 i_previous_time = I64C(1000) * timeGetTime();
274 i_previous_time = I64C(1000) * GetTickCount();
276 InitializeCriticalSection( &date_lock );
280 EnterCriticalSection( &date_lock );
283 (i_wrap_counts * I64C(0x100000000) + timeGetTime());
286 (i_wrap_counts * I64C(0x100000000) + GetTickCount());
288 if( i_previous_time > res )
290 /* Counter wrapped */
292 res += I64C(0x100000000) * 1000;
294 i_previous_time = res;
295 LeaveCriticalSection( &date_lock );
298 struct timeval tv_date;
300 /* gettimeofday() cannot fail given &tv_date is a valid address */
301 (void)gettimeofday( &tv_date, NULL );
302 res = (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec;
305 return cached_time = res;
311 * This function uses select() and an system date function to wake up at a
312 * precise date. It should be used for process synchronization. If current date
313 * is posterior to wished date, the function returns immediately.
314 * \param date The date to wake up at
316 void mwait( mtime_t date )
321 /* If the deadline is already elapsed, or within the clock precision,
322 * do not even bother the clock. */
323 if( ( date - cached_time ) < (mtime_t)prec ) // OK: mtime_t is signed
326 #if 0 && defined (HAVE_CLOCK_NANOSLEEP)
327 lldiv_t d = lldiv( date, 1000000 );
328 struct timespec ts = { d.quot, d.rem * 1000 };
331 while( ( val = clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts,
335 ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
336 while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL ) == EINTR );
340 mtime_t delay = date - mdate();
348 * More precise sleep()
350 * Portable usleep() function.
351 * \param delay the amount of time to sleep
353 void msleep( mtime_t delay )
355 mtime_t earlier = cached_time;
357 #if defined( HAVE_CLOCK_NANOSLEEP )
358 lldiv_t d = lldiv( delay, 1000000 );
359 struct timespec ts = { d.quot, d.rem * 1000 };
362 while( ( val = clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, &ts ) ) == EINTR );
365 ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
366 while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, &ts ) == EINTR );
369 #elif defined( HAVE_KERNEL_OS_H )
372 #elif defined( WIN32 ) || defined( UNDER_CE )
373 Sleep( (DWORD) (delay / 1000) );
375 #elif defined( HAVE_NANOSLEEP )
376 struct timespec ts_delay;
378 ts_delay.tv_sec = delay / 1000000;
379 ts_delay.tv_nsec = (delay % 1000000) * 1000;
381 while( nanosleep( &ts_delay, &ts_delay ) && ( errno == EINTR ) );
384 struct timeval tv_delay;
386 tv_delay.tv_sec = delay / 1000000;
387 tv_delay.tv_usec = delay % 1000000;
389 /* If a signal is caught, you are screwed. Update your OS to nanosleep()
390 * or clock_nanosleep() if this is an issue. */
391 select( 0, NULL, NULL, NULL, &tv_delay );
395 if( cached_time < earlier )
396 cached_time = earlier;
400 * Date management (internal and external)
404 * Initialize a date_t.
406 * \param date to initialize
407 * \param divider (sample rate) numerator
408 * \param divider (sample rate) denominator
411 void date_Init( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
414 p_date->i_divider_num = i_divider_n;
415 p_date->i_divider_den = i_divider_d;
416 p_date->i_remainder = 0;
422 * \param date to change
423 * \param divider (sample rate) numerator
424 * \param divider (sample rate) denominator
427 void date_Change( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
429 p_date->i_divider_num = i_divider_n;
430 p_date->i_divider_den = i_divider_d;
434 * Set the date value of a date_t.
439 void date_Set( date_t *p_date, mtime_t i_new_date )
441 p_date->date = i_new_date;
442 p_date->i_remainder = 0;
446 * Get the date of a date_t
451 mtime_t date_Get( const date_t *p_date )
457 * Move forwards or backwards the date of a date_t.
459 * \param date to move
460 * \param difference value
462 void date_Move( date_t *p_date, mtime_t i_difference )
464 p_date->date += i_difference;
468 * Increment the date and return the result, taking into account
471 * \param date to increment
472 * \param incrementation in number of samples
475 mtime_t date_Increment( date_t *p_date, uint32_t i_nb_samples )
477 mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
478 p_date->date += i_dividend / p_date->i_divider_num * p_date->i_divider_den;
479 p_date->i_remainder += (int)(i_dividend % p_date->i_divider_num);
481 if( p_date->i_remainder >= p_date->i_divider_num )
483 /* This is Bresenham algorithm. */
484 p_date->date += p_date->i_divider_den;
485 p_date->i_remainder -= p_date->i_divider_num;
491 #ifndef HAVE_GETTIMEOFDAY
496 * Number of micro-seconds between the beginning of the Windows epoch
497 * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970).
499 * This assumes all Win32 compilers have 64-bit support.
501 #if defined(_MSC_VER) || defined(_MSC_EXTENSIONS) || defined(__WATCOMC__)
502 # define DELTA_EPOCH_IN_USEC 11644473600000000Ui64
504 # define DELTA_EPOCH_IN_USEC 11644473600000000ULL
507 static uint64_t filetime_to_unix_epoch (const FILETIME *ft)
509 uint64_t res = (uint64_t) ft->dwHighDateTime << 32;
511 res |= ft->dwLowDateTime;
512 res /= 10; /* from 100 nano-sec periods to usec */
513 res -= DELTA_EPOCH_IN_USEC; /* from Win epoch to Unix epoch */
517 static int gettimeofday (struct timeval *tv, void *tz )
525 GetSystemTimeAsFileTime (&ft);
526 tim = filetime_to_unix_epoch (&ft);
527 tv->tv_sec = (long) (tim / 1000000L);
528 tv->tv_usec = (long) (tim % 1000000L);
537 * @return NTP 64-bits timestamp in host byte order.
539 uint64_t NTPtime64 (void)
542 #if defined (CLOCK_REALTIME)
543 clock_gettime (CLOCK_REALTIME, &ts);
547 gettimeofday (&tv, NULL);
548 ts.tv_sec = tv.tv_sec;
549 ts.tv_nsec = tv.tv_usec * 1000;
553 /* Convert nanoseconds to 32-bits fraction (232 picosecond units) */
554 uint64_t t = (uint64_t)(ts.tv_nsec) << 32;
558 /* There is 70 years (incl. 17 leap ones) offset to the Unix Epoch.
559 * No leap seconds during that period since they were not invented yet.
561 assert (t < 0x100000000);
562 t |= ((70LL * 365 + 17) * 24 * 60 * 60 + ts.tv_sec) << 32;