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