git.sesse.net Git - vlc/blob - src/misc/mtime.c

   1 /*****************************************************************************
   2  * mtime.c: high resolution time management functions
   3  * Functions are prototyped in mtime.h.
   4  *****************************************************************************
   5  * Copyright (C) 1998-2004 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   9  *          Rémi Denis-Courmont <rem$videolan,org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29
  30 #include <vlc/vlc.h>
  31
  32 #include <stdio.h>                                              /* sprintf() */
  33 #include <time.h>                      /* clock_gettime(), clock_nanosleep() */
  34 #include <stdlib.h>                                               /* lldiv() */
  35
  36
  37 #if defined( PTH_INIT_IN_PTH_H )                                  /* GNU Pth */
  38 #   include <pth.h>
  39 #endif
  40
  41 #ifdef HAVE_UNISTD_H
  42 #   include <unistd.h>                                           /* select() */
  43 #endif
  44
  45 #ifdef HAVE_KERNEL_OS_H
  46 #   include <kernel/OS.h>
  47 #endif
  48
  49 #if defined( WIN32 ) || defined( UNDER_CE )
  50 #   include <windows.h>
  51 #else
  52 #   include <sys/time.h>
  53 #endif
  54
  55 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_STRUCT_TIMESPEC)
  56 struct timespec
  57 {
  58     time_t  tv_sec;
  59     int32_t tv_nsec;
  60 };
  61 #endif
  62
  63 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_DECL_NANOSLEEP)
  64 int nanosleep(struct timespec *, struct timespec *);
  65 #endif
  66
  67 /**
  68  * Return a date in a readable format
  69  *
  70  * This function converts a mtime date into a string.
  71  * psz_buffer should be a buffer long enough to store the formatted
  72  * date.
  73  * \param date to be converted
  74  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
  75  * \return psz_buffer is returned so this can be used as printf parameter.
  76  */
  77 char *mstrtime( char *psz_buffer, mtime_t date )
  78 {
  79     static mtime_t ll1000 = 1000, ll60 = 60, ll24 = 24;
  80
  81     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%02d:%02d:%02d-%03d.%03d",
  82              (int) (date / (ll1000 * ll1000 * ll60 * ll60) % ll24),
  83              (int) (date / (ll1000 * ll1000 * ll60) % ll60),
  84              (int) (date / (ll1000 * ll1000) % ll60),
  85              (int) (date / ll1000 % ll1000),
  86              (int) (date % ll1000) );
  87     return( psz_buffer );
  88 }
  89
  90 /**
  91  * Convert seconds to a time in the format h:mm:ss.
  92  *
  93  * This function is provided for any interface function which need to print a
  94  * time string in the format h:mm:ss
  95  * date.
  96  * \param secs  the date to be converted
  97  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
  98  * \return psz_buffer is returned so this can be used as printf parameter.
  99  */
 100 char *secstotimestr( char *psz_buffer, int i_seconds )
 101 {
 102     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%d:%2.2d:%2.2d",
 103               (int) (i_seconds / (60 *60)),
 104               (int) ((i_seconds / 60) % 60),
 105               (int) (i_seconds % 60) );
 106     return( psz_buffer );
 107 }
 108
 109
 110 /**
 111  * Return high precision date
 112  *
 113  * Uses the gettimeofday() function when possible (1 MHz resolution) or the
 114  * ftime() function (1 kHz resolution).
 115  */
 116 mtime_t mdate( void )
 117 {
 118 #if defined (HAVE_CLOCK_NANOSLEEP)
 119     struct timespec ts;
 120
 121 # if (_POSIX_MONOTONIC_CLOCK - 0 >= 0)
 122     /* Try to use POSIX monotonic clock if available */
 123     if( clock_gettime( CLOCK_MONOTONIC, &ts ) )
 124 # endif
 125         /* Run-time fallback to real-time clock (always available) */
 126         (void)clock_gettime( CLOCK_REALTIME, &ts );
 127
 128     return ((mtime_t)ts.tv_sec * (mtime_t)1000000)
 129            + (mtime_t)(ts.tv_nsec / 1000);
 130
 131 #elif defined( HAVE_KERNEL_OS_H )
 132     return( real_time_clock_usecs() );
 133
 134 #elif defined( WIN32 ) || defined( UNDER_CE )
 135     /* We don't need the real date, just the value of a high precision timer */
 136     static mtime_t freq = I64C(-1);
 137     mtime_t usec_time;
 138
 139     if( freq == I64C(-1) )
 140     {
 141         /* Extract from the Tcl source code:
 142          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
 143          *
 144          * Some hardware abstraction layers use the CPU clock
 145          * in place of the real-time clock as a performance counter
 146          * reference.  This results in:
 147          *    - inconsistent results among the processors on
 148          *      multi-processor systems.
 149          *    - unpredictable changes in performance counter frequency
 150          *      on "gearshift" processors such as Transmeta and
 151          *      SpeedStep.
 152          * There seems to be no way to test whether the performance
 153          * counter is reliable, but a useful heuristic is that
 154          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
 155          * derived from a colorburst crystal and is therefore
 156          * the RTC rather than the TSC.  If it's anything else, we
 157          * presume that the performance counter is unreliable.
 158          */
 159
 160         freq = ( QueryPerformanceFrequency( (LARGE_INTEGER *)&freq ) &&
 161                  (freq == I64C(1193182) || freq == I64C(3579545) ) )
 162                ? freq : 0;
 163     }
 164
 165     if( freq != 0 )
 166     {
 167         /* Microsecond resolution */
 168         QueryPerformanceCounter( (LARGE_INTEGER *)&usec_time );
 169         return ( usec_time * 1000000 ) / freq;
 170     }
 171     else
 172     {
 173         /* Fallback on GetTickCount() which has a milisecond resolution
 174          * (actually, best case is about 10 ms resolution)
 175          * GetTickCount() only returns a DWORD thus will wrap after
 176          * about 49.7 days so we try to detect the wrapping. */
 177
 178         static CRITICAL_SECTION date_lock;
 179         static mtime_t i_previous_time = I64C(-1);
 180         static int i_wrap_counts = -1;
 181
 182         if( i_wrap_counts == -1 )
 183         {
 184             /* Initialization */
 185             i_previous_time = I64C(1000) * GetTickCount();
 186             InitializeCriticalSection( &date_lock );
 187             i_wrap_counts = 0;
 188         }
 189
 190         EnterCriticalSection( &date_lock );
 191         usec_time = I64C(1000) *
 192             (i_wrap_counts * I64C(0x100000000) + GetTickCount());
 193         if( i_previous_time > usec_time )
 194         {
 195             /* Counter wrapped */
 196             i_wrap_counts++;
 197             usec_time += I64C(0x100000000000);
 198         }
 199         i_previous_time = usec_time;
 200         LeaveCriticalSection( &date_lock );
 201
 202         return usec_time;
 203     }
 204 #else
 205     struct timeval tv_date;
 206
 207     /* gettimeofday() cannot fail given &tv_date is a valid address */
 208     (void)gettimeofday( &tv_date, NULL );
 209     return( (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec );
 210 #endif
 211 }
 212
 213 /**
 214  * Wait for a date
 215  *
 216  * This function uses select() and an system date function to wake up at a
 217  * precise date. It should be used for process synchronization. If current date
 218  * is posterior to wished date, the function returns immediately.
 219  * \param date The date to wake up at
 220  */
 221 void mwait( mtime_t date )
 222 {
 223 #if defined (HAVE_CLOCK_NANOSLEEP)
 224     lldiv_t d = lldiv( date, 1000000 );
 225     struct timespec ts = { d.quot, d.rem * 1000 };
 226
 227 # if (_POSIX_MONOTONIC_CLOCK - 0 >= 0)
 228     if( clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts, NULL ) )
 229 # endif
 230         clock_nanosleep( CLOCK_REALTIME, TIMER_ABSTIME, &ts, NULL );
 231 #else
 232
 233     mtime_t usec_time, delay;
 234
 235     usec_time = mdate();
 236     delay = date - usec_time;
 237     if( delay > 0 )
 238         msleep( delay );
 239
 240
 241     struct timeval tv_date;
 242     mtime_t        delay;          /* delay in msec, signed to detect errors */
 243
 244     /* see mdate() about gettimeofday() possible errors */
 245     gettimeofday( &tv_date, NULL );
 246
 247     /* calculate delay and check if current date is before wished date */
 248     delay = date - (mtime_t) tv_date.tv_sec * 1000000
 249                  - (mtime_t) tv_date.tv_usec
 250                  - 10000;
 251
 252     if( delay > 0 )
 253         msleep( delay );
 254 #endif
 255 }
 256
 257 /**
 258  * More precise sleep()
 259  *
 260  * Portable usleep() function.
 261  * \param delay the amount of time to sleep
 262  */
 263 void msleep( mtime_t delay )
 264 {
 265 #if defined( HAVE_CLOCK_NANOSLEEP )
 266     lldiv_t d = lldiv( delay, 1000000 );
 267     struct timespec ts = { d.quot, d.rem * 1000 };
 268
 269 # if (_POSIX_MONOTONIC_CLOCK - 0 >= 0)
 270     if( clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, NULL ) )
 271 # endif
 272         clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL );
 273
 274 #elif defined( HAVE_KERNEL_OS_H )
 275     snooze( delay );
 276
 277 #elif defined( PTH_INIT_IN_PTH_H )
 278     pth_usleep( delay );
 279
 280 #elif defined( ST_INIT_IN_ST_H )
 281     st_usleep( delay );
 282
 283 #elif defined( WIN32 ) || defined( UNDER_CE )
 284     Sleep( (int) (delay / 1000) );
 285
 286 #elif defined( HAVE_NANOSLEEP )
 287     struct timespec ts_delay;
 288
 289     ts_delay.tv_sec = delay / 1000000;
 290     ts_delay.tv_nsec = (delay % 1000000) * 1000;
 291
 292     nanosleep( &ts_delay, NULL );
 293
 294 #else
 295     struct timeval tv_delay;
 296
 297     tv_delay.tv_sec = delay / 1000000;
 298     tv_delay.tv_usec = delay % 1000000;
 299
 300     /* select() return value should be tested, since several possible errors
 301      * can occur. However, they should only happen in very particular occasions
 302      * (i.e. when a signal is sent to the thread, or when memory is full), and
 303      * can be ignored. */
 304     select( 0, NULL, NULL, NULL, &tv_delay );
 305 #endif
 306 }
 307
 308 /*
 309  * Date management (internal and external)
 310  */
 311
 312 /**
 313  * Initialize a date_t.
 314  *
 315  * \param date to initialize
 316  * \param divider (sample rate) numerator
 317  * \param divider (sample rate) denominator
 318  */
 319
 320 void date_Init( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 321 {
 322     p_date->date = 0;
 323     p_date->i_divider_num = i_divider_n;
 324     p_date->i_divider_den = i_divider_d;
 325     p_date->i_remainder = 0;
 326 }
 327
 328 /**
 329  * Change a date_t.
 330  *
 331  * \param date to change
 332  * \param divider (sample rate) numerator
 333  * \param divider (sample rate) denominator
 334  */
 335
 336 void date_Change( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 337 {
 338     p_date->i_divider_num = i_divider_n;
 339     p_date->i_divider_den = i_divider_d;
 340 }
 341
 342 /**
 343  * Set the date value of a date_t.
 344  *
 345  * \param date to set
 346  * \param date value
 347  */
 348 void date_Set( date_t *p_date, mtime_t i_new_date )
 349 {
 350     p_date->date = i_new_date;
 351     p_date->i_remainder = 0;
 352 }
 353
 354 /**
 355  * Get the date of a date_t
 356  *
 357  * \param date to get
 358  * \return date value
 359  */
 360 mtime_t date_Get( const date_t *p_date )
 361 {
 362     return p_date->date;
 363 }
 364
 365 /**
 366  * Move forwards or backwards the date of a date_t.
 367  *
 368  * \param date to move
 369  * \param difference value
 370  */
 371 void date_Move( date_t *p_date, mtime_t i_difference )
 372 {
 373     p_date->date += i_difference;
 374 }
 375
 376 /**
 377  * Increment the date and return the result, taking into account
 378  * rounding errors.
 379  *
 380  * \param date to increment
 381  * \param incrementation in number of samples
 382  * \return date value
 383  */
 384 mtime_t date_Increment( date_t *p_date, uint32_t i_nb_samples )
 385 {
 386     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
 387     p_date->date += i_dividend / p_date->i_divider_num * p_date->i_divider_den;
 388     p_date->i_remainder += (int)(i_dividend % p_date->i_divider_num);
 389
 390     if( p_date->i_remainder >= p_date->i_divider_num )
 391     {
 392         /* This is Bresenham algorithm. */
 393         p_date->date += p_date->i_divider_den;
 394         p_date->i_remainder -= p_date->i_divider_num;
 395     }
 396
 397     return p_date->date;
 398 }