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

   1 /*****************************************************************************
   2  * mtime.c: high rezolution time management functions
   3  * Functions are prototyped in mtime.h.
   4  *****************************************************************************
   5  * Copyright (C) 1998, 1999, 2000 VideoLAN
   6  *
   7  * Authors:
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this program; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, 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 #include <unistd.h>                                              /* select() */
  35 #include <sys/time.h>
  36
  37 #include "common.h"
  38 #include "mtime.h"
  39
  40 /*****************************************************************************
  41  * mstrtime: return a date in a readable format
  42  *****************************************************************************
  43  * This functions is provided for any interface function which need to print a
  44  * date. psz_buffer should be a buffer long enough to store the formatted
  45  * date.
  46  *****************************************************************************/
  47 char *mstrtime( char *psz_buffer, mtime_t date )
  48 {
  49     sprintf( psz_buffer, "%02d:%02d:%02d-%03d.%03d",
  50              (int) (date / (1000LL * 1000LL * 60LL * 60LL) % 24LL),
  51              (int) (date / (1000LL * 1000LL * 60LL) % 60LL),
  52              (int) (date / (1000LL * 1000LL) % 60LL),
  53              (int) (date / 1000LL % 1000LL),
  54              (int) (date % 1000LL) );
  55     return( psz_buffer );
  56 }
  57
  58 /*****************************************************************************
  59  * mdate: return high precision date (inline function)
  60  *****************************************************************************
  61  * Uses the gettimeofday() function when possible (1 MHz resolution) or the
  62  * ftime() function (1 kHz resolution).
  63  *****************************************************************************/
  64 mtime_t mdate( void )
  65 {
  66     struct timeval tv_date;
  67
  68     /* gettimeofday() could return an error, and should be tested. However, the
  69      * only possible error, according to 'man', is EFAULT, which can not happen
  70      * here, since tv is a local variable. */
  71     gettimeofday( &tv_date, NULL );
  72     return( (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec );
  73 }
  74
  75 /*****************************************************************************
  76  * mwait: wait for a date (inline function)
  77  *****************************************************************************
  78  * This function uses select() and an system date function to wake up at a
  79  * precise date. It should be used for process synchronization. If current date
  80  * is posterior to wished date, the function returns immediately.
  81  *****************************************************************************/
  82 void mwait( mtime_t date )
  83 {
  84     struct timeval tv_date, tv_delay;
  85     mtime_t        delay;          /* delay in msec, signed to detect errors */
  86
  87     /* see mdate() about gettimeofday() possible errors */
  88     gettimeofday( &tv_date, NULL );
  89
  90     /* calculate delay and check if current date is before wished date */
  91     delay = date - (mtime_t) tv_date.tv_sec * 1000000 - (mtime_t) tv_date.tv_usec;
  92     if( delay <= 0 )                 /* wished date is now or already passed */
  93     {
  94         return;
  95     }
  96 #ifndef usleep
  97     tv_delay.tv_sec = delay / 1000000;
  98     tv_delay.tv_usec = delay % 1000000;
  99
 100     /* see msleep() about select() errors */
 101     select( 0, NULL, NULL, NULL, &tv_delay );
 102 #else
 103     usleep( delay );
 104 #endif
 105 }
 106
 107 /*****************************************************************************
 108  * msleep: more precise sleep() (inline function)                        (ok ?)
 109  *****************************************************************************
 110  * Portable usleep() function.
 111  *****************************************************************************/
 112 void msleep( mtime_t delay )
 113 {
 114 #ifndef usleep
 115     struct timeval tv_delay;
 116
 117     tv_delay.tv_sec = delay / 1000000;
 118     tv_delay.tv_usec = delay % 1000000;
 119     /* select() return value should be tested, since several possible errors
 120      * can occur. However, they should only happen in very particular occasions
 121      * (i.e. when a signal is sent to the thread, or when memory is full), and
 122      * can be ingnored. */
 123     select( 0, NULL, NULL, NULL, &tv_delay );
 124 #else
 125     usleep( delay );
 126 #endif
 127 }