]> git.sesse.net Git - vlc/blobdiff - include/mtime.h
Rename all sout_Cfg* stuff to config_Chain* (as it isn't really sout specific)
[vlc] / include / mtime.h
index a3bc2a0d837f3dffe5cea848c6b8458691121645..458cf35d35ada05935dd81441f937af8fd91adbc 100644 (file)
@@ -1,7 +1,5 @@
 /*****************************************************************************
- * mtime.h: high rezolution time management functions
- * (c)1999 VideoLAN
- *****************************************************************************
+ * mtime.h: high resolution time management functions
  * This header provides portable high precision time management functions,
  * which should be the only ones used in other segments of the program, since
  * functions like gettimeofday() and ftime() are not always supported.
  * 'm' stands for 'micro', since maximum resolution is the microsecond.
  * Functions prototyped are implemented in interface/mtime.c.
  *****************************************************************************
- * Required headers:
- *  none
- * this header includes inline functions
- *****************************************************************************/
-
-/*****************************************************************************
- * mtime_t: high precision date or time interval
- *****************************************************************************
- * Store an high precision date or time interval. The maximum precision is the
- * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
- * time interval is then 292271 years, which should be length enough for any
- * video). Date are stored as a time interval since a common date.
- * Note that date and time intervals can be manipulated using regular arithmetic
- * operators, and that no special functions are required.
+ * Copyright (C) 1996, 1997, 1998, 1999, 2000 the VideoLAN team
+ * $Id$
+ *
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
-typedef s64 mtime_t;
 
 /*****************************************************************************
  * LAST_MDATE: date which will never happen
@@ -35,7 +36,7 @@ typedef s64 mtime_t;
  * returning the date of the first image to be displayed. It can be used in
  * comparaison with other values: all existing dates will be earlier.
  *****************************************************************************/
-#define LAST_MDATE ((mtime_t)((u64)(-1)/2))
+#define LAST_MDATE ((mtime_t)((uint64_t)(-1)/2))
 
 /*****************************************************************************
  * MSTRTIME_MAX_SIZE: maximum possible size of mstrtime
@@ -46,10 +47,37 @@ typedef s64 mtime_t;
  *****************************************************************************/
 #define MSTRTIME_MAX_SIZE 22
 
+/* Well, Duh? But it does clue us in that we are converting from
+   millisecond quantity to a second quantity or vice versa.
+*/
+#define MILLISECONDS_PER_SEC 1000
+
+#define msecstotimestr(psz_buffer, msecs) \
+  secstotimestr( psz_buffer, (msecs / (int) MILLISECONDS_PER_SEC) )
+
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-char *  mstrtime ( char *psz_buffer, mtime_t date );
-mtime_t mdate    ( void );
-void    mwait    ( mtime_t date );
-void    msleep   ( mtime_t delay );
+VLC_EXPORT( char *,  mstrtime, ( char *psz_buffer, mtime_t date ) );
+VLC_EXPORT( mtime_t, mdate,    ( void ) );
+VLC_EXPORT( void,    mwait,    ( mtime_t date ) );
+VLC_EXPORT( void,    msleep,   ( mtime_t delay ) );
+VLC_EXPORT( char *,  secstotimestr, ( char *psz_buffer, int secs ) );
+
+/*****************************************************************************
+ * date_t: date incrementation without long-term rounding errors
+ *****************************************************************************/
+struct date_t
+{
+    mtime_t  date;
+    uint32_t i_divider_num;
+    uint32_t i_divider_den;
+    uint32_t i_remainder;
+};
+
+VLC_EXPORT( void,    date_Init,      ( date_t *, uint32_t, uint32_t ) );
+VLC_EXPORT( void,    date_Change,    ( date_t *, uint32_t, uint32_t ) );
+VLC_EXPORT( void,    date_Set,       ( date_t *, mtime_t ) );
+VLC_EXPORT( mtime_t, date_Get,       ( const date_t * ) );
+VLC_EXPORT( void,    date_Move,      ( date_t *, mtime_t ) );
+VLC_EXPORT( mtime_t, date_Increment, ( date_t *, uint32_t ) );