hart_units.hpp

Go to the documentation of this file.

#pragma once
 
// Define this macro if those literals clash with existing ones in your codebase
#ifndef HART_DO_NOT_ADD_UNITS
 
#include "hart_utils.hpp"                  // pi, decibelsToRatio(), ratioToDecibels()
 
/// @defgroup Units Units
/// @brief Better readability
/// @{
 
namespace hart
{
 
/// @brief Represents a physical unit
/// @details You might want to use those without namespace, like `someMetric (...).as (dB)`.
/// If you're on C++17 or earlier, you can use the `HART_DECLARE_ALIASES_FOR_UNITS` macro.
/// For C++20 an on, you can just use `using enum Unit`.
/// @note New units may be introduced here, whenever necessary
enum class Unit
{
    native,  ///< Default (native) unit of whatever returns some value 
    linear,  ///< Value of a sample (voltage) in a linear domain
    dB,  ///< Value of something in decibels. Can represent voltage, power, or a domain-specific unit like "LUFS" or "dB TP"
    frames,  ///< Value of something in frames (samples)
    seconds,  ///< Time stamps, intervals, durations
    Hz,  ///< Hertz
    ratio,  ///< Generic ratio
    none  ///< Unitless value
};
 
}  // namespace hart
 
/// @brief Pre-C++20 macro to use units without namespace
/// @details For C++20 and later, you can just use `using enum Unit`
#define HART_DECLARE_ALIASES_FOR_UNITS
    constexpr hart::Unit native = hart::Unit::native;
    constexpr hart::Unit linear = hart::Unit::linear;
    constexpr hart::Unit dB = hart::Unit::dB;
    constexpr hart::Unit frames = hart::Unit::frames;
    constexpr hart::Unit seconds = hart::Unit::seconds;
    constexpr hart::Unit Hz = hart::Unit::Hz;
    constexpr hart::Unit ratio = hart::Unit::ratio;
    constexpr hart::Unit none = hart::Unit::none;
 
constexpr double inf_dB = hart::inf;
constexpr double oo_dB = hart::inf;
constexpr double pi_rad = hart::pi;
constexpr double twoPi_rad = hart::twoPi;
constexpr double halfPi_rad = hart::halfPi;
 
constexpr double operator"" _s (long double val) { return static_cast<double> (val); }
constexpr double operator"" _s (unsigned long long int val) { return static_cast<double> (val); }
constexpr double operator"" _ms (long double val) { return static_cast<double> (1e-3 * val); }
constexpr double operator"" _ms (unsigned long long int val) { return static_cast<double> (1e-3 * val); }
constexpr double operator"" _us (long double val) { return static_cast<double> (1e-6 * val); }
constexpr double operator"" _us (unsigned long long int val) { return static_cast<double> (1e-6 * val); }
constexpr double operator"" _ns (long double val) { return static_cast<double> (1e-9 * val); }
constexpr double operator"" _ns (unsigned long long int val) { return static_cast<double> (1e-9 * val); }
constexpr double operator"" _dB (long double val) { return static_cast<double> (val); }
constexpr double operator"" _dB (unsigned long long int val) { return static_cast<double> (val); }
constexpr double operator"" _dBTP (long double val) { return static_cast<double> (val); }
constexpr double operator"" _dBTP (unsigned long long int val) { return static_cast<double> (val); }
constexpr double operator"" _Hz (long double val) { return static_cast<double> (val); }
constexpr double operator"" _Hz (unsigned long long int val) { return static_cast<double> (val); }
constexpr double operator"" _kHz (long double val) { return static_cast<double> (1e3 * val); }
constexpr double operator"" _kHz (unsigned long long val) { return static_cast<double> (1e3 * val); }
constexpr double operator"" _rad (long double val) { return static_cast<double> (val); }
constexpr double operator"" _rad (unsigned long long val) { return static_cast<double>(val); }
constexpr double operator"" _deg (long double val) { return static_cast<double> (val * hart::pi / 180.0); }
constexpr double operator"" _deg (unsigned long long val) { return static_cast<double>(val) * hart::pi / 180.0; }
constexpr double operator"" _cents (long double val) { return static_cast<double> (val); }
constexpr double operator"" _cents (unsigned long long val) { return static_cast<double>(val); }
 
inline double operator"" _dB_as_ratio (long double val) { return hart::decibelsToRatio (static_cast<double> (val)); }
inline double operator"" _dB_as_ratio (unsigned long long int val) { return hart::decibelsToRatio (static_cast<double> (val)); }
inline double operator"" _ratio_as_dB (long double val) { return hart::ratioToDecibels (static_cast<double> (val)); }
inline double operator"" _ratio_as_dB (unsigned long long int val) { return hart::ratioToDecibels (static_cast<double> (val)); }
 
// TODO: percent <-> ratio conversions
 
/// @}
 
#endif  // HART_DO_NOT_ADD_UNITS