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-2001, 2003 VideoLAN
   6  * $Id: mtime.c,v 1.39 2003/12/03 21:50:50 sigmunau Exp $
   7  *
   8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*
  26  * TODO:
  27  *  see if using Linux real-time extensions is possible and profitable
  28  */
  29
  30 /*****************************************************************************
  31  * Preamble
  32  *****************************************************************************/
  33 #include <stdio.h>                                              /* sprintf() */
  34
  35 #include <vlc/vlc.h>
  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  * Return high precision date
 111  *
 112  * Uses the gettimeofday() function when possible (1 MHz resolution) or the
 113  * ftime() function (1 kHz resolution).
 114  */
 115 mtime_t mdate( void )
 116 {
 117 #if defined( HAVE_KERNEL_OS_H )
 118     return( real_time_clock_usecs() );
 119
 120 #elif defined( WIN32 ) || defined( UNDER_CE )
 121     /* We don't need the real date, just the value of a high precision timer */
 122     static mtime_t freq = I64C(-1);
 123     mtime_t usec_time;
 124
 125     if( freq == I64C(-1) )
 126     {
 127         /* Extract from the Tcl source code:
 128          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
 129          *
 130          * Some hardware abstraction layers use the CPU clock
 131          * in place of the real-time clock as a performance counter
 132          * reference.  This results in:
 133          *    - inconsistent results among the processors on
 134          *      multi-processor systems.
 135          *    - unpredictable changes in performance counter frequency
 136          *      on "gearshift" processors such as Transmeta and
 137          *      SpeedStep.
 138          * There seems to be no way to test whether the performance
 139          * counter is reliable, but a useful heuristic is that
 140          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
 141          * derived from a colorburst crystal and is therefore
 142          * the RTC rather than the TSC.  If it's anything else, we
 143          * presume that the performance counter is unreliable.
 144          */
 145
 146         freq = ( QueryPerformanceFrequency( (LARGE_INTEGER *)&freq ) &&
 147                  (freq == I64C(1193182) || freq == I64C(3579545) ) )
 148                ? freq : 0;
 149     }
 150
 151     if( freq != 0 )
 152     {
 153         /* Microsecond resolution */
 154         QueryPerformanceCounter( (LARGE_INTEGER *)&usec_time );
 155         return ( usec_time * 1000000 ) / freq;
 156     }
 157
 158     /* Milisecond resolution (actually, best case is about 10 ms resolution) */
 159     return 1000 * GetTickCount();
 160
 161 #else
 162     struct timeval tv_date;
 163
 164     /* gettimeofday() could return an error, and should be tested. However, the
 165      * only possible error, according to 'man', is EFAULT, which can not happen
 166      * here, since tv is a local variable. */
 167     gettimeofday( &tv_date, NULL );
 168     return( (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec );
 169
 170 #endif
 171 }
 172
 173 /**
 174  * Wait for a date
 175  *
 176  * This function uses select() and an system date function to wake up at a
 177  * precise date. It should be used for process synchronization. If current date
 178  * is posterior to wished date, the function returns immediately.
 179  * \param date The date to wake up at
 180  */
 181 void mwait( mtime_t date )
 182 {
 183 #if defined( HAVE_KERNEL_OS_H )
 184     mtime_t delay;
 185
 186     delay = date - real_time_clock_usecs();
 187     if( delay <= 0 )
 188     {
 189         return;
 190     }
 191     snooze( delay );
 192
 193 #elif defined( WIN32 ) || defined( UNDER_CE )
 194     mtime_t usec_time, delay;
 195
 196     usec_time = mdate();
 197     delay = date - usec_time;
 198     if( delay <= 0 )
 199     {
 200         return;
 201     }
 202     msleep( delay );
 203
 204 #else
 205
 206     struct timeval tv_date;
 207     mtime_t        delay;          /* delay in msec, signed to detect errors */
 208
 209     /* see mdate() about gettimeofday() possible errors */
 210     gettimeofday( &tv_date, NULL );
 211
 212     /* calculate delay and check if current date is before wished date */
 213     delay = date - (mtime_t) tv_date.tv_sec * 1000000
 214                  - (mtime_t) tv_date.tv_usec
 215                  - 10000;
 216
 217     /* Linux/i386 has a granularity of 10 ms. It's better to be in advance
 218      * than to be late. */
 219     if( delay <= 0 )                 /* wished date is now or already passed */
 220     {
 221         return;
 222     }
 223
 224 #   if defined( PTH_INIT_IN_PTH_H )
 225     pth_usleep( delay );
 226
 227 #   elif defined( ST_INIT_IN_ST_H )
 228     st_usleep( delay );
 229
 230 #   else
 231
 232 #       if defined( HAVE_NANOSLEEP )
 233     {
 234         struct timespec ts_delay;
 235         ts_delay.tv_sec = delay / 1000000;
 236         ts_delay.tv_nsec = (delay % 1000000) * 1000;
 237
 238         nanosleep( &ts_delay, NULL );
 239     }
 240
 241 #       else
 242     tv_date.tv_sec = delay / 1000000;
 243     tv_date.tv_usec = delay % 1000000;
 244     /* see msleep() about select() errors */
 245     select( 0, NULL, NULL, NULL, &tv_date );
 246 #       endif
 247
 248 #   endif
 249
 250 #endif
 251 }
 252
 253 /**
 254  * More precise sleep()
 255  *
 256  * Portable usleep() function.
 257  * \param delay the amount of time to sleep
 258  */
 259 void msleep( mtime_t delay )
 260 {
 261 #if defined( HAVE_KERNEL_OS_H )
 262     snooze( delay );
 263
 264 #elif defined( PTH_INIT_IN_PTH_H )
 265     pth_usleep( delay );
 266
 267 #elif defined( ST_INIT_IN_ST_H )
 268     st_usleep( delay );
 269
 270 #elif defined( WIN32 ) || defined( UNDER_CE )
 271     Sleep( (int) (delay / 1000) );
 272
 273 #elif defined( HAVE_NANOSLEEP )
 274     struct timespec ts_delay;
 275
 276     ts_delay.tv_sec = delay / 1000000;
 277     ts_delay.tv_nsec = (delay % 1000000) * 1000;
 278
 279     nanosleep( &ts_delay, NULL );
 280
 281 #else
 282     struct timeval tv_delay;
 283
 284     tv_delay.tv_sec = delay / 1000000;
 285     tv_delay.tv_usec = delay % 1000000;
 286
 287     /* select() return value should be tested, since several possible errors
 288      * can occur. However, they should only happen in very particular occasions
 289      * (i.e. when a signal is sent to the thread, or when memory is full), and
 290      * can be ignored. */
 291     select( 0, NULL, NULL, NULL, &tv_delay );
 292
 293 #endif
 294 }
 295