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