]> git.sesse.net Git - vlc/blob - src/misc/mtime.c
c735bdfcaafa6721488226f8ea347f9662ec142e
[vlc] / src / misc / mtime.c
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
7  * $Id$
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *          Rémi Denis-Courmont <rem$videolan,org>
11  *          Gisle Vanem
12  *
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.
17  *
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.
22  *
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  *****************************************************************************/
27
28 /*****************************************************************************
29  * Preamble
30  *****************************************************************************/
31
32 #ifdef HAVE_CONFIG_H
33 # include "config.h"
34 #endif
35
36 #include <vlc_common.h>
37
38 #include <time.h>                      /* clock_gettime(), clock_nanosleep() */
39 #include <assert.h>
40 #include <errno.h>
41
42 #ifdef HAVE_UNISTD_H
43 #   include <unistd.h>                                           /* select() */
44 #endif
45
46 #ifdef HAVE_KERNEL_OS_H
47 #   include <kernel/OS.h>
48 #endif
49
50 #if defined( WIN32 ) || defined( UNDER_CE )
51 #   include <windows.h>
52 #   include <mmsystem.h>
53 #endif
54
55 #if defined(HAVE_SYS_TIME_H)
56 #   include <sys/time.h>
57 #endif
58
59 #ifdef __APPLE__
60 #   include <mach/mach.h>
61 #   include <mach/mach_time.h>
62 #endif
63
64 #if !defined(HAVE_STRUCT_TIMESPEC)
65 struct timespec
66 {
67     time_t  tv_sec;
68     int32_t tv_nsec;
69 };
70 #endif
71
72 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_DECL_NANOSLEEP)
73 int nanosleep(struct timespec *, struct timespec *);
74 #endif
75
76 #if !defined (_POSIX_CLOCK_SELECTION)
77 #  define _POSIX_CLOCK_SELECTION (-1)
78 #endif
79
80 # if (_POSIX_CLOCK_SELECTION < 0)
81 /*
82  * We cannot use the monotonic clock is clock selection is not available,
83  * as it would screw vlc_cond_timedwait() completely. Instead, we have to
84  * stick to the realtime clock. Nevermind it screws everything when ntpdate
85  * warps the wall clock.
86  */
87 #  undef CLOCK_MONOTONIC
88 #  define CLOCK_MONOTONIC CLOCK_REALTIME
89 #elif !defined (HAVE_CLOCK_NANOSLEEP)
90 /* Clock selection without clock in the first place, I don't think so. */
91 #  error We have quite a situation here! Fix me if it ever happens.
92 #endif
93
94 /**
95  * Return a date in a readable format
96  *
97  * This function converts a mtime date into a string.
98  * psz_buffer should be a buffer long enough to store the formatted
99  * date.
100  * \param date to be converted
101  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
102  * \return psz_buffer is returned so this can be used as printf parameter.
103  */
104 char *mstrtime( char *psz_buffer, mtime_t date )
105 {
106     static const mtime_t ll1000 = 1000, ll60 = 60, ll24 = 24;
107
108     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%02d:%02d:%02d-%03d.%03d",
109              (int) (date / (ll1000 * ll1000 * ll60 * ll60) % ll24),
110              (int) (date / (ll1000 * ll1000 * ll60) % ll60),
111              (int) (date / (ll1000 * ll1000) % ll60),
112              (int) (date / ll1000 % ll1000),
113              (int) (date % ll1000) );
114     return( psz_buffer );
115 }
116
117 /**
118  * Convert seconds to a time in the format h:mm:ss.
119  *
120  * This function is provided for any interface function which need to print a
121  * time string in the format h:mm:ss
122  * date.
123  * \param secs  the date to be converted
124  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
125  * \return psz_buffer is returned so this can be used as printf parameter.
126  */
127 char *secstotimestr( char *psz_buffer, int i_seconds )
128 {
129     int i_hours, i_mins;
130     i_mins = i_seconds / 60;
131     i_hours = i_mins / 60 ;
132     if( i_hours )
133     {
134         snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%d:%2.2d:%2.2d",
135                  (int) i_hours,
136                  (int) (i_mins % 60),
137                  (int) (i_seconds % 60) );
138     }
139     else
140     {
141          snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%2.2d:%2.2d",
142                    (int) i_mins ,
143                    (int) (i_seconds % 60) );
144     }
145     return( psz_buffer );
146 }
147
148 #if defined (HAVE_CLOCK_NANOSLEEP)
149 static unsigned prec = 0;
150
151 static void mprec_once( void )
152 {
153     struct timespec ts;
154     if( clock_getres( CLOCK_MONOTONIC, &ts ))
155         clock_getres( CLOCK_REALTIME, &ts );
156
157     prec = ts.tv_nsec / 1000;
158 }
159 #endif
160
161 /**
162  * Return a value that is no bigger than the clock precision
163  * (possibly zero).
164  */
165 static inline unsigned mprec( void )
166 {
167 #if defined (HAVE_CLOCK_NANOSLEEP)
168     static pthread_once_t once = PTHREAD_ONCE_INIT;
169     pthread_once( &once, mprec_once );
170     return prec;
171 #else
172     return 0;
173 #endif
174 }
175
176 #ifdef __APPLE__
177 static mach_timebase_info_data_t mtime_timebase_info;
178 static pthread_once_t mtime_timebase_info_once = PTHREAD_ONCE_INIT;
179 static void mtime_init_timebase(void)
180 {
181     mach_timebase_info(&mtime_timebase_info);
182 }
183 #endif
184
185 /**
186  * Return high precision date
187  *
188  * Use a 1 MHz clock when possible, or 1 kHz
189  *
190  * Beware ! It doesn't reflect the actual date (since epoch), but can be the machine's uptime or anything (when monotonic clock is used)
191  */
192 mtime_t mdate( void )
193 {
194     mtime_t res;
195
196 #if defined (HAVE_CLOCK_NANOSLEEP)
197     struct timespec ts;
198
199     /* Try to use POSIX monotonic clock if available */
200     if( clock_gettime( CLOCK_MONOTONIC, &ts ) == EINVAL )
201         /* Run-time fallback to real-time clock (always available) */
202         (void)clock_gettime( CLOCK_REALTIME, &ts );
203
204     res = ((mtime_t)ts.tv_sec * (mtime_t)1000000)
205            + (mtime_t)(ts.tv_nsec / 1000);
206
207 #elif defined( HAVE_KERNEL_OS_H )
208     res = real_time_clock_usecs();
209
210 #elif defined( __APPLE__ )
211     pthread_once(&mtime_timebase_info_once, mtime_init_timebase);
212     uint64_t date = mach_absolute_time();
213
214     /* Convert to nanoseconds */
215     date *= mtime_timebase_info.numer;
216     date /= mtime_timebase_info.denom;
217
218     /* Convert to microseconds */
219     res = date / 1000;
220 #elif defined( WIN32 ) || defined( UNDER_CE )
221     /* We don't need the real date, just the value of a high precision timer */
222     static mtime_t freq = INT64_C(-1);
223
224     if( freq == INT64_C(-1) )
225     {
226         /* Extract from the Tcl source code:
227          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
228          *
229          * Some hardware abstraction layers use the CPU clock
230          * in place of the real-time clock as a performance counter
231          * reference.  This results in:
232          *    - inconsistent results among the processors on
233          *      multi-processor systems.
234          *    - unpredictable changes in performance counter frequency
235          *      on "gearshift" processors such as Transmeta and
236          *      SpeedStep.
237          * There seems to be no way to test whether the performance
238          * counter is reliable, but a useful heuristic is that
239          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
240          * derived from a colorburst crystal and is therefore
241          * the RTC rather than the TSC.  If it's anything else, we
242          * presume that the performance counter is unreliable.
243          */
244         LARGE_INTEGER buf;
245
246         freq = ( QueryPerformanceFrequency( &buf ) &&
247                  (buf.QuadPart == INT64_C(1193182) || buf.QuadPart == INT64_C(3579545) ) )
248                ? buf.QuadPart : 0;
249
250 #if defined( WIN32 )
251         /* on windows 2000, XP and Vista detect if there are two
252            cores there - that makes QueryPerformanceFrequency in
253            any case not trustable?
254            (may also be true, for single cores with adaptive
255             CPU frequency and active power management?)
256         */
257         HINSTANCE h_Kernel32 = LoadLibrary(_T("kernel32.dll"));
258         if(h_Kernel32)
259         {
260             void WINAPI (*pf_GetSystemInfo)(LPSYSTEM_INFO);
261             pf_GetSystemInfo = (void WINAPI (*)(LPSYSTEM_INFO))
262                                 GetProcAddress(h_Kernel32, _T("GetSystemInfo"));
263             if(pf_GetSystemInfo)
264             {
265                SYSTEM_INFO system_info;
266                pf_GetSystemInfo(&system_info);
267                if(system_info.dwNumberOfProcessors > 1)
268                   freq = 0;
269             }
270             FreeLibrary(h_Kernel32);
271         }
272 #endif
273     }
274
275     if( freq != 0 )
276     {
277         LARGE_INTEGER counter;
278         QueryPerformanceCounter (&counter);
279
280         /* Convert to from (1/freq) to microsecond resolution */
281         /* We need to split the division to avoid 63-bits overflow */
282         lldiv_t d = lldiv (counter.QuadPart, freq);
283
284         res = (d.quot * 1000000) + ((d.rem * 1000000) / freq);
285     }
286     else
287     {
288         /* Fallback on timeGetTime() which has a millisecond resolution
289          * (actually, best case is about 5 ms resolution)
290          * timeGetTime() only returns a DWORD thus will wrap after
291          * about 49.7 days so we try to detect the wrapping. */
292
293         static CRITICAL_SECTION date_lock;
294         static mtime_t i_previous_time = INT64_C(-1);
295         static int i_wrap_counts = -1;
296
297         if( i_wrap_counts == -1 )
298         {
299             /* Initialization */
300 #if defined( WIN32 )
301             i_previous_time = INT64_C(1000) * timeGetTime();
302 #else
303             i_previous_time = INT64_C(1000) * GetTickCount();
304 #endif
305             InitializeCriticalSection( &date_lock );
306             i_wrap_counts = 0;
307         }
308
309         EnterCriticalSection( &date_lock );
310 #if defined( WIN32 )
311         res = INT64_C(1000) *
312             (i_wrap_counts * INT64_C(0x100000000) + timeGetTime());
313 #else
314         res = INT64_C(1000) *
315             (i_wrap_counts * INT64_C(0x100000000) + GetTickCount());
316 #endif
317         if( i_previous_time > res )
318         {
319             /* Counter wrapped */
320             i_wrap_counts++;
321             res += INT64_C(0x100000000) * 1000;
322         }
323         i_previous_time = res;
324         LeaveCriticalSection( &date_lock );
325     }
326 #elif defined( __APPLE__ ) /* The version that should be used, if it was cancelable */
327     pthread_once(&mtime_timebase_info_once, mtime_init_timebase);
328     uint64_t mach_time = date * 1000 * mtime_timebase_info.denom / mtime_timebase_info.numer;
329     mach_wait_until(mach_time);
330
331 #else
332     struct timeval tv_date;
333
334     /* gettimeofday() cannot fail given &tv_date is a valid address */
335     (void)gettimeofday( &tv_date, NULL );
336     res = (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec;
337 #endif
338
339     return res;
340 }
341
342 #undef mwait
343 /**
344  * Wait for a date
345  *
346  * This function uses select() and an system date function to wake up at a
347  * precise date. It should be used for process synchronization. If current date
348  * is posterior to wished date, the function returns immediately.
349  * \param date The date to wake up at
350  */
351 void mwait( mtime_t date )
352 {
353     /* If the deadline is already elapsed, or within the clock precision,
354      * do not even bother the system timer. */
355     date -= mprec();
356
357 #if defined (HAVE_CLOCK_NANOSLEEP)
358     lldiv_t d = lldiv( date, 1000000 );
359     struct timespec ts = { d.quot, d.rem * 1000 };
360
361     int val;
362     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts,
363                                     NULL ) ) == EINTR );
364     if( val == EINVAL )
365     {
366         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
367         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL ) == EINTR );
368     }
369
370 #elif defined (WIN32)
371     mtime_t i_total;
372
373     while( (i_total = (date - mdate())) > 0 )
374     {
375         const mtime_t i_sleep = i_total / 1000;
376         DWORD i_delay = (i_sleep > 0x7fffffff) ? 0x7fffffff : i_sleep;
377         vlc_testcancel();
378         SleepEx( i_delay, TRUE );
379     }
380     vlc_testcancel();
381
382 #else
383     mtime_t delay = date - mdate();
384     if( delay > 0 )
385         msleep( delay );
386
387 #endif
388 }
389
390
391 #include "libvlc.h" /* vlc_backtrace() */
392 #undef msleep
393
394 /**
395  * Portable usleep(). Cancellation point.
396  *
397  * \param delay the amount of time to sleep
398  */
399 void msleep( mtime_t delay )
400 {
401 #if defined( HAVE_CLOCK_NANOSLEEP )
402     lldiv_t d = lldiv( delay, 1000000 );
403     struct timespec ts = { d.quot, d.rem * 1000 };
404
405     int val;
406     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, &ts ) ) == EINTR );
407     if( val == EINVAL )
408     {
409         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
410         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, &ts ) == EINTR );
411     }
412
413 #elif defined( HAVE_KERNEL_OS_H )
414     snooze( delay );
415
416 #elif defined( WIN32 ) || defined( UNDER_CE )
417     mwait (mdate () + delay);
418
419 #elif defined( HAVE_NANOSLEEP )
420     struct timespec ts_delay;
421
422     ts_delay.tv_sec = delay / 1000000;
423     ts_delay.tv_nsec = (delay % 1000000) * 1000;
424
425     while( nanosleep( &ts_delay, &ts_delay ) && ( errno == EINTR ) );
426
427 #elif defined( __APPLE__ ) /* The version that should be used, if it was cancelable */
428     pthread_once(&mtime_timebase_info_once, mtime_init_timebase);
429     uint64_t mach_time = delay * 1000 * mtime_timebase_info.denom / mtime_timebase_info.numer;
430     mach_wait_until(mach_time + mach_absolute_time());
431
432 #else
433     struct timeval tv_delay;
434
435     tv_delay.tv_sec = delay / 1000000;
436     tv_delay.tv_usec = delay % 1000000;
437
438     /* If a signal is caught, you are screwed. Update your OS to nanosleep()
439      * or clock_nanosleep() if this is an issue. */
440     select( 0, NULL, NULL, NULL, &tv_delay );
441 #endif
442 }
443
444 /*
445  * Date management (internal and external)
446  */
447
448 /**
449  * Initialize a date_t.
450  *
451  * \param date to initialize
452  * \param divider (sample rate) numerator
453  * \param divider (sample rate) denominator
454  */
455
456 void date_Init( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
457 {
458     p_date->date = 0;
459     p_date->i_divider_num = i_divider_n;
460     p_date->i_divider_den = i_divider_d;
461     p_date->i_remainder = 0;
462 }
463
464 /**
465  * Change a date_t.
466  *
467  * \param date to change
468  * \param divider (sample rate) numerator
469  * \param divider (sample rate) denominator
470  */
471
472 void date_Change( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
473 {
474     /* change time scale of remainder */
475     p_date->i_remainder = p_date->i_remainder * i_divider_n / p_date->i_divider_num;
476     p_date->i_divider_num = i_divider_n;
477     p_date->i_divider_den = i_divider_d;
478 }
479
480 /**
481  * Set the date value of a date_t.
482  *
483  * \param date to set
484  * \param date value
485  */
486 void date_Set( date_t *p_date, mtime_t i_new_date )
487 {
488     p_date->date = i_new_date;
489     p_date->i_remainder = 0;
490 }
491
492 /**
493  * Get the date of a date_t
494  *
495  * \param date to get
496  * \return date value
497  */
498 mtime_t date_Get( const date_t *p_date )
499 {
500     return p_date->date;
501 }
502
503 /**
504  * Move forwards or backwards the date of a date_t.
505  *
506  * \param date to move
507  * \param difference value
508  */
509 void date_Move( date_t *p_date, mtime_t i_difference )
510 {
511     p_date->date += i_difference;
512 }
513
514 /**
515  * Increment the date and return the result, taking into account
516  * rounding errors.
517  *
518  * \param date to increment
519  * \param incrementation in number of samples
520  * \return date value
521  */
522 mtime_t date_Increment( date_t *p_date, uint32_t i_nb_samples )
523 {
524     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000 * p_date->i_divider_den;
525     p_date->date += i_dividend / p_date->i_divider_num;
526     p_date->i_remainder += (int)(i_dividend % p_date->i_divider_num);
527
528     if( p_date->i_remainder >= p_date->i_divider_num )
529     {
530         /* This is Bresenham algorithm. */
531         assert( p_date->i_remainder < 2*p_date->i_divider_num);
532         p_date->date += 1;
533         p_date->i_remainder -= p_date->i_divider_num;
534     }
535
536     return p_date->date;
537 }
538
539 /**
540  * Decrement the date and return the result, taking into account
541  * rounding errors.
542  *
543  * \param date to decrement
544  * \param decrementation in number of samples
545  * \return date value
546  */
547 mtime_t date_Decrement( date_t *p_date, uint32_t i_nb_samples )
548 {
549     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000 * p_date->i_divider_den;
550     p_date->date -= i_dividend / p_date->i_divider_num;
551     unsigned i_rem_adjust = i_dividend % p_date->i_divider_num;
552
553     if( p_date->i_remainder < i_rem_adjust )
554     {
555         /* This is Bresenham algorithm. */
556         assert( p_date->i_remainder > -p_date->i_divider_num);
557         p_date->date -= 1;
558         p_date->i_remainder += p_date->i_divider_num;
559     }
560
561     p_date->i_remainder -= i_rem_adjust;
562
563     return p_date->date;
564 }
565
566 #ifndef HAVE_GETTIMEOFDAY
567
568 #ifdef WIN32
569
570 /*
571  * Number of micro-seconds between the beginning of the Windows epoch
572  * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970).
573  *
574  * This assumes all Win32 compilers have 64-bit support.
575  */
576 #if defined(_MSC_VER) || defined(_MSC_EXTENSIONS) || defined(__WATCOMC__)
577 #   define DELTA_EPOCH_IN_USEC  11644473600000000Ui64
578 #else
579 #   define DELTA_EPOCH_IN_USEC  11644473600000000ULL
580 #endif
581
582 static uint64_t filetime_to_unix_epoch (const FILETIME *ft)
583 {
584     uint64_t res = (uint64_t) ft->dwHighDateTime << 32;
585
586     res |= ft->dwLowDateTime;
587     res /= 10;                   /* from 100 nano-sec periods to usec */
588     res -= DELTA_EPOCH_IN_USEC;  /* from Win epoch to Unix epoch */
589     return (res);
590 }
591
592 static int gettimeofday (struct timeval *tv, void *tz )
593 {
594     FILETIME  ft;
595     uint64_t tim;
596
597     if (!tv) {
598         return VLC_EGENERIC;
599     }
600     GetSystemTimeAsFileTime (&ft);
601     tim = filetime_to_unix_epoch (&ft);
602     tv->tv_sec  = (long) (tim / 1000000L);
603     tv->tv_usec = (long) (tim % 1000000L);
604     return (0);
605 }
606
607 #endif
608
609 #endif
610
611 /**
612  * @return NTP 64-bits timestamp in host byte order.
613  */
614 uint64_t NTPtime64 (void)
615 {
616     struct timespec ts;
617 #if defined (CLOCK_REALTIME)
618     clock_gettime (CLOCK_REALTIME, &ts);
619 #else
620     {
621         struct timeval tv;
622         gettimeofday (&tv, NULL);
623         ts.tv_sec = tv.tv_sec;
624         ts.tv_nsec = tv.tv_usec * 1000;
625     }
626 #endif
627
628     /* Convert nanoseconds to 32-bits fraction (232 picosecond units) */
629     uint64_t t = (uint64_t)(ts.tv_nsec) << 32;
630     t /= 1000000000;
631
632
633     /* There is 70 years (incl. 17 leap ones) offset to the Unix Epoch.
634      * No leap seconds during that period since they were not invented yet.
635      */
636     assert (t < 0x100000000);
637     t |= ((70LL * 365 + 17) * 24 * 60 * 60 + ts.tv_sec) << 32;
638     return t;
639 }
640