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_KERNEL_OS_H )
 119     return( real_time_clock_usecs() );
 120
 121 #elif defined( WIN32 ) || defined( UNDER_CE )
 122     /* We don't need the real date, just the value of a high precision timer */
 123     static mtime_t freq = I64C(-1);
 124     mtime_t usec_time;
 125
 126     if( freq == I64C(-1) )
 127     {
 128         /* Extract from the Tcl source code:
 129          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
 130          *
 131          * Some hardware abstraction layers use the CPU clock
 132          * in place of the real-time clock as a performance counter
 133          * reference.  This results in:
 134          *    - inconsistent results among the processors on
 135          *      multi-processor systems.
 136          *    - unpredictable changes in performance counter frequency
 137          *      on "gearshift" processors such as Transmeta and
 138          *      SpeedStep.
 139          * There seems to be no way to test whether the performance
 140          * counter is reliable, but a useful heuristic is that
 141          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
 142          * derived from a colorburst crystal and is therefore
 143          * the RTC rather than the TSC.  If it's anything else, we
 144          * presume that the performance counter is unreliable.
 145          */
 146
 147         freq = ( QueryPerformanceFrequency( (LARGE_INTEGER *)&freq ) &&
 148                  (freq == I64C(1193182) || freq == I64C(3579545) ) )
 149                ? freq : 0;
 150     }
 151
 152     if( freq != 0 )
 153     {
 154         /* Microsecond resolution */
 155         QueryPerformanceCounter( (LARGE_INTEGER *)&usec_time );
 156         return ( usec_time * 1000000 ) / freq;
 157     }
 158     else
 159     {
 160         /* Fallback on GetTickCount() which has a milisecond resolution
 161          * (actually, best case is about 10 ms resolution)
 162          * GetTickCount() only returns a DWORD thus will wrap after
 163          * about 49.7 days so we try to detect the wrapping. */
 164
 165         static CRITICAL_SECTION date_lock;
 166         static mtime_t i_previous_time = I64C(-1);
 167         static int i_wrap_counts = -1;
 168
 169         if( i_wrap_counts == -1 )
 170         {
 171             /* Initialization */
 172             i_previous_time = I64C(1000) * GetTickCount();
 173             InitializeCriticalSection( &date_lock );
 174             i_wrap_counts = 0;
 175         }
 176
 177         EnterCriticalSection( &date_lock );
 178         usec_time = I64C(1000) *
 179             (i_wrap_counts * I64C(0x100000000) + GetTickCount());
 180         if( i_previous_time > usec_time )
 181         {
 182             /* Counter wrapped */
 183             i_wrap_counts++;
 184             usec_time += I64C(0x100000000000);
 185         }
 186         i_previous_time = usec_time;
 187         LeaveCriticalSection( &date_lock );
 188
 189         return usec_time;
 190     }
 191
 192 #elif defined (HAVE_CLOCK_NANOSLEEP)
 193     struct timespec ts;
 194
 195 # if (_POSIX_MONOTONIC_CLOCK - 0 >= 0)
 196     /* Try to use POSIX monotonic clock if available */
 197     if( clock_gettime( CLOCK_MONOTONIC, &ts ) )
 198 # endif
 199         /* Run-time fallback to real-time clock (always available) */
 200         (void)clock_gettime( CLOCK_REALTIME, &ts );
 201
 202     return ((mtime_t)ts.tv_sec * (mtime_t)1000000)
 203            + (mtime_t)(ts.tv_nsec / 1000);
 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_KERNEL_OS_H )
 224     mtime_t delay;
 225
 226     delay = date - real_time_clock_usecs();
 227     if( delay <= 0 )
 228     {
 229         return;
 230     }
 231     snooze( delay );
 232
 233 #elif defined( WIN32 ) || defined( UNDER_CE )
 234     mtime_t usec_time, delay;
 235
 236     usec_time = mdate();
 237     delay = date - usec_time;
 238     if( delay <= 0 )
 239     {
 240         return;
 241     }
 242     msleep( delay );
 243
 244 #elif defined (HAVE_CLOCK_NANOSLEEP)
 245     lldiv_t d = lldiv( date, 1000000 );
 246     struct timespec ts = { d.quot, d.rem * 1000 };
 247
 248 # if (_POSIX_MONOTONIC_CLOCK - 0 >= 0)
 249     if( clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts, NULL ) )
 250 # endif
 251         clock_nanosleep( CLOCK_REALTIME, TIMER_ABSTIME, &ts, NULL );
 252 #else
 253
 254     struct timeval tv_date;
 255     mtime_t        delay;          /* delay in msec, signed to detect errors */
 256
 257     /* see mdate() about gettimeofday() possible errors */
 258     gettimeofday( &tv_date, NULL );
 259
 260     /* calculate delay and check if current date is before wished date */
 261     delay = date - (mtime_t) tv_date.tv_sec * 1000000
 262                  - (mtime_t) tv_date.tv_usec
 263                  - 10000;
 264
 265     /* Linux/i386 has a granularity of 10 ms. It's better to be in advance
 266      * than to be late. */
 267     if( delay <= 0 )                 /* wished date is now or already passed */
 268     {
 269         return;
 270     }
 271
 272 #   if defined( PTH_INIT_IN_PTH_H )
 273     pth_usleep( delay );
 274
 275 #   elif defined( ST_INIT_IN_ST_H )
 276     st_usleep( delay );
 277
 278 #   else
 279
 280 #       if defined( HAVE_NANOSLEEP )
 281     {
 282         struct timespec ts_delay;
 283         ts_delay.tv_sec = delay / 1000000;
 284         ts_delay.tv_nsec = (delay % 1000000) * 1000;
 285
 286         nanosleep( &ts_delay, NULL );
 287     }
 288
 289 #       else
 290     tv_date.tv_sec = delay / 1000000;
 291     tv_date.tv_usec = delay % 1000000;
 292     /* see msleep() about select() errors */
 293     select( 0, NULL, NULL, NULL, &tv_date );
 294 #       endif
 295
 296 #   endif
 297
 298 #endif
 299 }
 300
 301 /**
 302  * More precise sleep()
 303  *
 304  * Portable usleep() function.
 305  * \param delay the amount of time to sleep
 306  */
 307 void msleep( mtime_t delay )
 308 {
 309 #if defined( HAVE_KERNEL_OS_H )
 310     snooze( delay );
 311
 312 #elif defined( PTH_INIT_IN_PTH_H )
 313     pth_usleep( delay );
 314
 315 #elif defined( ST_INIT_IN_ST_H )
 316     st_usleep( delay );
 317
 318 #elif defined( WIN32 ) || defined( UNDER_CE )
 319     Sleep( (int) (delay / 1000) );
 320
 321 #elif defined( HAVE_CLOCK_NANOSLEEP )
 322     lldiv_t d = lldiv( delay, 1000000 );
 323     struct timespec ts = { d.quot, d.rem * 1000 };
 324
 325 # if (_POSIX_MONOTONIC_CLOCK - 0 >= 0)
 326     if( clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, NULL ) )
 327 # endif
 328         clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL );
 329
 330 #elif defined( HAVE_NANOSLEEP )
 331     struct timespec ts_delay;
 332
 333     ts_delay.tv_sec = delay / 1000000;
 334     ts_delay.tv_nsec = (delay % 1000000) * 1000;
 335
 336     nanosleep( &ts_delay, NULL );
 337
 338 #else
 339     struct timeval tv_delay;
 340
 341     tv_delay.tv_sec = delay / 1000000;
 342     tv_delay.tv_usec = delay % 1000000;
 343
 344     /* select() return value should be tested, since several possible errors
 345      * can occur. However, they should only happen in very particular occasions
 346      * (i.e. when a signal is sent to the thread, or when memory is full), and
 347      * can be ignored. */
 348     select( 0, NULL, NULL, NULL, &tv_delay );
 349
 350 #endif
 351 }
 352
 353 /*
 354  * Date management (internal and external)
 355  */
 356
 357 /**
 358  * Initialize a date_t.
 359  *
 360  * \param date to initialize
 361  * \param divider (sample rate) numerator
 362  * \param divider (sample rate) denominator
 363  */
 364
 365 void date_Init( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 366 {
 367     p_date->date = 0;
 368     p_date->i_divider_num = i_divider_n;
 369     p_date->i_divider_den = i_divider_d;
 370     p_date->i_remainder = 0;
 371 }
 372
 373 /**
 374  * Change a date_t.
 375  *
 376  * \param date to change
 377  * \param divider (sample rate) numerator
 378  * \param divider (sample rate) denominator
 379  */
 380
 381 void date_Change( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 382 {
 383     p_date->i_divider_num = i_divider_n;
 384     p_date->i_divider_den = i_divider_d;
 385 }
 386
 387 /**
 388  * Set the date value of a date_t.
 389  *
 390  * \param date to set
 391  * \param date value
 392  */
 393 void date_Set( date_t *p_date, mtime_t i_new_date )
 394 {
 395     p_date->date = i_new_date;
 396     p_date->i_remainder = 0;
 397 }
 398
 399 /**
 400  * Get the date of a date_t
 401  *
 402  * \param date to get
 403  * \return date value
 404  */
 405 mtime_t date_Get( const date_t *p_date )
 406 {
 407     return p_date->date;
 408 }
 409
 410 /**
 411  * Move forwards or backwards the date of a date_t.
 412  *
 413  * \param date to move
 414  * \param difference value
 415  */
 416 void date_Move( date_t *p_date, mtime_t i_difference )
 417 {
 418     p_date->date += i_difference;
 419 }
 420
 421 /**
 422  * Increment the date and return the result, taking into account
 423  * rounding errors.
 424  *
 425  * \param date to increment
 426  * \param incrementation in number of samples
 427  * \return date value
 428  */
 429 mtime_t date_Increment( date_t *p_date, uint32_t i_nb_samples )
 430 {
 431     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
 432     p_date->date += i_dividend / p_date->i_divider_num * p_date->i_divider_den;
 433     p_date->i_remainder += (int)(i_dividend % p_date->i_divider_num);
 434
 435     if( p_date->i_remainder >= p_date->i_divider_num )
 436     {
 437         /* This is Bresenham algorithm. */
 438         p_date->date += p_date->i_divider_den;
 439         p_date->i_remainder -= p_date->i_divider_num;
 440     }
 441
 442     return p_date->date;
 443 }