blob: 735af4a9f46c6dd1d610f4fe2b564104bb599e6d [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001/*
2 * Copyright 2005 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11#ifndef WEBRTC_BASE_TIMEUTILS_H_
12#define WEBRTC_BASE_TIMEUTILS_H_
13
pbosc7c26a02017-01-02 08:42:32 -080014#include <stdint.h>
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000015#include <time.h>
16
pbosc7c26a02017-01-02 08:42:32 -080017#include <ctime>
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000018
19namespace rtc {
20
Peter Boström0c4e06b2015-10-07 12:23:21 +020021static const int64_t kNumMillisecsPerSec = INT64_C(1000);
22static const int64_t kNumMicrosecsPerSec = INT64_C(1000000);
23static const int64_t kNumNanosecsPerSec = INT64_C(1000000000);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000024
Peter Boström0c4e06b2015-10-07 12:23:21 +020025static const int64_t kNumMicrosecsPerMillisec =
26 kNumMicrosecsPerSec / kNumMillisecsPerSec;
27static const int64_t kNumNanosecsPerMillisec =
28 kNumNanosecsPerSec / kNumMillisecsPerSec;
29static const int64_t kNumNanosecsPerMicrosec =
30 kNumNanosecsPerSec / kNumMicrosecsPerSec;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000031
Honghai Zhang82d78622016-05-06 11:29:15 -070032// TODO(honghaiz): Define a type for the time value specifically.
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000033
Taylor Brandstetterb3c68102016-05-27 14:15:43 -070034class ClockInterface {
35 public:
36 virtual ~ClockInterface() {}
nissedeb95f32016-11-28 01:54:54 -080037 virtual int64_t TimeNanos() const = 0;
Taylor Brandstetterb3c68102016-05-27 14:15:43 -070038};
39
40// Sets the global source of time. This is useful mainly for unit tests.
41//
deadbeeff5f03e82016-06-06 11:16:06 -070042// Returns the previously set ClockInterface, or nullptr if none is set.
43//
44// Does not transfer ownership of the clock. SetClockForTesting(nullptr)
45// should be called before the ClockInterface is deleted.
Taylor Brandstetterb3c68102016-05-27 14:15:43 -070046//
47// This method is not thread-safe; it should only be used when no other thread
48// is running (for example, at the start/end of a unit test, or start/end of
49// main()).
50//
51// TODO(deadbeef): Instead of having functions that access this global
52// ClockInterface, we may want to pass the ClockInterface into everything
53// that uses it, eliminating the need for a global variable and this function.
deadbeeff5f03e82016-06-06 11:16:06 -070054ClockInterface* SetClockForTesting(ClockInterface* clock);
Taylor Brandstetterb3c68102016-05-27 14:15:43 -070055
deadbeef22e08142017-06-12 14:30:28 -070056// Returns previously set clock, or nullptr if no custom clock is being used.
57ClockInterface* GetClockForTesting();
58
Taylor Brandstetter4f0dfbd2016-06-15 17:15:23 -070059// Returns the actual system time, even if a clock is set for testing.
60// Useful for timeouts while using a test clock, or for logging.
nissedeb95f32016-11-28 01:54:54 -080061int64_t SystemTimeNanos();
Taylor Brandstetter4f0dfbd2016-06-15 17:15:23 -070062int64_t SystemTimeMillis();
63
honghaiz34b11eb2016-03-16 08:55:44 -070064// Returns the current time in milliseconds in 32 bits.
65uint32_t Time32();
66
67// Returns the current time in milliseconds in 64 bits.
nisse1bffc1d2016-05-02 08:18:55 -070068int64_t TimeMillis();
Honghai Zhang82d78622016-05-06 11:29:15 -070069// Deprecated. Do not use this in any new code.
70inline int64_t Time() {
71 return TimeMillis();
honghaiz34b11eb2016-03-16 08:55:44 -070072}
73
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000074// Returns the current time in microseconds.
nissedeb95f32016-11-28 01:54:54 -080075int64_t TimeMicros();
Honghai Zhang82d78622016-05-06 11:29:15 -070076
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000077// Returns the current time in nanoseconds.
nissedeb95f32016-11-28 01:54:54 -080078int64_t TimeNanos();
79
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000080
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000081// Returns a future timestamp, 'elapsed' milliseconds from now.
Honghai Zhang82d78622016-05-06 11:29:15 -070082int64_t TimeAfter(int64_t elapsed);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000083
84// Number of milliseconds that would elapse between 'earlier' and 'later'
85// timestamps. The value is negative if 'later' occurs before 'earlier'.
Honghai Zhang82d78622016-05-06 11:29:15 -070086int64_t TimeDiff(int64_t later, int64_t earlier);
87int32_t TimeDiff32(uint32_t later, uint32_t earlier);
honghaiz34b11eb2016-03-16 08:55:44 -070088
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000089// The number of milliseconds that have elapsed since 'earlier'.
Honghai Zhang82d78622016-05-06 11:29:15 -070090inline int64_t TimeSince(int64_t earlier) {
91 return TimeMillis() - earlier;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000092}
93
94// The number of milliseconds that will elapse between now and 'later'.
nissedeb95f32016-11-28 01:54:54 -080095inline int64_t TimeUntil(int64_t later) {
Honghai Zhang82d78622016-05-06 11:29:15 -070096 return later - TimeMillis();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000097}
98
henrike@webrtc.org99b41622014-05-21 20:42:17 +000099class TimestampWrapAroundHandler {
100 public:
101 TimestampWrapAroundHandler();
102
Peter Boström0c4e06b2015-10-07 12:23:21 +0200103 int64_t Unwrap(uint32_t ts);
henrike@webrtc.org99b41622014-05-21 20:42:17 +0000104
105 private:
Peter Boström0c4e06b2015-10-07 12:23:21 +0200106 uint32_t last_ts_;
107 int64_t num_wrap_;
henrike@webrtc.org99b41622014-05-21 20:42:17 +0000108};
109
Torbjorn Granlund46c9cc02015-12-01 13:06:34 +0100110// Convert from std::tm, which is relative to 1900-01-01 00:00 to number of
111// seconds from 1970-01-01 00:00 ("epoch"). Don't return time_t since that
112// is still 32 bits on many systems.
113int64_t TmToSeconds(const std::tm& tm);
114
nissecdf37a92016-09-13 23:41:47 -0700115// Return the number of microseconds since January 1, 1970, UTC.
116// Useful mainly when producing logs to be correlated with other
117// devices, and when the devices in question all have properly
118// synchronized clocks.
119//
120// Note that this function obeys the system's idea about what the time
121// is. It is not guaranteed to be monotonic; it will jump in case the
122// system time is changed, e.g., by some other process calling
123// settimeofday. Always use rtc::TimeMicros(), not this function, for
124// measuring time intervals and timeouts.
125int64_t TimeUTCMicros();
126
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000127} // namespace rtc
128
129#endif // WEBRTC_BASE_TIMEUTILS_H_