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