[deb_ffmpeg.git] / ffmpeg / libavutil / time.h

/*
 * Copyright (c) 2000-2003 Fabrice Bellard
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef AVUTIL_TIME_H
#define AVUTIL_TIME_H

#include <stdint.h>

/**
 * Get the current time in microseconds.
 */
int64_t av_gettime(void);

/**
 * Get the current time in microseconds since some unspecified starting point.
 * On platforms that support it, the time comes from a monotonic clock
 * This property makes this time source ideal for measuring relative time.
 * The returned values may not be monotonic on platforms where a monotonic
 * clock is not available.
 */
int64_t av_gettime_relative(void);

/**
 * Indicates with a boolean result if the av_gettime_relative() time source
 * is monotonic.
 */
int av_gettime_relative_is_monotonic(void);

/**
 * Sleep for a period of time.  Although the duration is expressed in
 * microseconds, the actual delay may be rounded to the precision of the
 * system timer.
 *
 * @param  usec Number of microseconds to sleep.
 * @return zero on success or (negative) error code.
 */
int av_usleep(unsigned usec);

#endif /* AVUTIL_TIME_H */
Commit	Line	Data
2ba45a60 DM	1	/*
	2	* Copyright (c) 2000-2003 Fabrice Bellard
	3	*
	4	* This file is part of FFmpeg.
	5	*
	6	* FFmpeg is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU Lesser General Public
	8	* License as published by the Free Software Foundation; either
	9	* version 2.1 of the License, or (at your option) any later version.
	10	*
	11	* FFmpeg is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	* Lesser General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU Lesser General Public
	17	* License along with FFmpeg; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef AVUTIL_TIME_H
	22	#define AVUTIL_TIME_H
	23
	24	#include <stdint.h>
	25
	26	/**
	27	* Get the current time in microseconds.
	28	*/
	29	int64_t av_gettime(void);
	30
	31	/**
	32	* Get the current time in microseconds since some unspecified starting point.
	33	* On platforms that support it, the time comes from a monotonic clock
	34	* This property makes this time source ideal for measuring relative time.
f6fa7814 DM	35	* The returned values may not be monotonic on platforms where a monotonic
f6fa7814 DM	36	* clock is not available.
2ba45a60 DM	37	*/
	38	int64_t av_gettime_relative(void);
	39
	40	/**
	41	* Indicates with a boolean result if the av_gettime_relative() time source
	42	* is monotonic.
	43	*/
	44	int av_gettime_relative_is_monotonic(void);
	45
	46	/**
	47	* Sleep for a period of time. Although the duration is expressed in
	48	* microseconds, the actual delay may be rounded to the precision of the
	49	* system timer.
	50	*
	51	* @param usec Number of microseconds to sleep.
	52	* @return zero on success or (negative) error code.
	53	*/
	54	int av_usleep(unsigned usec);
	55
	56	#endif /* AVUTIL_TIME_H */