git.sesse.net Git - vlc/blob - 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 #include <vlc/vlc.h>
  33
  34 #include <stdio.h>                                              /* sprintf() */
  35 #include <time.h>                      /* clock_gettime(), clock_nanosleep() */
  36 #include <stdlib.h>                                               /* lldiv() */
  37 #include <assert.h>
  38 #include <errno.h>
  39
  40
  41 #if defined( PTH_INIT_IN_PTH_H )                                  /* GNU Pth */
  42 #   include <pth.h>
  43 #endif
  44
  45 #ifdef HAVE_UNISTD_H
  46 #   include <unistd.h>                                           /* select() */
  47 #endif
  48
  49 #ifdef HAVE_KERNEL_OS_H
  50 #   include <kernel/OS.h>
  51 #endif
  52
  53 #if defined( WIN32 ) || defined( UNDER_CE )
  54 #   include <windows.h>
  55 #endif
  56 #if defined(HAVE_SYS_TIME_H)
  57 #   include <sys/time.h>
  58 #endif
  59
  60 #if !defined(HAVE_STRUCT_TIMESPEC)
  61 struct timespec
  62 {
  63     time_t  tv_sec;
  64     int32_t tv_nsec;
  65 };
  66 #endif
  67
  68 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_DECL_NANOSLEEP)
  69 int nanosleep(struct timespec *, struct timespec *);
  70 #endif
  71
  72 /**
  73  * Return a date in a readable format
  74  *
  75  * This function converts a mtime date into a string.
  76  * psz_buffer should be a buffer long enough to store the formatted
  77  * date.
  78  * \param date to be converted
  79  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
  80  * \return psz_buffer is returned so this can be used as printf parameter.
  81  */
  82 char *mstrtime( char *psz_buffer, mtime_t date )
  83 {
  84     static mtime_t ll1000 = 1000, ll60 = 60, ll24 = 24;
  85
  86     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%02d:%02d:%02d-%03d.%03d",
  87              (int) (date / (ll1000 * ll1000 * ll60 * ll60) % ll24),
  88              (int) (date / (ll1000 * ll1000 * ll60) % ll60),
  89              (int) (date / (ll1000 * ll1000) % ll60),
  90              (int) (date / ll1000 % ll1000),
  91              (int) (date % ll1000) );
  92     return( psz_buffer );
  93 }
  94
  95 /**
  96  * Convert seconds to a time in the format h:mm:ss.
  97  *
  98  * This function is provided for any interface function which need to print a
  99  * time string in the format h:mm:ss
 100  * date.
 101  * \param secs  the date to be converted
 102  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
 103  * \return psz_buffer is returned so this can be used as printf parameter.
 104  */
 105 char *secstotimestr( char *psz_buffer, int i_seconds )
 106 {
 107     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%d:%2.2d:%2.2d",
 108               (int) (i_seconds / (60 *60)),
 109               (int) ((i_seconds / 60) % 60),
 110               (int) (i_seconds % 60) );
 111     return( psz_buffer );
 112 }
 113
 114 /**
 115  * Return a value that is no bigger than the clock precision
 116  * (possibly zero).
 117  */
 118 static inline unsigned mprec( void )
 119 {
 120 #if defined (HAVE_CLOCK_NANOSLEEP)
 121     struct timespec ts;
 122     if( clock_getres( CLOCK_MONOTONIC, &ts ))
 123         clock_getres( CLOCK_REALTIME, &ts );
 124
 125     return ts.tv_nsec / 1000;
 126 #endif
 127     return 0;
 128 }
 129
 130 static unsigned prec = 0;
 131 static volatile mtime_t cached_time = 0;
 132 #if (_POSIX_MONOTONIC_CLOCK - 0 < 0)
 133 # define CLOCK_MONOTONIC CLOCK_REALTIME
 134 #endif
 135
 136 /**
 137  * Return high precision date
 138  *
 139  * Uses the gettimeofday() function when possible (1 MHz resolution) or the
 140  * ftime() function (1 kHz resolution).
 141  */
 142 mtime_t mdate( void )
 143 {
 144     mtime_t res;
 145
 146 #if defined (HAVE_CLOCK_NANOSLEEP)
 147     struct timespec ts;
 148
 149     /* Try to use POSIX monotonic clock if available */
 150     if( clock_gettime( CLOCK_MONOTONIC, &ts ) == EINVAL )
 151         /* Run-time fallback to real-time clock (always available) */
 152         (void)clock_gettime( CLOCK_REALTIME, &ts );
 153
 154     res = ((mtime_t)ts.tv_sec * (mtime_t)1000000)
 155            + (mtime_t)(ts.tv_nsec / 1000);
 156
 157 #elif defined( HAVE_KERNEL_OS_H )
 158     res = real_time_clock_usecs();
 159
 160 #elif defined( WIN32 ) || defined( UNDER_CE )
 161     /* We don't need the real date, just the value of a high precision timer */
 162     static mtime_t freq = I64C(-1);
 163     mtime_t usec_time;
 164
 165     if( freq == I64C(-1) )
 166     {
 167         /* Extract from the Tcl source code:
 168          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
 169          *
 170          * Some hardware abstraction layers use the CPU clock
 171          * in place of the real-time clock as a performance counter
 172          * reference.  This results in:
 173          *    - inconsistent results among the processors on
 174          *      multi-processor systems.
 175          *    - unpredictable changes in performance counter frequency
 176          *      on "gearshift" processors such as Transmeta and
 177          *      SpeedStep.
 178          * There seems to be no way to test whether the performance
 179          * counter is reliable, but a useful heuristic is that
 180          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
 181          * derived from a colorburst crystal and is therefore
 182          * the RTC rather than the TSC.  If it's anything else, we
 183          * presume that the performance counter is unreliable.
 184          */
 185         LARGE_INTEGER buf;
 186
 187         freq = ( QueryPerformanceFrequency( &buf ) &&
 188                  (buf.QuadPart == I64C(1193182) || buf.QuadPart == I64C(3579545) ) )
 189                ? buf.QuadPart : 0;
 190     }
 191
 192     if( freq != 0 )
 193     {
 194         LARGE_INTEGER counter;
 195         QueryPerformanceCounter (&counter);
 196
 197         /* Convert to from (1/freq) to microsecond resolution */
 198         /* We need to split the division to avoid 63-bits overflow */
 199         lldiv_t d = lldiv (counter.QuadPart, freq);
 200
 201         res = (d.quot * 1000000) + ((d.rem * 1000000) / freq);
 202     }
 203     else
 204     {
 205         /* Fallback on GetTickCount() which has a milisecond resolution
 206          * (actually, best case is about 10 ms resolution)
 207          * GetTickCount() only returns a DWORD thus will wrap after
 208          * about 49.7 days so we try to detect the wrapping. */
 209
 210         static CRITICAL_SECTION date_lock;
 211         static mtime_t i_previous_time = I64C(-1);
 212         static int i_wrap_counts = -1;
 213
 214         if( i_wrap_counts == -1 )
 215         {
 216             /* Initialization */
 217             i_previous_time = I64C(1000) * GetTickCount();
 218             InitializeCriticalSection( &date_lock );
 219             i_wrap_counts = 0;
 220         }
 221
 222         EnterCriticalSection( &date_lock );
 223         res = I64C(1000) *
 224             (i_wrap_counts * I64C(0x100000000) + GetTickCount());
 225         if( i_previous_time > res )
 226         {
 227             /* Counter wrapped */
 228             i_wrap_counts++;
 229             usec_time += I64C(0x100000000) * 1000;
 230         }
 231         i_previous_time = usec_time;
 232         LeaveCriticalSection( &date_lock );
 233     }
 234 #else
 235     struct timeval tv_date;
 236
 237     /* gettimeofday() cannot fail given &tv_date is a valid address */
 238     (void)gettimeofday( &tv_date, NULL );
 239     res = (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec;
 240 #endif
 241
 242     return cached_time = res;
 243 }
 244
 245 /**
 246  * Wait for a date
 247  *
 248  * This function uses select() and an system date function to wake up at a
 249  * precise date. It should be used for process synchronization. If current date
 250  * is posterior to wished date, the function returns immediately.
 251  * \param date The date to wake up at
 252  */
 253 void mwait( mtime_t date )
 254 {
 255     if( prec == 0 )
 256         prec = mprec();
 257
 258     /* If the deadline is already elapsed, or within the clock precision,
 259      * do not even bother the clock. */
 260     if( ( date - cached_time ) < (mtime_t)prec ) // OK: mtime_t is signed
 261         return;
 262
 263 #if 0 && defined (HAVE_CLOCK_NANOSLEEP)
 264     lldiv_t d = lldiv( date, 1000000 );
 265     struct timespec ts = { d.quot, d.rem * 1000 };
 266
 267     int val;
 268     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts,
 269                                     NULL ) ) == EINTR );
 270     if( val == EINVAL )
 271     {
 272         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
 273         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL ) == EINTR );
 274     }
 275 #else
 276
 277     mtime_t delay = date - mdate();
 278     if( delay > 0 )
 279         msleep( delay );
 280
 281 #endif
 282 }
 283
 284 /**
 285  * More precise sleep()
 286  *
 287  * Portable usleep() function.
 288  * \param delay the amount of time to sleep
 289  */
 290 void msleep( mtime_t delay )
 291 {
 292     mtime_t earlier = cached_time;
 293
 294 #if defined( HAVE_CLOCK_NANOSLEEP )
 295     lldiv_t d = lldiv( delay, 1000000 );
 296     struct timespec ts = { d.quot, d.rem * 1000 };
 297
 298     int val;
 299     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, &ts ) ) == EINTR );
 300     if( val == EINVAL )
 301     {
 302         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
 303         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, &ts ) == EINTR );
 304     }
 305
 306 #elif defined( HAVE_KERNEL_OS_H )
 307     snooze( delay );
 308
 309 #elif defined( PTH_INIT_IN_PTH_H )
 310     pth_usleep( delay );
 311
 312 #elif defined( ST_INIT_IN_ST_H )
 313     st_usleep( delay );
 314
 315 #elif defined( WIN32 ) || defined( UNDER_CE )
 316     Sleep( (int) (delay / 1000) );
 317
 318 #elif defined( HAVE_NANOSLEEP )
 319     struct timespec ts_delay;
 320
 321     ts_delay.tv_sec = delay / 1000000;
 322     ts_delay.tv_nsec = (delay % 1000000) * 1000;
 323
 324     while( nanosleep( &ts_delay, &ts_delay ) && ( errno == EINTR ) );
 325
 326 #else
 327     struct timeval tv_delay;
 328
 329     tv_delay.tv_sec = delay / 1000000;
 330     tv_delay.tv_usec = delay % 1000000;
 331
 332     /* If a signal is caught, you are screwed. Update your OS to nanosleep()
 333      * or clock_nanosleep() if this is an issue. */
 334     select( 0, NULL, NULL, NULL, &tv_delay );
 335 #endif
 336
 337     earlier += delay;
 338     if( cached_time < earlier )
 339         cached_time = earlier;
 340 }
 341
 342 /*
 343  * Date management (internal and external)
 344  */
 345
 346 /**
 347  * Initialize a date_t.
 348  *
 349  * \param date to initialize
 350  * \param divider (sample rate) numerator
 351  * \param divider (sample rate) denominator
 352  */
 353
 354 void date_Init( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 355 {
 356     p_date->date = 0;
 357     p_date->i_divider_num = i_divider_n;
 358     p_date->i_divider_den = i_divider_d;
 359     p_date->i_remainder = 0;
 360 }
 361
 362 /**
 363  * Change a date_t.
 364  *
 365  * \param date to change
 366  * \param divider (sample rate) numerator
 367  * \param divider (sample rate) denominator
 368  */
 369
 370 void date_Change( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 371 {
 372     p_date->i_divider_num = i_divider_n;
 373     p_date->i_divider_den = i_divider_d;
 374 }
 375
 376 /**
 377  * Set the date value of a date_t.
 378  *
 379  * \param date to set
 380  * \param date value
 381  */
 382 void date_Set( date_t *p_date, mtime_t i_new_date )
 383 {
 384     p_date->date = i_new_date;
 385     p_date->i_remainder = 0;
 386 }
 387
 388 /**
 389  * Get the date of a date_t
 390  *
 391  * \param date to get
 392  * \return date value
 393  */
 394 mtime_t date_Get( const date_t *p_date )
 395 {
 396     return p_date->date;
 397 }
 398
 399 /**
 400  * Move forwards or backwards the date of a date_t.
 401  *
 402  * \param date to move
 403  * \param difference value
 404  */
 405 void date_Move( date_t *p_date, mtime_t i_difference )
 406 {
 407     p_date->date += i_difference;
 408 }
 409
 410 /**
 411  * Increment the date and return the result, taking into account
 412  * rounding errors.
 413  *
 414  * \param date to increment
 415  * \param incrementation in number of samples
 416  * \return date value
 417  */
 418 mtime_t date_Increment( date_t *p_date, uint32_t i_nb_samples )
 419 {
 420     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
 421     p_date->date += i_dividend / p_date->i_divider_num * p_date->i_divider_den;
 422     p_date->i_remainder += (int)(i_dividend % p_date->i_divider_num);
 423
 424     if( p_date->i_remainder >= p_date->i_divider_num )
 425     {
 426         /* This is Bresenham algorithm. */
 427         p_date->date += p_date->i_divider_den;
 428         p_date->i_remainder -= p_date->i_divider_num;
 429     }
 430
 431     return p_date->date;
 432 }
 433
 434 #ifdef WIN32
 435 /*
 436  * Number of micro-seconds between the beginning of the Windows epoch
 437  * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970).
 438  *
 439  * This assumes all Win32 compilers have 64-bit support.
 440  */
 441 #if defined(_MSC_VER) || defined(_MSC_EXTENSIONS) || defined(__WATCOMC__)
 442 #   define DELTA_EPOCH_IN_USEC  11644473600000000Ui64
 443 #else
 444 #   define DELTA_EPOCH_IN_USEC  11644473600000000ULL
 445 #endif
 446
 447 static uint64_t filetime_to_unix_epoch (const FILETIME *ft)
 448 {
 449     uint64_t res = (uint64_t) ft->dwHighDateTime << 32;
 450
 451     res |= ft->dwLowDateTime;
 452     res /= 10;                   /* from 100 nano-sec periods to usec */
 453     res -= DELTA_EPOCH_IN_USEC;  /* from Win epoch to Unix epoch */
 454     return (res);
 455 }
 456
 457 static int gettimeofday (struct timeval *tv, void *tz )
 458 {
 459     FILETIME  ft;
 460     uint64_t tim;
 461
 462     if (!tv) {
 463         return VLC_EGENERIC;
 464     }
 465     GetSystemTimeAsFileTime (&ft);
 466     tim = filetime_to_unix_epoch (&ft);
 467     tv->tv_sec  = (long) (tim / 1000000L);
 468     tv->tv_usec = (long) (tim % 1000000L);
 469     return (0);
 470 }
 471 #endif
 472
 473
 474
 475 /**
 476  * @return NTP 64-bits timestamp in host byte order.
 477  */
 478 uint64_t NTPtime64 (void)
 479 {
 480     struct timespec ts;
 481 #if defined (CLOCK_REALTIME)
 482     clock_gettime (CLOCK_REALTIME, &ts);
 483 #else
 484     {
 485         struct timeval tv;
 486         gettimeofday (&tv, NULL);
 487         ts.tv_sec = tv.tv_sec;
 488         ts.tv_nsec = tv.tv_usec * 1000;
 489     }
 490 #endif
 491
 492     /* Convert nanoseconds to 32-bits fraction (232 picosecond units) */
 493     uint64_t t = (uint64_t)(ts.tv_nsec) << 32;
 494     t /= 1000000000;
 495
 496
 497     /* There is 70 years (incl. 17 leap ones) offset to the Unix Epoch.
 498      * No leap seconds during that period since they were not invented yet.
 499      */
 500     assert (t < 0x100000000);
 501     t |= ((70LL * 365 + 17) * 24 * 60 * 60 + ts.tv_sec) << 32;
 502     return t;
 503 }
 504