f75ab82b46
To support libraries and dependencies compatible with absl way of debug printing custom types. In particular gtest can use AbslStringify to produce nice output when unit types are compared with EXPECT macros. Bug: None Change-Id: Ie78293a225f61977f256f0234e07d166b1977e2d Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/364162 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Commit-Queue: Danil Chapovalov <danilchap@webrtc.org> Cr-Commit-Position: refs/heads/main@{#43164}
101 lines
3.1 KiB
C++
101 lines
3.1 KiB
C++
/*
|
|
* Copyright (c) 2019 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
#ifndef API_UNITS_FREQUENCY_H_
|
|
#define API_UNITS_FREQUENCY_H_
|
|
|
|
#include <cstdint>
|
|
#include <cstdlib>
|
|
#include <limits>
|
|
#include <string>
|
|
#include <type_traits>
|
|
|
|
#include "api/units/time_delta.h"
|
|
#include "rtc_base/checks.h"
|
|
#include "rtc_base/system/rtc_export.h"
|
|
#include "rtc_base/units/unit_base.h" // IWYU pragma: export
|
|
|
|
namespace webrtc {
|
|
|
|
class Frequency final : public rtc_units_impl::RelativeUnit<Frequency> {
|
|
public:
|
|
template <typename T>
|
|
static constexpr Frequency MilliHertz(T value) {
|
|
static_assert(std::is_arithmetic<T>::value, "");
|
|
return FromValue(value);
|
|
}
|
|
template <typename T>
|
|
static constexpr Frequency Hertz(T value) {
|
|
static_assert(std::is_arithmetic<T>::value, "");
|
|
return FromFraction(1'000, value);
|
|
}
|
|
template <typename T>
|
|
static constexpr Frequency KiloHertz(T value) {
|
|
static_assert(std::is_arithmetic<T>::value, "");
|
|
return FromFraction(1'000'000, value);
|
|
}
|
|
|
|
Frequency() = delete;
|
|
|
|
template <typename Sink>
|
|
friend void AbslStringify(Sink& sink, Frequency value);
|
|
|
|
template <typename T = int64_t>
|
|
constexpr T hertz() const {
|
|
return ToFraction<1000, T>();
|
|
}
|
|
template <typename T = int64_t>
|
|
constexpr T millihertz() const {
|
|
return ToValue<T>();
|
|
}
|
|
|
|
private:
|
|
friend class rtc_units_impl::UnitBase<Frequency>;
|
|
using RelativeUnit::RelativeUnit;
|
|
static constexpr bool one_sided = true;
|
|
};
|
|
|
|
inline constexpr Frequency operator/(int64_t nominator,
|
|
const TimeDelta& interval) {
|
|
constexpr int64_t kKiloPerMicro = 1000 * 1000000;
|
|
RTC_DCHECK_LE(nominator, std::numeric_limits<int64_t>::max() / kKiloPerMicro);
|
|
RTC_CHECK(interval.IsFinite());
|
|
RTC_CHECK(!interval.IsZero());
|
|
return Frequency::MilliHertz(nominator * kKiloPerMicro / interval.us());
|
|
}
|
|
|
|
inline constexpr TimeDelta operator/(int64_t nominator,
|
|
const Frequency& frequency) {
|
|
constexpr int64_t kMegaPerMilli = 1000000 * 1000;
|
|
RTC_DCHECK_LE(nominator, std::numeric_limits<int64_t>::max() / kMegaPerMilli);
|
|
RTC_CHECK(frequency.IsFinite());
|
|
RTC_CHECK(!frequency.IsZero());
|
|
return TimeDelta::Micros(nominator * kMegaPerMilli / frequency.millihertz());
|
|
}
|
|
|
|
inline constexpr double operator*(Frequency frequency, TimeDelta time_delta) {
|
|
return frequency.hertz<double>() * time_delta.seconds<double>();
|
|
}
|
|
inline constexpr double operator*(TimeDelta time_delta, Frequency frequency) {
|
|
return frequency * time_delta;
|
|
}
|
|
|
|
RTC_EXPORT std::string ToString(Frequency value);
|
|
inline std::string ToLogString(Frequency value) {
|
|
return ToString(value);
|
|
}
|
|
|
|
template <typename Sink>
|
|
void AbslStringify(Sink& sink, Frequency value) {
|
|
sink.Append(ToString(value));
|
|
}
|
|
|
|
} // namespace webrtc
|
|
#endif // API_UNITS_FREQUENCY_H_
|