Home | History | Annotate | Download | only in pulse
      1 #ifndef footimevalhfoo
      2 #define footimevalhfoo
      3 
      4 /* $Id: timeval.h 1971 2007-10-28 19:13:50Z lennart $ */
      5 
      6 /***
      7   This file is part of PulseAudio.
      8 
      9   Copyright 2004-2006 Lennart Poettering
     10   Copyright 2006 Pierre Ossman <ossman (at) cendio.se> for Cendio AB
     11 
     12   PulseAudio is free software; you can redistribute it and/or modify
     13   it under the terms of the GNU Lesser General Public License as
     14   published by the Free Software Foundation; either version 2.1 of the
     15   License, or (at your option) any later version.
     16 
     17   PulseAudio is distributed in the hope that it will be useful, but
     18   WITHOUT ANY WARRANTY; without even the implied warranty of
     19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     20   Lesser General Public License for more details.
     21 
     22   You should have received a copy of the GNU Lesser General Public
     23   License along with PulseAudio; if not, write to the Free Software
     24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
     25   USA.
     26 ***/
     27 
     28 #include <pulse/cdecl.h>
     29 #include <pulse/sample.h>
     30 
     31 /** \file
     32  * Utility functions for handling timeval calculations */
     33 
     34 PA_C_DECL_BEGIN
     35 
     36 #define PA_MSEC_PER_SEC 1000
     37 #define PA_USEC_PER_SEC 1000000
     38 #define PA_NSEC_PER_SEC 1000000000
     39 #define PA_USEC_PER_MSEC 1000
     40 
     41 struct timeval;
     42 
     43 /** Return the current timestamp, just like UNIX gettimeofday() */
     44 struct timeval *pa_gettimeofday(struct timeval *tv);
     45 
     46 /** Calculate the difference between the two specified timeval
     47  * structs. */
     48 pa_usec_t pa_timeval_diff(const struct timeval *a, const struct timeval *b) PA_GCC_PURE;
     49 
     50 /** Compare the two timeval structs and return 0 when equal, negative when a < b, positive otherwse */
     51 int pa_timeval_cmp(const struct timeval *a, const struct timeval *b) PA_GCC_PURE;
     52 
     53 /** Return the time difference between now and the specified timestamp */
     54 pa_usec_t pa_timeval_age(const struct timeval *tv);
     55 
     56 /** Add the specified time inmicroseconds to the specified timeval structure */
     57 struct timeval* pa_timeval_add(struct timeval *tv, pa_usec_t v) PA_GCC_PURE;
     58 
     59 /** Store the specified uec value in the timeval struct. \since 0.9.7 */
     60 struct timeval* pa_timeval_store(struct timeval *tv, pa_usec_t v);
     61 
     62 /** Load the specified tv value and return it in usec. \since 0.9.7 */
     63 pa_usec_t pa_timeval_load(const struct timeval *tv);
     64 
     65 PA_C_DECL_END
     66 
     67 #endif
     68