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