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