file_path
stringlengths 21
202
| content
stringlengths 19
1.02M
| size
int64 19
1.02M
| lang
stringclasses 8
values | avg_line_length
float64 5.88
100
| max_line_length
int64 12
993
| alphanum_fraction
float64 0.27
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/include/carb/cpp20/Memory.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "../cpp17/Memory.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp20
{
using ::carb::cpp::construct_at;
} // namespace cpp20
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({ static_assert(std::is_function<decltype(carb::cpp20::construct_at<bool>)>::value, ""); });
| 857 | C | 28.586206 | 117 | 0.756126 |
omniverse-code/kit/include/carb/cpp20/TypeTraits.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "../cpp17/TypeTraits.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
//! (Deprecated) Namespace for C++20 features using C++14 semantics. Use \ref carb::cpp instead.
namespace cpp20
{
using ::carb::cpp::is_nothrow_convertible;
using ::carb::cpp::remove_cvref;
using ::carb::cpp::remove_cvref_t;
using ::carb::cpp::type_identity;
using ::carb::cpp::type_identity_t;
} // namespace cpp20
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
static_assert(carb::cpp20::is_nothrow_convertible<bool, int>::value, "1");
static_assert(std::is_same<int, carb::cpp20::remove_cvref<const int&>::type>::value, "2");
static_assert(std::is_same<int, carb::cpp20::remove_cvref_t<const int&>>::value, "3");
static_assert(std::is_same<int, carb::cpp20::type_identity<int>::type>::value, "4");
static_assert(std::is_same<int, carb::cpp20::type_identity_t<int>>::value, "4");
});
| 1,458 | C | 35.474999 | 96 | 0.722222 |
omniverse-code/kit/include/carb/cpp20/Barrier.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "Atomic.h"
#include "Bit.h"
#include "../cpp/Barrier.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp20
{
using ::carb::cpp::barrier;
}
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({ carb::cpp20::barrier<> val{ 5 }; });
| 815 | C | 25.32258 | 85 | 0.75092 |
omniverse-code/kit/include/carb/cpp20/Span.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "TypeTraits.h"
#include "../cpp17/StdDef.h"
#include "../cpp/Span.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp20
{
using ::carb::cpp::data; // From ImplData.h
using ::carb::cpp::dynamic_extent;
using ::carb::cpp::span;
} // namespace cpp20
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
static_assert(std::is_function<decltype(carb::cpp20::data<int, 5>)>::value, "");
static_assert(carb::cpp20::dynamic_extent == size_t(-1), "");
static_assert(std::is_class<carb::cpp20::span<int, 5>>::value, "");
});
| 1,113 | C | 29.108107 | 85 | 0.72327 |
omniverse-code/kit/include/carb/cpp20/Bit.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "TypeTraits.h"
#include "../cpp/Bit.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp20
{
using ::carb::cpp::bit_cast;
using ::carb::cpp::bit_ceil;
using ::carb::cpp::bit_floor;
using ::carb::cpp::countl_zero;
using ::carb::cpp::countr_zero;
using ::carb::cpp::endian;
using ::carb::cpp::has_single_bit;
using ::carb::cpp::popcount;
} // namespace cpp20
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
static_assert(std::is_function<decltype(carb::cpp20::bit_cast<int, unsigned>)>::value, "1");
static_assert(std::is_function<decltype(carb::cpp20::bit_ceil<unsigned>)>::value, "2");
static_assert(std::is_function<decltype(carb::cpp20::bit_floor<unsigned>)>::value, "3");
static_assert(std::is_function<decltype(carb::cpp20::countl_zero<unsigned>)>::value, "4");
static_assert(std::is_function<decltype(carb::cpp20::countr_zero<unsigned>)>::value, "5");
static_assert(std::is_enum<carb::cpp20::endian>::value, "6");
static_assert(std::is_function<decltype(carb::cpp20::has_single_bit<unsigned>)>::value, "7");
static_assert(std::is_function<decltype(carb::cpp20::popcount<unsigned>)>::value, "8");
});
| 1,727 | C | 36.565217 | 97 | 0.717429 |
omniverse-code/kit/include/carb/cpp20/Atomic.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "../cpp/Atomic.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp20
{
using ::carb::cpp::atomic;
using ::carb::cpp::atomic_bool;
using ::carb::cpp::atomic_char;
using ::carb::cpp::atomic_char16_t;
using ::carb::cpp::atomic_char32_t;
using ::carb::cpp::atomic_int;
using ::carb::cpp::atomic_int16_t;
using ::carb::cpp::atomic_int32_t;
using ::carb::cpp::atomic_int64_t;
using ::carb::cpp::atomic_int8_t;
using ::carb::cpp::atomic_int_fast16_t;
using ::carb::cpp::atomic_int_fast32_t;
using ::carb::cpp::atomic_int_fast64_t;
using ::carb::cpp::atomic_int_fast8_t;
using ::carb::cpp::atomic_int_least16_t;
using ::carb::cpp::atomic_int_least32_t;
using ::carb::cpp::atomic_int_least64_t;
using ::carb::cpp::atomic_int_least8_t;
using ::carb::cpp::atomic_intmax_t;
using ::carb::cpp::atomic_intptr_t;
using ::carb::cpp::atomic_llong;
using ::carb::cpp::atomic_long;
using ::carb::cpp::atomic_notify_all;
using ::carb::cpp::atomic_notify_one;
using ::carb::cpp::atomic_ptrdiff_t;
using ::carb::cpp::atomic_ref;
using ::carb::cpp::atomic_schar;
using ::carb::cpp::atomic_short;
using ::carb::cpp::atomic_size_t;
using ::carb::cpp::atomic_uchar;
using ::carb::cpp::atomic_uint;
using ::carb::cpp::atomic_uint16_t;
using ::carb::cpp::atomic_uint32_t;
using ::carb::cpp::atomic_uint64_t;
using ::carb::cpp::atomic_uint8_t;
using ::carb::cpp::atomic_uint_fast16_t;
using ::carb::cpp::atomic_uint_fast32_t;
using ::carb::cpp::atomic_uint_fast64_t;
using ::carb::cpp::atomic_uint_fast8_t;
using ::carb::cpp::atomic_uint_least16_t;
using ::carb::cpp::atomic_uint_least32_t;
using ::carb::cpp::atomic_uint_least64_t;
using ::carb::cpp::atomic_uint_least8_t;
using ::carb::cpp::atomic_uintmax_t;
using ::carb::cpp::atomic_uintptr_t;
using ::carb::cpp::atomic_ullong;
using ::carb::cpp::atomic_ulong;
using ::carb::cpp::atomic_ushort;
using ::carb::cpp::atomic_wait;
using ::carb::cpp::atomic_wait_explicit;
using ::carb::cpp::atomic_wchar_t;
} // namespace cpp20
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
static_assert(std::is_class<carb::cpp20::atomic<int>>::value, "1");
static_assert(std::is_class<carb::cpp20::atomic_ref<int>>::value, "2");
static_assert(std::is_function<decltype(carb::cpp20::atomic_wait<int>)>::value, "3");
static_assert(std::is_function<decltype(carb::cpp20::atomic_wait_explicit<int>)>::value, "4");
static_assert(std::is_function<decltype(carb::cpp20::atomic_notify_one<int>)>::value, "5");
static_assert(std::is_function<decltype(carb::cpp20::atomic_notify_all<int>)>::value, "6");
});
| 3,121 | C | 35.302325 | 98 | 0.709388 |
omniverse-code/kit/include/carb/detail/DeferredLoad.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Internal utilities for loading Carbonite functions at runtime.
#include "../Defines.h"
#if !defined(CARB_REQUIRE_LINKED) || defined(DOXYGEN_BUILD)
//! Changes how the `carbReallocate` symbol is acquired.
//!
//! If \c CARB_REQUIRE_LINKED is defined as 1 before this file is included, then Carbonite-provided functions (e.g.
//! `carbReallocate` and `omniGetErrorApi`) will be imported from \e carb.dll or \e libcarb.so and the binary must link
//! against the import library for the module. This can be useful for applications that want to use these functions
//! prior to initializing the framework.
//!
//! If not defined or defined as \c 0, the functions will be marked weakly-linked and the binary need not link against
//! the import library. Attempting to call these functions will dynamically attempt to find then in the already-loaded
//! \e carb module. If it cannot be found a warning will be thrown.
//!
//! \see CARB_DETAIL_DEFINE_DEFERRED_LOAD
//! \see carbReallocate
# define CARB_REQUIRE_LINKED 0
#endif
//! Create a "deferred loader" function.
//!
//! \param fn_name_ The name of the function to define.
//! \param symbol_ The target function to attempt to load.
//! \param type_pack_ The type of the symbol to load as a parenthesized pack. For example, if the target \c symbol_
//! refers to something like `int foo(char, double)`, this would be `(int (*)(char, double))`. The enclosing
//! parenthesis are needed because these arguments contain spaces and commas.
#define CARB_DETAIL_DEFINE_DEFERRED_LOAD(fn_name_, symbol_, type_pack_) \
inline auto fn_name_()->CARB_DEPAREN(type_pack_) \
{ \
CARB_DETAIL_DEFINE_DEFERRED_LOAD_IMPL(symbol_, type_pack_); \
} \
static_assert(true, "follow with ;")
#if CARB_REQUIRE_LINKED || defined DOXYGEN_BUILD
//! \cond DEV
//! Implementation of the function body for \c CARB_DETAIL_DEFINE_DEFERRED_LOAD.
# define CARB_DETAIL_DEFINE_DEFERRED_LOAD_IMPL(symbol_, type_pack_) return &symbol_
//! \endcond DEV
#elif CARB_PLATFORM_LINUX || CARB_PLATFORM_MACOS
# define CARB_DETAIL_DEFINE_DEFERRED_LOAD_IMPL(symbol_, type_pack_) \
auto impl = &symbol_; \
CARB_FATAL_UNLESS(impl != nullptr, "Could not find `" CARB_STRINGIFY( \
symbol_) "` function -- make sure that libcarb.so is loaded"); \
return impl
#elif CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
# define CARB_DETAIL_DEFINE_DEFERRED_LOAD_IMPL(symbol_, type_pack_) \
using TargetSymbolType = CARB_DEPAREN(type_pack_); \
static TargetSymbolType cached_impl = nullptr; \
if (!cached_impl) \
{ \
HMODULE carb_dll_h = GetModuleHandleW(L"carb.dll"); \
CARB_FATAL_UNLESS(carb_dll_h != nullptr, "Could not find `carb.dll` module -- make sure that it is loaded"); \
cached_impl = reinterpret_cast<TargetSymbolType>(GetProcAddress(carb_dll_h, CARB_STRINGIFY(symbol_))); \
CARB_FATAL_UNLESS( \
cached_impl != nullptr, \
"Could not find `" CARB_STRINGIFY( \
symbol_) "` function at runtime -- #define CARB_REQUIRE_LINKED 1 before including this file"); \
} \
return cached_impl
#else
# define CARB_DETAIL_DEFINE_DEFERRED_LOAD_IMPL(symbol_, type_pack_) CARB_UNSUPPORTED_PLATFORM()
#endif
| 5,213 | C | 60.341176 | 122 | 0.502206 |
omniverse-code/kit/include/carb/detail/NoexceptType.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \cond DEV
//! \file
//!
//! \brief Workaround for GCC's \c -Wnoexcept-type warning in pre-C++17.
#pragma once
#include "../Defines.h"
//! \def CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE
//! Push a new layer of diagnostic checks which ignore GCC's \c noexcept-type warning. If this warning is not relevant
//! for the compiler configuration, this does nothing.
//!
//! GCC 7 before C++17 warns you about using a `R(*)(Args...) noexcept` as a type parameter because the mangling will
//! change in C++17. If you do not rely on mangling (as is the case of most inlined code), then this warning can be
//! safely ignored. The only case where an inlined function relies on mangling rules is if you rely on a function-local
//! static to be the same across shared object boundaries between two functions with different `noexcept` specifiers,
//! which is not common. See the GCC bug (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=80985) for additional details.
//!
//! Use of this macro should always be paired with \c CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE.
//!
//! \code
//! void foo() noexcept;
//!
//! CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE()
//! template <typename F>
//! void bar(F f) // <- error would occur here
//! {
//! f();
//! }
//! CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE()
//!
//! int main()
//! {
//! bar(foo); // <- attempt to provide `F = void(*)() noexcept`
//! }
//! \endcode
//!
//! \def CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE
//! The opposite of \c CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE -- pops one layer of diagnostics if push added one. If
//! \c CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE did nothing, then this macro will also do nothing.
#if __cplusplus < 201703L && CARB_COMPILER_GNUC && !CARB_TOOLCHAIN_CLANG && __GNUC__ == 7
# define CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE() CARB_IGNOREWARNING_GNUC_WITH_PUSH("-Wnoexcept-type")
# define CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE() CARB_IGNOREWARNING_GNUC_POP
#else
# define CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE()
# define CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE()
#endif
//! \endcond
| 2,492 | C | 41.254237 | 119 | 0.711878 |
omniverse-code/kit/include/carb/eventdispatcher/EventDispatcherBindingsPython.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "../dictionary/DictionaryBindingsPython.h"
#include "../variant/VariantBindingsPython.h"
#include "IEventDispatcher.h"
namespace carb
{
namespace eventdispatcher
{
inline variant::Variant objectToVariant(const py::handle& o)
{
if (py::isinstance<py::bool_>(o))
{
return variant::Variant(o.cast<bool>());
}
else if (py::isinstance<py::int_>(o))
{
return variant::Variant(o.cast<int64_t>());
}
else if (py::isinstance<py::float_>(o))
{
return variant::Variant(o.cast<double>());
}
else if (py::isinstance<py::str>(o))
{
auto str = o.cast<std::string>();
return variant::Variant(omni::string(str.begin(), str.end()));
}
else
{
return variant::Variant(o.cast<py::object>());
}
}
// Requires the GIL
inline py::object variantToObject(const variant::Variant& v)
{
if (v.data().vtable->typeName == variant::eBool)
{
return py::bool_(v.getValue<bool>().value());
}
else if (v.data().vtable->typeName == variant::eFloat || v.data().vtable->typeName == variant::eDouble)
{
return py::float_(v.getValue<double>().value());
}
else if (v.data().vtable->typeName == variant::eString)
{
omni::string str = v.getValue<omni::string>().value();
return py::str(str.data(), str.length());
}
else if (v.data().vtable->typeName == variant::eCharPtr)
{
const char* p = v.getValue<const char*>().value();
return py::str(p);
}
else if (v.data().vtable->typeName == variant::eDictionary)
{
auto item = v.getValue<const dictionary::Item*>().value();
auto iface = getCachedInterface<dictionary::IDictionary>();
CARB_ASSERT(iface, "Failed to acquire interface IDictionary");
return dictionary::getPyObject(iface, item);
}
else if (v.data().vtable->typeName == variant::PyObjectVTable::get()->typeName)
{
return v.getValue<py::object>().value();
}
else
{
// Try numeric
auto intval = v.getValue<int64_t>();
if (intval)
return py::int_(intval.value());
CARB_LOG_WARN("Unknown type %s to convert to python object; using None", v.data().vtable->typeName.c_str());
CARB_ASSERT(false, "Unknown type %s to convert to python", v.data().vtable->typeName.c_str());
return py::none();
}
}
class PyEvent : public std::enable_shared_from_this<PyEvent>
{
const Event* p;
std::vector<NamedVariant> variants;
CARB_PREVENT_COPY_AND_MOVE(PyEvent);
public:
RString eventName;
PyEvent(const Event& e) : p(&e), eventName(p->eventName)
{
}
void endRef()
{
if (p)
{
// Would use weak_from_this(), but need C++17; check against 2 since shared_from_this() will increase the
// count by one.
if (this->shared_from_this().use_count() > 2)
{
// Need a local copy
variants = { p->variants, p->variants + p->numVariants };
}
p = nullptr;
}
}
bool hasKey(const char* pkey) const
{
RStringKey key(pkey);
if (p)
return p->hasKey(key);
return std::binary_search(variants.begin(), variants.end(), NamedVariant{ key, {} }, detail::NamedVariantLess{});
}
py::object get(const char* pkey) const
{
const variant::Variant* v = nullptr;
RStringKey key(pkey);
if (p)
v = p->get(key);
else
{
auto iter =
std::lower_bound(variants.begin(), variants.end(), NamedVariant{ key, {} }, detail::NamedVariantLess{});
if (iter != variants.end() && iter->name == key)
v = &iter->value;
}
return v ? variantToObject(*v) : py::none();
}
};
using PyEventPtr = std::shared_ptr<PyEvent>;
inline void definePythonModule(py::module& m)
{
m.def("acquire_eventdispatcher_interface", []() { return getCachedInterface<IEventDispatcher>(); },
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>(),
R"(Acquires the Event Dispatcher interface.)");
py::class_<ObserverGuard, std::shared_ptr<ObserverGuard>>(m, "ObserverGuard", R"(ObserverGuard.
Lifetime control for a registered observer. Unregister the observer by calling the reset() function or allowing the
object to be collected.)")
.def("reset", [](ObserverGuard& self) { self.reset(); }, py::call_guard<py::gil_scoped_release>(),
R"(Explicitly stops an observer.
Having this object collected has the same effect, implicitly.
This is safe to perform while dispatching.
Since observers can be in use by this thread or any thread, this function is carefully synchronized with all other
Event Dispatcher operations.
- During `reset()`, further calls to the observer are prevented, even if other threads are currently dispatching an
event that would be observed by the observer in question.
- If any other thread is currently calling the observer in question, `reset()` will wait until all other threads have
left the observer callback function.
- If the observer function is *not* in the backtrace of the current thread, the observer function is immediately
released.
- If the observer function is in the backtrace of the current thread, `reset()` will return without waiting and without
releasing the observer callback. Instead, releasing the function will be performed when the `dispatch_event()` call
in the current thread finishes.
When `reset()` returns, it is guaranteed that the observer callback function will no longer be called and all calls to
it have completed (except if the calling thread is dispatching).)");
py::class_<PyEvent, PyEventPtr>(m, "Event", R"(Event.
Contains the event_name and payload for a dispatched event.
)")
.def_property_readonly("event_name", [](const PyEventPtr& self) { return self->eventName.c_str(); },
py::call_guard<py::gil_scoped_release>(), R"(The name of the event)")
.def("has_key", &PyEvent::hasKey, py::arg("key_name"), py::call_guard<py::gil_scoped_release>(),
R"(Returns True if a given key name is present in the payload.
Args:
key_name: The name of a key to check against the payload.
Returns:
`True` if the key is present in the payload; `False` otherwise.)")
.def("get", &PyEvent::get, py::arg("key_name") /* GIL managed internally */, R"(Accesses a payload item by key name.
Args:
key_name: The name of a key to find in the payload.
Returns:
None if the key is not present, otherwise returns an object representative of the type in the payload.)")
.def("__getitem__", &PyEvent::get, py::arg("key_name") /* GIL managed internally */,
R"(Accesses a payload item by key name.
Args:
key_name: The name of a key to find in the payload.
Returns:
None if the key is not present, otherwise returns an object representative of the type in the payload.)");
py::class_<IEventDispatcher>(m, "IEventDispatcher", R"()")
.def("observe_event",
[](IEventDispatcher* ed, int order, const char* eventName, std::function<void(PyEventPtr)> onEventFn,
py::handle filterDict) {
std::vector<NamedVariant> vec;
if (!filterDict.is_none())
{
auto dict = filterDict.cast<py::dict>();
vec.reserve(dict.size());
for (auto& entry : dict)
{
vec.push_back(
{ RStringKey(entry.first.cast<std::string>().c_str()), objectToVariant(entry.second) });
}
std::sort(vec.begin(), vec.end(), detail::NamedVariantLess{});
}
auto p = new decltype(onEventFn)(std::move(onEventFn));
auto func = [](const Event& e, void* ud) {
// Convert the event
auto event = std::make_shared<PyEvent>(e);
callPythonCodeSafe(*static_cast<decltype(onEventFn)*>(ud), event);
event->endRef();
};
auto cleanup = [](void* ud) { delete static_cast<decltype(onEventFn)*>(ud); };
py::gil_scoped_release nogil;
return ObserverGuard(
ed->internalObserveEvent(order, RString(eventName), vec.size(), vec.data(), func, cleanup, p));
},
py::arg("order") = 0, py::arg("event_name"), py::arg("on_event"), py::arg("filter") = py::none(),
py::return_value_policy::move,
R"(Registers an observer with the Event Dispatcher system.
An observer is a callback that is called whenever :func:`.dispatch_event` is called. The observers are invoked in the
thread that calls `dispatch_event()`, and multiple threads may be calling `dispatch_event()` simultaneously, so
observers must be thread-safe unless the application can ensure synchronization around `dispatch_event()` calls.
Observers can pass an optional dictionary of `filter` arguments. The key/value pairs of `filter` arguments cause an
observer to only be invoked for a `dispatch_event()` call that contains at least the same values. For instance, having a
filter dictionary of `{"WindowID": 1234}` will only cause the observer to be called if `dispatch_event()` is given the
same value as a `"WindowID"` parameter.
Observers can be added inside of an observer notification (i.e. during a call to `dispatch_event()`), however these new
observers will not be called for currently the dispatching event. A subsequent recursive call to `dispatch_event()` (on
the current thread only) will also call the new observer. The new observer will be available to all other threads once
the `dispatch_event()` call (in which it was added) completes.
Args:
order: (int) A value determining call order. Observers with lower order values are called earlier. Observers with
the same order value and same filter argument values will be called in the order they are registered. Observers
with the same order value with different filter arguments are called in an indeterminate order.
event_name: (str) The event name to observe
on_event: (function) A function that is invoked when an event matching `event_name` and any `filter` arguments is
dispatched.
filter: [optional] (dict) If present, must be a dict of key(str)/value(any) pairs.
Returns:
An ObserverGuard object that, when collected, removes the observer from the Event Dispatcher system.
)")
.def("has_observers",
[](IEventDispatcher* ed, const char* eventName, py::handle filterDict) {
std::vector<NamedVariant> vec;
if (!filterDict.is_none())
{
auto dict = filterDict.cast<py::dict>();
vec.reserve(dict.size());
for (auto& entry : dict)
{
vec.push_back(
{ RStringKey(entry.first.cast<std::string>().c_str()), objectToVariant(entry.second) });
}
std::sort(vec.begin(), vec.end(), detail::NamedVariantLess{});
}
py::gil_scoped_release nogil;
return ed->internalHasObservers(RString(eventName), vec.size(), vec.data());
},
py::arg("event_name"), py::arg("filter") = py::none(),
R"(Queries the Event Dispatcher whether any observers are listening to a specific event signature.
Emulates a call to :func:`.dispatch_event()` (without actually calling any observers) and returns `True` if any
observers would be called.
Args:
event_name: (str) The event name to query
filter: [optional] (dict) If present, must be a dict of key(str)/value(any) pairs.
Returns:
`True` if at least one observer would be called with the given `filter` arguments; `False` otherwise.)")
.def("dispatch_event",
[](IEventDispatcher* ed, const char* eventName, py::handle payload) {
std::vector<NamedVariant> vec;
if (!payload.is_none())
{
auto dict = payload.cast<py::dict>();
vec.reserve(dict.size());
for (auto& entry : dict)
{
vec.push_back({ RStringKey(entry.first.cast<std::string>().c_str()),
variant::Variant(entry.second.cast<py::object>()) });
}
std::sort(vec.begin(), vec.end(), detail::NamedVariantLess{});
}
py::gil_scoped_release nogil;
return ed->internalDispatch({ RString(eventName), vec.size(), vec.data() });
},
py::arg("event_name"), py::arg("payload") = py::none(),
R"(Dispatches an event and immediately calls all observers that would observe this particular event.
Finds and calls all observers (in the current thread) that observe the given event signature.
It is safe to recursively dispatch events (i.e. call `dispatch_event()` from within a called observer), but care must be
taken to avoid endless recursion. See the rules in :func:`.observe_event()` for observers added during a
`dispatch_event()` call.
Args:
event_name: (str) The name of the event to dispatch
payload: (dict) If present, must be a dict of key(str)/value(any) pairs.
Returns:
The number of observers that were called, excluding those from recursive calls.)");
}
} // namespace eventdispatcher
} // namespace carb
| 14,380 | C | 42.186186 | 124 | 0.615994 |
omniverse-code/kit/include/carb/eventdispatcher/EventDispatcherTypes.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Type definitions for *carb.eventdispatcher.plugin*
#pragma once
#include "../Strong.h"
#include "../variant/VariantUtils.h"
namespace carb
{
namespace eventdispatcher
{
//! A handle to an observer, registered with \ref IEventDispatcher::observeEvent().
CARB_STRONGTYPE(Observer, size_t);
//! Special value indicating an invalid observer.
constexpr Observer kInvalidObserver{};
//! Structure definition for a named variant: a key/value pair with a value of varying type.
struct NamedVariant
{
RStringKey name; //!< The key
variant::Variant value; //!< The value
};
static_assert(std::is_standard_layout<NamedVariant>::value, ""); // Not interop-safe as it is not trivially copyable
//! Structure definition for event data. Typically not used; instead use the \ref Event wrapper-class.
struct EventData
{
RString eventName; //!< The name of the event
size_t numVariants; //!< Number of items in the \c variants array member
NamedVariant const* variants; //!< An array of \ref NamedVariant of length \c numVariants
};
CARB_ASSERT_INTEROP_SAFE(EventData);
//! A presentation class for \ref EventData. Allows querying the data via a simple C++ interface.
class Event final : public EventData
{
CARB_PREVENT_COPY_AND_MOVE(Event);
public:
/**
* Returns true if an Event contains the requested key.
*
* @param key The key to query.
* @returns \c true if the key is contained in the Event, \c false otherwise.
*/
bool hasKey(RStringKey key) const;
/**
* Returns a variant value from the event by key.
* @param key The key to query.
* @returns A \ref variant::Variant representing the item if the key is present; \c nullptr otherwise.
*/
const variant::Variant* get(RStringKey key) const;
/**
* Retrieves a value from the Event by key.
*
* @tparam T The requested type to convert the value to.
* @param key The key to query.
* @returns An \c optional value where \c has_value() is \c true if the key exists and the variant value that it
* represents can be converted to type \c T. Otherwise returns an empty \c optional.
*/
template <class T>
cpp::optional<T> getValue(RStringKey key) const;
/**
* Retrieves a value from the Event by key, or a fallback value.
*
* Effectively the same as `getValue<T>(key).value_or(defaultValue)`
*
* @tparam T The requested type to convert the value to.
* @param key The key to query.
* @param defaultValue A value to return if the key does not exist or is not convertible to \c T.
*/
template <class T>
T getValueOr(RStringKey key, T&& defaultValue) const;
};
static_assert(sizeof(Event) == sizeof(EventData), "");
//! Callback function called when an event is dispatched. Typically not manually used as it is generated by
//! \ref IEventDispatcher::observeEvent().
using ObserverFn = void (*)(const Event&, void*);
//! Callback function called when an observer is terminated with \ref IEventDispatcher::stopObserving(). Typically not
//! manually used as it is generated by \ref IEventDispatcher::observeEvent().
using CleanupFn = void (*)(void*);
//! Structure to manage the lifetime of an observer. Similar to \c std::unique_ptr.
class ObserverGuard
{
public:
CARB_PREVENT_COPY(ObserverGuard);
/**
* Default constructor. Constructs an empty \c ObserverGuard.
*/
constexpr ObserverGuard() noexcept;
/**
* Constructor that accepts an \ref Observer handle.
* @param o The \ref Observer to manage.
*/
constexpr explicit ObserverGuard(Observer o) noexcept;
/**
* Move constructor. Moves the \ref Observer managed by \p other to \c *this and leaves \p other empty.
* @param other The other \c ObserverGuard.
*/
ObserverGuard(ObserverGuard&& other) noexcept;
/**
* Destructor.
*/
~ObserverGuard() noexcept;
/**
* Move-assign operator. Moves the \ref Observer managed by \p other to \c *this.
* @param other The other \c ObserverGuard.
*/
ObserverGuard& operator=(ObserverGuard&& other) noexcept;
/**
* Releases the managed \ref Observer to the caller and leaves \c *this empty.
*
* @note This does not stop the managed \ref Observer.
* @return The \ref Observer previously managed by \c *this.
*/
Observer release() noexcept;
/**
* Stops any currently managed observer (as via \ref IEventDispatcher::stopObserving()) and takes ownership of the
* given \ref Observer.
*
* @param o The new \ref Observer to manage, or \ref kInvalidObserver to remain empty.
*/
void reset(Observer o = kInvalidObserver) noexcept;
/**
* Exchanges state with another \c ObserverGuard.
* @param o The other \c ObserverGuard.
*/
void swap(ObserverGuard& o) noexcept;
/**
* Returns the managed \ref Observer while maintaining management of it.
* @returns The managed \ref Observer.
*/
constexpr Observer get() const noexcept;
/**
* Validation test.
* @returns \c true if \c *this is non-empty (manages a valid observer); \c false otherwise.
*/
explicit operator bool() const noexcept;
private:
Observer m_o;
};
} // namespace eventdispatcher
} // namespace carb
| 5,781 | C | 32.229885 | 118 | 0.684311 |
omniverse-code/kit/include/carb/eventdispatcher/IEventDispatcher.h | // Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Interface definition for *carb.eventdispatcher.plugin*
#pragma once
#include "../Interface.h"
#include "EventDispatcherTypes.h"
namespace carb
{
//! Namespace for *carb.eventdispatcher.plugin* and related utilities.
namespace eventdispatcher
{
class ObserverGuard;
//! Interface for *carb.eventdispatcher.plugin*.
struct IEventDispatcher
{
CARB_PLUGIN_INTERFACE("carb::eventdispatcher::IEventDispatcher", 0, 1)
//! @private (see observeEvent())
Observer(CARB_ABI* internalObserveEvent)(int order,
RString eventName,
size_t numVariants,
NamedVariant const* variants,
ObserverFn fn,
CleanupFn cleanup,
void* ud);
/**
* Stops the given observer. Safe to perform while dispatching.
*
* Since observers can be in use by this thread or any thread, this function is carefully synchronized with all
* other IEventDispatcher operations.
* - During stopObserving(), further calls to the observer are prevented, even if other threads are currently
* dispatching an event that would be observed by the observer in question.
* - If any other thread is currently calling the observer in question, stopObserving() will wait until all other
* threads have left the observer function.
* - If the observer function is \b not in the callstack of the current thread, the cleanup function provided to
* \c internalObserveEvent() is called and any \ref variant::Variant objects captured to filter events are
* destroyed.
* - If the observer function is in the callstack of the current thread, stopObserving() will return without
* waiting, calling the cleanup function or destroying \ref variant::Variant objects. Instead, this cleanup will
* be performed when the \ref dispatchEvent() call in the current thread finishes.
*
* When stopObserving() returns, it is guaranteed that the observer function will no longer be called and all calls
* to it have completed (except if the calling thread is dispatching).
*
* @warning This function must be called exactly once per \ref Observer created by \ref observeEvent(). The
* \ref ObserverGuard calls this function automatically.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
*
* @param ob The \ref Observer to stop.
* @returns \c true if the Observer was found and stopped; \c false otherwise.
*/
bool(CARB_ABI* stopObserving)(Observer ob);
//! @private (see hasObservers())
bool(CARB_ABI* internalHasObservers)(RString eventName, size_t numVariants, NamedVariant const* variants);
//! @private (see dispatchEvent())
size_t(CARB_ABI* internalDispatch)(const EventData&);
/**
* Queries to see if the system is currently dispatching an event.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
*
* @param currentThread If \c false, checks to see if any thread is currently dispatching. However, the return value
* should be used for debugging purposes only as it is a transient value and could be stale by the time it is read
* by the application. If \c true, checks to see if the current thread is dispatching (that is, the callstack
* includes a call to \ref dispatchEvent()).
* @returns \c true if any thread or the current thread is dispatching based on the value of \p currentThread;
* \c false otherwise.
*/
bool(CARB_ABI* isDispatching)(bool currentThread);
/**
* Registers an observer with the Event Dispatcher system.
*
* An observer is an invocable object (function, functor, lambda, etc.) that is called whenever \ref dispatchEvent()
* is called. The observers are invoked in the thread that calls \ref dispatchEvent(), and multiple threads could be
* calling \ref dispatchEvent() simultaneously, so observers must be thread-safe unless the application can ensure
* synchronization around \ref dispatchEvent() calls.
*
* Observers can pass zero or any number of @p filterArgs parameters. These @p filterArgs cause an observer to only
* be invoked for a \ref dispatchEvent() call that contains at least the same values. For instance, having a filter
* pair for key "WindowID" with a specific value will only cause the observer to be called if \ref dispatchEvent()
* is given the same value as a "WindowID" parameter.
*
* Observers can be added inside of an observer notification (i.e. during a call to \ref dispatchEvent()), however
* these new observers will <b>not be called</b> for the currently dispatching event. A subsequent recursive call to
* \ref dispatchEvent() <em>(on the current thread only)</em> will also call the new observer. The new observer will
* be available to all other threads once the \ref dispatchEvent() call--in which it was added--returns.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
*
* @param order A value determining call order. Observers with lower order values are called earlier. Observers with
* the same order value and same filter argument values will be called in the order they are registered. Observers
* with the same order value with \a different filter argument values are called in an indeterminate order.
* @param eventName The name of the event to observe.
* @param invocable An object that is invoked when an event matching the \p eventName and \p filterArgs is
* dispatched. The object must be callable as `void(const Event&)`.
* @param filterArgs Zero or more arguments that filter observer invocations. Each argument must be of type
* `std::pair<RStringKey, T>` where the first parameter is the key and the second is the value. The value must be
* of a type understood by a \ref variant::Translator specialization.
* @returns An \ref ObserverGuard representing the lifetime of the observer. When the \ref ObserverGuard is reset or
* destroyed, the observer is unregistered as with \ref stopObserving().
*/
template <class Invocable, class... Args>
CARB_NODISCARD ObserverGuard observeEvent(int order, RString eventName, Invocable&& invocable, Args&&... filterArgs);
/**
* Registers an observer with the Event Dispatcher system.
*
* An observer is an invocable object (function, functor, lambda, etc.) that is called whenever \ref dispatchEvent()
* is called. The observers are invoked in the thread that calls \ref dispatchEvent(), and multiple threads could be
* calling \ref dispatchEvent() simultaneously, so observers must be thread-safe unless the application can ensure
* synchronization around \ref dispatchEvent() calls.
*
* Observers can pass zero or any number of @p filterArgs parameters. These @p filterArgs cause an observer to only
* be invoked for a \ref dispatchEvent() call that contains at least the same values. For instance, having a filter
* pair for key "WindowID" with a specific value will only cause the observer to be called if \ref dispatchEvent()
* is given the same value as a "WindowID" parameter.
*
* Observers can be added inside of an observer notification (i.e. during a call to \ref dispatchEvent()), however
* these new observers will <b>not be called</b> for the currently dispatching event. However, a recursive call to
* \ref dispatchEvent() <em>(on the current thread only)</em> will also call the new observer. The new observer will
* be available to all other threads once the \ref dispatchEvent() call--in which it was added--returns.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
*
* @param order A value determining call order. Observers with lower order values are called earlier. Observers with
* the same order value and same filter argument values will be called in the order they are registered. Observers
* with the same order value with \a different filter argument values are called in an indeterminate order.
* @param eventName The name of the event to observe.
* @param invocable An object that is invoked when an event matching the \p eventName and \p filterArgs is
* dispatched. The object must be callable as `void(const Event&)`.
* @tparam InIter An InputIterator that is forward-iterable and resolves to a \ref NamedVariant when dereferenced.
* @param begin An InputIterator representing the start of the filter parameters.
* @param end A past-the-end InputIterator representing the end of the filter parameters.
* @returns An \ref ObserverGuard representing the lifetime of the observer. When the \ref ObserverGuard is reset or
* destroyed, the observer is unregistered as with \ref stopObserving().
*/
template <class Invocable, class InIter>
CARB_NODISCARD ObserverGuard
observeEventIter(int order, RString eventName, Invocable&& invocable, InIter begin, InIter end);
/**
* Queries the Event Dispatcher whether any observers are listening to a specific event signature.
*
* Emulates a call to \ref dispatchEvent() (without actually calling any observers) and returns \c true if any
* observers would be called.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
* @param eventName The name of the event to query.
* @param filterArgs Zero or more key/value pairs that would be used for observer filtering as in a call to
* \ref dispatchEvent(). Each argument must be of type `std::pair<RStringKey, T>` where the first parameter is the
* key and the second is the value. The value must be of a type understood by a \ref variant::Translator
* specialization.
* @returns \c true if at least one observer would be called if the same arguments were passed to
* \ref dispatchEvent(); \c false otherwise.
*/
template <class... Args>
bool hasObservers(RString eventName, Args&&... filterArgs);
/**
* Queries the Event Dispatcher whether any observers are listening to a specific event signature.
*
* Emulates a call to \ref dispatchEvent() (without actually calling any observers) and returns \c true if any
* observers would be called.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
* @tparam InIter An InputIterator that is forward-iterable and resolves to a \ref NamedVariant when dereferenced.
* The entries are used for observer filtering.
* @param eventName The name of the event to query.
* @param begin An InputIterator representing the start of the event key/value pairs.
* @param end A past-the-end InputIterator representing the end of the event key/value pairs.
* @returns \c true if at least one observer would be called if the same arguments were passed to
* \ref dispatchEvent(); \c false otherwise.
*/
template <class InIter>
bool hasObserversIter(RString eventName, InIter begin, InIter end);
/**
* Dispatches an event and immediately calls all observers that would observe this particular event.
*
* Finds and calls all observers (in the current thread) that observe the given event signature.
*
* It is safe to recursively dispatch events (i.e. call dispatchEvent() from a called observer), but care must be
* taken to avoid endless recursion. See the rules in observeEvent() for observers added during a dispatchEvent()
* call.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
* @param eventName The name of the event to dispatch.
* @param payload Zero or more key/value pairs that are used as the event payload and may be queried by observers or
* used to filter observers. Each argument must be of type `std::pair<RStringKey, T>` where the first parameter is
* the key and the second is the value. The value must be of a type understood by a \ref variant::Translator
* specialization.
* @returns The count of observers that were called. Recursive dispatch calls are not included.
*/
template <class... Args>
size_t dispatchEvent(RString eventName, Args&&... payload);
/**
* Dispatches an event and immediately calls all observers that would observe this particular event.
*
* Finds and calls all observers (in the current thread) that observe the given event signature.
*
* It is safe to recursively dispatch events (i.e. call dispatchEvent() from a called observer), but care must be
* taken to avoid endless recursion. See the rules in observeEvent() for observers added during a dispatchEvent()
* call.
*
* @thread_safety Safe to perform while any thread is performing any operation against IEventDispatcher.
* @tparam InIter An InputIterator that is forward-iterable and resolves to a \ref NamedVariant when dereferenced.
* The entries are used as the event payload and may be queried by observers or used to filter observers.
* @param eventName The name of the event to dispatch.
* @param begin An InputIterator representing the start of the event key/value pairs.
* @param end A past-the-end InputIterator representing the end of the event key/value pairs.
* @returns The count of observers that were called. Recursive dispatch calls are not included.
*/
template <class InIter>
size_t dispatchEventIter(RString eventName, InIter begin, InIter end);
};
} // namespace eventdispatcher
} // namespace carb
#include "IEventDispatcher.inl"
| 14,595 | C | 59.314049 | 121 | 0.712915 |
omniverse-code/kit/include/carb/filesystem/FindFiles.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Utilities for finding files.
#pragma once
#include "../extras/Path.h"
#include "../extras/StringProcessor.h"
#include "../extras/StringUtils.h"
#include "IFileSystem.h"
#include "../Format.h"
#include "../../omni/str/Wildcard.h"
#include <cstdint>
#include <cstring>
namespace carb
{
namespace filesystem
{
//! Flag type for \ref FindFilesArgs
//! @see kFindFilesFlagNone kFindFilesFlagRecursive kFindFilesFlagMatchStem kFindFilesFlagReplaceEnvironmentVariables
using FindFilesFlag = uint32_t;
//! Default empty flag
constexpr FindFilesFlag kFindFilesFlagNone = 0x0;
//! Flag to recursively search directories.
constexpr FindFilesFlag kFindFilesFlagRecursive = (1 << 0);
//! When matching wildcards, only match the "stem".
//!
//! The "stem" is defined by carb::extras::Path. In short, given the following files:
//!
//! /a/b/c/d.txt -> d
//! /a/b/c/d -> d
//! /a/b/c/.d -> .d
//! /a/b/c/d.old.txt -> d.old
constexpr FindFilesFlag kFindFilesFlagMatchStem = (1 << 1);
//! Before walking the filesystem, a text replace is performed on each given search path. The token `${MY_ENV_VAR}`
//! would be replaced with the environment variable `MY_ENV_VAR`.
//!
//! Example: ${USERPROFILE}/kit -> C:/Users/ncournia/kit
constexpr FindFilesFlag kFindFilesFlagReplaceEnvironmentVariables = (1 << 2);
//! Callback for each encountered file invoked before canonicalization and pattern matching.
//! @param path the non-canonical path encountered
//! @param userData the value of \ref FindFilesArgs::onFilterNonCanonicalContext
//! @retval WalkAction::eContinue to continue with canonicalization and pattern matching.
//! @retval WalkAction::eSkip to stop processing the file and move to the next file.
//! @retval WalkAction::eStop to stop the search.
using FindFilesOnFilterNonCanonicalFn = WalkAction(const char* path, void* userData);
//! Callback invoked when a file matches a pattern matchWildcards and does not match a pattern in excludeWildcards.
//! @param canonical The canonical path to the file
//! @param userData the value of \ref FindFilesArgs::onMatchedContext
using FindFilesOnMatchedFn = void(const char* canonical, void* userData);
//! Callback invoked when a file matches a pattern matchWildcards and excludeWildcards.
//! @param canonical The canonical path to the file
//! @param userData the value of \ref FindFilesArgs::onExcludedContext
using FindFilesOnExcludedFn = void(const char* canonical, void* userData);
//! Callback invoked when a file matches does not match a pattern in matchWildcards.
//! @param canonical The canonical path to the file
//! @param userData the value of \ref FindFilesArgs::onSkippedContext
using FindFilesOnSkippedFn = void(const char* canonical, void* userData);
//! Callback invoked when starting a search in one of the given search paths.
//! @param canonical The canonical path to the file
//! @param userData the value of \ref FindFilesArgs::onSearchPathContext
using FindFilesOnSearchPathFn = void(const char* path, void* userData);
//! Search parameters passed to findFiles().
//!
//! Recommended usage:
//!
//! FindFilesArgs args{}; // this zero initializes arguments
//!
//! const char* const* paths = { "/myPath", "myRelativePath" };
//! const char* const* patterns = { "*.dll" };
//!
//! args.searchPaths = paths;
//! args.searchPathsCount = CARB_COUNTOF(paths);
//!
//! args.matchWildcards = patterns;
//! args.matchWildcardsCount = CARB_COUNTOF(patterns);
//!
//! args.onMatched = [](const char* canonical, void*) { printf("found: %s\n", canonical); };
//!
//! if (!findFiles(args)) { CARB_LOG_ERROR(" :( "); }
//!
struct FindFilesArgs
{
//! A list of paths (directories) to search.
//!
//! If \ref kFindFilesFlagReplaceEnvironmentVariables is specified in flags, tokens in the form `${MY_ENV_VAR}` will
//! be replaced with the corresponding environment variable.
//!
//! If \ref kFindFilesFlagRecursive is specified in flags, each path is searched recursively.
//!
//! Paths may be absolute or relative. If relative, the value of \ref IFileSystem::getAppDirectoryPath() is
//! prepended to the path.
//!
//! @warning Must not be nullptr.
const char* const* searchPaths;
uint32_t searchPathsCount; //!< Number of paths in searchPaths. Must be greater than 0.
//! The wildcard pattern to match files in the given searchPaths.
//!
//! Special characters are:
//! * `*` matches all characters
//! * `?` matches a single character.
//!
//! For example, given the file `"libMyPlugin.plugin.dll"`:
//! * `*` -> Matches!
//! * `lib` -> Not a match.
//! * `*.so` -> Not a match.
//! * `lib*` -> Matches!
//! * `*.plugin.*` -> Matches!
//! * `libMyPlugin.plugin?dll` -> Matches!
//!
//! When matching, only the filename is considered. So, given the path `/a/b/c/d.txt` only `d.txt` is considered
//! when matching.
//!
//! The extension of the filename can be ignored by passing the \ref kFindFilesFlagMatchStem to flags.
//!
//! Matched files may be excluded (see \ref excludeWildcards below).
//!
//! @warning Must not be nullptr.
const char* const* matchWildcards;
uint32_t matchWildcardsCount; //!< Number of patterns in matchWildcards. Must be greater than 0.
//! The wildcard pattern to exclude files in the given search paths.
//!
//! Pattern matching follow the same rules as \ref matchWildcards.
//!
//! These patterns are checked only when the filename matches \ref matchWildcards. If the filename matches a
//! pattern in both \ref matchWildcards and \ref excludeWildcards, the file is excluded.
//!
//! May be nullptr.
const char* const* excludeWildcards;
uint32_t excludeWildcardsCount; //!< Number of patterns in excludeWildcards. May be 0.
//! A list of prefixes to ignore during pattern matching.
//!
//! If not pattern matches a filename, pattern matching will be attempted again with the prefixes in this list
//! stripped. For example, given:
//!
//! ignorePrexies = { "lib" };
//! matchWildcard = { "MyPlugin.plugin.*" };
//!
//! We see the following output:
//! * `MyPlugin.plugin.dll` -> Match!
//! * `libMyPlugin.plugin.dll` -> Match! ("lib" prefix was ignored)
//!
//! May be nullptr
const char* const* ignorePrefixes;
uint32_t ignorePrefixesCount; //!< Number of prefixes in ignorePrefixes. May be 0.
//! IFileSystem to use to walk the given search paths.
//!
//! If nullptr, `tryAcquireInterface<IFileSystem>` is called.
IFileSystem* fs;
//! Callback for each encountered file invoked before canonicalization and pattern matching.
//!
//! This callback is invoked on each file in the given search paths. The callback is invoked before many of the
//! expensive parts of the search algorithm, such as file canonicalization and pattern matching.
//! May be nullptr.
FindFilesOnFilterNonCanonicalFn* onFilterNonCanonical;
void* onFilterNonCanonicalContext; //!< Context passed to onFilterNonCanonical. May be nullptr.
//! Callback invoked when a file matches a pattern matchWildcards and does not match a pattern in excludeWildcards.
//!
//! May be nullptr.
FindFilesOnMatchedFn* onMatched;
void* onMatchedContext; //!< Context passed to onMatched. May be nullptr.
//! Callback invoked when a file matches a pattern matchWildcards and excludeWildcards.
//!
//! May be nullptr.
FindFilesOnExcludedFn* onExcluded;
void* onExcludedContext; //!< Context passed to onExcluded. May be nullptr.
//! Callback invoked when a file matches does not match a pattern in matchWildcards.
//!
//! May be nullptr.
FindFilesOnSkippedFn* onSkipped;
void* onSkippedContext; //!< Context passed to onSkipped. May be nullptr.
//! Callback invoked when starting a search in one of the given search paths.
//!
//! May be nullptr.
FindFilesOnSearchPathFn* onSearchPath;
void* onSearchPathContext; //!< Context passed to onSearchPath. May be nullptr.
//! Bitmask of flags to change search behavior. See FindFilesFlag.
FindFilesFlag flags;
};
//! Finds files in a given list of search paths matching a given list of patterns.
//!
//! See \ref FindFilesArgs for argument documentation.
//!
//! The search can be incredibly expensive:
//! `O(searchPathsCount^(<files>^(ignorePrefixesCount^(matchWildcardsCount + excludeWildcardsCount))))`
//!
//! The following Python-ish pseudo-code gives you an idea of the algorithm used:
//! \rst
//! .. code-block:: python
//!
//! foreach path in searchPaths:
//! path = substituteEnvVars(path)
//! foreach file in path:
//! if eContinue == onFilterNonCanonical(file):
//! foreach prefix in ["", ignorePrefixes]:
//! stripped = prefix[len(prefix):]
//! matched = False
//! if isMatch(stripped, matchWildcards): # loops over each wildcard pattern
//! if isMatch(stripped, excludeWildcards): # loops over each wildcard pattern
//! return # any match of an exclusion pattern immediately excludes the file
//! else:
//! matched = True
//! if matched:
//! return onMatched(canonical)
//! \endrst
//! \param args The arguments as a structure
//! \returns `true` if the filesystem was searched; `false` otherwise.
inline bool findFiles(const FindFilesArgs& args);
#ifndef DOXYGEN_BUILD
namespace detail
{
struct FindFilesContext
{
const FindFilesArgs* args;
IFileSystem* fs;
};
inline WalkAction onFile(const DirectoryItemInfo* const info, void* userData)
{
if (info->type == DirectoryItemType::eFile)
{
auto context = reinterpret_cast<const FindFilesContext*>(userData);
// the canonicalization of a file is expensive. here we give the user a chance to
// tell us if we should canonicalize the file
if (context->args->onFilterNonCanonical)
{
WalkAction action =
context->args->onFilterNonCanonical(info->path, context->args->onFilterNonCanonicalContext);
switch (action)
{
case WalkAction::eStop:
return WalkAction::eStop;
case WalkAction::eSkip:
return WalkAction::eContinue;
default: // eContinue
break; // fall-through
}
}
std::string canonical = context->fs->makeCanonicalPath(info->path);
extras::Path path(canonical);
std::string target;
if (context->args->flags & kFindFilesFlagMatchStem)
{
target = path.getStem();
}
else
{
target = path.getFilename();
}
const char* toMatch = target.c_str();
// note, even if a pattern matches, we still have to loop through all of "ignorePrefixesCount" looking for an
// exclusion since exclusions take precedent.
bool matched = false;
for (int32_t i = -1; i < int32_t(context->args->ignorePrefixesCount); ++i)
{
const char* prefix = "";
if (-1 != i)
{
prefix = context->args->ignorePrefixes[i];
}
if (extras::startsWith(toMatch, prefix))
{
const char* strippedMatch = toMatch + std::strlen(prefix);
if (omni::str::matchWildcards(
strippedMatch, context->args->matchWildcards, context->args->matchWildcardsCount))
{
if (omni::str::matchWildcards(
strippedMatch, context->args->excludeWildcards, context->args->excludeWildcardsCount))
{
if (context->args->onExcluded)
{
context->args->onExcluded(canonical.c_str(), context->args->onExcludedContext);
}
return WalkAction::eContinue; // exclusion takes precedent. ignore the file and keep searching
}
else
{
matched = true;
}
}
}
}
if (matched)
{
if (context->args->onMatched)
{
context->args->onMatched(canonical.c_str(), context->args->onMatchedContext);
}
}
else
{
if (context->args->onSkipped)
{
context->args->onSkipped(canonical.c_str(), context->args->onSkippedContext);
}
}
}
return WalkAction::eContinue;
}
} // namespace detail
#endif
inline bool findFiles(const FindFilesArgs& args)
{
if (!args.searchPaths || !args.searchPathsCount)
{
CARB_LOG_ERROR("searchPath must be specified");
return false;
}
if (!args.matchWildcards || !args.matchWildcardsCount)
{
CARB_LOG_ERROR("match wildcard must be specified");
return false;
}
auto framework = getFramework();
if (!framework)
{
CARB_LOG_ERROR("carb::Framework not active");
return false;
}
IFileSystem* fs;
if (args.fs)
{
fs = framework->verifyInterface<IFileSystem>(args.fs);
if (!fs)
{
CARB_LOG_ERROR("incompatible carb::filesystem::IFileSystem");
return false;
}
}
else
{
fs = framework->tryAcquireInterface<IFileSystem>();
if (!fs)
{
CARB_LOG_ERROR("unable to acquire carb::filesystem::IFileSystem");
return false;
}
}
detail::FindFilesContext userData = { &args, fs };
for (uint32_t i = 0; i < args.searchPathsCount; ++i)
{
const char* dir = args.searchPaths[i];
std::string dirWithEnv;
if (args.flags & kFindFilesFlagReplaceEnvironmentVariables)
{
dirWithEnv = extras::replaceEnvironmentVariables(dir);
dir = dirWithEnv.c_str();
}
extras::Path path{ dir };
const char* fullPath = path.getStringBuffer();
std::string tmp;
if (!path.isAbsolute())
{
tmp = carb::fmt::format("{}/{}", fs->getAppDirectoryPath(), dir);
fullPath = tmp.c_str();
}
if (args.onSearchPath)
{
args.onSearchPath(fullPath, args.onSearchPathContext);
}
if (args.flags & kFindFilesFlagRecursive)
{
fs->forEachDirectoryItemRecursive(fullPath, detail::onFile, const_cast<detail::FindFilesContext*>(&userData));
}
else
{
fs->forEachDirectoryItem(fullPath, detail::onFile, &userData);
}
}
return true;
}
} // namespace filesystem
} // namespace carb
| 15,454 | C | 34.94186 | 122 | 0.633428 |
omniverse-code/kit/include/carb/filesystem/IFileSystem.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//! @brief Carbonite FileSystem interface definition file.
#pragma once
#include "../Defines.h"
#include "../Types.h"
#include <stdlib.h>
#include <string>
#include <time.h>
#include <vector>
namespace carb
{
//! Namespace for Carbonite FileSystem.
namespace filesystem
{
//! Opaque type for referring to a File instance.
//! @see IFileSystem::openFileToRead IFileSystem::openFileToWrite IFileSystem::openFileToReadWrite
//! IFileSystem::openFileToAppend
struct File DOXYGEN_EMPTY_CLASS;
struct IFileSystem;
//! Type definition of a subscription.
typedef uint32_t SubscriptionId;
//! Indicates an invalid subscription.
const SubscriptionId kInvalidSubscriptionId = 0;
/**
* Defines the type of directory item.
*/
enum class DirectoryItemType
{
eFile, //!< Item type is a file, or other type such as socket or block device; type is not a directory
eDirectory, //!< Item type is a directory
};
/**
* Defines change action that is reported to callback function.
*/
enum class ChangeAction
{
/// Reported when a file is created
eCreated,
/// Reported when a file is modified
eModified,
/// Reported when a file is deleted
eDeleted,
/// Generally reported when a file is renamed. However, due to OS limitations in how events are delivered, a rename
/// may come through on rare occasion as separate eCreated and eDeleted events.
/// These are supported on Windows and Linux but not Mac OS.
eRenamed
};
/**
* Defines the behavior requested by the callback function.
*/
enum class WalkAction : signed char
{
/// Stops all iteration and causes forEachDirectoryItem[Recursive] to return immediately.
eStop = -1,
/// Skips the rest of the current directory and any remaining subdirectories of the current directory.
eSkip,
/// Continues iteration.
eContinue,
};
/**
* Information about a file
*/
struct FileInfo
{
/// The type of this item: Directory or File.
DirectoryItemType type;
/// The time that this item was last modified.
time_t modifiedTimestamp;
/// The time that this item was created.
time_t createdTimestamp;
/// The size of this item in bytes.
size_t size;
/// Whether this item is a symlink. On Windows, this is a reparse point which also includes directory junctions.
bool isSymlink;
};
/**
* Defines struct to hold item info during directory walk.
*/
struct DirectoryItemInfo : public FileInfo
{
//! The path to the file.
//!
//! Make a copy of the string if retention is desired after the callback. The path will be prefixed with the `path`
//! that is passed to \ref IFileSystem::forEachDirectoryItem() (or
//! \ref IFileSystem::forEachDirectoryItemRecursive()).
const char* path;
};
/**
* fixed positions in a file that a file pointer can be moved relative to.
*/
enum class FileWhence
{
eBegin, ///< beginning of the file.
eCurrent, ///< current position in the file.
eEnd, ///< end of the file.
};
/**
* defines the potential states that an open file stream can be in. These states are only valid
* after an operation such as read, write, seek, etc complete. The current state of the file
* stream can be retrieved with getFileStatus(). Its return value will persist until another
* operation on the stream completes.
*/
enum class FileStatus
{
eOk, ///< the stream is valid and ready to be operated on. No special state is set.
eEof, ///< the stream has reached an end-of-file condition on the last operation.
eError, ///< the stream has encountered an error on the last operation.
};
/** Base type for flags for the IFileSystem::makeCanonicalPathEx2() function. */
using CanonicalFlags = uint32_t;
/** Flag to indicate that the file must also exist in order for the function to succeed. When
* this flag is used, the behavior will match IFileSystem::makeCanonicalPathEx2().
*/
constexpr CanonicalFlags fCanonicalFlagCheckExists = 0x01;
/**
* Defines the callback function to use when listening to changes on file system.
*
* @param path The path for file system change.
* @param action The change action that occurred.
* @param userData The user data associated with the subscription to the change event.
* @param newPath The path for the new name of the file. Used only for eRenamed action, otherwise it's nullptr
*/
typedef void (*OnChangeEventFn)(const char* path, ChangeAction action, void* userData, const char* newPath);
/**
* Defines a file system for Carbonite.
*
* This interface provides a number of useful platform independent functions when working with files and folders in a
* file system. All paths are in UTF-8 encoding using forward slash as path separator.
*
* On Windows, the maximum path of 32767 characters is supported. However, path components can't be longer than 255
* characters.
* Linux has a maximum filename length of 255 characters for most filesystems (including EXT4), and a
* maximum path of 4096 characters.
*/
struct IFileSystem
{
// 1.3: Eliminated error/warning logging and made use of ErrorApi for error codes
CARB_PLUGIN_INTERFACE("carb::filesystem::IFileSystem", 1, 3)
/**
* Returns the full path to the executable for this program.
*
* @ref ErrorApi state is not changed by this function.
*
* @return the full canonical path to the executable, including executable name and extension.
* This path will not change for the lifetime of the process.
*/
const char*(CARB_ABI* getExecutablePath)();
/**
* Returns the full path to the directory that contains the executable for this program.
*
* @ref ErrorApi state is not changed by this function.
*
* @returns the full canonical path to the directory that contains the executable file.
* This will not include the executable filename itself. This path will not
* change for the lifetime of the process.
*/
const char*(CARB_ABI* getExecutableDirectoryPath)();
/**
* Retrieves the full path to the 'app'.
*
* @ref ErrorApi state is not changed by this function.
*
* @returns the buffer containing the application path string. The contents of this buffer
* will be modified by any call to setAppDirectoryPath(). The buffer itself will
* persist for the lifetime of the framework. This will return `nullptr` until it
* is initialized by a call to \ref setAppDirectoryPath().
*
* @note Access to the application directory string is not thread safe. It is the caller's
* responsibility to ensure the application path is not being modified from another
* thread while it is being retrieved.
*/
const char*(CARB_ABI* getAppDirectoryPath)();
/**
* Sets the full path to the 'app'.
*
* @note (Windows) The extended path prefix is stripped if provided. Directory separators are converted to `/`.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultOutOfMemory - A buffer to store the path could not be allocated
* * @ref omni::core::kResultInsufficientBuffer - \p path exceeds the size of the buffer
*
* @param[in] path the relative or absolute path to the 'app'. If a relative path is used,
* this will be resolved relative to the current working directory.
* @returns no return value.
*/
void(CARB_ABI* setAppDirectoryPath)(const char* path);
/**
* Returns the full path to the current working directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed on success
* * @ref omni::core::kResultOutOfMemory - A buffer to store the path could not be allocated
* * @ref omni::core::kResultInsufficientBuffer - the working directory exceeds the size of the buffer
* * Other errors may be reported based on the underlying platform calls
*
* @returns `nullptr` if an error occurs, or the buffer containing the current working directory path string. The
* contents of this buffer will be modified by any call to \ref getCurrentDirectoryPath() or
* \ref setCurrentDirectoryPath(). The buffer itself will persist for the lifetime of the framework.
*
* @note Retrieving the current working directory is not thread safe. Since only a single
* working directory is maintained for each process, it could be getting changed from
* another thread while being retrieved. It is the caller's responsibility to ensure
* that all access to the current working directory is safely serialized.
*/
const char*(CARB_ABI* getCurrentDirectoryPath)();
/**
* Sets the current working directory for the system.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed on success
* * @ref omni::core::kResultInvalidArgument - @p path was `nullptr`
* * @ref omni::core::kResultOutOfMemory - A buffer to store the path could not be allocated
* * @ref omni::core::kResultInsufficientBuffer - the working directory exceeds the size of the buffer
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] path the new current working directory path. This may be a relative or
* absolute path. This must name a directory that already exists. This
* name must not exist as a file on the file system. This may not be
* nullptr.
* @returns `true` if the new working directory is successfully set; `false` if an error occurs.
*
* @note Setting or retrieving the current working directory is not thread safe. Since
* the current working directory is global to the process, the caller is responsible
* for guaranteeing that the working directory will not change while attempting to
* retrieve it.
*/
bool(CARB_ABI* setCurrentDirectoryPath)(const char* path);
/**
* Tests whether the path provided exists in the file system.
*
* This function does not generate any error logging.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed on success
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The absolute or relative path to test for existence. Relative paths are resolved from
* the current working directory (as returned from getCurrentDirectoryPath()).
* @return true if and only if 'path' exists in the file system.
*/
bool(CARB_ABI* exists)(const char* path);
/**
* Tests whether it's possible to write to file with the provided path.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultSuccess - \p path exists but was not writable
* * @ref omni::core::kResultInvalidArgument - \p path is `nullptr`
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultInvalidState - Parent path is not a directory so \p path can not be created
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * Other errors may be reported based on the underlying platform calls
*
* @param path The absolute or relative path to test for writability. Relative paths are resolved from
* the current working directory (as returned from getCurrentDirectoryPath()).
* @return true if it's possible to write to this file.
*
* @note This accessibility check only answers the question of whether the user has
* _permission_ to write to the file, not that an open for write will always succeed.
* At least on Windows, it is still possible that another thread or process could
* have the file open without write sharing capabilities. In this case, the caller
* should just do a test open of the file since that will answer the question of
* whether write sharing is currently allowed on the file. On Linux there isn't any
* kernel enforced file sharing functionality so permission to the file should also
* imply the user will succeed to open it for write.
*/
bool(CARB_ABI* isWritable)(const char* path);
/**
* Tests whether the path provided is a directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultSuccess - \p path exists but was not a directory
* * @ref omni::core::kResultInvalidArgument - \p path is `nullptr`
* * @ref omni::core::kResultNotFound - The file was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The absolute or relative path to test for existence. Relative paths are resolved from
* the current working directory (as returned from getCurrentDirectoryPath()).
* @return true if and only if 'path' is a directory.
*/
bool(CARB_ABI* isDirectory)(const char* path);
/**
* Use platform functions to build canonical path relative to the base root.
*
* The path must exist. See @ref makeCanonicalPath() or @ref makeCanonicalPathEx2() for a version where the path may
* not need to exist.
*
* @par Errors
* Accessible via @ref carb::ErrorApi. This function always modifies the error state.
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultInsufficientBuffer - The provided \p buffer was too small to receive the canonicalized
* string. The contents of \p buffer are unchanged and the return value is the number of bytes required (including
* the NUL terminator).
* * @ref omni::core::kResultNullPointer - No buffer was provided, so nothing was written. The return value is the
* number of bytes required to contain the canonical path (include the NUL terminator).
* * Other errors may be reported based on the underlying platform calls
*
* @param path The absolute or relative path to canonicalize.
* @param base The base path to resolve relative path against. This can be `nullptr`to use
* the working directory (as returned from getCurrentDirectoryPath()) to resolve
* the relative path.
* @param buffer The buffer to write the canonical path to. This may be `nullptr` if only
* the required size of the buffer is needed.
* @param bufferSize The size of the buffer @p buffer in bytes.
* @return The number of characters written to the buffer @p buffer if the buffer is large enough.
* If the buffer is not large enough, nothing will be written to the buffer and the
* required size of the buffer in bytes including the NUL terminator will be returned. If an error occurs,
* 0 is returned.
*/
size_t(CARB_ABI* makeCanonicalPathEx)(const char* path, const char* base, char* buffer, size_t bufferSize);
/**
* Use platform functions to build canonical path relative to the base root.
*
* The path must exist if \ref fCanonicalFlagCheckExists is passed in the \p flags parameter.
*
* @par Errors
* Accessible via @ref carb::ErrorApi. This function always modifies the error state.
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The absolute or relative path to canonicalize.
* @param base The base path to resolve relative path against. This can be `nullptr`to use
* the working directory (as returned from getCurrentDirectoryPath()) to resolve
* the relative path.
* @param flags Flags to control the behavior of this operation.
* @return A `std::string` containing the canonicalized path, or an empty string if an error occurs.
*
* @note By default, this assumes that the requested file exists on the filesystem. On
* Linux, the existence of the file will still be checked as a side effect of the
* operation. On Windows however, no explicit check for the file existing in the
* filesystem will be performed unless the @ref fCanonicalFlagCheckExists flag is used.
*/
std::string makeCanonicalPath(const char* path,
const char* base = nullptr,
CanonicalFlags flags = fCanonicalFlagCheckExists);
/**
* Opens a file for reading in binary mode.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed with a non-`nullptr` return value
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * @ref omni::core::kResultOutOfMemory - Allocation failure
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] path The absolute or relative path for the file. This may not be nullptr.
* Relative paths are resolved from the current working directory (as
* returned from getCurrentDirectoryPath()).
* @returns a new File object representing the opened file if the file exists and was able
* to be successfully opened for read. This object must be passed to closeFile()
* when it is no longer needed.
* @returns nullptr if the named file does not exist in the file system or another error
* occurred (ie: insufficient permissions, allocation failure, etc).
*
* @remarks This opens an existing file for reading. If the file does not exist, this will
* fail. A new file will never be created if the named file does not already exist.
* If a new file needs to be created, it must first be opened for write with
* openFileToWrite(), for read and write with openFileToReadWrite(), or for append
* with openFileToAppend(). The file pointer will initially be at the beginning of
* the file. All reads will occur starting from the current file pointer position.
*/
File*(CARB_ABI* openFileToRead)(const char* path);
/**
* Opens a file for writing in binary mode.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed with a non-`nullptr` return value
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * @ref omni::core::kResultOutOfMemory - Allocation failure
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] path The absolute or relative path for the file. This may not be nullptr.
* Relative paths are resolved from the current working directory (as
* returned from getCurrentDirectoryPath()).
* @returns a new File object representing the opened file if successful. A new file will
* have been created if it previously did not exist. This object must be passed
* to closeFile() when it is no longer needed.
* @returns nullptr if the named file could neither be created nor opened. This may be
* the result of insufficient permissions to the file or an allocation failure.
* A warning will be written to the default logger in this case.
*
* @remarks This opens a file for writing. If the file does not exist, it will be created.
* If the file does exist, it will always be truncated to an empty file. The file
* pointer will initially be positioned at the beginning of the file. All writes to
* the file will occur at the current file pointer position. If the file needs
* to be opened for writing without truncating its contents, it should be opened
* either for append access (ie: openFileToAppend()) or for read/write access
* (ie: openFileToReadWrite()).
*/
File*(CARB_ABI* openFileToWrite)(const char* path);
/**
* Opens a file for appending in binary mode.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed with a non-`nullptr` return value
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * @ref omni::core::kResultOutOfMemory - Allocation failure
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] path The absolute or relative path for the file. This may not be nullptr.
* Relative paths are resolved from the current working directory (as
* returned from getCurrentDirectoryPath()).
* @returns a new File object representing the opened file if successful. A new file will
* have been created if it previously did not exist. This object must be passed
* to closeFile() when it is no longer needed.
* @returns nullptr if the named file could neither be created nor opened. This may be
* the result of insufficient permissions to the file or an allocation failure.
* A warning will be written to the default logger in this case.
*
* @remarks This opens a file for appending. If the file does not exist, it will always be
* created. The file pointer is initially positioned at the end of the file. All
* writes to the file will be performed at the end of the file regardless of the
* current file pointer position. If random access writes are needed, the file
* should be opened for read/write access (ie: openFileToReadWrite()) instead.
*/
File*(CARB_ABI* openFileToAppend)(const char* path);
/**
* Closes a file returned by any of the openFileTo*() functions.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - @p file was `nullptr`
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] file the File object representing the file to be closed. This object
* will no longer be valid upon return and must not be used again.
* This object would have been returned by a previous openFileTo*()
* call. If `nullptr` is provided, it is ignored.
* @returns no return value.
* @see openFileToRead openFileToWrite openFileToAppend openFileToReadWrite
*
* @post The \ref File is destroyed and must not be accessed anymore.
*/
void(CARB_ABI* closeFile)(File* file);
/**
* Gets the total size of the file.
*
* @note Writable files will execute a \ref flushFile() as part of this request.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * Other errors may be reported based on the underlying platform calls
*
* @param file object corresponding to an open file.
* @return The total size of the file in bytes, or 0 if an error occurs. If the file is 0 bytes,
* \ref carb::ErrorApi::getError() can be queried and the result will be \ref omni::core::kResultSuccess.
*/
size_t(CARB_ABI* getFileSize)(File* file);
/**
* Gets the time of last modification to the file.
*
* @note Writable files will execute a \ref flushFile() as part of this request.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * Other errors may be reported based on the underlying platform calls
*
* @param file object corresponding to an open file.
* @return The time this file was last modified. If an error occurs, 0 is returned and
* @ref carb::ErrorApi::getError() contains the error code.
*/
time_t(CARB_ABI* getFileModTime)(File* file);
/**
* Gets the time of last modification to the file or directory item at path.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultNotFound - The file was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to a file or directory item; relative paths are resolved from the current
* working directory (as returned from getCurrentDirectoryPath()).
* @return The time the item at 'path' was last modified. If an error occurs, 0 is returned and
* @ref carb::ErrorApi::getError() contains the error code.
*/
time_t(CARB_ABI* getModTime)(const char* path);
/**
* Gets the time of creation of the file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * Other errors may be reported based on the underlying platform calls
*
* @param file object corresponding to an open file.
* @return The time this file was created. If an error occurs, 0 is returned and @ref carb::ErrorApi::getError()
* contains the error code.
*/
time_t(CARB_ABI* getFileCreateTime)(File* file);
/**
* Gets the time of creation of the file or directory item at path.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultNotFound - The file was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to a file or directory item; relative paths are resolved from the current
* working directory (as returned from getCurrentDirectoryPath()).
* @return The time the file at @p path was created. If an error occurs, 0 is returned and
* @ref carb::ErrorApi::getError() contains the error code.
*/
time_t(CARB_ABI* getCreateTime)(const char* path);
/**
* Reads a chunk of binary data from a file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultFail - A failure was reported during read, \ref getFileStatus() will report error.
* * Other errors may be reported based on the underlying platform calls
*
* @param file Object corresponding to an open file for reading in binary mode.
* @param chunk Memory to read the binary data to, at least chunkSize bytes large.
* @param chunkSize Number of bytes to read from file into 'chunk' memory area.
* @return Number of bytes read, this can be less than requested 'chunkSize' when reading the last bytes of
* data. Will return 0 when all data has been read from the file.
*/
size_t(CARB_ABI* readFileChunk)(File* file, void* chunk, size_t chunkSize);
/**
* Writes a chunk of binary data to a file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultFail - A failure was reported during write, \ref getFileStatus() will report error.
* * Other errors may be reported based on the underlying platform calls
*
* @param file An open file for writing in binary mode.
* @param chunk The memory buffer to write to the file.
* @param chunkSize Number of bytes from 'chunk' to write to the file.
* @returns the number of bytes successfully written to the file. This can be less than the
* requested @p chunkSize if an error occurs (ie: disk full).
* @returns 0 if no data could be written to the file.
*/
size_t(CARB_ABI* writeFileChunk)(File* file, const void* chunk, const size_t chunkSize);
/**
* Reads a line of character data from a text file (without including the line ending characters `\r` or `\n`).
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed with a non-`nullptr` return value
* * @ref omni::core::kResultSuccess - At end-of-file
* * @ref omni::core::kResultFail - A failure was reported during read, \ref getFileStatus() will report error.
* * Other errors may be reported based on the underlying platform calls
*
* @note This function considers a `\n` by itself to be a line ending, as well as `\r\n`. A `\r` by itself is not
* considered a line ending. The line endings are consumed from the file stream but are not present in the result.
* @note For @p maxLineSize of 0, `nullptr` is always returned without any change to the @p file read pointer. For
* @p maxLineSize of 1 when not at end-of-file, @p line will only contain a NUL terminator and if a line ending is
* at the start of the file stream it will be consumed.
*
* @param file A file returned from openFileToRead() or openFileToReadWrite().
* @param line The string that will receive the read line. Unlike `fgets()`, the result will NOT end with any line
* ending characters (`\n` or `\r\n`), but they will be consumed from the file stream.
* @param maxLineSize The maximum number of characters that can be read into @p line, including NUL terminator.
* If the buffer is exhausted before end-of-line is reached the buffer will be NUL terminated and thus still a
* proper C-style string but won't necessarily contain the full line from the file.
* @return Returns @p line on each successful read, or `nullptr` if @p file is at end-of-file or an error occurs.
*/
char*(CARB_ABI* readFileLine)(File* file, char* line, size_t maxLineSize);
/**
* Writes a line of characters to a text file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned.
* * @ref omni::core::kResultFail - A failure was reported during write, \ref getFileStatus() will report error.
* * Other errors may be reported based on the underlying platform calls
*
* @param file An file returned from openFileToWrite() or openFileToAppend().
* @param line The null-terminated string to write. A newline will always be appended to the
* string in the file if it is successfully written.
* @returns true if the string is successfully written to the file.
* @returns false if the full string could not be written to the file.
*/
bool(CARB_ABI* writeFileLine)(File* file, const char* line);
/**
* Flushes any unwritten data to the file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * Other errors may be reported based on the underlying platform calls
*
* When a file is closed, either by calling closeFile or during program termination, all the associated buffers are
* automatically flushed.
*
* @param file An open file for writing or appending.
*/
void(CARB_ABI* flushFile)(File* file);
/**
* Removes (deletes) a file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The file was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] path The path of the file to be removed. This must not have any open file
* objects on it otherwise the operation will fail.
* @returns true if the file was removed from the file system.
* @returns false if the file could not be removed. This is often caused by either having
* the file still open by either the calling process or another process, or by
* not having sufficient permission to delete the file.
*/
bool(CARB_ABI* removeFile)(const char* path);
/**
* Make a temporary directory.
*
* The directory is created under the system temporary directory area and will have a randomized name.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultInsufficientBuffer - The provided bufferSize was not sufficient
* * Other errors may be reported based on the underlying platform calls
*
* @param pathBuffer The buffer that will receive the full path to the created directory. This may not
* be `nullptr`.
* @param bufferSize The size of the buffer for storing the path. This size also includes the null
* terminator for the string. If this is too small to store the output path.
* @return `true` if the creation was successful and a path to the newly created temporary directory
* was returned in @p pathBuffer. On success, the temporary directory is guaranteed to exist
* and be writable by the caller. The caller is responsible for removing this directory when
* it is no longer needed.
* @return `false` if the temporary directory could not be created for any reason. In this case, the
* @p pathBuffer buffer will not be modified and its contents will be undefined.
*/
bool(CARB_ABI* makeTempDirectory)(char* pathBuffer, size_t bufferSize);
/** Make a single directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultAlreadyExists - The directory already exists. If `false` is returned then a file exists
* that prevents creation of the directory; if `true` is returned then the directory already exists (not an error)
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to the directory to create. Relative paths will be resolved from the
* current working directory (as returned from getCurrentDirectoryPath()). This
* may not be nullptr or an empty string.
* @retval true if the path did not previously exist and the creation as a folder was successful, or if the path
* already existed as a directory (@ref omni::core::kResultAlreadyExists is reported)
* @retval false if the path already existed as a non-directory entry (@ref omni::core::kResultAlreadyExists), or
* if the path could not be created for another reason (@ref carb::ErrorApi will have reason)
*
* @remarks This attempts to make a single new directory entry. All path components leading up
* to the new path must already exist for this to be expected to succeed. The path
* may already exist and this call will still succeed.
*
* @remarks Note that this operation is global to the system. There is no control over what
* other threads or processes in the system may be simultaneously doing to the named
* path. It is the caller's responsibility to gracefully handle any potential failures
* due to the action of another thread or process.
*
* @note There is a possible race condition with another thread or process creating the same
* path simultaneously. If this occurs, this call will still succeed in most cases.
* There is an additional rare possible race condition where the file or folder could
* also be deleted by an external thread or process after it also beat the calling thread
* to creating the path. In this case, this call will fail. For this to occur there
* would need to be the named path created then immediately destroyed externally.
*
* @note This call itself is thread safe. However, the operation it performs may race with
* other threads or processes in the system. Since file system directories are global
* and shared by other processes, an external caller may create or delete the same
* directory as is requested here during the call. There is unfortunately no way to
* prevent this or make it safer since the creator or deleter of the path may not
* even be local to the system (ie: a network share operation was requested). The
* best a caller can do you be to guarantee its own threads do not simultaneously
* attempt to operate on the same path.
*/
bool(CARB_ABI* makeDirectory)(const char* path);
/** Make one or more directories.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultAlreadyExists - The directory already exists. If `false` is returned then a file exists
* that prevents creation of the directory; if `true` is returned then the directory already exists (not an error)
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to the directory to create. Relative paths will be resolved from the
* current working directory (as returned from getCurrentDirectoryPath()). This
* may not be nullptr or an empty string.
* @retval true if the path did not previously exist and the creation as a folder was successful, or if the path
* already existed as a directory (@ref omni::core::kResultAlreadyExists is reported)
* @retval false if the path already existed as a non-directory entry (@ref omni::core::kResultAlreadyExists), or
* if the path could not be created for another reason (@ref carb::ErrorApi will have reason)
*
* @remarks This attempts to create one or more directories. All components listed in the path
* will be created if they do not already exist. If one of the path components already
* exists as a non-directory object, the operation will fail. If creating any of the
* intermediate path components fails, the whole operation will fail. If any of the
* components already exists as a directory, it will be ignored and continue with the
* operation.
*
* @note This call itself is thread safe. The operation itself may have a race condition with
* other threads or processes however. Please see makeDirectory() for more information
* about these possible race conditions.
*/
bool(CARB_ABI* makeDirectories)(const char* path);
/**
* Remove a directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The directory was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to the directory to remove; relative paths will be resolved from the
* current working directory (as returned from getCurrentDirectoryPath()).
* @return true if the removal was successful, otherwise false.
* @note This will never follow symbolic links. The symbolic link will be removed, but its target will not.
* @note On Windows, it is neither possible to remove the current working directory nor any
* directory containing it. This is because the Windows process holds an open handle
* to the current working directory without delete sharing permissions at all times.
* In order to remove the current working directory, the caller must first change the
* working directory to another valid path, then call removeDirectory(). On Linux,
* removing the current working directory is technically possible, however, doing so
* will leave the process in an undefined state since its working directory is no longer
* valid. Changing away from the working directory before calling this is still a good
* idea even on Linux.
*/
bool(CARB_ABI* removeDirectory)(const char* path);
/**
* Copy a file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAlreadyExists - The target file already exists
* * Other errors may be reported based on the underlying platform calls
*
* @param from The path to a file to copy; relative paths will be resolved from the current
* working directory (as returned from getCurrentDirectoryPath()).
* @param to The destination filename and path; relative paths will be resolved from the
* current working directory (as returned from getCurrentDirectoryPath()).
* @returns \c true if the file was copied successfully; \c false if an error occurs.
*/
bool(CARB_ABI* copy)(const char* from, const char* to);
/**
* Moves (renames) a file or directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAlreadyExists - The target file already exists
* * Other errors may be reported based on the underlying platform calls
*
* @note A rename to the same file will be successful with no error.
*
* @param from The path to a file or directory to rename; relative paths will be resolved from
* the current working directory (as returned from getCurrentDirectoryPath()).
* @param to The destination path; relative paths will be resolved from the current working
* directory (as returned from getCurrentDirectoryPath()).
* @returns \c true if the file was moved successfully; \c false if an error occurs.
*/
bool(CARB_ABI* move)(const char* from, const char* to);
/**
* User implemented callback function type for directory iteration.
*
* @note On Posix systems, a block device, socket, or pipe will still have `info->type` as
* \ref DirectoryItemType::eFile, but \ref ErrorApi::getError() will report \ref omni::core::kResultInvalidDataType;
* otherwise \ref ErrorApi::getError() will report \ref omni::core::kResultSuccess.
*
* @param info about a file. See \ref DirectoryItemInfo. The `path` member will be prefixed by the `path` passed to
* \ref forEachDirectoryItem() (or \ref forEachDirectoryItemRecursive())
* @param userData Any data that needs to be passed to the function for managing state across function calls, etc.
* @return one of the `WalkAction` enum values to instruct forEachDirectoryItem[Recursive] on how to proceed.
*
* @note It is entirely possible that by the time this callback function is called for a given file
* or directory, that file or directory could have already been deleted, moved, or renamed by
* another thread or process. In this case the file information that is passed to the callback
* function may already be out of date. The callback function should take this into account
* before taking any action on the given file or directory. One possible way to detect this
* is to check if the `info->createdTimestamp` and `info->modifiedTimestamp` values are zero.
* The callback could also verify that the file still exists before acting on it.
*/
typedef WalkAction (*OnDirectoryItemFn)(const DirectoryItemInfo* const info, void* userData);
/**
* Iterate through each item in the directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The path was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to the directory; relative paths will be resolved from the current
* working directory (as returned from getCurrentDirectoryPath()).
* @param onDirectoryItem The function to call for each directory item, see \ref OnDirectoryItemFn type
* @param userData The user data passed to the callback function for each item. May be `nullptr`.
*
* @note It is entirely possible that by the time the callback function is called for a given file
* or directory, that file or directory could have already been deleted, moved, or renamed by
* another thread or process. In this case the file information that is passed to the callback
* function may already be out of date. The callback function should take this into account
* before taking any action on the given file or directory. One possible way to detect this
* is to check if the @ref DirectoryItemInfo::createdTimestamp and
* @ref DirectoryItemInfo::modifiedTimestamp values are zero. The callback could also verify
* that the file still exists before acting on it.
*/
void(CARB_ABI* forEachDirectoryItem)(const char* path, OnDirectoryItemFn onDirectoryItem, void* userData);
/**
* Iterate through each item in the directory and recursive into subdirectories.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The path was not found
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to the directory; relative paths will be resolved from the current
* working directory (as returned from getCurrentDirectoryPath()).
* @param onDirectoryItem The function to call for each directory item, see IFileSystem::DirectoryCallback type
* @param userData The user data passed to the callback function for each item.
* @note This will follow symbolic links.
*
* @note It is entirely possible that by the time the callback function is called for a given file
* or directory, that file or directory could have already been deleted, moved, or renamed by
* another thread or process. In this case the file information that is passed to the callback
* function may already be out of date. The callback function should take this into account
* before taking any action on the given file or directory. One possible way to detect this
* is to check if the @ref DirectoryItemInfo::createdTimestamp and
* @ref DirectoryItemInfo::modifiedTimestamp values are zero. The callback could also verify
* that the file still exists before acting on it.
*/
void(CARB_ABI* forEachDirectoryItemRecursive)(const char* path, OnDirectoryItemFn onDirectoryItem, void* userData);
/**
* Subscribes to listen on change events on a path.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless @ref kInvalidSubscriptionId is returned
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultFail - A system error occurred
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to subscribe to.
* This path must be an existing file or directory on disk.
* @param onChangeEvent The callback function to be called when the events are fired.
* @param userData The user data passed to the callback function for each item.
* @returns subscription id if the path was successfully subscribed
* @retval kInvalidSubscriptionId if @p path does not exist, or some other error occurred (see @ref ErrorApi to
* determine the reason)
*
* @note The change subscriptions on directories are not recursive.
* If you watch a directory, you will not get change events for
* files/directories within subdirectories.
*
* @note Modifications to subdirectories (e.g. creating/deleting a file
* inside it) will not produce change events.
* OM-1071: there is a bug in the Windows implementation where deleting
* a file in a subdirectory produces a @ref ChangeAction::eModified event.
*
* @note If @p path points to a directory, deleting the directory will produce
* a @ref ChangeAction::eDeleted event and then no more events will be
* produced from the stream, even if the directory is created again.
* This behavior differs if @p path points to a file. Change events
* will continue to be produced for a file after it's been deleted if
* it's created again.
*
* @note Mac OS only appears to support ~512 subscriptions in a process
* (this value was determined experimentally).
* For subscription 513+, notifications are no longer sent.
*/
SubscriptionId(CARB_ABI* subscribeToChangeEvents)(const char* path, OnChangeEventFn onChangeEvent, void* userData);
/**
* Unsubscribes from listening to change events on a path.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultNotFound - The given \p subscriptionId was not found
* * @ref omni::core::kResultFail - A system error occurred
* * Other errors may be reported based on the underlying platform calls
*
* @note It is safe to call this from within the callback passed to @ref subscribeToChangeEvents(). The function
* will not return until the subscription callback is guaranteed to be exited by all other threads.
*
* @param subscription Subscription id
*/
void(CARB_ABI* unsubscribeToChangeEvents)(SubscriptionId subscriptionId);
/**
* retrieves the current file pointer position for an open file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * @ref omni::core::kResultSuccess - No error occurred
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] file the file object to retrieve the current position for. This may have been
* opened for read or write. Files that were opened for append will always
* write at the end of the file regardless of the current file position. The
* file pointer's current position is typically unused or undefined in the
* append case.
* @returns the current position in the file in bytes relative to the beginning.
* @returns -1 if the file's position could not be retrieved.
*
* @remarks This retrieves the current location of the file pointer in a file that has been
* opened for read, write, or append. The offset is always returned in bytes. The
* current file position may be beyond the end of the file if the file pointer was
* recently placed beyond the end of the file. However, this does not actually
* reflect the size of the file until at least one byte is written into it at the
* new position beyond the file's end.
*/
int64_t(CARB_ABI* getFilePosition)(File* file);
/**
* sets the new file pointer position for an open file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * \ref omni::core::kResultInvalidArgument - an invalid argument was supplied
* * \ref omni::core::kResultFail - an underlying platform call failed
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] file the file object to set the current position for. This may have been
* opened for read or write. Files that were opened for append will
* always write at the end of the file regardless of the current file
* position. The file pointer's current position is typically unused or
* undefined in the append case.
* @param[in] offsetFromWhence the new position for the file pointer relative to the
* location specified in @p whence. This value may be negative
* only if @p whence is not FileWhence::eBegin. This may specify
* an index beyond the current end of the file when combined with
* @p whence.
* @param[in] whence the fixed location in the file to move the file pointer relative to.
* @returns true if the file position was successfully set.
* @returns false if the file position could not be set or was invalid.
*
* @remarks This attempts to reposition the file pointer in an open file. The new absolute
* position may not be negative once combined with @p whence. If the new absolute
* position is beyond the current end of the file, the file will not be extended
* until at least one byte is written into the file at that new position or the file
* is truncated at the current position with truncateFileAtCurrentPosition(). When
* it is written to or truncated with a larger size than previous, the new space
* will be filled with zeros. Note however, that if the file pointer is set beyond
* the end of the file, the getFilePosition() call will return that same position
* even though it is larger than the file currently is.
*/
bool(CARB_ABI* setFilePosition)(File* file, int64_t offsetFromWhence, FileWhence whence);
/**
* truncates a file at the current file position.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - An invalid argument was provided
* * @ref omni::core::kResultAccessDenied - Attempting to truncate a read-only file
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] file the file to be truncated. This must have been opened for write or
* append.
* @retval true if the file was successfully truncated.
* @retval false if the file could not be truncated for any reason.
*
* @remarks This truncates a file at the current file pointer position. This can be used
* to extend a file without needing to write anything to it by opening the file,
* setting the file pointer to the desired size with setFilePointer(), then calling
* this function to set the new end of the file. The new area of the file will be
* filled with zeros if it was extended. If the file is being shortened, all data
* in the file beyond the current file pointer will be removed.
*/
bool(CARB_ABI* truncateFileAtCurrentPosition)(File* file);
/**
* helper functions to move to the beginning of an open file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * Other errors may be reported based on the underlying platform calls
*
* @see setFilePosition()
* @param[in] file the file stream
* @returns \c true if the file pointer is successfully moved; \c false if an error occurs.
*/
bool setFilePositionBegin(File* file);
/**
* helper functions to move to the end of an open file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * Other errors may be reported based on the underlying platform calls
*
* @see setFilePosition()
* @param[in] file the file stream
* @returns \c true if the file pointer is successfully moved; \c false if an error occurs.
*/
bool setFilePositionEnd(File* file);
/**
* opens the file for read and write in binary mode.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `nullptr` is returned
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * @ref omni::core::kResultOutOfMemory - Allocation failure
* * Other errors may be reported based on the underlying platform calls
*
* @param[in] path the absolute or relative path to the file to open. This may not be
* nullptr. Relative paths are resolved from the current working
* directory (as returned from getCurrentDirectoryPath()).
* @returns a new open file stream object if the file is successfully opened. This file
* object must be closed with closeFile() when it is no longer needed.
* @returns nullptr if the file could not be opened for any reason. This can occur if the
* file could not be created or there are insufficient permissions to access the
* file, or an allocation failure occurred.
*
* @remarks This opens a file for both read and write access. If the file already exists, it
* is not truncated. If the file does not exist, it will be created. The file
* pointer is initially placed at the beginning of the file. All writes to the file
* will occur at the current file pointer location.
*/
File*(CARB_ABI* openFileToReadWrite)(const char* path);
/**
* retrieves the current status of a file stream object.
*
* @par Errors
* This function does not modify the calling thread's error state
*
* @param[in] file an open file stream to check the status of.
* @retval FileStatus::eOk if the file stream is still in a valid state and more read or
* write operation may potentially succeed.
* @retval FileStatus::eError if the file stream has encountered an error of any kind.
* This may include a partial write due to a full disk or a disk quota being
* reached.
* @retval FileStatus::eEof if a file stream opened for read has already read the last
* bytes in the file. A future call to readFile*() will simply return 0 or
* nullptr from the same file position.
*
* @remarks This retrieves the current status of a file stream object. The status allows
* the caller to differentiate an error from an end-of-file condition for the
* last file operation. The error condition on the file will be reset after
* each operation after being stored for later retrieval. The file stream status
* value will remain valid until the next operation is performed on the file.
*
* @note As with all other file operations, retrieving this status is not thread safe
* and could change if another thread performs an unprotected operation on the
* same stream. It is the caller's responsibility to ensure operations on the
* file stream are appropriately protected.
*
* @note The file status will not be modified by calls to getFileSize(), getFileModTime(),
* flushFile(), or getFilePosition().
*
*/
FileStatus(CARB_ABI* getFileStatus)(File* file);
/**
* fills the FileInfo struct with info about the given file.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - \p info was \c nullptr or \p path was empty or \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * Other errors may be reported based on the underlying platform calls
*
* @param path The path to the file.
* @param info The struct populated with info about the file.
* @return \c true if information was gathered; \c false if an error occurs.
*/
bool(CARB_ABI* getFileInfo)(const char* path, FileInfo* info);
/**
* Returns the current time of the file system.
*
* @par Errors
* This function does not change error state
*
* @returns the current time as via `time(0)`
*/
time_t(CARB_ABI* getCurrentTime)();
/**
* Tests whether it's possible to read a file or directory.
*
* @par Errors
* Accessible via @ref carb::ErrorApi
* * Note: Error state is not changed unless `false` is returned
* * @ref omni::core::kResultInvalidArgument - \p path is `nullptr`
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultAccessDenied - Access was denied to the file
* * Other errors may be reported based on the underlying platform calls
*
* @param path The absolute or relative path to test for readability. Relative paths are
* resolved from the current working directory (as returned from the
* getCurrentDirectoryPath() function). This may not be `nullptr` or an
* empty string.
* @returns `true` if the given file or directory exists and is readable by the calling user.
* Returns `false` if the file or directory doesn't exist or the user does not have
* permission to read from it. For a directory, readability represents permission
* to list the contents of the directory.
*
* @note This accessibility check only answers the question of whether the user has
* _permission_ to read the file, not that an open for read will always succeed.
* At least on Windows, it is still possible that another thread or process could
* have the file open without read sharing capabilities. In this case, the caller
* should just do a test open of the file since that will answer the question of
* whether read sharing is currently allowed on the file. On Linux there isn't any
* kernel enforced file sharing functionality so permission to the file should also
* imply the user will succeed to open it for read.
*/
bool(CARB_ABI* isReadable)(const char* path);
/**
* Use platform functions to build canonical path relative to the base root.
*
* The path must exist if \ref fCanonicalFlagCheckExists is passed in the \p flags parameter.
*
* @par Errors
* Accessible via @ref carb::ErrorApi. This function always modifies the error state.
* * @ref omni::core::kResultSuccess - No error occurred
* * @ref omni::core::kResultInvalidArgument - \p path was \c nullptr
* * @ref omni::core::kResultNotFound - The file was not found
* * @ref omni::core::kResultInsufficientBuffer - The provided \p buffer was too small to receive the canonicalized
* string. The contents of \p buffer are unchanged and the return value is the number of bytes required (including
* the NUL terminator).
* * @ref omni::core::kResultNullPointer - No buffer was provided, so nothing was written. The return value is the
* number of bytes required to contain the canonical path (include the NUL terminator).
* * Other errors may be reported based on the underlying platform calls
*
* If returned size is greater than passed bufferSize, then nothing is written to the buffer.
* If returned size is 0, then canonical path failed to be built or doesn't exist.
*
* @param path The absolute or relative path to canonicalize.
* @param base The base path to resolve relative path against. This can be `nullptr`to use
* the working directory (as returned from getCurrentDirectoryPath()) to resolve
* the relative path.
* @param flags Flags to control the behavior of this operation.
* @param buffer The buffer to write the canonical path to. This may be `nullptr` if only
* the required size of the buffer is needed.
* @param bufferSize The size of the buffer @p buffer in bytes.
* @return The number of bytes written to the buffer @p buffer if the buffer is large enough.
* If the buffer is not large enough, nothing will be written to the buffer and the
* required size of the buffer in bytes will be returned. If an error occurs, 0 is returned.
*
* @note By default, this assumes that the requested file exists on the filesystem. On
* Linux, the existence of the file will still be checked as a side effect of the
* operation. On Windows however, no explicit check for the file existing in the
* filesystem will be performed unless the @ref fCanonicalFlagCheckExists is used.
*/
size_t(CARB_ABI* makeCanonicalPathEx2)(
const char* path, const char* base, CanonicalFlags flags, char* buffer, size_t bufferSize);
};
inline std::string IFileSystem::makeCanonicalPath(const char* path, const char* base, CanonicalFlags flags)
{
std::string str(128, '\0');
size_t bytes = this->makeCanonicalPathEx2(path, base, flags, &str[0], str.size());
if (bytes == 0)
return {};
if (bytes > str.size())
{
str.resize(bytes);
bytes = this->makeCanonicalPathEx2(path, base, flags, &str[0], str.size());
CARB_ASSERT(bytes != 0 && str.size() >= bytes);
}
str.resize(bytes - 1); // Bytes includes the NUL terminator, so remove it here
return str;
}
inline bool IFileSystem::setFilePositionBegin(File* file)
{
return setFilePosition(file, 0, FileWhence::eBegin);
}
inline bool IFileSystem::setFilePositionEnd(File* file)
{
return setFilePosition(file, 0, FileWhence::eEnd);
}
} // namespace filesystem
} // namespace carb
| 69,643 | C | 52.53113 | 120 | 0.66861 |
omniverse-code/kit/include/carb/assert/AssertUtils.h | // Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Helper utility functions to modify assertion failure behavior.
*/
#pragma once
#include "../Framework.h"
/** Placeholder macro for any work that needs to be done at the global level for any IAssert
* related functionality. Do not call this directly.
*/
#define CARB_ASSERT_GLOBALS()
/** Namespace for all low level Carbonite functionality. */
namespace carb
{
/** Namespace for all assertion checking helpers and interfaces. */
namespace assert
{
/** Registers the IAssert implementation with the calling module.
*
* @returns No return value.
*
* @remarks This will be called once during framework startup to attempt to register the
* IAssert interface implementation with the calling module. Once the interface
* is acquired, it will be valid through @ref g_carbAssert until the framework
* is shutdown.
*/
inline void registerAssertForClient() noexcept
{
g_carbAssert = getFramework()->tryAcquireInterface<IAssert>();
}
/** Removes the global instance of the IAssert interface.
*
* @returns No return value.
*
* @remarks This will be called during framework shutdown or module unload to clear out the
* IAssert interface pointer for the module. Once cleared out, all functionality
* that makes use of it will be effectively disabled for that module.
*/
inline void deregisterAssertForClient() noexcept
{
g_carbAssert = nullptr;
}
/** Disables the assertion failure dialog for the process.
*
* @param[in] disable `true` to disable the assertion dialog from appearing. `false` to enable
* the assertion dialog.
*
* @returns The previous value of the `disableDialog` flag, in other words: `true` if the dialog
* was previously disabled; `false` if the dialog was previously enabled.
*
* @remarks By default this dialog only shows on Windows when not attached to a debugger.
* Disabling the dialog is useful for test apps or unit tests that want to run in a
* 'headless' mode but that may still trigger assertions. In this case, at least if
* the assertion fails and the process possibly crashes, it won't be stuck waiting
* on user input.
*/
inline bool disableDialog(bool disable)
{
if (g_carbAssert)
{
return !!(g_carbAssert->setAssertionFlags(disable ? fAssertSkipDialog : 0, disable ? 0 : fAssertSkipDialog) &
fAssertSkipDialog);
}
return false;
}
/** Sets whether the software breakpoint for a failed assertion should be triggered.
*
* @param[in] enabled Set to `true` to trigger the software breakpoint when an assertion fails.
* Set to `false` to skip over the software breakpoint and just continue
* execution when an assertion fails. The default behavior is to always
* trigger the software breakpoint unless it is overridden by user input
* on the assertion dialog (if enabled).
* @returns The previous value of the `useBreakpoint` flag, in other words: `true` if breakpoints
* were previously enabled; `false` if breakpoints were previously disabled.
*
* @remarks This sets whether the software breakpoint for failed assertions should be triggered.
* This can be used to allow failed assertions to just continue execution instead of
* hitting the software breakpoint. The assertion failure message is always still
* written to the log destinations. This is useful for checking whether certain 'safe'
* assertions failed during execution - allow them to continue execution as normal,
* then periodically check the assertion failure count with getFailureCount().
* Note that this still won't prevent a crash after a 'fatal' assertion fails.
*/
inline bool useBreakpoint(bool enabled)
{
if (g_carbAssert)
{
return !(g_carbAssert->setAssertionFlags(enabled ? 0 : fAssertSkipBreakpoint, enabled ? fAssertSkipBreakpoint : 0) &
fAssertSkipBreakpoint);
}
return true;
}
/** Sets whether a message should be printed out to the console on a failed assertion.
*
* @param[in] enabled Set to `true` to cause an assertion message to be printed to the console when
* an assertion fails. Set to `false` to prevent the assertion message from showing.
* The assertion message is shown by default.
* @return The previous value of the `showToConsole` flag, in other words: `true` if show-to-console was
* previously enabled; `false` if show-to-console was previously disabled.
*/
inline bool showToConsole(bool enabled)
{
if (g_carbAssert)
{
return !(g_carbAssert->setAssertionFlags(enabled ? 0 : fAssertNoConsole, enabled ? fAssertNoConsole : 0) &
fAssertNoConsole);
}
return true;
}
/** Retrieves the current assertion failure count for the calling process.
*
* @returns The total number of assertions that have failed in the calling process. For most
* normally functioning apps, this should always be zero. This can be used in unit
* tests to determine whether some 'safe' assertions failed without requiring manual
* verification or user input. When used in unit tests, this should be combined with
* carbAssertUseBreakpoint() to ensure the normal execution isn't stopped if an
* assertion fails.
*/
inline uint64_t getFailureCount()
{
return g_carbAssert ? g_carbAssert->getAssertionFailureCount() : 0;
}
} // namespace assert
} // namespace carb
| 6,118 | C | 41.493055 | 124 | 0.695816 |
omniverse-code/kit/include/carb/assert/IAssert.h | // Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Provides an interface to allow for more detailed assertion failure dialogues.
*/
#pragma once
// NOTE: this interface is included and used in a very low level header. No more headers than are
// absolutely necessary should be included from here.
#include "../Interface.h"
#include <stdarg.h>
/** Namespace for all low level Carbonite functionality. */
namespace carb
{
/** Namespace for all assertion checking helpers and interfaces. */
namespace assert
{
/** Base type for the flags that control the behavior of CARB_ASSERT() and CARB_CHECK() failure reporting. */
using AssertFlags = uint32_t;
/** Flag to indicate that the assertion confirmation dialog should always be skipped for this
* process. When set, the dialog will be assumed to always behave as though the button to
* break into the debugger had been pressed. When clear, the dialog will show based on
* platform defaults.
*/
constexpr AssertFlags fAssertSkipDialog = 0x00000001;
/** Flag to indicate that the software breakpoint that is triggered on a failing assertion
* is to be ignored. When set, the breakpoint will never be executed and execution will
* simply continue after reporting the failed assertion to the logs. When clear, the
* breakpoint will be executed normally.
*/
constexpr AssertFlags fAssertSkipBreakpoint = 0x00000002;
/** Flag to indicate that the assertion should not produce any console output. When set, an
* assertion will not print anything to the console, but the failure count will increase.
*/
constexpr AssertFlags fAssertNoConsole = 0x00000004;
/** Interface to provide functionality to display assertion failures in greater detail. This
* provides a way to encapsulate OS specific functionality for gathering additional information,
* displaying dialogues, and providing additional debugging functionality. Without this interface,
* assertion failure reports are only really limited to log messages and software breakpoints.
*/
struct IAssert
{
CARB_PLUGIN_INTERFACE("carb::assert::IAssert", 1, 0)
/** Sets, clears, or retrieves the assertion behavioral flags.
*
* @param[in] set A mask of zero or more flags to enable. This may be 0 to indicate
* that no new flags should be set. This is a combination of the
* fAssert* flags.
* @param[in] clear A mask of zero or more flags to disable. This may be 0 to indicate
* that no new flags should be cleared. This is a combination of the
* fAssert* flags.
* @returns The flags immediately before set/clear changes were applied.
*
* @note This is always thread safe; changes are applied atomically. Also, set and clear can be 0
* to retrieve the current set of flags.
*/
AssertFlags(CARB_ABI* setAssertionFlags)(AssertFlags set, AssertFlags clear);
/** Retrieves the count of how many assertions have failed.
*
* @returns The number of assertions that have failed in the calling process.
*
* @remarks This retrieves the current number of assertion failures that have occurred in the
* calling process. This may be combined with using the @ref fAssertSkipBreakpoint
* and @ref fAssertSkipDialog flags to allow certain assertions to continue in a
* 'headless' mode whose behavior can then be monitored externally.
*/
uint64_t(CARB_ABI* getAssertionFailureCount)();
/** Reports the failure of an assertion condition to all applicable destinations.
*
* @param[in] condition The text describing the failed assertion condition. This may not be
* `nullptr`.
* @param[in] file The name of the file that the assertion is in. This may not be
* `nullptr`.
* @param[in] func The name of the function that the assertion is in. This may not be
* `nullptr`.
* @param[in] line The line number that the assertion failed in.
* @param[in] fmt A printf() style format string providing more information for the
* failed assertion. This may be `nullptr` if no additional information
* is necessary or provided.
* @param[in] ... Additional arguments required to fulfill the format string's needs.
* Note that this is expected to be a single va_list object containing
* the arguments. For this reason, the @ref reportFailedAssertion()
* variant is expected to be the one that is called instead of the 'V'
* one being called directly.
* @returns `true` if a software breakpoint should be triggered.
* @returns `false` if the assertion should attempt to be ignored.
*
* @remarks This handles displaying an assertion failure message to the user. The failure
* message will be unconditionally written to the attached console and the debugger
* output window (if running on Windows under a debugger). If no debugger is
* attached to the process, a simple message box will be shown to the user indicating
* that an assertion failure occurred and allowing them to choose how to proceed.
* If a debugger is attached, the default behavior is to break into the debugger
* unconditionally.
*
* @note If running under the MSVC debugger, double clicking on the assertion failure text
* in the MSVC output window will jump to the source file and line containing the
* failed assertion.
*/
bool(CARB_ABI* reportFailedAssertionV)(
const char* condition, const char* file, const char* func, int32_t line, const char* fmt, ...);
/** Reports the failure of an assertion condition to all applicable destinations.
*
* @param[in] condition The text describing the failed assertion condition. This may not be
* `nullptr`.
* @param[in] file The name of the file that the assertion is in. This may not be
* `nullptr`.
* @param[in] func The name of the function that the assertion is in. This may not be
* `nullptr`.
* @param[in] line The line number that the assertion failed in.
* @param[in] fmt A printf() style format string providing more information for the
* failed assertion. This may be `nullptr` if no additional information
* is necessary or provided.
* @param[in] ... Additional arguments required to fulfill the format string's needs.
* @returns `true` if a software breakpoint should be triggered.
* @returns `false` if the assertion should attempt to be ignored.
*
* @remarks This handles displaying an assertion failure message to the user. The failure
* message will be unconditionally written to the attached console and the debugger
* output window (if running on Windows under a debugger). If no debugger is
* attached to the process, a simple message box will be shown to the user indicating
* that an assertion failure occurred and allowing them to choose how to proceed.
* If a debugger is attached, the default behavior is to break into the debugger
* unconditionally.
*
* @note If running under the MSVC debugger, double clicking on the assertion failure text
* in the MSVC output window will jump to the source file and line containing the
* failed assertion.
*
* @note This variant of the function is present to allow the @p fmt parameter to default
* to `nullptr` so that it can be used with a version of the CARB_ASSERT() macro that
* doesn't pass any message.
*/
bool reportFailedAssertion(
const char* condition, const char* file, const char* func, int32_t line, const char* fmt = nullptr, ...)
{
va_list args;
bool result;
va_start(args, fmt);
result = reportFailedAssertionV(condition, file, func, line, fmt, &args);
va_end(args);
return result;
}
};
} // namespace assert
} // namespace carb
/** Defines the global variable that holds the pointer to the IAssert implementation. This will
* be `nullptr` if the IAssert interface is unavailable, disabled, or has not been initialized
* yet. This variable is specific to each module.
*/
CARB_WEAKLINK CARB_HIDDEN carb::assert::IAssert* g_carbAssert;
| 9,338 | C | 52.982659 | 112 | 0.659242 |
omniverse-code/kit/include/carb/streamclient/StreamClient.h | // Copyright (c) 2019-2020, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <carb/Interface.h>
#include <carb/cudainterop/CudaInterop.h>
#include <carb/graphics/Graphics.h>
#include <carb/input/IInput.h>
namespace carb
{
namespace streamclient
{
class Context;
class Frame;
/**
* Defines the streamclient interface.
*/
struct StreamClient
{
CARB_PLUGIN_INTERFACE("carb::streamclient::StreamClient", 0, 2);
/**
* Creates stream client context.
*
* @param[in] graphics A pointer to a graphics interface to use.
* @param[in] cudaInterop A pointer to a CUDA interop interface.
* @param[in] device A pointer to a graphics device instance.
* @return A pointer to the stream client context or nullptr.
*/
Context*(CARB_ABI* createContext)(carb::graphics::Graphics* graphics,
carb::cudainterop::CudaInterop* cudaInterop,
carb::graphics::Device* device);
/**
* Destroys stream client context.
*
* @param[in] ctx A pointer to the stream client context.
*/
void(CARB_ABI* destroyContext)(Context* ctx);
/**
* Starts stream client.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] addr A pointer to a server IP address.
* @param[in] port A server port number.
* @return true if client started and connected successfully.
*/
bool(CARB_ABI* startClient)(Context* ctx, const char* addr, uint16_t port);
/**
* Stops stream client.
*
* @param[in] ctx A pointer to the stream client context.
*/
void(CARB_ABI* stopClient)(Context* ctx);
/**
* Pushes keyboard input event to a remote stream server.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] evt A reference to the keyboard input event description.
*/
void(CARB_ABI* pushKeyboardEvent)(Context* ctx, const carb::input::KeyboardEvent& evt);
/**
* Pushes mouse input event to a remote stream server.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] evt A reference to the mouse input event description.
*/
void(CARB_ABI* pushMouseEvent)(Context* ctx, const carb::input::MouseEvent& evt);
/**
* Pushes gamepad input event to a remote stream server.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] evt A reference to the gamepad input event description.
*/
void(CARB_ABI* pushGamepadEvent)(Context* ctx, const carb::input::GamepadEvent& evt);
/**
* Pushes window resize event to a remote stream server.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] width New window width.
* @param[in] height New window height.
*/
void(CARB_ABI* pushResizeEvent)(Context* ctx, uint32_t width, uint32_t height);
/**
* Fetches video frame from streaming queue.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] cmdList A pointer to the graphics command list to store readback and transformation commands.
* @return A pointer to a video frame object or nullptr.
*
* The lifetime of each video frame object is managed inside stream client context, so caller don't have manage it
* by self. The contents of video frame object becomes invalid after Nth call of fetch function.
*
* This method DOES NOT execute the command list, just adds readback, transformation and resource state transition
* commands in it. So the actual frame content will be available only after the command list will be executed on the
* caller side. Additionally, caller could add a fence in the same list after this method call to check when the
* frame content will be ready. It is not nessesary if caller uses the same command list for rendering commands.
*/
Frame*(CARB_ABI* fetchFrame)(Context* ctx, carb::graphics::CommandList* cmdList);
/**
* Renders video frame with built-in tiny renderer.
*
* @param[in] ctx A pointer to the stream client context.
* @param[in] cmdList A pointer to the graphics command list to store rendering commands.
* @param[in] frame A pointer to the video frame object or nullptr.
*
* This method DOES NOT render and DOES NOT execute the command list. It adds rendering commands in the
* provided command list for subsequent execution on the caller side.
*/
void(CARB_ABI* renderFrame)(Context* ctx, carb::graphics::CommandList* cmdList, Frame* frame);
/**
* Returns a pointer to texture object from a video frame object.
*
* @param[in] frame A pointer to a frame object obtained from fetchFrame call.
* @return a pointer to texture object or nullptr.
*/
carb::graphics::Texture*(CARB_ABI* getFrameTexture)(const Frame* frame);
/**
* Returns a pointer to texture descriptor object from a video frame object.
*
* @param[in] frame A pointer to a frame object obtained from fetchFrame call.
* @return a pointer to texture descriptor object or nullptr.
*/
carb::graphics::Descriptor*(CARB_ABI* getFrameDescriptor)(const Frame* frame);
/**
* Returns an extent of a video frame.
*
* @param[in] frame A pointer to a frame object obtained from fetchFrame call.
* @return a pair of { width, height } for a given frame.
*/
carb::Uint2(CARB_ABI* getFrameExtent)(const Frame* frame);
};
} // namespace streamclient
} // namespace carb
| 5,975 | C | 37.805195 | 120 | 0.675816 |
omniverse-code/kit/include/carb/streamclient/StreamClientUtils.h | // Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <algorithm>
#include <utility>
#include <carb/Defines.h>
#include <carb/Framework.h>
#include <carb/streamclient/StreamClient.h>
namespace carb
{
namespace streamclient
{
/**
* Defines the wrapper around streamclient interface and context.
*/
class StreamClientWrapper
{
public:
/**
* Constructs an uninitilized wrapper object.
*/
inline StreamClientWrapper(){};
/**
* Deinitialize and destroys wrapper object.
*/
virtual ~StreamClientWrapper()
{
done();
};
inline void swap(StreamClientWrapper& other)
{
std::swap(m_interface, other.m_interface);
std::swap(m_context, other.m_context);
}
inline std::string resolvePath(const std::string& path, const std::string& root = "")
{
auto tokens = carb::getCachedInterface<carb::tokens::ITokens>();
carb::extras::Path resultPath = carb::tokens::resolveString(tokens, path.c_str());
// If relative - relative to the root
if (!root.empty() && resultPath.isRelative())
{
resultPath = carb::extras::Path(root).join(resultPath);
}
return resultPath;
}
public:
/**
* Initialize the wrapper instance
*
* @param[in] framework A pointer to a framework interface to use.
* @param[in] graphics A pointer to a graphics interface to use.
* @param[in] cudaInterop A pointer to a CUDA interop interface.
* @param[in] device A pointer to a graphics device instance.
* @return True if successfull.
*/
bool init(carb::Framework* framework,
carb::graphics::Graphics* graphics,
carb::cudainterop::CudaInterop* cudaInterop,
carb::graphics::Device* device)
{
{
// Ensure we load the plugin
const std::string gfxPath = resolvePath("${kit}/plugins/gpu.foundation");
const char* paths[] = { gfxPath.c_str() };
const char* plugins[] = { "carb.livestream.plugin" };
loadPluginsFromPatterns(plugins, countOf(plugins), paths, countOf(paths));
}
m_interface = framework->acquireInterface<carb::streamclient::StreamClient>();
if (!m_interface)
{
return false;
}
m_context = m_interface->createContext(graphics, cudaInterop, device);
if (!m_context)
{
return false;
}
return true;
}
/**
* Deinitialize the wrapper instance.
*/
void done()
{
if (m_interface && m_context)
{
m_interface->stopClient(m_context);
m_interface->destroyContext(m_context);
m_context = nullptr;
}
}
/**
* Starts stream client.
*
* @param[in] addr A pointer to a server IP address.
* @param[in] port A server port number.
* @return true if client started and connected successfully.
*/
bool start(const char* addr, uint16_t port)
{
if (m_interface && m_context)
{
return m_interface->startClient(m_context, addr, port);
}
return false;
}
/**
* Stops stream client.
*/
void stop()
{
if (m_interface && m_context)
{
m_interface->stopClient(m_context);
}
}
/**
* Pushes keyboard input event to a remote stream server.
*
* @param[in] evt A reference to the keyboard input event description.
*/
void pushKeyboardEvent(const carb::input::KeyboardEvent& evt)
{
if (m_interface && m_context)
{
m_interface->pushKeyboardEvent(m_context, evt);
}
}
/**
* Pushes mouse input event to a remote stream server.
*
* @param[in] evt A reference to the keyboard input event description.
*/
void pushMouseEvent(const carb::input::MouseEvent& evt)
{
if (m_interface && m_context)
{
m_interface->pushMouseEvent(m_context, evt);
}
}
/**
* Pushes gamepad input event to a remote stream server.
*
* @param[in] evt A reference to the mouse input event description.
*/
void pushGamepadEvent(const carb::input::GamepadEvent& evt)
{
if (m_interface && m_context)
{
m_interface->pushGamepadEvent(m_context, evt);
}
}
/**
* Pushes window resize event to a remote stream server.
*
* @param[in] width New window width.
* @param[in] height New window height.
*/
void pushResizeEvent(uint32_t width, uint32_t height)
{
if (m_interface && m_context)
{
m_interface->pushResizeEvent(m_context, width, height);
}
}
/**
* Fetches video frame from streaming queue.
*
* @param[in] cmdList A pointer to the graphics command list to store readback and transformation commands.
* @return A pointer to a video frame object or nullptr.
*/
Frame* fetchFrame(carb::graphics::CommandList* cmdList)
{
if (m_interface && m_context && cmdList)
{
return m_interface->fetchFrame(m_context, cmdList);
}
return nullptr;
}
/**
* Renders video frame with built-in tiny renderer.
*
* @param[in] cmdList A pointer to the graphics command list to store rendering commands.
* @param[in] frame A pointer to the video frame object or nullptr.
*/
void renderFrame(carb::graphics::CommandList* cmdList, Frame* frame)
{
if (m_interface && m_context && cmdList && frame)
{
m_interface->renderFrame(m_context, cmdList, frame);
}
}
/**
* Returns a pointer to texture object from a video frame object.
*
* @param[in] frame A pointer to a frame object obtained from fetchFrame call.
* @return a pointer to texture object or nullptr.
*/
carb::graphics::Texture* getFrameTexture(const Frame* frame)
{
if (m_interface && frame)
{
return m_interface->getFrameTexture(frame);
}
return nullptr;
}
/**
* Returns a pointer to texture descriptor object from a video frame object.
*
* @param[in] frame A pointer to a frame object obtained from fetchFrame call.
* @return a pointer to texture descriptor object or nullptr.
*/
carb::graphics::Descriptor* getFrameDescriptor(const Frame* frame)
{
if (m_interface && frame)
{
return m_interface->getFrameDescriptor(frame);
}
return nullptr;
}
/**
* Returns an extent of a video frame.
*
* @param[in] frame A pointer to a frame object obtained from fetchFrame call.
* @return a pair of { width, height } for a given frame.
*/
carb::Uint2 getFrameExtent(const Frame* frame)
{
if (m_interface && frame)
{
return m_interface->getFrameExtent(frame);
}
return { 0, 0 };
}
private:
StreamClientWrapper(const StreamClientWrapper&) = delete;
StreamClientWrapper& operator=(const StreamClientWrapper&) = delete;
private:
carb::streamclient::StreamClient* m_interface = nullptr;
carb::streamclient::Context* m_context = nullptr;
};
} // namespace streamclient
} // namespace carb
| 7,802 | C | 26.867857 | 111 | 0.600487 |
omniverse-code/kit/include/carb/livestream/StreamServer.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <carb/Interface.h>
#include <carb/cudainterop/CudaInterop.h>
#include <carb/graphics/Graphics.h>
#include <carb/graphicsmux/GraphicsMux.h>
#include <carb/input/IInput.h>
namespace carb
{
namespace livestream
{
class Context;
enum class AudioSampleFormat: uint32_t
{
eSFloat, //! floating point in the range [-1 .. 1]
eUFloat, //! floating point in the range [0 .. 1]
eSInt16, //! signed 16-bit integer in the range [INT16_MIN .. INT16_MAX]
eUInt16 //! unsigned 16-bit integer in the range [0 .. UINT16_MAX]
};
/**
* Describes audio samples buffer
*/
struct AudioSamplesDesc
{
AudioSampleFormat sampleFormat; //! audio sample format
uint32_t samplingRate; //! sampling rate (sampling frequency) in Hertz
uint32_t channelCount; //! total number of channels
uint32_t channelMask; //! channel presence mask (unmuted channels are marked with non-zero bits)
};
/**
* Defines the Livestream Vision interface.
*/
struct Vision
{
CARB_PLUGIN_INTERFACE("carb::livestream::Vision", 0, 4);
/**
* Creates Livestream Vision context.
*
* @param graphics Pointer to optional graphics interface to use or nullptr.
* @param graphicsmux Pointer to optional graphics multiplexing API for async CUDA command recording or nullptr.
* @param device Pointer to optional graphics device instance or nullptr.
* @return Pointer to Livestream Vision context or nullptr.
*/
Context*(CARB_ABI* createContext)(carb::graphics::Graphics* graphics,
carb::graphicsmux::GraphicsMux* graphicsMux,
carb::graphics::Device* device);
/**
* Destroys Livestream Vision context.
*
* @param ctx Pointer to the Livestream Vision context.
*/
void(CARB_ABI* destroyContext)(Context* ctx);
/**
* Binds input interfaces to a Livestream Vision context.
*
* @param ctx Pointer to the Livestream Vision context.
* @param keyboard Pointer to the keyboard input interface.
* @param mouse Pointer to the mouse input interface.
* @param gamepad Pointer to the gamepad input interface.
*/
void(CARB_ABI* bindInput)(Context* ctx,
carb::input::Keyboard* keyboard,
carb::input::Mouse* mouse,
carb::input::Gamepad* gamepad);
/**
* Pump the cached livestream input events into carb::input.
* This function must be called from main thread.
*
* @param ctx Pointer to the Livestream Vision context.
*/
void(CARB_ABI* updateInput)(Context* ctx);
/**
* Starts Livestream Vision server.
*
* @param ctx Pointer to the Livestream Vision context.
* @return true if server started successfully.
*/
bool(CARB_ABI* startServer)(Context* ctx);
/**
* Stops Livestream Vision server.
*
* @param ctx Pointer to the Livestream Vision context.
*/
void(CARB_ABI* stopServer)(Context* ctx);
/**
* Get remote client width and height.
*
* @param ctx Pointer to the Livestream Vision context.
* @param extent Pointer to an extent destination.
* @return true if extent is filled with valid data.
*/
bool(CARB_ABI* getRemoteClientExtent)(Context* ctx, carb::Uint2* extent);
/**
* Records a command to send a frame from a CUDA buffer memory.
*
* @param ctx Pointer to the Livestream Vision context.
* @param commandList Pointer to the command list to use.
* @param cudaMemory Unified pointer to the CUDA buffer memory.
* @param pitch The frame row pitch in bytes.
* @param width The frame width in pixels.
* @param height The frame height in rows.
*/
void(CARB_ABI* cmdSendCudaMemoryFrame)(Context* ctx,
carb::graphicsmux::CommandList* commandList,
void* cudaMemory,
uint32_t pitch,
uint32_t width,
uint32_t height);
/**
* Enqueue a frame from a CUDA buffer memory.
*
* @param ctx Pointer to the Livestream Vision context.
* @param cudaMemory Unified pointer to the CUDA buffer memory.
* @param pitch The frame row pitch in bytes.
* @param width The frame width in pixels.
* @param height The frame height in rows.
*/
void(CARB_ABI* sendCudaMemoryFrame)(Context* ctx, void* cudaMemory, uint32_t pitch, uint32_t width, uint32_t height);
/**
* Enqueue a frame from a CUDA buffer external memory.
*
* @param ctx Pointer to the Livestream Vision context.
* @param cudaExternalMemory Pointer to the CUDA buffer external memory.
* @param pitch The frame row pitch in bytes.
* @param width The frame width in pixels
* @param height The frame height in rows
*/
void(CARB_ABI* sendCudaExternalMemoryFrame)(Context* ctx,
carb::cudainterop::ExternalMemory* cudaExternalMemory,
uint32_t pitch,
uint32_t width,
uint32_t height);
/**
* Enqueue a frame from a shared texture.
*
* @param ctx Pointer to the Livestream Vision context.
* @param textureHandle Pointer to the shared texture handle description.
* @param texture Pointer to the texture object.
*/
void(CARB_ABI* sendSharedTextureFrame)(Context* ctx,
carb::graphics::SharedResourceHandle* textureHandle,
carb::graphics::Texture* texture);
/**
* Enqueue an audio samples.
*
* @param ctx Pointer to the Livestream Vision context.
* @param buf Pointer to the auduo samples buffer.
* @param size Audio samples buffer size in bytes.
* @param time Audio samples starting time in milleseconds.
* @param desc Audio samples description.
*/
void(CARB_ABI* sendAudioSamples)(Context* ctx, const void* buf, size_t size, uint32_t time, const AudioSamplesDesc& desc);
};
} // namespace livestream
} // namespace carb
| 6,817 | C | 36.668508 | 126 | 0.624908 |
omniverse-code/kit/include/carb/livestream/StreamServerUtils.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <carb/Defines.h>
#include <carb/Framework.h>
#include <carb/livestream/StreamServer.h>
#include <algorithm>
#include <utility>
namespace carb
{
namespace livestream
{
/**
* Defines the wrapper around stream server interface and its context.
*/
class StreamServerWrapper
{
public:
/**
* Constructs an uninitilized wrapper object.
*/
inline StreamServerWrapper(){};
/**
* Deinitialize and destroys wrapper object.
*/
virtual ~StreamServerWrapper()
{
done();
};
inline void swap(StreamServerWrapper& other)
{
std::swap(m_interface, other.m_interface);
std::swap(m_context, other.m_context);
}
public:
/**
* Initialize the wrapper instance.
*
* @param[in] framework Pointer to a framework interface to use.
* @param[in] graphics Pointer to a graphics interface to use.
* @param[in] graphicsMux Pointer to optional graphics multiplexing API for async CUDA command recording or nullptr.
* @param[in] device Pointer to a graphics device instance.
* @return true if successfull.
*/
bool init(carb::Framework* framework,
carb::graphics::Graphics* graphics,
carb::graphicsmux::GraphicsMux* graphicsMux,
carb::graphics::Device* device)
{
m_interface = framework->tryAcquireInterface<carb::livestream::Vision>();
if (!m_interface)
{
return false;
}
m_context = m_interface->createContext(graphics, graphicsMux, device);
if (!m_context)
{
return false;
}
return true;
}
/**
* Deinitialize the wrapper instance.
*/
void done()
{
if (m_interface && m_context)
{
m_interface->stopServer(m_context);
m_interface->destroyContext(m_context);
m_context = nullptr;
}
}
/**
* Check if the wrapper instance is initialized properly.
*
* @return true if the wrapper is initialized properly.
*/
inline bool isValid() const
{
return (m_interface && m_context);
}
/**
* Binds input interfaces to a server context.
*
* @param keyboard Pointer to the keyboard input interface.
* @param mouse Pointer to the mouse input interface.
* @param gamepad Pointer to the gamepad input interface.
*/
void bindInput(carb::input::Keyboard* keyboard, carb::input::Mouse* mouse, carb::input::Gamepad* gamepad)
{
if (m_interface && m_context)
{
m_interface->bindInput(m_context, keyboard, mouse, gamepad);
}
}
/**
* Pump the remote client cached input events into carb::input.
* This function must be called from main thread.
*/
void updateInput()
{
if (m_interface && m_context)
{
m_interface->updateInput(m_context);
}
}
/**
* Starts streaming server.
*
* @return true if server started successfully.
*/
bool start()
{
if (m_interface && m_context)
{
return m_interface->startServer(m_context);
}
return false;
}
/**
* Stops streaming server.
*/
void stop()
{
if (m_interface && m_context)
{
m_interface->stopServer(m_context);
}
}
/**
* Get remote client cached width and height.
*
* @param extent Pointer to an extent destination.
* @return true if extent is filled with valid data.
*/
bool getRemoteClientExtent(carb::Uint2* extent)
{
if (m_interface && m_context && extent)
{
return m_interface->getRemoteClientExtent(m_context, extent);
}
return false;
}
/**
* Records a command to send a frame from a CUDA buffer memory.
*
* @param commandList Pointer to the command list to use.
* @param cudaMemory Unified pointer to the CUDA buffer memory.
* @param pitch The frame row pitch in bytes.
* @param width The frame width in pixels.
* @param height The frame height in rows.
*/
void cmdSendCudaMemoryFrame(
carb::graphicsmux::CommandList* commandList, void* cudaMemory, uint32_t pitch, uint32_t width, uint32_t height)
{
if (m_interface && m_context)
{
m_interface->cmdSendCudaMemoryFrame(m_context, commandList, cudaMemory, pitch, width, height);
}
}
/**
* Enqueue a frame from a CUDA buffer memory.
*
* @param cudaMemory Unified pointer to the CUDA buffer memory.
* @param pitch The frame row pitch in bytes.
* @param width The frame width in pixels.
* @param height The frame height in rows.
*/
void sendCudaMemoryFrame(void* cudaMemory, uint32_t pitch, uint32_t width, uint32_t height)
{
if (m_interface && m_context)
{
m_interface->sendCudaMemoryFrame(m_context, cudaMemory, pitch, width, height);
}
}
/**
* Enqueue a frame from a CUDA buffer external memory.
*
* @param cudaExternalMemory Pointer to the CUDA buffer external memory.
* @param pitch The frame row pitch in bytes.
* @param width The frame width in pixels
* @param height The frame height in rows
*/
void sendCudaExternalMemoryFrame(carb::cudainterop::ExternalMemory* cudaExternalMemory,
uint32_t pitch,
uint32_t width,
uint32_t height)
{
if (m_interface && m_context)
{
m_interface->sendCudaExternalMemoryFrame(m_context, cudaExternalMemory, pitch, width, height);
}
}
/**
* Enqueue a frame from a shared texture.
*
* @param textureHandle Pointer to the shared texture handle description.
* @param texture Pointer to the texture object.
*/
void sendSharedTextureFrame(carb::graphics::SharedResourceHandle* textureHandle, carb::graphics::Texture* texture)
{
if (m_interface && m_context)
{
m_interface->sendSharedTextureFrame(m_context, textureHandle, texture);
}
}
/**
* Enqueue an audio samples.
*
* @param buf Pointer to the auduo samples buffer.
* @param size Audio samples buffer size in bytes.
* @param time Audio samples starting time in milleseconds.
* @param desc Audio samples description.
*/
void sendAudioSamples(const void* buf, size_t size, uint32_t time, const AudioSamplesDesc& desc)
{
if (m_interface && m_context)
{
m_interface->sendAudioSamples(m_context, buf, size, time, desc);
}
}
private:
StreamServerWrapper(const StreamServerWrapper&) = delete;
StreamServerWrapper& operator=(const StreamServerWrapper&) = delete;
private:
carb::livestream::Vision* m_interface = nullptr;
carb::livestream::Context* m_context = nullptr;
};
} // namespace livestream
} // namespace carb
| 7,561 | C | 27.752852 | 120 | 0.61103 |
omniverse-code/kit/include/carb/container/IntrusiveList.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite intrusive list container.
#pragma once
#include "../Defines.h"
#include <iterator>
namespace carb
{
namespace container
{
/**
* Defines a "link node" that \ref IntrusiveList will use for tracking data for the contained type.
*/
template <class T>
class IntrusiveListLink
{
public:
//! The object that contains `*this`.
using ValueType = T;
//! Constructor.
constexpr IntrusiveListLink() noexcept = default;
//! Destructor. Asserts that the link is not contained in an @ref IntrusiveList.
~IntrusiveListLink()
{
// Shouldn't be contained at destruction time
CARB_ASSERT(!isContained());
}
//! Reports whether this link object is inserted into am @ref IntrusiveList container.
//! @returns `true` if this link object is present in an @ref IntrusiveList; `false` otherwise.
bool isContained() const noexcept
{
return m_next != nullptr;
}
private:
template <class U, IntrusiveListLink<U> U::*V>
friend class IntrusiveList;
CARB_VIZ IntrusiveListLink* m_next{ nullptr };
IntrusiveListLink* m_prev{ nullptr };
CARB_PREVENT_COPY_AND_MOVE(IntrusiveListLink);
constexpr IntrusiveListLink(IntrusiveListLink* init) noexcept : m_next(init), m_prev(init)
{
}
};
/**
* IntrusiveList is very similar to std::list, but requires the tracking information to be contained within the stored
* type `T`, rather than built around it. In other words, the tracking information is "intrusive" in the type `T` by way
* of the @ref IntrusiveListLink type. IntrusiveList does no allocation of the `T` type; all allocation is done outside
* of the context of IntrusiveList, which allows stored items to be on the stack, grouped with other items, etc.
*
* The impetus behind intrusive containers is specifically to allow the application to own the allocation patterns for a
* type, but still be able to store them in a container. For `std::list`, everything goes through an `Allocator` type,
* but in a real application some stored instances may be on the stack while others are on the heap, which makes using
* `std::list` impractical. Furthermore, a stored type may wish to be removed from one list and inserted into another.
* With `std::list`, this would require heap interaction to erase from one list and insert into another. With
* IntrusiveList, this operation would not require any heap interaction and would be done very quickly (O(1)).
*
* Another example is a `std::list` of polymorphic types. For `std::list` the contained type would have to be a pointer
* or pointer-like type which is an inefficient use of space, cache, etc.
*
* Since IntrusiveList doesn't require any form of `Allocator`, the allocation strategy is completely left up to the
* application. This means that items could be allocated on the stack, pooled, or items mixed between stack and heap.
*
* IntrusiveList matches `std::list` with the following exceptions:
* - The `iterator` and `initializer_list` constructor variants are not present in IntrusiveList.
* - The `iterator` and `initializer_list` insert() variants are not present in IntrusiveList.
* - IntrusiveList cannot be copied (though may still be moved).
* - IntrusiveList does not have `erase()` to erase an item from the list, but instead has remove() which will remove an
* item from the container. It is up to the caller to manage the memory for the item.
* - Likewise, clear() functions as a "remove all" and does not destroy items in the container.
* - IntrusiveList does not have any emplace functions as it is not responsible for construction of items.
* - iter_from_value() is a new function that translates an item contained in IntrusiveList into an iterator.
*
* Example:
* @code{.cpp}
* // Given a class Waiter whose purpose is to wait until woken:
* class Waiter {
* public:
* void wait();
* IntrusiveListLink<Waiter> link;
* };
*
* IntrusiveList<Waiter, &Waiter::link> list;
*
* Waiter w;
* list.push_back(w);
* w.wait();
* list.remove(w);
*
* // Since the Waiter instance is on the stack there is no heap used to track items in `list`.
* @endcode
*
* Example 2:
* @code{.cpp}
* // Intrusive list can be used to move items between multiple lists using the same link node without any heap
* // usage.
* class MyItem { public:
* // ...
* void process();
* IntrusiveListLink<MyItem> link;
* };
*
* using MyItemList = IntrusiveList<MyItem, &MyItem::link>;
* MyItemList dirty;
* MyItemList clean;
*
* MyItemList::iter;
* while (!dirty.empty())
* {
* MyItem& item = dirty.pop_front();
* item.process();
* clean.push_back(item);
* }
* @endcode
*
* @tparam T The contained object type.
* @tparam U A pointer-to-member of `T` that must be of type @ref IntrusiveListLink. This member will be used by the
* IntrusiveList for tracking the contained object.
*/
template <class T, IntrusiveListLink<T> T::*U>
class CARB_VIZ IntrusiveList
{
public:
//! The type of the contained object.
using ValueType = T;
//! The type of the @ref IntrusiveListLink that must be a member of ValueType.
using Link = IntrusiveListLink<T>;
// Iterator support
// clang-format off
//! A LegacyBidirectionalIterator to `const ValueType`.
//! @see <a href="https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator">LegacyBidirectionalIterator</a>
class const_iterator
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using iterator_category = std::bidirectional_iterator_tag;
using value_type = ValueType;
using difference_type = ptrdiff_t;
using pointer = const value_type*;
using reference = const value_type&;
const_iterator() noexcept = default;
reference operator * () const { assertNotEnd(); return IntrusiveList::_value(*m_where); }
pointer operator -> () const { assertNotEnd(); return std::addressof(operator*()); }
const_iterator& operator ++ () noexcept /* ++iter */ { assertNotEnd(); incr(); return *this; }
const_iterator operator ++ (int) noexcept /* iter++ */ { assertNotEnd(); const_iterator i{ *this }; incr(); return i; }
const_iterator& operator -- () noexcept /* --iter */ { decr(); return *this; }
const_iterator operator -- (int) noexcept /* iter-- */ { const_iterator i{ *this }; decr(); return i; }
bool operator == (const const_iterator& rhs) const noexcept { assertSameOwner(rhs); return m_where == rhs.m_where; }
bool operator != (const const_iterator& rhs) const noexcept { assertSameOwner(rhs); return m_where != rhs.m_where; }
protected:
friend class IntrusiveList;
Link* m_where{ nullptr };
#if CARB_ASSERT_ENABLED
const IntrusiveList* m_owner{ nullptr };
const_iterator(Link* where, const IntrusiveList* owner) : m_where(where), m_owner(owner) {}
void assertOwner(const IntrusiveList* list) const noexcept
{
CARB_ASSERT(m_owner == list, "IntrusiveList iterator for invalid container");
}
void assertSameOwner(const const_iterator& rhs) const noexcept
{
CARB_ASSERT(m_owner == rhs.m_owner, "IntrusiveList iterators are from different containers");
}
void assertNotEnd() const noexcept
{
CARB_ASSERT(m_where != m_owner->_end(), "Invalid operation on IntrusiveList::end() iterator");
}
#else
const_iterator(Link* where, const IntrusiveList*) : m_where(where) {}
void assertOwner(const IntrusiveList* list) const noexcept
{
CARB_UNUSED(list);
}
void assertSameOwner(const const_iterator& rhs) const noexcept
{
CARB_UNUSED(rhs);
}
void assertNotEnd() const noexcept {}
#endif // !CARB_ASSERT_ENABLED
void incr() { m_where = m_where->m_next; }
void decr() { m_where = m_where->m_prev; }
#endif // !DOXYGEN_SHOULD_SKIP_THIS
};
//! A LegacyBidirectionalIterator to `ValueType`.
//! @see <a href="https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator">LegacyBidirectionalIterator</a>
class iterator : public const_iterator
{
using Base = const_iterator;
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using iterator_category = std::bidirectional_iterator_tag;
using value_type = ValueType;
using difference_type = ptrdiff_t;
using pointer = value_type*;
using reference = value_type&;
iterator() noexcept = default;
reference operator * () const { this->assertNotEnd(); return IntrusiveList::_value(*this->m_where); }
pointer operator -> () const { this->assertNotEnd(); return std::addressof(operator*()); }
iterator& operator ++ () noexcept /* ++iter */ { this->assertNotEnd(); this->incr(); return *this; }
iterator operator ++ (int) noexcept /* iter++ */ { this->assertNotEnd(); iterator i{ *this }; this->incr(); return i; }
iterator& operator -- () noexcept /* --iter */ { this->decr(); return *this; }
iterator operator -- (int) noexcept /* iter-- */ { iterator i{ *this }; this->decr(); return i; }
protected:
friend class IntrusiveList;
iterator(Link* where, const IntrusiveList* owner) : Base(where, owner) {}
#endif
};
//! Helper definition for std::reverse_iterator<iterator>
using reverse_iterator = std::reverse_iterator<iterator>;
//! Helper definition for std::reverse_iterator<const_iterator>
using const_reverse_iterator = std::reverse_iterator<const_iterator>;
// clang-format on
CARB_PREVENT_COPY(IntrusiveList);
//! Constructor. Initializes `*this` to be empty().
constexpr IntrusiveList() : m_list(&m_list)
{
}
//! Move-construct. Moves all entries to `*this` from @p other and leaves it empty.
//! @param other Another IntrusiveList to move entries from.
IntrusiveList(IntrusiveList&& other) noexcept : m_list(&m_list)
{
swap(other);
}
//! Destructor. Implies clear().
~IntrusiveList()
{
clear();
m_list.m_next = m_list.m_prev = nullptr; // prevent the assert
}
//! Move-assign. Moves all entries from @p other and leaves @p other in a valid but possibly non-empty state.
//! @param other Another IntrusiveList to move entries from.
IntrusiveList& operator=(IntrusiveList&& other) noexcept
{
swap(other);
return *this;
}
//! Checks whether the container is empty.
//! @returns `true` if `*this` is empty; `false` otherwise.
bool empty() const noexcept
{
return !m_size;
}
//! Returns the number of elements contained.
//! @returns The number of elements contained.
size_t size() const noexcept
{
return m_size;
}
//! Returns the maximum possible number of elements.
//! @returns The maximum possible number of elements.
size_t max_size() const noexcept
{
return size_t(-1);
}
// Forward iterator support
//! Returns an iterator to the beginning.
//! @returns An iterator to the beginning.
iterator begin() noexcept
{
return iterator(_head(), this);
}
//! Returns an iterator to the end.
//! @returns An iterator to the end.
iterator end() noexcept
{
return iterator(_end(), this);
}
//! Returns a const_iterator to the beginning.
//! @returns A const_iterator to the beginning.
const_iterator cbegin() const noexcept
{
return const_iterator(_head(), this);
}
//! Returns a const_iterator to the end.
//! @returns A const_iterator to the end.
const_iterator cend() const noexcept
{
return const_iterator(_end(), this);
}
//! Returns a const_iterator to the beginning.
//! @returns A const_iterator to the beginning.
const_iterator begin() const noexcept
{
return cbegin();
}
//! Returns a const_iterator to the end.
//! @returns A const_iterator to the end.
const_iterator end() const noexcept
{
return cend();
}
// Reverse iterator support
//! Returns a reverse_iterator to the beginning.
//! @returns A reverse_iterator to the beginning.
reverse_iterator rbegin() noexcept
{
return reverse_iterator(end());
}
//! Returns a reverse_iterator to the end.
//! @returns A reverse_iterator to the end.
reverse_iterator rend() noexcept
{
return reverse_iterator(begin());
}
//! Returns a const_reverse_iterator to the beginning.
//! @returns A const_reverse_iterator to the beginning.
const_reverse_iterator crbegin() const noexcept
{
return const_reverse_iterator(cend());
}
//! Returns a const_reverse_iterator to the end.
//! @returns A const_reverse_iterator to the end.
const_reverse_iterator crend() const noexcept
{
return const_reverse_iterator(cbegin());
}
//! Returns a const_reverse_iterator to the beginning.
//! @returns A const_reverse_iterator to the beginning.
const_reverse_iterator rbegin() const noexcept
{
return crbegin();
}
//! Returns a const_reverse_iterator to the end.
//! @returns A const_reverse_iterator to the end.
const_reverse_iterator rend() const noexcept
{
return crend();
}
//! Returns an iterator to the given value if it is contained in `*this`, otherwise returns `end()`. O(n).
//! @param[in] value The value to check for.
//! @returns An @ref iterator to @p value if contained in `*this`; end() otherwise.
iterator locate(T& value) noexcept
{
Link* l = _link(value);
if (!l->isContained())
return end();
Link* b = m_list.m_next;
while (b != _end())
{
if (b == l)
return iterator(l, this);
b = b->m_next;
}
return end();
}
//! Returns an iterator to the given value if it is contained in `*this`, otherwise returns `end()`. O(n).
//! @param[in] value The value to check for.
//! @returns A @ref const_iterator to @p value if contained in `*this`; end() otherwise.
const_iterator locate(T& value) const noexcept
{
Link* l = _link(value);
if (!l->isContained())
return end();
Link* b = m_list.m_next;
while (b != _end())
{
if (b == l)
return const_iterator(l, this);
b = b->m_next;
}
return end();
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
CARB_DEPRECATED("Use locate()") iterator find(T& value) noexcept
{
return locate(value);
}
CARB_DEPRECATED("Use locate()") const_iterator find(T& value) const noexcept
{
return locate(value);
}
#endif
//! Naively produces an @ref IntrusiveList::iterator for @p value within `*this`.
//! @warning Undefined behavior results if @p value is not contained within `*this`. Use find() to safely check.
//! @param value The value to convert.
//! @returns An @ref iterator to @p value.
iterator iter_from_value(T& value)
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained() || locate(value) != end());
return iterator(l->isContained() ? l : _end(), this);
}
//! Naively produces an @ref IntrusiveList::iterator for @p value within `*this`.
//! @warning Undefined behavior results if @p value is not contained within `*this`. Use find() to safely check.
//! @param value The value to convert.
//! @returns A @ref const_iterator to @p value.
const_iterator iter_from_value(T& value) const
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained() || locate(value) != end());
return const_iterator(l->isContained() ? l : _end(), this);
}
//! Accesses the first element.
//! @warning Undefined behavior if `*this` is empty().
//! @returns A reference to the first element.
T& front()
{
CARB_ASSERT(!empty());
return _value(*_head());
}
//! Accesses the first element.
//! @warning Undefined behavior if `*this` is empty().
//! @returns A const reference to the first element.
const T& front() const
{
CARB_ASSERT(!empty());
return _value(*_head());
}
//! Accesses the last element.
//! @warning Undefined behavior if `*this` is empty().
//! @returns A reference to the last element.
T& back()
{
CARB_ASSERT(!empty());
return _value(*_tail());
}
//! Accesses the last element.
//! @warning Undefined behavior if `*this` is empty().
//! @returns A const reference to the last element.
const T& back() const
{
CARB_ASSERT(!empty());
return _value(*_tail());
}
//! Inserts an element at the beginning of the list.
//! @note Precondition: @p value must not be contained (via `U`) in `*this` or any other IntrusiveList.
//! @param value The value to insert.
//! @returns @p value for convenience.
T& push_front(T& value)
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained());
Link* const prev = _head();
l->m_next = prev;
l->m_prev = _end();
m_list.m_next = l;
prev->m_prev = l;
++m_size;
return value;
}
//! Removes the first element.
//! @note Precondition: `*this` must not be empty().
//! @returns The prior first element in the list, which is now no longer contained in the list.
T& pop_front()
{
CARB_ASSERT(!empty());
Link* const head = _head();
Link* const next = head->m_next;
m_list.m_next = next;
next->m_prev = _end();
head->m_next = head->m_prev = nullptr;
--m_size;
return _value(*head);
}
//! Inserts an element at the end of the list.
//! @note Precondition: @p value must not be contained (via `U`) in `*this` or any other IntrusiveList.
//! @param value The value to insert.
//! @returns @p value for convenience.
T& push_back(T& value)
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained());
Link* const prev = _tail();
l->m_next = _end();
l->m_prev = prev;
prev->m_next = l;
m_list.m_prev = l;
++m_size;
return value;
}
//! Removes the last element.
//! @note Precondition: `*this` must not be empty().
//! @returns The prior last element in the list, which is now no longer contained in the list.
T& pop_back()
{
CARB_ASSERT(!empty());
Link* const tail = _tail();
Link* const prev = tail->m_prev;
m_list.m_prev = prev;
prev->m_next = _end();
tail->m_next = tail->m_prev = nullptr;
--m_size;
return _value(*tail);
}
//! Removes all elements from the list.
//! @note Postcondition: `*this` is empty().
void clear()
{
if (_head() != _end())
{
do
{
Link* p = _head();
m_list.m_next = p->m_next;
p->m_next = p->m_prev = nullptr;
} while (_head() != _end());
m_list.m_prev = _end();
m_size = 0;
}
}
//! Inserts an element before @p pos.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`; @p value must not be contained (via `U`)
//! in this or any other IntrusiveList.
//! @param pos A @ref const_iterator indicating the insertion position. @p value will be inserted before @p pos.
//! @param value The value to insert.
//! @returns An @ref iterator to the newly-inserted @p value.
iterator insert(const_iterator pos, T& value)
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained());
l->m_prev = pos.m_where->m_prev;
l->m_next = pos.m_where;
l->m_prev->m_next = l;
l->m_next->m_prev = l;
++m_size;
return iterator(l, this);
}
//! Removes an element by iterator.
//! @note Precondition: @p pos must be a valid const_iterator of `*this` and may not be end().
//! @param pos A @ref const_iterator to the element to remove.
//! @returns A @ref iterator to the element immediately following @p pos, or end() if no elements followed it.
iterator remove(const_iterator pos)
{
CARB_ASSERT(!empty());
pos.assertNotEnd();
pos.assertOwner(this);
Link* next = pos.m_where->m_next;
pos.m_where->m_prev->m_next = pos.m_where->m_next;
pos.m_where->m_next->m_prev = pos.m_where->m_prev;
pos.m_where->m_next = pos.m_where->m_prev = nullptr;
--m_size;
return iterator(next, this);
}
//! Removes an element by reference.
//! @note Precondition: @p value must be contained in `*this`.
//! @param value The element to remove.
//! @returns @p value for convenience.
T& remove(T& value)
{
Link* l = _link(value);
if (l->isContained())
{
CARB_ASSERT(!empty());
CARB_ASSERT(locate(value) != end());
l->m_prev->m_next = l->m_next;
l->m_next->m_prev = l->m_prev;
l->m_next = l->m_prev = nullptr;
--m_size;
}
return value;
}
//! Swaps the contents of `*this` with another IntrusiveList.
//! @param other The other IntrusiveList to swap with.
void swap(IntrusiveList& other) noexcept
{
if (this != std::addressof(other))
{
// Fix up the end iterators first.
Link *&lhead = _head()->m_prev, *<ail = _tail()->m_next;
Link *&rhead = other._head()->m_prev, *&rtail = other._tail()->m_next;
lhead = ltail = other._end();
rhead = rtail = _end();
// Now swap pointers
std::swap(_end()->m_next, other._end()->m_next);
std::swap(_end()->m_prev, other._end()->m_prev);
std::swap(m_size, other.m_size);
}
}
//! Merges two sorted lists.
//! @note Precondition: `*this` and @p other must be sorted using @p comp.
//! @note This operation is stable: for equivalent elements in the two lists elements from `*this` shall always
//! precede the elements from @p other. The order of equivalent elements within `*this` and @p other will not
//! change.
//! @param[inout] other Another IntrusiveList to merge with. Must be sorted via `comp`. Will be empty after this
//! call.
//! @param comp The comparator predicate, such as `std::less`.
template <class Compare>
void merge(IntrusiveList& other, Compare comp)
{
if (this == std::addressof(other))
return;
if (!other.m_size)
// Nothing to do
return;
// splice all of other's nodes onto the end of *this
Link* const head = _end();
Link* const otherHead = other._end();
Link* const mid = otherHead->m_next;
_splice(head, other, mid, otherHead, other.m_size);
if (head->m_next != mid)
_mergeSame(head->m_next, mid, head, comp);
}
//! Merges two sorted lists.
//! @see merge(IntrusiveList& other, Compare comp)
//! @param[inout] other Another IntrusiveList to merge with. Must be sorted via `comp`. Will be empty after this
//! call.
//! @param comp The comparator predicate, such as `std::less`.
template <class Compare>
void merge(IntrusiveList&& other, Compare comp)
{
merge(other, comp);
}
//! Merges two sorted lists via `std::less`.
//! @see merge(IntrusiveList& other, Compare comp)
//! @param[inout] other Another IntrusiveList to merge with. Must be sorted via `comp`. Will be empty after this
//! call.
void merge(IntrusiveList& other)
{
merge(other, std::less<ValueType>());
}
//! Merges two sorted lists via `std::less`.
//! @see merge(IntrusiveList& other, Compare comp)
//! @param[inout] other Another IntrusiveList to merge with. Must be sorted via `comp`. Will be empty after this
//! call.
void merge(IntrusiveList&& other)
{
merge(other);
}
//! Transfers elements from another IntrusiveList into `*this`.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`.
//! @param pos The position before which to insert elements from @p other.
//! @param other Another IntrusiveList to splice from. Will be empty after this call.
void splice(const_iterator pos, IntrusiveList& other)
{
pos.assertOwner(this);
if (this == std::addressof(other) || other.empty())
return;
_splice(pos.m_where, other, other.m_list.m_next, other._end(), other.m_size);
}
//! Transfers elements from another IntrusiveList into `*this`.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`.
//! @param pos The position before which to insert elements from @p other.
//! @param other Another IntrusiveList to splice from. Will be empty after this call.
void splice(const_iterator pos, IntrusiveList&& other)
{
splice(pos, other);
}
//! Transfers an element from another IntrusiveList into `*this`.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`. @p it must be a valid iterator of @p other
//! and may not be `other.end()`.
//! @param pos The position before which to insert the element from @p other.
//! @param other The IntrusiveList that @p it is from.
//! @param it An @ref iterator to an element from @p other. Will be removed from @p other and transferred to
//! `*this`.
void splice(const_iterator pos, IntrusiveList& other, iterator it)
{
pos.assertOwner(this);
it.assertNotEnd();
it.assertOwner(std::addressof(other));
Link* const last = it.m_where->m_next;
if (this != std::addressof(other) || (pos.m_where != it.m_where && pos.m_where != last))
_splice(pos.m_where, other, it.m_where, last, 1);
}
//! Transfers an element from another IntrusiveList into `*this`.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`. @p it must be a valid iterator of @p other
//! and may not be `other.end()`.
//! @param pos The position before which to insert the element from @p other.
//! @param other The IntrusiveList that @p it is from.
//! @param it An @ref iterator to an element from @p other. Will be removed from @p other and transferred to
//! `*this`.
void splice(const_iterator pos, IntrusiveList&& other, iterator it)
{
splice(pos, other, it);
}
//! Transfers a range of elements from another IntrusiveList into `*this`.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`. @p first and @p end must be a valid
//! iterator range of @p other. @p pos must not be in the range `[first, end)`.
//! @param pos The position before which to insert the element(s) from @p other.
//! @param other The IntrusiveList that @p first and @p end are from.
//! @param first Combined with @p end describes a range of elements from @p other that will be moved to @p pos.
//! @param end Combined with @p first describes a range of elements from @p other that will be moved to @p pos.
void splice(const_iterator pos, IntrusiveList& other, const_iterator first, const_iterator end)
{
pos.assertOwner(this);
first.assertOwner(std::addressof(other));
end.assertOwner(std::addressof(other));
if (first == end)
return;
#if CARB_ASSERT_ENABLED
if (pos.m_owner == first.m_owner)
{
// The behavior is undefined if pos is an iterator in the range [first, end); though we don't have an
// efficient way of testing for that, so loop through and check
for (const_iterator it = first; it != end; ++it)
CARB_ASSERT(it != pos);
}
#endif
if (this != std::addressof(other))
{
size_t range = std::distance(first, end);
CARB_ASSERT(other.m_size >= range);
other.m_size -= range;
m_size += range;
}
_splice(pos.m_where, first.m_where, end.m_where);
}
//! Transfers a range of elements from another IntrusiveList into `*this`.
//! @note Precondition: @p pos must be a valid const_iterator of `*this`. @p first and @p end must be a valid
//! iterator range of @p other. @p pos must not be in the range `[first, end)`.
//! @param pos The position before which to insert the element(s) from @p other.
//! @param other The IntrusiveList that @p first and @p end are from.
//! @param first Combined with @p end describes a range of elements from @p other that will be moved to @p pos.
//! @param end Combined with @p first describes a range of elements from @p other that will be moved to @p pos.
void splice(const_iterator pos, IntrusiveList&& other, const_iterator first, const_iterator end)
{
splice(pos, other, first, end);
}
//! Reverses the order of the elements.
void reverse() noexcept
{
Link* end = _end();
Link* n = end;
for (;;)
{
Link* next = n->m_next;
n->m_next = n->m_prev;
n->m_prev = next;
if (next == end)
break;
n = next;
}
}
//! Sorts the contained elements by the specified comparator function.
//! @param comp The comparator function, such as `std::less`.
template <class Compare>
void sort(Compare comp)
{
_sort(_end()->m_next, m_size, comp);
}
//! Sorts the contained elements by the specified comparator function.
void sort()
{
sort(std::less<ValueType>());
}
private:
CARB_VIZ Link m_list;
CARB_VIZ size_t m_size{ 0 };
template <class Compare>
static Link* _sort(Link*& first, size_t size, Compare comp)
{
switch (size)
{
case 0:
return first;
case 1:
return first->m_next;
default:
break;
}
auto mid = _sort(first, size >> 1, comp);
const auto last = _sort(mid, size - (size >> 1), comp);
first = _mergeSame(first, mid, last, comp);
return last;
}
template <class Compare>
static Link* _mergeSame(Link* first, Link* mid, const Link* last, Compare comp)
{
// Merge the sorted ranges [first, mid) and [mid, last)
// Returns the new beginning of the range (which won't be `first` if it was spliced elsewhere)
Link* newfirst;
if (comp(_value(*mid), _value(*first)))
// mid will be spliced to the front of the range
newfirst = mid;
else
{
// Establish comp(mid, first) by skipping over elements from the first range already in position
newfirst = first;
do
{
first = first->m_next;
if (first == mid)
return newfirst;
} while (!comp(_value(*mid), _value(*first)));
}
// process one run splice
for (;;)
{
auto runStart = mid;
// find the end of the run of elements we need to splice from the second range into the first
do
{
mid = mid->m_next;
} while (mid != last && comp(_value(*mid), _value(*first)));
// [runStart, mid) goes before first
_splice(first, runStart, mid);
if (mid == last)
return newfirst;
// Re-establish comp(mid, first) by skipping over elements from the first range already in position.
do
{
first = first->m_next;
if (first == mid)
return newfirst;
} while (!comp(_value(*mid), _value(*first)));
}
}
Link* _splice(Link* const where, IntrusiveList& other, Link* const first, Link* const last, size_t count)
{
if (this != std::addressof(other))
{
// Different list, need to fix up size
m_size += count;
other.m_size -= count;
}
return _splice(where, first, last);
}
static Link* _splice(Link* const before, Link* const first, Link* const last) noexcept
{
CARB_ASSERT(before != first && before != last && first != last);
Link* const firstPrev = first->m_prev;
firstPrev->m_next = last;
Link* const lastPrev = last->m_prev;
lastPrev->m_next = before;
Link* const beforePrev = before->m_prev;
beforePrev->m_next = first;
before->m_prev = lastPrev;
last->m_prev = firstPrev;
first->m_prev = beforePrev;
return last;
}
static Link* _link(T& value) noexcept
{
return std::addressof(value.*U);
}
static T& _value(Link& l) noexcept
{
// Need to calculate the offset of our link member which will allow adjusting the pointer to where T is.
// This will not work if T uses virtual inheritance. Also, offsetof() cannot be used because we have a pointer
// to the member
size_t offset = size_t(reinterpret_cast<uint8_t*>(&(((T*)0)->*U)));
return *reinterpret_cast<T*>(reinterpret_cast<uint8_t*>(std::addressof(l)) - offset);
}
static const T& _value(const Link& l) noexcept
{
// Need to calculate the offset of our link member which will allow adjusting the pointer to where T is.
// This will not work if T uses virtual inheritance. Also, offsetof() cannot be used because we have a pointer
// to the member
size_t offset = size_t(reinterpret_cast<uint8_t*>(&(((T*)0)->*U)));
return *reinterpret_cast<const T*>(reinterpret_cast<const uint8_t*>(std::addressof(l)) - offset);
}
constexpr Link* _head() const noexcept
{
return const_cast<Link*>(m_list.m_next);
}
constexpr Link* _tail() const noexcept
{
return const_cast<Link*>(m_list.m_prev);
}
constexpr Link* _end() const noexcept
{
return const_cast<Link*>(&m_list);
}
};
} // namespace container
} // namespace carb
| 35,340 | C | 35.622798 | 129 | 0.601302 |
omniverse-code/kit/include/carb/container/RingBuffer.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
// Implements a thread-safe (if used as directed) ring-buffer that can be used to store objects of various types and
// sizes. An age-old problem of ring-buffers is that they must copy the data in and out because data may wrap around and
// therefore not be contiguous. This implementation gets around that issue by using virtual memory to map the same page
// adjacently in memory. This uses double the address space without double the memory and allows pointers to be returned
// to the caller that automatically wrap around.
#pragma once
#include "../Defines.h"
#include "../CarbWindows.h"
#include "../cpp/Atomic.h"
#include "../extras/Errors.h"
#include "../thread/Util.h"
#include <atomic>
#include <memory>
#include <utility>
#if CARB_POSIX
# include <sys/mman.h>
# include <sys/stat.h>
# include <fcntl.h>
# include <unistd.h>
#endif
#if CARB_PLATFORM_MACOS
# include <sys/posix_shm.h>
# define ftruncate64 ftruncate
#endif
namespace carb
{
namespace container
{
namespace detail
{
#if CARB_PLATFORM_WINDOWS
// RingBufferAllocator performs the memory-mapping trick listed above. First the requested size is rounded up to the
// system allocation granularity, then we search the address space for a place where we can map that much memory to two
// adjacent addresses.
class RingBufferAllocator
{
public:
uint8_t* Allocate(size_t& size)
{
if (!size)
size = 1;
// Get the allocation granularity
CARBWIN_SYSTEM_INFO info;
memset(&info, 0, sizeof(info));
::GetSystemInfo(reinterpret_cast<SYSTEM_INFO*>(&info));
// Round up to allocation granularity
size += (info.dwAllocationGranularity - 1);
size &= ~size_t(info.dwAllocationGranularity - 1);
HANDLE mapping = ::CreateFileMappingW(
CARBWIN_INVALID_HANDLE_VALUE, nullptr, CARBWIN_PAGE_READWRITE, (DWORD)(size >> 32), (DWORD)size, nullptr);
CARB_FATAL_UNLESS(
mapping != nullptr, "CreateFileMapping failed: %s", carb::extras::getLastWinApiErrorMessage().c_str());
// Map to two adjacent pages so that writes across the boundary will wrap around automatically.
for (;;)
{
// Try to reserve a block of memory large enough for both mappings
uint8_t* search = (uint8_t*)::VirtualAlloc(nullptr, size * 2, CARBWIN_MEM_RESERVE, CARBWIN_PAGE_READWRITE);
CARB_FATAL_UNLESS(search != nullptr, "Failed to find a mapping location");
::VirtualFree(search, 0, CARBWIN_MEM_RELEASE);
uint8_t* where = (uint8_t*)::MapViewOfFileEx(mapping, CARBWIN_FILE_MAP_ALL_ACCESS, 0, 0, size, search);
DWORD err1 = ::GetLastError();
CARB_FATAL_UNLESS(where || search, "MapViewOfFileEx failed to find starting location: %s",
carb::extras::getLastWinApiErrorMessage().c_str());
if (!where)
{
// Failed to map here; continue the search
continue;
}
uint8_t* where2 = (uint8_t*)::MapViewOfFileEx(mapping, CARBWIN_FILE_MAP_ALL_ACCESS, 0, 0, size, where + size);
DWORD err2 = ::GetLastError();
CARB_FATAL_UNLESS(where2 == nullptr || where2 == (where + size),
"MapViewOfFileEx returned unexpected value: %s",
carb::extras::getLastWinApiErrorMessage().c_str());
if (where2)
{
// We can close the mapping handle without affecting the mappings
::CloseHandle(mapping);
return where;
}
// Failed to map in the expected location; unmap and try again
::UnmapViewOfFile(where);
search = where + info.dwAllocationGranularity;
CARB_FATAL_UNLESS(search < info.lpMaximumApplicationAddress, "Failed to find a mapping location");
CARB_UNUSED(err1, err2);
}
}
void Free(uint8_t* mem, size_t size)
{
::UnmapViewOfFile(mem);
::UnmapViewOfFile(mem + size);
}
};
#elif CARB_POSIX
class RingBufferAllocator
{
public:
uint8_t* Allocate(size_t& size)
{
if (!size)
size = 1;
int const granularity = getpagesize();
// Round up to allocation granularity
size = (size + granularity - 1) & -(ptrdiff_t)granularity;
// Create a memory "file" and size to the requested size
# if 0
// memfd_create would be the preferable way of doing this, but it doesn't appear to be available
int fd = ::memfd_create("ringbuffer", 0u);
CARB_FATAL_UNLESS(fd != -1, "memfd_create failed: %d/%s", errno, strerror(errno));
# else
// Fall back to creating a shared memory object. Linux doesn't appear to have a way to do this anonymously like
// Windows does.
char buffer[128];
# if CARB_PLATFORM_MACOS
// Mac OS limits the SHM name to PSHMNAMLEN.
// POSIX seems to limit this to PATH_MAX.
snprintf(buffer, CARB_MIN(PSHMNAMLEN + 1, sizeof(buffer)), "/carb-ring-%d-%p", getpid(), this);
# else
snprintf(buffer, CARB_MIN(PATH_MAX + 1, sizeof(buffer)), "/carb-ringbuffer-%d-%p", getpid(), this);
# endif
int fd = shm_open(buffer, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
CARB_FATAL_UNLESS(fd != -1, "shm_open failed: %d/%s", errno, strerror(errno));
shm_unlink(buffer);
# endif
CARB_FATAL_UNLESS(ftruncate64(fd, size) != -1, "ftruncate failed: %d/%s", errno, strerror(errno));
// Map to two adjacent pages so that writes across the boundary will wrap around automatically.
// Try to map twice the address space and then re-map the top portion first
uint8_t* search = (uint8_t*)mmap(nullptr, size * 2, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
if (search != MAP_FAILED)
{
// Unmap the top half
munmap(search + size, size);
// Re-map as the same page as bottom
uint8_t* mmap2 = (uint8_t*)mmap(search + size, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
if (mmap2 == (search + size))
{
// Success!
// We no longer need the file descriptor around since the mmaps survive without it
close(fd);
return search;
}
// Failed or didn't take the hint for some reason
if (mmap2 != MAP_FAILED)
munmap(mmap2, size);
munmap(search, size);
}
else
{
search = nullptr;
}
// Fall-back to search mode
for (;;)
{
uint8_t* where = (uint8_t*)mmap(search, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
CARB_FATAL_UNLESS(
where != MAP_FAILED || search, "mmap failed to find starting location: %d/%s", errno, strerror(errno));
if (where == MAP_FAILED || (search && where != search))
{
// Failed to map here; continue the search
CARB_FATAL_UNLESS(!where || munmap(where, size) == 0, "munmap failed: %d/%s", errno, strerror(errno));
search += granularity;
continue;
}
uint8_t* where2 = (uint8_t*)mmap(where + size, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
if (where2 != MAP_FAILED)
{
if (where2 == (where + size))
{
// We can close the file descriptor without affecting the mappings
close(fd);
return where;
}
// Got a response, but not where we asked for
CARB_FATAL_UNLESS(munmap(where2, size) == 0, "munmap failed: %d/%s", errno, strerror(errno));
where2 = nullptr;
}
// Failed to map in the expected location. Unmap the first and try again.
CARB_FATAL_UNLESS(munmap(where, size) == 0, "munmap failed: %d/%s", errno, strerror(errno));
search = where + granularity;
CARB_FATAL_UNLESS(search >= where, "Failed to find a mapping location");
}
}
void Free(uint8_t* mem, size_t size)
{
munmap(mem, size);
munmap(mem + size, size);
}
};
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
} // namespace detail
class RingBuffer : private detail::RingBufferAllocator
{
public:
/**
* The guaranteed minimum alignment returned by alloc().
*/
constexpr static size_t kMinAlignment = sizeof(size_t);
/**
* The maximum alignment that can be requested by alloc().
*/
constexpr static size_t kMaxAlignment = 4096;
/**
* Constructs the RingBuffer
*
* @param memSize The requested size in bytes. This will be rounded up to the system's allocation granularity.
*/
RingBuffer(size_t memSize);
~RingBuffer();
/**
* Returns the storage capacity of the RingBuffer.
*
* This size will be greater than or equal to the size passed to the RingBuffer() constructor. Not all of this space
* is usable by the application as some is used for internal record-keeping.
*
* @return size in bytes of the storage area of the RingBuffer
*/
size_t capacity() const;
/**
* Returns the approximate used space of the RingBuffer.
*
* This is approximate due to other threads potentially changing the RingBuffer while this function is being called.
*
* @return the approximate size in bytes available to be read
*/
size_t approx_used() const;
/**
* Returns the approximate available space of the RingBuffer.
*
* This is approximate due to other threads potentially changing the RingBuffer while this function is being called.
* Also, some memory is used for record-keeping, so not all of this space is available to the application.
*
* @return the approximate size in bytes available to be written
*/
size_t approx_available() const;
/**
* Allocates the requested size from the RingBuffer.
*
* The returned pointer is not available to be read() from the RingBuffer until commit() is called. If space is not
* available, or the requested size exceed the total available memory of the RingBuffer, nullptr is returned.
* @thread_safety may be called from multiple threads simultaneously.
*
* @param bytes The requested size in bytes to write to the RingBuffer
* @param align The alignment required for the returned memory block. at least `sizeof(size_t)` alignment is
* guaranteed. Must be a power of 2 and must not exceed \ref kMaxAlignment.
* @return A pointer to memory of \ref bytes size to be written by the application. Use commit() to signal to the
* RingBuffer that the memory is ready to be read(). nullptr is returned if the requested size is not available or
* the requested alignment could not be granted.
*/
void* alloc(size_t bytes, size_t align = 0);
/**
* Allocates the requested size from the RingBuffer, waiting until space is available.
*
* The returned pointer is not available to be read() from the RingBuffer until commit() is called. If space is not
* available, \ref onWait is called and the function waits until space is available. If the requested size exceeds
* the total available memory of the RingBuffer, or alignment is invalid, nullptr is returned. Note that in a
* single-threaded environment, this function may deadlock.
*
* @thread_safety may be called from multiple threads simultaneously.
*
* @param bytes The requested size in bytes to write to the RingBuffer
* @param onWait A function-like object that is called when waiting must occur
* @param align The alignment required for the returned memory block. at least `sizeof(size_t)` alignment is
* guaranteed. Must be a power of 2 and must not exceed \ref kMaxAlignment.
* @return A pointer to memory of \ref bytes size to be written by the application. Use commit() to signal to the
* RingBuffer that the memory is ready to be read(). nullptr is returned if the requested size exceeds the total
* RingBuffer size or the requested alignment could not be granted.
*/
template <class Func>
void* allocWait(size_t bytes, Func&& onWait, size_t align = 0);
/**
* Commits memory returned by alloc() or allocWait() and makes it available to read().
*
* This must be called on every block of memory returned from alloc() and allocWait(), otherwise subsequent read()
* operations will fail.
*
* @thread_safety may be called from multiple threads simultaneously.
*
* @param where The memory returned from alloc() that is ready to be committed.
*/
void commit(void* where);
/**
* Peeks at next value from the RingBuffer without removing it, and calls \ref f() with the value.
*
* @thread_safety may be called from multiple threads simultaneously, and may be called while other threads are
* writing via alloc() and commit(). May NOT be called while read() is called from another thread.
*
* @param f must be a function-like object with signature void(void* memory, size_t size) where memory is a pointer
* to the memory block that was returned from alloc() and size is the size that was passed to alloc().
* @return true if a value was successfully peeked and \ref f was called. false if no values are available to be
* peeked or the next value has not been committed by commit() yet.
*/
template <class Func>
bool peek(Func&& f) const;
/**
* Reads a value from the RingBuffer and calls \ref f() with the value.
*
* @thread_safety may NOT be called from multiple threads simultaneously. Can be called while other threads are
* writing via alloc() and commit(). Must also be serialized with peek().
*
* @param f must be a function-like object with signature void(void* memory, size_t size) where memory is a pointer
* to the memory block that was returned from alloc() and size is the size that was passed to alloc().
* @return true if a value was successfully read and \ref f was called. false if no values are available to be read
* or the next value has not been committed by commit() yet.
*/
template <class Func>
bool read(Func&& f);
/**
* Reads all values from the RingBuffer and calls \ref f() on each value. Causes less contention with alloc() than
* repeated read() calls because shared pointers are only updated at the end, but this also means that space in the
* RingBuffer only becomes available right before readAll() returns.
*
* @thread_safety may NOT be called from multiple threads simultaneously. Can be called while other threads are
* writing via alloc() and commit(). Must also be serialized with peek() and read().
*
* @param f must be a function-like object with signature bool(void* memory, size_t size) where memory is a pointer
* to the memory block that was returned from alloc() and `size` is the size that was passed to alloc(). If \ref f
* returns true, then the value is consumed and \ref f is called with the next value if one exists. If \ref f
* returns false, then the value is not consumed (similar to peek()) and readAll() terminates.
* @returns the count of times that \ref f returns true. If the next value to read is not committed, or no values
* are available for read, 0 is returned.
*/
template <class Func>
size_t readAll(Func&& f);
/**
* Reads a value from the RingBuffer by copying it into the given buffer.
*
* @thread_safety may be called from multiple threads simultaneously. Can be called while other threads are writing
* via alloc() and commit(). When multiple threads are reading simultaneously, a larger value (than \ref bufferSize)
* may be spuriously returned and should be ignored by the application.
*
* When a single thread is calling readCopy(), \ref bufferSize can be 0 to determine the size of the next value to
* be read. With multiple threads calling readCopy() another thread could read the value.
*
* @param buffer The memory buffer to write to.
* @param bufferSize The size of \ref buffer and the maximum size of an object that can be read.
* @return 0 if no values are available to be read or the next value hasn't been committed by commit() yet. If
* the return value is less-than or equal-to bufferSize, the next value has been read and copied into \ref buffer.
* If the return value is greater than bufferSize, the value has NOT been read and the return value indicates the
* minimum size of \ref bufferSize required to read the next object.
*/
size_t readCopy(void* buffer, size_t bufferSize);
/**
* Returns if \ref mem belongs to the RingBuffer.
*
* @param mem The memory block to check.
* @return true if \ref mem is owned by the RingBuffer; false otherwise.
*/
bool isOwned(void* mem) const;
/**
* Helper function to write the given object to the RingBuffer.
*
* @thread_safety may be called from multiple threads simultaneously.
*
* @param t The object to write. This parameter is forwarded to the constructor of T.
* @return true if the object was written; false if space could not be allocated for the object.
*/
template <class T>
bool writeObject(T&& t);
/**
* Helper function to write the given object to the RingBuffer, waiting until space is available to write.
*
* Note that in a single-threaded environment, this function may deadlock.
*
* @thread_safety may be called from multiple threads simultaneously.
*
* @param t The object to write. This parameter is forwarded to the constructor of T.
* @param onWait The function-like object to call when waiting must occur.
* @return true if the object was written; false if space could not be allocated for the object.
*/
template <class T, class Func>
bool writeObjectWait(T&& t, Func&& onWait);
/**
* Helper function to read an object from the RingBuffer.
*
* @thread_safety may NOT be called from multiple threads simultaneously. Can be called while other threads are
* writing via alloc() and commit().
*
* @param t The object to populate (via std::move) with the next object in the RingBuffer.
* @return true if the object was read; false if no object was available to read
*/
template <class T>
bool readObject(T& t);
/**
* Waits until data has been allocated from the RingBuffer. This is not as useful as waiting for committed data
* (since data may not yet be available to read), but can be done simultaneously by multiple threads.
*
* @thread_safety may be called from multiple threads simultaneously.
*/
void waitForAllocatedData();
/**
* Waits until data has been committed to the RingBuffer that is ready to be read.
*
* @thread_safety may NOT be called from multiple threads simultaneously. Can be called while other threads are
* writing via alloc() and commit(). Use waitForAllocatedData() if multiple threads are necessary.
*/
void waitForCommittedData();
private:
struct Header
{
constexpr static uint32_t kCommitted = uint32_t(1) << 0;
constexpr static uint32_t kPadding = uint32_t(1) << 1;
carb::cpp::atomic_uint32_t bytes;
std::uint32_t requestedBytes;
Header(uint32_t bytes_, uint32_t requestedBytes_, uint32_t flags = 0)
: bytes(bytes_ | flags), requestedBytes(requestedBytes_)
{
CARB_ASSERT((bytes_ & (kCommitted | kPadding)) == 0);
}
};
size_t constrain(size_t val) const
{
return val & (m_memorySize - 1);
}
template <class T>
static T* alignForward(T* where, size_t align)
{
return reinterpret_cast<T*>((reinterpret_cast<size_t>(where) + align - 1) & -(ptrdiff_t)align);
}
static bool isPowerOf2(size_t val)
{
return (val & (val - 1)) == 0;
}
constexpr static size_t kCacheLineSize = 64;
uint8_t* const m_memory;
size_t const m_memorySize;
carb::cpp::atomic_size_t m_readPtr{ 0 };
// Pad so that the write head/tail members are in a separate cache line
size_t padding1[(kCacheLineSize - sizeof(uint8_t*) - sizeof(size_t) - sizeof(carb::cpp::atomic_size_t)) / sizeof(size_t)];
// Use a two-phased write approach. The stable condition is where m_writeHead and m_writeTail are equal. However,
// during alloc(), m_writeHead is moved first and the space between m_writeHead and m_writeTail is in flux and can
// not be read. Once alloc() has written everything that it needs to, m_writeTail catches up to m_writeHead and the
// RingBuffer is once again stable.
carb::cpp::atomic_size_t m_writeHead{ 0 };
carb::cpp::atomic_size_t m_writeTail{ 0 };
// Pad out to a separate cache line
size_t padding2[(kCacheLineSize - (2 * sizeof(carb::cpp::atomic_size_t))) / sizeof(size_t)];
};
inline RingBuffer::RingBuffer(size_t memSize)
: m_memory(detail::RingBufferAllocator::Allocate(memSize)), m_memorySize(memSize)
{
CARB_UNUSED(padding1);
CARB_UNUSED(padding2);
static_assert(alignof(Header) <= kMinAlignment, "Invalid alignment assumption");
#if CARB_DEBUG
// Test rollover
m_readPtr = m_writeHead = m_writeTail = size_t(-ptrdiff_t(m_memorySize));
#endif
}
inline RingBuffer::~RingBuffer()
{
// Nothing should be remaining in the ring buffer at destruction time
CARB_ASSERT(approx_used() == 0);
detail::RingBufferAllocator::Free(m_memory, m_memorySize);
}
inline size_t RingBuffer::capacity() const
{
return m_memorySize;
}
inline size_t RingBuffer::approx_used() const
{
size_t write = m_writeTail.load(std::memory_order_relaxed);
size_t read = m_readPtr.load(std::memory_order_relaxed);
ptrdiff_t diff = (write - read);
return diff < 0 ? 0 : diff > ptrdiff_t(m_memorySize) ? m_memorySize : size_t(diff);
}
inline size_t RingBuffer::approx_available() const
{
return capacity() - approx_used();
}
inline void* RingBuffer::alloc(size_t bytes, size_t align)
{
// Will never have enough memory to allocate this
if (bytes == 0 || (bytes + align) > (m_memorySize - sizeof(Header)))
return nullptr;
// Alignment greater than max is not allowed
if (align > kMaxAlignment || !isPowerOf2(align))
{
return nullptr;
}
// Make sure bytes is aligned at least to kMinAlignment.
size_t requestedBytes = bytes;
bytes = (bytes + kMinAlignment - 1) & -(ptrdiff_t)kMinAlignment;
if (align <= kMinAlignment)
align = kMinAlignment;
size_t const baseNeeded = bytes + sizeof(Header);
size_t writeHead = m_writeHead.load(std::memory_order_acquire);
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
uint8_t* currentMem;
ptrdiff_t padding;
size_t needed;
for (;;)
{
currentMem = m_memory + constrain(writeHead) + sizeof(Header);
padding = alignForward(currentMem, align) - currentMem;
CARB_ASSERT((padding & ptrdiff_t(sizeof(Header) - 1)) == 0); // Must be aligned to sizeof(Header)
needed = baseNeeded + padding;
// Check if we have enough available to satisfy the request
if (ptrdiff_t(needed) > ptrdiff_t(capacity() - (writeHead - readPtr)))
{
return nullptr;
}
// Update the pointer
if (CARB_LIKELY(m_writeHead.compare_exchange_strong(
writeHead, writeHead + needed, std::memory_order_acquire, std::memory_order_relaxed)))
break;
// Failed; writeHead was updated by the failed compare_exchange; refresh readPtr
readPtr = m_readPtr.load(std::memory_order_acquire);
}
if (padding)
{
// Create the padding space Header if necessary
new (currentMem - sizeof(Header)) Header(uint32_t(padding - sizeof(Header)), uint32_t(padding - sizeof(Header)),
Header::kPadding | Header::kCommitted);
currentMem += padding;
}
// Create the header (with the kCommitted bit zero)
new (currentMem - sizeof(Header)) Header(uint32_t(bytes), uint32_t(requestedBytes));
// We have to wait until m_writeTail becomes our writeHead. This allows sequential writes to be properly ordered.
size_t tail = m_writeTail.load(std::memory_order_relaxed);
while (tail != writeHead)
{
m_writeTail.wait(tail, std::memory_order_relaxed);
tail = m_writeTail.load(std::memory_order_relaxed);
}
m_writeTail.store(writeHead + needed, std::memory_order_release);
m_writeTail.notify_all();
return currentMem;
}
template <class Func>
inline void* RingBuffer::allocWait(size_t bytes, Func&& onWait, size_t align)
{
// Will never have enough memory to allocate this
if (bytes == 0 || (bytes + align) > (m_memorySize - sizeof(Header)))
{
return nullptr;
}
// Alignment greater than max is not allowed
if (align > kMaxAlignment || !isPowerOf2(align))
{
CARB_ASSERT(0);
return nullptr;
}
// Make sure bytes is aligned at least to kMinAlignment.
size_t requestedBytes = bytes;
bytes = (bytes + kMinAlignment - 1) & -(ptrdiff_t)kMinAlignment;
size_t const baseNeeded = bytes + sizeof(Header);
size_t writeHead;
uint8_t* const baseMem = m_memory;
uint8_t* currentMem;
ptrdiff_t padding;
size_t needed;
if (align <= kMinAlignment)
{
// We don't need any padding, so just increment the pointer
needed = baseNeeded;
padding = 0;
writeHead = m_writeHead.fetch_add(needed, std::memory_order_acquire);
currentMem = baseMem + constrain(writeHead) + sizeof(Header);
}
else
{
// When specific alignment is required, we can't blindly increment the writeHead pointer, because the amount of
// padding necessary is dependent on the current value of writeHead.
writeHead = m_writeHead.load(std::memory_order_acquire);
for (;;)
{
currentMem = baseMem + constrain(writeHead) + sizeof(Header);
padding = alignForward(currentMem, align) - currentMem;
CARB_ASSERT((padding & ptrdiff_t(sizeof(Header) - 1)) == 0); // Must be aligned to sizeof(Header)
needed = baseNeeded + padding;
// Update the pointer
if (CARB_LIKELY(m_writeHead.compare_exchange_strong(
writeHead, writeHead + needed, std::memory_order_acquire, std::memory_order_relaxed)))
{
break;
}
// Failed; writeHead was updated by the failed compare_exchange. Loop and try again
}
}
// If necessary, block until we have space to write
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
if (CARB_UNLIKELY(ptrdiff_t(writeHead + needed - readPtr) > ptrdiff_t(m_memorySize)))
{
// We don't currently have capacity, so we need to wait
onWait();
// Wait for memory to be available
do
{
m_readPtr.wait(readPtr, std::memory_order_relaxed);
readPtr = m_readPtr.load(std::memory_order_relaxed);
} while (ptrdiff_t(writeHead + needed - readPtr) > ptrdiff_t(m_memorySize));
}
if (padding)
{
// Create the padding space Header if necessary
new (currentMem - sizeof(Header)) Header(uint32_t(padding - sizeof(Header)), uint32_t(padding - sizeof(Header)),
Header::kPadding | Header::kCommitted);
currentMem += padding;
}
// Create the header (with the kCommitted bit zero)
new (currentMem - sizeof(Header)) Header(uint32_t(bytes), uint32_t(requestedBytes));
// We have to wait until m_writeTail becomes our writeHead. This allows sequential writes to be properly ordered.
size_t tail = m_writeTail.load(std::memory_order_relaxed);
while (tail != writeHead)
{
m_writeTail.wait(tail, std::memory_order_relaxed);
tail = m_writeTail.load(std::memory_order_relaxed);
}
m_writeTail.store(writeHead + needed, std::memory_order_release);
m_writeTail.notify_all();
return currentMem;
}
inline void RingBuffer::commit(void* mem)
{
CARB_ASSERT(isOwned(mem));
Header* header = reinterpret_cast<Header*>(reinterpret_cast<uint8_t*>(mem) - sizeof(Header));
uint32_t result = header->bytes.fetch_or(Header::kCommitted, std::memory_order_release);
header->bytes.notify_one(); // notify the waiter in waitForCommittedData()
CARB_ASSERT(!(result & Header::kCommitted)); // Shouldn't already be committed
CARB_UNUSED(result);
}
template <class Func>
inline bool RingBuffer::peek(Func&& f) const
{
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
size_t writePtr = m_writeTail.load(std::memory_order_acquire);
for (;;)
{
// Any bytes to read?
if (ptrdiff_t(writePtr - readPtr) <= 0)
return false;
uint8_t* offset = m_memory + constrain(readPtr);
Header* header = reinterpret_cast<Header*>(offset);
// Check if the next header has been committed
uint32_t bytes = header->bytes.load(std::memory_order_acquire);
if (!!(bytes & Header::kPadding))
{
// For padding, we're just going to skip it and look ahead
CARB_ASSERT(!!(bytes & Header::kCommitted)); // Should be committed
bytes &= ~(Header::kPadding | Header::kCommitted);
readPtr += (bytes + sizeof(Header));
continue;
}
// Must be committed
if (!(bytes & Header::kCommitted))
return false;
bytes &= ~Header::kCommitted;
// This may also indicate multiple threads calling read() simultaneously which is not allowed
CARB_FATAL_UNLESS(
(bytes + sizeof(Header)) <= (writePtr - readPtr), "RingBuffer internal error or memory corruption");
// Call the function to handle the data
f(offset + sizeof(Header), header->requestedBytes);
return true;
}
}
template <class Func>
inline bool RingBuffer::read(Func&& f)
{
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
size_t writePtr = m_writeTail.load(std::memory_order_acquire);
for (;;)
{
// Any bytes to read?
if (ptrdiff_t(writePtr - readPtr) <= 0)
return false;
uint8_t* offset = m_memory + constrain(readPtr);
Header* header = reinterpret_cast<Header*>(offset);
// Check if the next header has been committed
size_t bytes = header->bytes.load(std::memory_order_acquire);
if (!!(bytes & Header::kPadding))
{
// Try to skip padding
CARB_ASSERT(!!(bytes & Header::kCommitted)); // Should be committed
bytes &= ~(Header::kPadding | Header::kCommitted);
CARB_FATAL_UNLESS(m_readPtr.exchange(readPtr + bytes + sizeof(Header), std::memory_order_release) == readPtr,
"RingBuffer::read is not thread-safe; call from only one thread or use readCopy()");
m_readPtr.notify_all();
readPtr += (bytes + sizeof(Header));
continue;
}
// Must be committed
if (!(bytes & Header::kCommitted))
return false;
bytes &= ~Header::kCommitted;
// This may also indicate multiple threads calling read() simultaneously which is not allowed
CARB_FATAL_UNLESS(
(bytes + sizeof(Header)) <= (writePtr - readPtr), "RingBuffer internal error or memory corruption");
// Call the function to handle the data
f(offset + sizeof(Header), header->requestedBytes);
// Move the read pointer
CARB_FATAL_UNLESS(m_readPtr.exchange(readPtr + bytes + sizeof(Header), std::memory_order_release) == readPtr,
"RingBuffer::read is not thread-safe; call from only one thread or use readCopy()");
m_readPtr.notify_all();
return true;
}
}
template <class Func>
inline size_t RingBuffer::readAll(Func&& f)
{
size_t origReadPtr = m_readPtr.load(std::memory_order_acquire);
size_t writePtr = m_writeTail.load(std::memory_order_acquire);
size_t count = 0;
size_t readPtr = origReadPtr;
for (;;)
{
// Any bytes to read?
if (ptrdiff_t(writePtr - readPtr) <= 0)
{
break;
}
uint8_t* offset = m_memory + constrain(readPtr);
Header* header = reinterpret_cast<Header*>(offset);
// Check if the next header has been committed
size_t bytes = header->bytes.load(std::memory_order_acquire);
if (!!(bytes & Header::kPadding))
{
// Try to skip padding
CARB_ASSERT(!!(bytes & Header::kCommitted)); // Should be committed
bytes &= ~(Header::kPadding | Header::kCommitted);
readPtr += (bytes + sizeof(Header));
continue;
}
// Terminate iteration if we encounter a non-committed value
if (!(bytes & Header::kCommitted))
break;
bytes &= ~Header::kCommitted;
// This may also indicate multiple threads calling read() simultaneously which is not allowed
CARB_FATAL_UNLESS(
(bytes + sizeof(Header)) <= (writePtr - readPtr), "RingBuffer internal error or memory corruption");
// Call the function to handle the data
if (!f(offset + sizeof(Header), header->requestedBytes))
break;
++count;
// Advance the read pointer
readPtr += (bytes + sizeof(Header));
}
if (readPtr != origReadPtr)
{
CARB_FATAL_UNLESS(m_readPtr.exchange(readPtr, std::memory_order_release) == origReadPtr,
"RingBuffer::readAll is not thread-safe; call from only one thread or use readCopy()");
m_readPtr.notify_all();
}
return count;
}
inline size_t RingBuffer::readCopy(void* buffer, size_t bufSize)
{
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
for (;;)
{
size_t writePtr = m_writeTail.load(std::memory_order_acquire);
// Any bytes to read?
if (ptrdiff_t(writePtr - readPtr) <= 0)
return 0;
uint8_t* offset = m_memory + constrain(readPtr);
Header* header = reinterpret_cast<Header*>(offset);
// Check if the next header has been committed
size_t bytes = header->bytes.load(std::memory_order_acquire);
if (!!(bytes & Header::kPadding))
{
// Try to skip padding
CARB_ASSERT(!!(bytes & Header::kCommitted)); // Padding is always committed
bytes &= ~(Header::kPadding | Header::kCommitted);
// If we fail the compare_exchange, readPtr is re-loaded and we try again.
if (CARB_LIKELY(m_readPtr.compare_exchange_strong(
readPtr, readPtr + sizeof(Header) + bytes, std::memory_order_release, std::memory_order_relaxed)))
readPtr += (sizeof(Header) + bytes);
m_readPtr.notify_all();
continue;
}
// Must be committed
if (!(bytes & Header::kCommitted))
return 0;
bytes &= ~Header::kCommitted;
if ((bytes + sizeof(Header)) > (writePtr - readPtr))
{
// This *may* happen if another thread has advanced the read pointer, and another thread has written to the
// block of data that we're currently trying to read from. It is incredibly rare, but we should refresh our
// pointers and try again.
readPtr = m_readPtr.load(std::memory_order_acquire);
continue;
}
// Check if we have enough space to write. If not, return the size needed. NOTE: for the reasons listed in the
// above comment, this may spuriously return.
if (header->requestedBytes > bufSize)
return header->requestedBytes;
// Copy the data
memcpy(buffer, offset + sizeof(Header), header->requestedBytes);
// If we fail the compare_exchange, readPtr is re-loaded and we try again.
if (CARB_LIKELY(m_readPtr.compare_exchange_strong(
readPtr, readPtr + sizeof(Header) + bytes, std::memory_order_release, std::memory_order_relaxed)))
{
m_readPtr.notify_all();
return header->requestedBytes;
}
}
}
inline bool RingBuffer::isOwned(void* mem) const
{
return mem >= m_memory && mem < (m_memory + (2 * m_memorySize));
}
template <class T>
bool RingBuffer::writeObject(T&& obj)
{
using Type = typename std::decay<T>::type;
void* mem = this->alloc(sizeof(Type), alignof(Type));
if (!mem)
return false;
new (mem) Type(std::forward<T>(obj));
this->commit(mem);
return true;
}
template <class T, class Func>
bool RingBuffer::writeObjectWait(T&& obj, Func&& onWait)
{
using Type = typename std::decay<T>::type;
void* mem = this->allocWait(sizeof(Type), std::forward<Func>(onWait), alignof(Type));
if (!mem)
return false;
new (mem) Type(std::forward<T>(obj));
this->commit(mem);
return true;
}
template <class T>
bool RingBuffer::readObject(T& obj)
{
return this->read([&obj](void* mem, size_t size) {
using Type = typename std::decay<T>::type;
CARB_UNUSED(size);
CARB_ASSERT(size >= sizeof(Type));
CARB_ASSERT((reinterpret_cast<size_t>(mem) & (alignof(Type) - 1)) == 0);
Type* p = reinterpret_cast<Type*>(mem);
obj = std::move(*p);
p->~Type();
});
}
inline void RingBuffer::waitForAllocatedData()
{
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
size_t writePtr = m_writeTail.load(std::memory_order_acquire);
while (ptrdiff_t(writePtr - readPtr) <= 0)
{
m_writeTail.wait(writePtr, std::memory_order_relaxed);
writePtr = m_writeTail.load(std::memory_order_relaxed);
}
}
inline void RingBuffer::waitForCommittedData()
{
size_t readPtr = m_readPtr.load(std::memory_order_acquire);
size_t writePtr = m_writeTail.load(std::memory_order_acquire);
for (;;)
{
// Any bytes to read?
if (ptrdiff_t(writePtr - readPtr) <= 0)
{
m_writeTail.wait(writePtr);
writePtr = m_writeTail.load(std::memory_order_relaxed);
continue;
}
uint8_t* offset = m_memory + constrain(readPtr);
Header* header = reinterpret_cast<Header*>(offset);
// Check if the next header has been committed
uint32_t bytes = header->bytes.load(std::memory_order_acquire);
if (!!(bytes & Header::kPadding))
{
// For padding, we're just going to skip it and look ahead
CARB_ASSERT(!!(bytes & Header::kCommitted)); // Should be committed
bytes &= ~(Header::kPadding | Header::kCommitted);
// Skip the header
readPtr += (bytes + sizeof(Header));
offset = m_memory + constrain(readPtr);
header = reinterpret_cast<Header*>(offset);
}
// Must be committed
if (!(bytes & Header::kCommitted))
{
// Wait for commit
header->bytes.wait(bytes, std::memory_order_relaxed);
}
// Bytes are now available
return;
}
}
} // namespace container
} // namespace carb
| 40,446 | C | 37.411206 | 126 | 0.628492 |
omniverse-code/kit/include/carb/container/RHUnorderedSet.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite Robin-hood Unordered Set container.
#pragma once
#include "RobinHoodImpl.h"
namespace carb
{
namespace container
{
/**
* Implements an Unordered Set, that is: a container that contains a set of keys that all must be unique. There is no
* defined order to the set of keys.
*
* \copydetails detail::RobinHood
*
* @warning This container is similar to, but not a drop-in replacement for `std::unordered_set` due to differences in
* iterator invalidation and memory layout.
*
* Iterator/reference/pointer invalidation (note differences from `std::unordered_set`):
* Operation | Invalidates
* --------- | -----------
* All read operations | Never
* `clear`, `rehash`, `reserve`, `operator=`, `insert`, `emplace` | Always
* `erase` | Only the element removed
* `swap` | All iterators, no pointers/references
*
* @tparam Key The key type
* @tparam Hasher A functor to use as a hashing function for \c Key
* @tparam Equals A functor to use to compare two \c Key values for equality
* @tparam LoadFactorMax100 The load factor to use for the table. This value must be in the range `[10, 100]` and
* represents the percentage of entries in the hash table that will be filled before resizing. Open-addressing hash maps
* with 100% usage have better memory usage but worse performance since they need "gaps" in the hash table to terminate
* runs.
*/
template <class Key, class Hasher = std::hash<Key>, class Equals = std::equal_to<Key>, size_t LoadFactorMax100 = 80>
class RHUnorderedSet
: public detail::RobinHood<LoadFactorMax100, Key, const Key, detail::Identity<Key, const Key>, Hasher, Equals>
{
using Base = detail::RobinHood<LoadFactorMax100, Key, const Key, detail::Identity<Key, const Key>, Hasher, Equals>;
public:
//! The key type
using key_type = typename Base::key_type;
//! The value type (effectively `const key_type`)
using value_type = typename Base::value_type;
//! Unsigned integer type (typically \c size_t)
using size_type = typename Base::size_type;
//! Signed integer type (typically \c ptrdiff_t)
using difference_type = typename Base::difference_type;
//! The hash function
using hasher = typename Base::hasher;
//! The key-equals function
using key_equal = typename Base::key_equal;
//! \c value_type&
using reference = typename Base::reference;
//! `const value_type&`
using const_reference = typename Base::const_reference;
//! \c value_type*
using pointer = typename Base::pointer;
//! `const value_type*`
using const_pointer = typename Base::const_pointer;
//! A \a LegacyForwardIterator to \c value_type
using iterator = typename Base::iterator;
//! A \a LegacyForwardIterator to `const value_type`
using const_iterator = typename Base::const_iterator;
//! A \a LegacyForwardIterator to \c value_type that proceeds to the next matching key when incremented.
using find_iterator = typename Base::find_iterator;
//! A \a LegacyForwardIterator to `const value_type` that proceeds to the next matching key when incremented.
using const_find_iterator = typename Base::const_find_iterator;
/**
* Constructs empty container.
*/
constexpr RHUnorderedSet() noexcept = default;
/**
* Copy constructor. Copies elements from another container.
*
* @note \c *this may have a different \ref capacity() than \p other.
* @param other The other container to copy entries from.
*/
RHUnorderedSet(const RHUnorderedSet& other) : Base(other)
{
}
/**
* Move constructor. Moves elements from another container.
*
* @note No move constructors on contained elements are invoked. \p other will be empty() after this operation.
* @param other The other container to move entries from.
*/
RHUnorderedSet(RHUnorderedSet&& other) : Base(std::move(other))
{
}
/**
* Destructor. Destroys all contained elements and frees memory.
*/
~RHUnorderedSet() = default;
/**
* Copy-assign operator. Destroys all currently stored elements and copies elements from another container.
*
* @param other The other container to copy entries from.
* @returns \c *this
*/
RHUnorderedSet& operator=(const RHUnorderedSet& other)
{
Base::operator=(other);
return *this;
}
/**
* Move-assign operator. Effectively swaps with another container.
*
* @param other The other container to copy entries from.
* @returns \c *this
*/
RHUnorderedSet& operator=(RHUnorderedSet&& other)
{
Base::operator=(std::move(other));
return *this;
}
/**
* Inserts an element into the container.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param value The value to insert by copying.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
std::pair<iterator, bool> insert(const value_type& value)
{
return this->insert_unique(value);
}
/**
* Inserts an element into the container.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param value The value to insert by moving.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
std::pair<iterator, bool> insert(value_type&& value)
{
return this->insert_unique(std::move(value));
}
/**
* Inserts an element into the container. Only participates in overload resolution if
* `std::is_constructible_v<value_type, P&&>` is true.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param value The value to insert by constructing via `std::forward<P>(value)`.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
template <class P>
std::pair<iterator, bool> insert(std::enable_if_t<std::is_constructible<value_type, P&&>::value, P&&> value)
{
return insert(value_type{ std::forward<P>(value) });
}
/**
* Constructs an element in-place.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param args The arguments to pass to the \c value_type constructor.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
template <class... Args>
std::pair<iterator, bool> emplace(Args&&... args)
{
// The value is the key, so just construct the item here
return insert(value_type{ std::forward<Args>(args)... });
}
/**
* Removes elements with the given key.
*
* References, pointers and iterators to the erase element are invalidated. All other iterators, pointers and
* references remain valid.
*
* @param key the key value of elements to remove
* @returns the number of elements removed (either 1 or 0).
*/
size_type erase(const key_type& key)
{
auto vt = this->internal_find(key);
if (vt)
{
this->internal_erase(vt);
return 1;
}
return 0;
}
/**
* Returns the number of elements matching the specified key.
*
* @param key The key to check for.
* @returns The number of elements with the given key (either 1 or 0).
*/
size_t count(const key_type& key) const
{
return !!this->internal_find(key);
}
#ifndef DOXYGEN_BUILD
using Base::begin;
using Base::cbegin;
using Base::cend;
using Base::end;
using Base::capacity;
using Base::empty;
using Base::max_size;
using Base::size;
using Base::clear;
using Base::erase;
using Base::swap;
using Base::contains;
using Base::equal_range;
using Base::find;
using Base::rehash;
using Base::reserve;
#endif
};
} // namespace container
} // namespace carb
| 9,186 | C | 34.608527 | 120 | 0.664707 |
omniverse-code/kit/include/carb/container/RobinHoodImpl.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite Robin-hood container generic implementation.
#pragma once
#include "../Defines.h"
#include <algorithm>
#include <iterator>
#include "../cpp/Bit.h"
namespace carb
{
namespace container
{
namespace detail
{
#ifndef DOXYGEN_BUILD
template <class Key, class ValueType>
struct Select1st
{
const Key& operator()(const ValueType& vt) const noexcept
{
return vt.first;
}
};
template <class Key, class ValueType>
struct Identity
{
const Key& operator()(const ValueType& vt) const noexcept
{
return vt;
}
};
#endif
/**
* Implements a "Robin Hood" open-addressing hash container that can either store keys alone or key/value pairs; this
* template is not meant to be used directly--instead use \ref RHUnorderedSet, \ref RHUnorderedMap,
* \ref RHUnorderedMultimap, or \ref RHUnorderedMultiset.
*
* \details
* In an open-addressing ("OA") hash table, the contained items are stored in the buckets directly. Contrast this with
* traditional hash tables that typically have a level of indirection: buckets point to the head of a linked-list that
* contains every item that hashes to that bucket. Open-addressing hash tables are great for using contiguous memory,
* whereas traditional hash tables have a separate allocation per node and fragment memory. However, OA hash tables have
* a couple downsides: if a collision occurs on insertion, probing must happen until an open spot is found where the
* item can be placed. For a find operation, probing must continue until an empty spot is reached to make sure that
* all keys have been checked. When erasing an item, a "deleted" marker must be put in its place so that probing past
* the key can continue. This system also gives advantage to earlier insertions and penalizes later collisions.
*
* The Robin Hood algorithm for open-addressing hashing was first postulated by Pedro Celis in 1986:
* https://cs.uwaterloo.ca/research/tr/1986/CS-86-14.pdf. Simply put, it applies a level of fairness to locality of
* items within the OA hash table. This is done by tracking the distance from an items ideal insertion point. Similarly
* the distance-from-ideal can be easily computed for existing locations that are probed. Once a probed location for a
* new item will cause the new item to be worse off (farther from ideal insertion) than the existing item, the new item
* can "steal" the location from the existing item, which must then probe until it finds a location where it is worse
* off than the existing item, and so on. This balancing of locality has beneficial side effects for finding and erasing
* too: when searching for an item, once a location is reached where the item would be worse off than the existing item,
* probing can cease with the knowledge that the item is not contained.
*
* OA hash tables cannot be direct drop-in replacements for closed-addressing hash containers such as
* `std::unordered_map` as nearly every modification to the table can potentially invalidate any other iterator.
*
* Open-addressing hash tables may not be a good replacement for `std` unordered containers in cases where the key
* and/or value is very large (though this may be mitigated somewhat by using indirection through `std::unique_ptr`).
* Since OA hash tables must carry the size of each value_type, having a low load factor (or a high capacity() to size()
* ratio) wastes a lot of memory, especially if the key/value pair is very large.
*
* It is important to keep OA hash tables as compact as possible, as operations like `clear()` and iterating over the
* hash table are `O(n)` over `capacity()`, not `size()`. You can always ensure that the hash table is as compact as
* possible by calling `rehash(0)`.
*
* Because of the nature of how elements are stored in this hash table, there are two iterator types: `iterator` and
* `find_iterator` (both with `const` versions). These types can be compared with each other, but incrementing these
* objects works differently. `iterator` and `const_iterator` traverse to the next item in the container, while
* `find_iterator` and `const_find_iterator` will only traverse to the next item with the same key. In multi-key
* containers, items with the same key may not necessarily be stored adjacently, so incrementing `iterator` may not
* encounter the next item with the same key as the previous. For unique-key containers, incrementing a `find_iterator`
* will always produce `end()` since keys are guaranteed to be unique.
*/
template <size_t LoadFactorMax100, class Key, class ValueType, class KeyFromValue, class Hasher, class Equals>
class CARB_VIZ RobinHood
{
public:
#ifndef DOXYGEN_BUILD
using key_type = Key;
using value_type = ValueType;
using size_type = std::size_t;
using difference_type = std::ptrdiff_t;
using hasher = Hasher;
using key_equal = Equals;
using reference = value_type&;
using const_reference = const value_type&;
using pointer = value_type*;
using const_pointer = const value_type*;
static_assert(LoadFactorMax100 >= 10 && LoadFactorMax100 <= 100, "Load factor must be in range [10, 100]");
// clang-format off
class iter_base
{
public:
constexpr iter_base() noexcept = default;
bool operator == (const iter_base& other) const noexcept { CARB_ASSERT(owner == other.owner); return where == other.where; }
bool operator != (const iter_base& other) const noexcept { CARB_ASSERT(owner == other.owner); return where != other.where; }
protected:
constexpr iter_base(const RobinHood* owner_, value_type* where_) noexcept : owner(owner_), where(where_) {}
CARB_VIZ const RobinHood* owner{ nullptr };
CARB_VIZ value_type* where{ nullptr };
};
class CARB_VIZ const_find_iterator : public iter_base
{
using Base = iter_base;
public:
using iterator_category = std::forward_iterator_tag;
using value_type = RobinHood::value_type;
using difference_type = ptrdiff_t;
using pointer = const value_type*;
using reference = const value_type&;
constexpr const_find_iterator() noexcept = default;
reference operator * () const noexcept { CARB_ASSERT(this->where); return *this->where; }
pointer operator -> () const noexcept { CARB_ASSERT(this->where); return this->where; }
const_find_iterator& operator ++ () noexcept { CARB_ASSERT(this->where); incr(); return *this; }
const_find_iterator operator ++ (int) noexcept { const_find_iterator i{ *this }; incr(); return i; }
protected:
friend class RobinHood;
constexpr const_find_iterator(const RobinHood* owner_, value_type* where_) noexcept : Base{ owner_, where_ } {}
void incr() { CARB_ASSERT(this->owner && this->where); this->where = this->owner->_findnext(this->where); }
};
class find_iterator : public const_find_iterator
{
using Base = const_find_iterator;
public:
using iterator_category = std::forward_iterator_tag;
using value_type = RobinHood::value_type;
using difference_type = ptrdiff_t;
using pointer = value_type*;
using reference = value_type&;
constexpr find_iterator() noexcept = default;
reference operator * () const noexcept { CARB_ASSERT(this->where); return *this->where; }
pointer operator -> () const noexcept { CARB_ASSERT(this->where); return this->where; }
find_iterator& operator ++ () noexcept { CARB_ASSERT(this->where); this->incr(); return *this; }
find_iterator operator ++ (int) noexcept { CARB_ASSERT(this->where); find_iterator i{ *this }; this->incr(); return i; }
protected:
friend class RobinHood;
constexpr find_iterator(const RobinHood* owner_, value_type* where_) noexcept : Base(owner_, where_) {}
};
class CARB_VIZ const_iterator : public iter_base
{
using Base = iter_base;
public:
using iterator_category = std::forward_iterator_tag;
using value_type = RobinHood::value_type;
using difference_type = ptrdiff_t;
using pointer = const value_type*;
using reference = const value_type&;
constexpr const_iterator() noexcept = default;
reference operator * () const noexcept { CARB_ASSERT(this->where); return *this->where; }
pointer operator -> () const noexcept { CARB_ASSERT(this->where); return this->where; }
const_iterator& operator ++ () noexcept { CARB_ASSERT(this->where); incr(); return *this; }
const_iterator operator ++ (int) noexcept { const_iterator i{ *this }; incr(); return i; }
protected:
friend class RobinHood;
constexpr const_iterator(const RobinHood* owner_, value_type* where_) noexcept : Base{ owner_, where_ } {}
void incr() { CARB_ASSERT(this->owner && this->where); this->where = this->owner->_next(this->where); }
};
class iterator : public const_iterator
{
using Base = const_iterator;
public:
using iterator_category = std::forward_iterator_tag;
using value_type = RobinHood::value_type;
using difference_type = ptrdiff_t;
using pointer = value_type*;
using reference = value_type&;
constexpr iterator() noexcept = default;
reference operator * () const noexcept { CARB_ASSERT(this->where); return *this->where; }
pointer operator -> () const noexcept { CARB_ASSERT(this->where); return this->where; }
iterator& operator ++ () noexcept { CARB_ASSERT(this->where); this->incr(); return *this; }
iterator operator ++ (int) noexcept { CARB_ASSERT(this->where); iterator i{ *this }; this->incr(); return i; }
protected:
friend class RobinHood;
constexpr iterator(const RobinHood* owner_, value_type* where_) noexcept : Base(owner_, where_) {}
};
// clang-format on
constexpr RobinHood() noexcept = default;
RobinHood(const RobinHood& other)
{
// This effectively rebuilds `other` as *this, but it sizes *this as compactly as possible (whereas `other` may
// have a high capacity():size() ratio).
reserve(other.size());
for (auto& entry : other)
{
auto result = internal_insert_multi(KeyFromValue{}(entry));
new (result) value_type(entry); // copy
}
}
RobinHood(RobinHood&& other)
{
std::swap(m_data, other.m_data);
}
~RobinHood()
{
if (m_data.m_table)
{
if (!empty() && !std::is_trivially_destructible<value_type>::value)
{
for (size_t i = 0; i != m_data.m_tableSize; ++i)
{
if (isHashValid(m_data.m_hashes[i]))
m_data.m_table[i].~value_type();
}
}
std::free(std::exchange(m_data.m_table, nullptr));
m_data.m_hashes = nullptr;
m_data.m_size = m_data.m_tableSize = 0;
}
}
RobinHood& operator=(const RobinHood& other)
{
clear();
reserve(other.size());
for (auto& entry : other)
{
auto result = internal_insert_multi(KeyFromValue{}(entry));
new (result) value_type(entry);
}
return *this;
}
RobinHood& operator=(RobinHood&& other)
{
if (this != &other)
{
std::swap(m_data, other.m_data);
}
return *this;
}
#endif
/**
* Creates an iterator to the first element in the container.
*
* @returns a `const_iterator` to the first element in the container. If the container is empty() the iterator
* will be equal to \ref cend().
*/
const_iterator cbegin() const
{
if (CARB_UNLIKELY(empty()))
return cend();
auto const end = m_data.m_hashes + m_data.m_tableSize;
for (auto e = m_data.m_hashes; e != end; ++e)
if (isHashValid(*e))
return { this, m_data.m_table + (e - m_data.m_hashes) };
// Should never get here since we checked empty()
CARB_ASSERT(0);
return cend();
}
/**
* Creates an iterator to the first element in the container.
*
* @returns an `iterator` to the first element in the container. If the container is empty() the iterator will
* be equal to \ref end().
*/
iterator begin()
{
if (CARB_UNLIKELY(empty()))
return end();
auto const kEnd = m_data.m_hashes + m_data.m_tableSize;
for (auto e = m_data.m_hashes; e != kEnd; ++e)
if (isHashValid(*e))
return { this, m_data.m_table + (e - m_data.m_hashes) };
// Should never get here since we checked empty()
CARB_ASSERT(0);
return end();
}
/**
* Creates an iterator to the first element in the container.
*
* @returns a `const_iterator` to the first element in the container. If the container is empty() the iterator
* will be equal to \ref end().
*/
const_iterator begin() const
{
return cbegin();
}
/**
* Creates an iterator to the past-the-end element in the container.
*
* @returns a `const_iterator` to the past-the-end element in the container. This iterator is a placeholder;
* attempting to access it results in undefined behavior.
*/
const_iterator cend() const
{
return { this, nullptr };
}
/**
* Creates an iterator to the past-the-end element in the container.
*
* @returns an `iterator` to the past-the-end element in the container. This iterator is a placeholder;
* attempting to access it results in undefined behavior.
*/
iterator end()
{
return { this, nullptr };
}
/**
* Creates an iterator to the past-the-end element in the container.
*
* @returns a `const_iterator` to the past-the-end element in the container. This iterator is a placeholder;
* attempting to access it results in undefined behavior.
*/
const_iterator end() const
{
return cend();
}
/**
* Checks whether the container is empty.
* @returns \c true if the container contains no elements; \c false otherwise.
*/
bool empty() const noexcept
{
return !m_data.m_size;
}
/**
* Returns the number of elements contained. O(1)
* @returns the number of elements contained.
*/
size_t size() const noexcept
{
return m_data.m_size;
}
/**
* Returns the maximum possible number of elements. O(1)
* @returns the maximum possible number of elements.
*/
constexpr size_t max_size() const noexcept
{
return size_t(-1) & ~kDeletedBit;
}
/**
* Returns the number of elements that can be stored with the current memory usage. This is based on the
* `LoadFactorMax100` percentage and the current power-of-two memory allocation size. O(1)
* @see reserve()
* @returns the number of elements that can be stored with the current memory usage.
*/
size_t capacity() const noexcept
{
// Handle case where Windows.h may have defined 'max'
#pragma push_macro("max")
#undef max
if (CARB_LIKELY(m_data.m_tableSize <= (std::numeric_limits<size_t>::max() / 100)))
return (m_data.m_tableSize * LoadFactorMax100) / 100;
#pragma pop_macro("max")
// In the unlikely event of a huge table, switch operations to not overflow
return (m_data.m_tableSize / 100) * LoadFactorMax100;
}
/**
* Clears the contents. O(n) over \ref capacity()
*
* Erases all elements from the container. After this call \ref size() returns zero. Invalidates all iterators,
* pointers and references to contained elements.
*
* @note This does not free the memory used by the container; to free the hash table memory, use `rehash(0)` after
* this call.
*/
void clear()
{
if (!empty())
{
size_t* const end = m_data.m_hashes + m_data.m_tableSize;
for (size_t* e = m_data.m_hashes; e != end; ++e)
{
if (isHashValid(*e) && !std::is_trivially_destructible<value_type>::value)
m_data.m_table[e - m_data.m_hashes].~value_type();
*e = kEmpty;
}
m_data.m_size = 0;
}
}
/**
* Swaps the contents of two containers. O(1)
*
* Exchanges the contents of \c *this with \p other. Will not invoke any move/copy/swap operations on the individual
* elements.
*
* All iterators are invalidated for both containers. However, pointers and references to contained elements remain
* valid.
*
* The \c Hasher and \c KeyEqual template parameters must be \a Swappable.
* @param other The other container to swap with \c *this.
*/
void swap(RobinHood& other)
{
std::swap(m_data, other.m_data);
}
/**
* Removes the given element.
*
* References, pointers and iterators to the erased element are invalidated. All other iterators, pointers and
* references remain valid.
*
* @param pos The \c iterator to the element to remove. This iterator must be valid and dereferenceable.
* @returns the iterator immediately following \p pos.
*/
iterator erase(const_iterator pos)
{
CARB_ASSERT(pos.owner == this);
assertContained(pos.where);
internal_erase(pos.where);
return iterator{ this, _next(pos.where) };
}
/**
* Removes the elements in the given range.
*
* The range `[first, last)` must be a valid range in `*this`. References, pointers and iterators to erased elements
* are invalidated. All other iterators, pointers and references to other elements remain valid.
*
* @param first The start of the range of iterators to remove.
* @param last The past-the-end iterator for the range to remove.
* @returns \p last
*/
iterator erase(const_iterator first, const_iterator last)
{
while (first != last)
first = erase(first);
return { this, first.where };
}
/**
* Removes the given element.
*
* References, pointers and iterators to the erased element are invalidated. All other iterators, pointers and
* references remain valid.
*
* @param pos The \c const_find_iterator to the element to remove. This iterator must be valid and dereferenceable.
* @returns the \c find_iterator immediately following \p pos.
*/
find_iterator erase(const_find_iterator pos)
{
CARB_ASSERT(pos.owner == this);
assertContained(pos.where);
find_iterator next{ this, _findnext(pos.where) };
internal_erase(pos.where);
return next;
}
/**
* Removes the elements in the given range.
*
* The range `[first, last)` must be a valid range in `*this`. References, pointers and iterators to erased elements
* are invalidated. All other iterators, pointers and references to other elements remain valid.
*
* @param first The start of the range of iterators to remove.
* @param last The past-the-end iterator for the range to remove.
* @returns \p last
*/
find_iterator erase(const_find_iterator first, const_find_iterator last)
{
while (first != last)
first = erase(first);
return { this, first.where };
}
/**
* Finds the first element with the specified key.
*
* @note \c find_iterator objects returned from this function will only iterate through elements with the same key;
* they cannot be used to iterate through the entire container.
*
* @param key The key of the element(s) to search for.
* @returns a \c find_iterator to the first element matching \p key, or \ref end() if no element was found matching
* \p key.
*/
find_iterator find(const key_type& key)
{
return { this, internal_find(key) };
}
/**
* Finds the first element with the specified key.
*
* @note \c const_find_iterator objects returned from this function will only iterate through elements with the same
* key; they cannot be used to iterate through the entire container.
*
* @param key The key of the element(s) to search for.
* @returns a \c const_find_iterator to the first element matching \p key, or \ref cend() if no element was found
* matching \p key.
*/
const_find_iterator find(const key_type& key) const
{
return { this, internal_find(key) };
}
/**
* Returns whether there is at least one element matching a given key in the container.
*
* @note This function can be faster than \c count() for multimap and multiset containers.
* @param key The key of the element to search for.
* @returns \c true if at least one element matching \p key exists in the container; \c false otherwise.
*/
bool contains(const key_type& key) const
{
return !!internal_find(key);
}
/**
* Returns a range containing all elements with the given key.
*
* @note \c find_iterator objects returned from this function will only iterate through elements with the same key;
* they cannot be used to iterate through the entire container.
*
* @param key The key of the element(s) to search for.
* @returns A \c pair containing a pair of iterators for the desired range. If there are no such elements, both
* iterators will be \ref end().
*/
std::pair<find_iterator, find_iterator> equal_range(const key_type& key)
{
auto vt = this->internal_find(key);
find_iterator fend{ this, nullptr };
return vt ? std::make_pair(find_iterator{ this, vt }, fend) : std::make_pair(fend, fend);
}
/**
* Returns a range containing all elements with the given key.
*
* @note \c const_find_iterator objects returned from this function will only iterate through elements with the same
* key; they cannot be used to iterate through the entire container.
*
* @param key The key of the element(s) to search for.
* @returns A \c pair containing a pair of iterators for the desired range. If there are no such elements, both
* iterators will be \ref end().
*/
std::pair<const_find_iterator, const_find_iterator> equal_range(const key_type& key) const
{
auto vt = this->internal_find(key);
const_find_iterator fend{ this, nullptr };
return vt ? std::make_pair(const_find_iterator{ this, vt }, fend) : std::make_pair(fend, fend);
}
/**
* Reserves space for at least the specified number of elements and regenerates the hash table.
*
* Sets \ref capacity() of \c *this to a value greater-than-or-equal-to \p n. If \ref capacity() already exceeds
* \p n, nothing happens.
*
* If a rehash occurs, all iterators, pointers and references to existing elements are invalidated.
*
* @param n The desired minimum capacity of \c *this.
*/
void reserve(size_t n)
{
if (n > capacity())
{
rehash(n);
}
}
/**
* Sets the capacity of the container to the lowest valid value greater-than-or-equal-to the given value, and
* rehashes the container.
*
* If \p n is less-than \ref size(), \ref size() is used instead.
*
* The value is computed as if by `cpp::bit_ceil(std::ceil(float(n * 100) / float(LoadFactorMax100)))` with a
* minimum size of 8.
*
* If the container is empty and \p n is zero, the memory for the container is freed.
*
* After this function is called, all iterators, pointers and references to existing elements are invalidated.
*
* @param n The minimum capacity for the container. The actual size of the container may be larger than this.
*/
void rehash(size_t n)
{
if (n < m_data.m_size)
n = m_data.m_size;
if (n == 0)
{
std::free(m_data.m_table);
m_data.m_table = nullptr;
m_data.m_hashes = nullptr;
m_data.m_tableSize = 0;
return;
}
ncvalue_type* const oldtable = m_data.m_table;
size_t* const oldhashes = m_data.m_hashes;
size_t* const oldend = oldhashes + m_data.m_tableSize;
size_t minsize = (n * 100 + (LoadFactorMax100 - 1)) / LoadFactorMax100; // ceiling (round up)
constexpr static auto kMinSize_ = kMinSize; // CC-1110
size_t newsize = ::carb_max(kMinSize_, cpp::bit_ceil(minsize)); // must be a power of 2
m_data.m_tableSize = newsize;
CARB_ASSERT(capacity() >= m_data.m_size);
m_data.m_table =
static_cast<ncvalue_type*>(std::malloc(m_data.m_tableSize * (sizeof(ncvalue_type) + sizeof(size_t))));
m_data.m_hashes = reinterpret_cast<size_t*>(m_data.m_table + m_data.m_tableSize);
size_t* const end = m_data.m_hashes + m_data.m_tableSize;
// Initialize
for (size_t* e = m_data.m_hashes; e != end; ++e)
*e = kEmpty;
for (size_t* e = oldhashes; e != oldend; ++e)
if (isHashValid(*e))
{
auto result = internal_insert_multi2(*e, KeyFromValue{}(oldtable[e - oldhashes]));
new (result) ncvalue_type(std::move(oldtable[e - oldhashes]));
oldtable[e - oldhashes].~value_type();
}
std::free(oldtable);
}
#ifndef DOXYGEN_BUILD
protected:
constexpr static size_t kDeletedBit = size_t(1) << (8 * sizeof(size_t) - 1);
constexpr static size_t kEmpty = size_t(-1) & ~kDeletedBit;
constexpr static size_t kMinSize = 8; // Minimum hash table size
static_assert(cpp::has_single_bit(kMinSize), "Must be power of 2");
using ncvalue_type = typename std::remove_const_t<value_type>;
static constexpr bool isEmpty(size_t h) noexcept
{
return h == kEmpty;
}
static constexpr bool isDeleted(size_t h) noexcept
{
return !!(h & kDeletedBit);
}
static constexpr bool isHashValid(size_t h) noexcept
{
return !(isDeleted(h) || isEmpty(h));
}
struct Data : public Hasher, public Equals
{
CARB_VIZ ncvalue_type* m_table{ nullptr };
CARB_VIZ size_t* m_hashes{ nullptr };
CARB_VIZ size_t m_size{ 0 };
CARB_VIZ size_t m_tableSize{ 0 };
};
size_t hash(const key_type& key) const noexcept
{
const Hasher& hasher = m_data;
size_t h = size_t(hasher(key)) & ~kDeletedBit;
return h ^ (h == kEmpty);
}
bool equals(const key_type& k1, const key_type& k2) const noexcept
{
const Equals& e = m_data;
return e(k1, k2);
}
void assertContained(const value_type* v) const
{
CARB_UNUSED(v);
CARB_ASSERT(v >= m_data.m_table && v < (m_data.m_table + m_data.m_tableSize));
}
const size_t* _end() const noexcept
{
return m_data.m_hashes + m_data.m_tableSize;
}
value_type* _next(value_type* prev) const
{
assertContained(prev);
const size_t* e = m_data.m_hashes + (prev - m_data.m_table) + 1;
for (; e != _end(); ++e)
if (isHashValid(*e))
return m_data.m_table + (e - m_data.m_hashes);
return nullptr;
}
value_type* _findnext(value_type* prev) const
{
assertContained(prev);
size_t const h = m_data.m_hashes[(prev - m_data.m_table)];
CARB_ASSERT(isHashValid(h));
key_type const& key = KeyFromValue{}(*prev);
size_t const kMask = (m_data.m_tableSize - 1);
size_t const start = (h & kMask); // starting index of the search. If we get back to this point, we're done.
size_t index = ((prev - m_data.m_table) + 1) & kMask;
size_t dist = (index - start) & kMask;
for (; index != start; index = (index + 1) & kMask, ++dist)
{
size_t* e = m_data.m_hashes + index;
if (isEmpty(*e))
{
return nullptr;
}
if (*e == h && equals(KeyFromValue{}(m_data.m_table[index]), key))
{
return m_data.m_table + index;
}
size_t entryDist = (index - *e) & kMask;
if (dist > entryDist)
{
return nullptr;
}
}
return nullptr;
}
constexpr iterator make_iter(value_type* where) const noexcept
{
return iterator{ this, where };
}
std::pair<iterator, bool> insert_unique(const value_type& value)
{
auto result = internal_insert(KeyFromValue{}(value));
if (result.second)
new (result.first) value_type(value);
return std::make_pair(iterator{ this, result.first }, result.second);
}
std::pair<iterator, bool> insert_unique(value_type&& value)
{
auto result = internal_insert(KeyFromValue{}(value));
if (result.second)
new (result.first) value_type(std::move(value));
return std::make_pair(iterator{ this, result.first }, result.second);
}
iterator insert_multi(const value_type& value)
{
return { this, new (internal_insert_multi(KeyFromValue{}(value))) value_type(value) };
}
iterator insert_multi(value_type&& value)
{
return { this, new (internal_insert_multi(KeyFromValue{}(value))) value_type(std::move(value)) };
}
ncvalue_type* internal_insert_multi(const key_type& key)
{
if (((m_data.m_size) + 1) >= capacity())
{
reserve(m_data.m_size + 1);
}
CARB_ASSERT(m_data.m_size < m_data.m_tableSize);
size_t h = hash(key);
++m_data.m_size;
return internal_insert_multi2(h, key);
}
ncvalue_type* internal_insert_multi2(size_t h, const key_type& key)
{
size_t const kMask = (m_data.m_tableSize - 1);
size_t index = h & kMask;
size_t last = (index - 1) & kMask;
size_t dist = 0; // distance from desired slot
size_t* e;
for (;;)
{
e = m_data.m_hashes + index;
if (isEmpty(*e))
{
*e = h;
return m_data.m_table + index;
}
// Compute the distance of the existing item or deleted entry
size_t const existingDist = (index - *e) & kMask;
if (isDeleted(*e))
{
// The evicted item can only go into a deleted slot only if it's "fair": our distance-from-desired must
// be same or worse than the existing deleted item.
if (dist >= existingDist)
{
// We can take a deleted entry that meets or exceeds our desired distance
*e = h;
return m_data.m_table + (e - m_data.m_hashes);
}
}
else if (dist > existingDist)
{
// Our distance from desired now exceeds the current entry, so we'll take it and evict whatever was
// previously there. Proceed to the next phase to find a spot for the evicted entry.
dist = existingDist;
break;
}
if (CARB_UNLIKELY(index == last))
{
// We reached the end without finding a valid spot, but there are deleted entries in the table. So
// rebuild to remove all of the deleted entries and recursively call.
rebuild();
return internal_insert_multi2(h, key);
}
index = (index + 1) & kMask;
++dist;
}
// At this point, we have to evict an existing item in order to insert at a fair position. The slot that will
// contain our new entry is pointed at by `orig`. Our caller will be responsible for initializing the value_type
ncvalue_type* const orig = m_data.m_table + (e - m_data.m_hashes);
std::swap(*e, h);
ncvalue_type value(std::move(*orig));
orig->~value_type(); // caller will need to reconstruct.
// We are now taking the perspective of the evicted item. `h` is already the hash value for the evicted item, so
// recompute `last`. `dist` is already the distance from desired for the evicted item as well.
last = (h - 1) & kMask;
// Start with the following index as it is the first candidate for the evicted item.
index = (index + 1) & kMask;
++dist;
for (;;)
{
e = m_data.m_hashes + index;
if (isEmpty(*e))
{
// Found an empty slot that the evicted item can move into.
*e = h;
new (m_data.m_table + index) value_type(std::move(value));
return orig;
}
size_t existingDist = (index - *e) & kMask;
if (isDeleted(*e))
{
// The evicted item can only go into a deleted slot only if it's "fair": our distance-from-desired must
// be same or worse than the existing deleted item.
if (dist >= existingDist)
{
*e = h;
new (m_data.m_table + index) value_type(std::move(value));
return orig;
}
}
else if (dist > existingDist)
{
// For an existing item, we can swap it out with the previously evicted item if it is worse off than the
// item at this location. It becomes the new evicted item and we continue traversal until we find a
// suitable location for it.
std::swap(*e, h);
swapValue(value, m_data.m_table[e - m_data.m_hashes]);
dist = existingDist;
last = (h - 1) & kMask;
}
if (index == last)
{
// We're in a bad state. There are too many deleted items and we've walked the entire list trying to
// find a location. Do a rebuild to remove all the deleted entries and re-hash everything then call
// recursively.
std::swap(m_data.m_hashes[orig - m_data.m_table], h);
// Reconstruct the item at orig since it was previously deleted.
new (orig) value_type(std::move(value));
CARB_ASSERT(h == hash(key));
rebuild();
return internal_insert_multi2(h, key);
}
index = (index + 1) & kMask;
++dist;
}
}
std::pair<ncvalue_type*, bool> internal_insert(const key_type& key)
{
if ((m_data.m_size + 1) >= capacity())
{
reserve(m_data.m_size + 1);
}
CARB_ASSERT(m_data.m_size < m_data.m_tableSize);
size_t h = hash(key);
auto result = internal_insert2(h, key);
m_data.m_size += result.second;
return result;
}
std::pair<ncvalue_type*, bool> internal_insert2(size_t h, const key_type& key)
{
size_t const kMask = (m_data.m_tableSize - 1);
size_t index = h & kMask;
size_t last = (index - 1) & kMask;
size_t dist = 0; // distance from desired slot
size_t* firstDeletedSlot = nullptr;
size_t* e;
for (;;)
{
e = m_data.m_hashes + index;
if (isEmpty(*e))
{
*e = h;
return std::make_pair(m_data.m_table + index, true);
}
if (*e == h && equals(KeyFromValue{}(m_data.m_table[index]), key))
{
return std::make_pair(m_data.m_table + index, false);
}
// Compute the distance of the existing item or deleted entry
size_t const existingDist = (index - *e) & kMask;
if (dist > existingDist)
{
// Our distance from desired now exceeds the current entry, so we'll take it. If it's deleted, we can
// merely take it, but if something already exists there, we need to move it down the line.
if (!firstDeletedSlot && isDeleted(*e))
{
firstDeletedSlot = e;
}
if (firstDeletedSlot)
{
// If we found a deleted slot, we can go into it
*firstDeletedSlot = h;
return std::make_pair(m_data.m_table + (firstDeletedSlot - m_data.m_hashes), true);
}
if (CARB_UNLIKELY(index == last))
{
// We reached the end without finding a valid spot, but there are deleted entries in the table. So
// rebuild to remove all of the deleted entries and recursively call.
rebuild();
return internal_insert2(h, key);
}
// We break out and proceed to find a new location for the existing entry
dist = existingDist;
break;
}
else if (!firstDeletedSlot && dist == existingDist && isDeleted(*e))
{
firstDeletedSlot = e;
}
if (CARB_UNLIKELY(index == last))
{
// We reached the end without finding a valid spot. Rebuild to remove all deleted entries and call
// recursively.
rebuild();
return internal_insert2(h, key);
}
index = (index + 1) & kMask;
++dist;
}
// At this point, we guarantee that we need to insert and we had to evict an existing item. The slot that will
// contain our new entry is pointed at by `orig`. Our caller will be responsible for initializing the value_type
ncvalue_type* const orig = m_data.m_table + (e - m_data.m_hashes);
std::swap(*e, h);
ncvalue_type value(std::move(*orig));
orig->~value_type(); // caller will need to reconstruct.
// We are now taking the perspective of the evicted item. `h` is already the hash value for the evicted item, so
// recompute `last`. `dist` is already the distance from desired for the evicted item as well.
last = (h - 1) & kMask;
// Start with the following index as it is the first candidate for the evicted item.
index = (index + 1) & kMask;
++dist;
for (;;)
{
e = m_data.m_hashes + index;
if (isEmpty(*e))
{
// Found an empty slot that the evicted item can move into.
*e = h;
new (m_data.m_table + index) value_type(std::move(value));
return std::make_pair(orig, true);
}
size_t existingDist = (index - *e) & kMask;
if (isDeleted(*e))
{
// The evicted item can only go into a deleted slot only if it's "fair": our distance-from-desired must
// be same or worse than the existing deleted item.
if (dist >= existingDist)
{
*e = h;
new (m_data.m_table + index) value_type(std::move(value));
return std::make_pair(orig, true);
}
}
else if (dist > existingDist)
{
// For an existing item, we can swap it out with the previously evicted item if it is worse off than the
// item at this location. It becomes the new evicted item and we continue traversal until we find a
// suitable location for it.
std::swap(*e, h);
swapValue(value, m_data.m_table[e - m_data.m_hashes]);
dist = existingDist;
last = (h - 1) & kMask;
}
if (index == last)
{
// We're in a bad state. There are too many deleted items and we've walked the entire list trying to
// find a location. Do a rebuild to remove all the deleted entries and re-hash everything then call
// recursively.
std::swap(m_data.m_hashes[orig - m_data.m_table], h);
// Reconstruct the item at orig since it was previously deleted.
new (orig) value_type(std::move(value));
CARB_ASSERT(h == hash(key));
rebuild();
return internal_insert2(h, key);
}
index = (index + 1) & kMask;
++dist;
}
}
size_t internal_count_multi(const key_type& key) const
{
size_t count = 0;
for (auto vt = internal_find(key); vt; vt = _findnext(vt))
++count;
return count;
}
void internal_erase(value_type* value)
{
--m_data.m_size;
value->~value_type();
size_t index = value - m_data.m_table;
size_t* h = m_data.m_hashes + index;
// Set the deleted bit, but we retain most bits in the hash so that distance checks work properly.
*h |= kDeletedBit;
// If our next entry is kEmpty, then we can walk backwards and set everything to kEmpty. This will keep the
// table a bit cleaner of deleted entries.
size_t const kMask = m_data.m_tableSize - 1;
if (isEmpty(m_data.m_hashes[(index + 1) & kMask]))
{
do
{
*h = kEmpty;
index = (index - 1) & kMask;
h = m_data.m_hashes + index;
} while (isDeleted(*h));
}
}
value_type* internal_find(const key_type& key) const
{
if (CARB_UNLIKELY(empty()))
return nullptr;
size_t const h = hash(key);
size_t const kMask = size_t(m_data.m_tableSize - 1);
size_t index = h & kMask;
size_t dist = 0;
for (;;)
{
size_t* e = m_data.m_hashes + index;
if (isEmpty(*e))
return nullptr;
if (*e == h && equals(KeyFromValue{}(m_data.m_table[index]), key))
{
return m_data.m_table + index;
}
size_t entryDist = (index - *e) & kMask;
if (dist > entryDist)
return nullptr;
// We do not need to check against the last entry here because distance keeps increasing. Eventually it will
// be larger than the number of items in the map.
++dist;
index = (index + 1) & kMask;
}
}
static void swapValue(ncvalue_type& v1, ncvalue_type& v2) noexcept
{
// Cannot use std::swap because key is const, so work around it with move-construct/destruction
ncvalue_type temp{ std::move(v1) };
v1.~value_type();
new (&v1) ncvalue_type(std::move(v2));
v2.~value_type();
new (&v2) ncvalue_type(std::move(temp));
}
// Similar to rehash except that it keeps the same table size
void rebuild()
{
ncvalue_type* const oldtable = m_data.m_table;
size_t* const oldhashes = m_data.m_hashes;
size_t* const oldend = oldhashes + m_data.m_tableSize;
m_data.m_table =
static_cast<ncvalue_type*>(std::malloc(m_data.m_tableSize * (sizeof(ncvalue_type) + sizeof(size_t))));
m_data.m_hashes = reinterpret_cast<size_t*>(m_data.m_table + m_data.m_tableSize);
size_t* const end = m_data.m_hashes + m_data.m_tableSize;
for (size_t* e = m_data.m_hashes; e != end; ++e)
*e = kEmpty;
if (CARB_LIKELY(m_data.m_size != 0))
{
for (size_t* e = oldhashes; e != oldend; ++e)
{
if (isHashValid(*e))
{
auto result = internal_insert_multi2(*e, KeyFromValue{}(oldtable[e - oldhashes]));
new (result) ncvalue_type(std::move(oldtable[e - oldhashes]));
oldtable[e - oldhashes].~value_type();
}
}
}
std::free(oldtable);
}
#endif
private:
CARB_VIZ Data m_data;
};
/**
* ADL swap function. Swaps between two containers that have the same template parameters.
*
* @param lhs The first container
* @param rhs The second container.
*/
template <size_t LoadFactorMax100, class Key, class ValueType, class KeyFromValue, class Hasher, class Equals>
void swap(RobinHood<LoadFactorMax100, Key, ValueType, KeyFromValue, Hasher, Equals>& lhs,
RobinHood<LoadFactorMax100, Key, ValueType, KeyFromValue, Hasher, Equals>& rhs)
{
lhs.swap(rhs);
}
/**
* Equality operator. Checks for equality between two containers.
*
* @param lhs The first container.
* @param rhs The second container.
* @returns \c true if the containers are equal, that is, the second container is a permutation of the first.
*/
template <size_t LoadFactorMax100_1, size_t LoadFactorMax100_2, class Key, class ValueType, class KeyFromValue, class Hasher1, class Hasher2, class Equals>
bool operator==(const RobinHood<LoadFactorMax100_1, Key, ValueType, KeyFromValue, Hasher1, Equals>& lhs,
const RobinHood<LoadFactorMax100_2, Key, ValueType, KeyFromValue, Hasher2, Equals>& rhs)
{
Equals equals{};
return std::is_permutation(
lhs.begin(), lhs.end(), rhs.begin(), rhs.end(), [&equals](const ValueType& l, const ValueType& r) {
KeyFromValue kfv{};
return equals(kfv(l), kfv(r));
});
}
/**
* Inequality operator. Checks for inequality between two containers.
*
* @param lhs The first container.
* @param rhs The second container.
* @returns \c true if the containers are not equal, that is, the second container is not a permutation of the first.
*/
template <size_t LoadFactorMax100_1, size_t LoadFactorMax100_2, class Key, class ValueType, class KeyFromValue, class Hasher1, class Hasher2, class Equals>
bool operator!=(const RobinHood<LoadFactorMax100_1, Key, ValueType, KeyFromValue, Hasher1, Equals>& lhs,
const RobinHood<LoadFactorMax100_2, Key, ValueType, KeyFromValue, Hasher2, Equals>& rhs)
{
return !(lhs == rhs);
}
} // namespace detail
} // namespace container
} // namespace carb
| 47,315 | C | 37.065969 | 155 | 0.589707 |
omniverse-code/kit/include/carb/container/LocklessQueue.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Defines the LocklessQueue class
#pragma once
#include "../Defines.h"
#include "../cpp/Atomic.h"
#include "../thread/Util.h"
#include <thread>
namespace carb
{
//! Carbonite container classes
namespace container
{
template <class T>
class LocklessQueueLink;
template <class T, LocklessQueueLink<T> T::*U>
class LocklessQueue;
/**
* Defines the link object. Each class contained by LocklessQueue must have a member of type LocklessQueueLink.
*/
template <class T>
class LocklessQueueLink
{
public:
/**
* Default constructor.
*/
constexpr LocklessQueueLink() = default;
CARB_PREVENT_COPY_AND_MOVE(LocklessQueueLink);
private:
CARB_VIZ std::atomic<T*> m_next;
friend T;
template <class U, LocklessQueueLink<U> U::*V>
friend class LocklessQueue;
};
/**
* @brief Implements a lockless queue: a FIFO queue that is thread-safe yet requires no kernel synchronization.
*
* LocklessQueue is designed to be easy-to-use. For a class `Foo` that you want to be contained in a LocklessQueue, it
* must have a member of type LocklessQueueLink<Foo>. This member is what the LocklessQueue will use for tracking data.
*
* Pushing to LocklessQueue is simply done through LocklessQueue::push(), which is entirely thread-safe.
* LocklessQueue ensures first-in-first-out (FIFO) for each producer pushing to LocklessQueue. Multiple producers
* may be pushing into LocklessQueue simultaneously, so their items can become mingled, but each producer's pushed
* items will be strongly ordered.
*
* Popping on the other hand is different for single-consumer vs. multiple-consumer. For
* single-consumer (via the LocklessQueue::popSC() function) only one thread may be popping from LocklessQueue at any
* given time. It is up to the caller to ensure this mutual exclusivity.
*
* If multiple-consumer is desired, use the LocklessQueue::popMC() function; it ensures additional
* thread safety and is therefore higher cost. Furthermore LocklessQueue::popMC() has a contention back-off
* capability that will attempt to solve high-contention situations with progressive spin and sleep if absolutely
* necessary.
*
* Simple example:
* ```cpp
* class Foo
* {
* public:
* LocklessQueueLink<Foo> m_link;
* };
*
* LocklessQueue<Foo, &Foo::m_link> queue;
* queue.push(new Foo);
* Foo* p = queue.popSC();
* delete p;
* ```
*
* @thread_safety LocklessQueue is entirely thread-safe except where declared otherwise. No allocation happens with a
* LocklessQueue; instead the caller is responsible for construction/destruction of contained objects.
*
* @tparam T The type to contain.
* @tparam U A pointer-to-member of a LocklessQueueLink member within T (see above example).
*/
template <class T, LocklessQueueLink<T> T::*U>
class CARB_VIZ LocklessQueue
{
public:
/**
* Constructs a new LocklessQueue.
*/
constexpr LocklessQueue() : m_head(nullptr), m_tail(nullptr)
{
}
CARB_PREVENT_COPY(LocklessQueue);
/**
* LocklessQueue is partially movable in that it can be move-constructed from another LocklessQueue, but cannot be
* move-assigned. This is to guarantee that the state of the receiving LocklessQueue is a fresh state.
*/
LocklessQueue(LocklessQueue&& rhs) : m_head(nullptr), m_tail(nullptr)
{
this->steal(rhs);
}
/**
* Cannot move-assign, only move-construct. This is to guarantee the state of the receiving LocklessQueue is a fresh
* state.
*/
LocklessQueue& operator=(LocklessQueue&&) = delete;
/**
* Destructor.
*
* @warning Asserts that isEmpty() returns `true`.
*/
~LocklessQueue()
{
// Not good to destroy when not empty
CARB_ASSERT(isEmpty());
}
/**
* Indicates whether the queue is empty.
*
* @warning Another thread may have modified the LocklessQueue before this function returns.
*
* @returns `true` if the queue appears empty; `false` if items appear to exist in the queue.
*/
bool isEmpty() const
{
// Reading the tail is more efficient because much contention can happen on m_head
return !m_tail.load(std::memory_order_relaxed);
}
/**
* Pushes an entry onto the LocklessQueue.
*
* @param p The item to push into the queue.
*
* @returns `true` if the queue was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
bool push(T* p)
{
// Make sure the node isn't already pointing at something
next(p).store(nullptr, std::memory_order_relaxed);
return _push(p, p);
}
/**
* Pushes a contiguous block of entries from [ @p begin, @p end) onto the queue.
*
* @note All of the entries are guaranteed to remain strongly ordered and will not be interspersed with entries from
* other threads.
*
* @param begin An <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">InputIterator</a> of the
* first item to push. `*begin` must resolve to a `T&`.
* @param end An off-the-end InputIterator after the last item to push.
* @returns true if the queue was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
#ifndef DOXYGEN_BUILD
template <class InputItRef,
std::enable_if_t<std::is_convertible<decltype(std::declval<InputItRef&>()++, *std::declval<InputItRef&>()), T&>::value,
bool> = false>
#else
template <class InputItRef>
#endif
bool push(InputItRef begin, InputItRef end)
{
// Handle empty list
if (begin == end)
return false;
// Walk through iterators and have them point to each other
InputItRef last = begin;
InputItRef iter = begin;
iter++;
for (; iter != end; last = iter++)
{
next(std::addressof(*last)).store(std::addressof(*iter), std::memory_order_relaxed);
}
next(std::addressof(*last)).store(nullptr, std::memory_order_relaxed);
return _push(std::addressof(*begin), std::addressof(*last));
}
/**
* Pushes a block of pointers-to-entries from [ @p begin, @p end) onto the queue.
*
* @note All of the entries are guaranteed to remain strongly ordered and will not be interspersed with entries from
* other threads.
*
* @param begin An <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">InputIterator</a> of the
* first item to push. `*begin` must resolve to a `T*`.
* @param end An off-the-end InputIterator after the last item to push.
* @returns true if the queue was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
#ifndef DOXYGEN_BUILD
template <class InputItPtr,
std::enable_if_t<std::is_convertible<decltype(std::declval<InputItPtr&>()++, *std::declval<InputItPtr&>()), T*>::value,
bool> = true>
#else
template <class InputItPtr>
#endif
bool push(InputItPtr begin, InputItPtr end)
{
// Handle empty list
if (begin == end)
return false;
// Walk through iterators and have them point to each other
InputItPtr last = begin;
InputItPtr iter = begin;
iter++;
for (; iter != end; last = iter++)
{
next(*last).store(*iter, std::memory_order_relaxed);
}
next(*last).store(nullptr, std::memory_order_relaxed);
return _push(*begin, *last);
}
/**
* Ejects all entries from this queue as a new LocklessQueue.
*
* @note To clear all items use popAll().
*/
CARB_NODISCARD LocklessQueue eject()
{
return LocklessQueue(std::move(*this));
}
/**
* Atomically steals all entries from another LocklessQueue and adds them to *this.
*
* Effectively pops everything from \p rhs and then pushes everything to \c *this. This can be done in two steps
* though since everything is already linked together: first the head/tail of \p rhs are exchanged with \c nullptr
* in a multi-consumer manner, then since everything is already linked together they can be pushed as one group onto
* the end of \c *this. Therefore, this is much quicker than a loop that pops from one queue and pushes to another.
* @param rhs A LocklessQueue to atomically steal all entries from.
*/
void steal(LocklessQueue& rhs)
{
static T* const mediator = reinterpret_cast<T*>(size_t(-1));
// Need to pop everything from rhs, so this is similar to popAll()
T* head;
for (;;)
{
// The mediator acts as both a lock and a signal
head = rhs.m_head.exchange(mediator, std::memory_order_relaxed);
if (CARB_UNLIKELY(!head))
{
// The first xchg on the tail will tell the enqueuing thread that it is safe to blindly write out to the
// head pointer. A cmpxchg honors the algorithm.
T* m = mediator;
if (CARB_UNLIKELY(!rhs.m_head.compare_exchange_strong(
m, nullptr, std::memory_order_relaxed, std::memory_order_relaxed)))
{
// Couldn't write a nullptr back. Try again.
continue;
}
if (CARB_UNLIKELY(!!rhs.m_tail.load(std::memory_order_relaxed)))
{
bool isNull;
// Wait for consistency
this_thread::spinWaitWithBackoff([&] { return rhs.consistent(isNull); });
if (!isNull)
{
// Try again.
continue;
}
}
// Nothing on the queue.
return;
}
if (CARB_UNLIKELY(head == mediator))
{
// Another thread is in a pop function. Wait until m_head is no longer the mediator.
this_thread::spinWaitWithBackoff([&] { return rhs.mediated(); });
// Try again.
continue;
}
break;
}
// Release our lock and swap with the tail
rhs.m_head.store(nullptr, std::memory_order_release);
T* end = rhs.m_tail.exchange(nullptr, std::memory_order_release);
// Push onto *this
_push(head, end);
}
/**
* Empties the queue.
*
* @note To perform an action on each item as it is popped, use forEach() instead.
*/
void popAll()
{
static T* const mediator = reinterpret_cast<T*>(size_t(-1));
T* head;
for (;;)
{
// The mediator acts as both a lock and a signal
head = m_head.exchange(mediator, std::memory_order_relaxed);
if (CARB_UNLIKELY(!head))
{
// The first xchg on the tail will tell the enqueuing thread that it is safe to blindly write out to the
// head pointer. A cmpxchg honors the algorithm.
T* m = mediator;
if (CARB_UNLIKELY(!m_head.compare_exchange_strong(
m, nullptr, std::memory_order_relaxed, std::memory_order_relaxed)))
{
// Couldn't write a nullptr back. Try again.
continue;
}
if (CARB_UNLIKELY(!!m_tail.load(std::memory_order_relaxed)))
{
bool isNull;
// Wait for consistency
this_thread::spinWaitWithBackoff([&] { return this->consistent(isNull); });
if (!isNull)
{
// Try again.
continue;
}
}
// Nothing on the queue.
return;
}
if (CARB_UNLIKELY(head == mediator))
{
// Another thread is in a pop function. Wait until m_head is no longer the mediator.
this_thread::spinWaitWithBackoff([&] { return this->mediated(); });
// Try again.
continue;
}
break;
}
// Release our lock and swap with the tail
m_head.store(nullptr, std::memory_order_release);
m_tail.exchange(nullptr, std::memory_order_release);
}
/**
* Pops all available items from the queue calling a functionish object on each.
*
* First, pops all available items from `*this` and then calls @p f on each.
*
* @note As the pop is the first thing that happens, any new entries that get pushed while the function is executing
* will NOT be popped and will remain in LocklessQueue when this function returns.
*
* @param f A functionish object that accepts a `T*` parameter. Called for each item that was popped from the queue.
*/
template <class Func>
void forEach(Func&& f)
{
static T* const mediator = reinterpret_cast<T*>(size_t(-1));
T* head;
for (;;)
{
// The mediator acts as both a lock and a signal
head = m_head.exchange(mediator, std::memory_order_relaxed);
if (CARB_UNLIKELY(!head))
{
// The first xchg on the tail will tell the enqueuing thread that it is safe to blindly write out to the
// head pointer. A cmpxchg honors the algorithm.
T* m = mediator;
if (CARB_UNLIKELY(!m_head.compare_exchange_strong(
m, nullptr, std::memory_order_relaxed, std::memory_order_relaxed)))
{
// Couldn't write a nullptr back. Try again.
continue;
}
if (CARB_UNLIKELY(!!m_tail.load(std::memory_order_relaxed)))
{
bool isNull;
// Wait for consistency
this_thread::spinWaitWithBackoff([&] { return this->consistent(isNull); });
if (!isNull)
{
// Try again.
continue;
}
}
// Nothing on the queue.
return;
}
if (CARB_UNLIKELY(head == mediator))
{
// Another thread is in a pop function. Wait until m_head is no longer the mediator.
this_thread::spinWaitWithBackoff([&] { return this->mediated(); });
// Try again.
continue;
}
break;
}
// Release our lock and swap with the tail
m_head.store(nullptr, std::memory_order_release);
T* e = m_tail.exchange(nullptr, std::memory_order_release);
for (T *p = head, *n; p; p = n)
{
// Ensure that we have a next item (except for `e`; the end of the queue). It's possible
// that a thread is in `push()` and has written the tail at the time of exchange, above,
// but has not yet written the previous item's next pointer.
n = next(p).load(std::memory_order_relaxed);
if (CARB_UNLIKELY(!n && p != e))
n = waitForEnqueue(next(p));
f(p);
}
}
/**
* Pop first entry (Single-consumer).
*
* @thread_safety May only be done in a single thread and is mutually exclusive with all other functions that modify
* LocklessQueue *except* push(). Use popMC() for a thread-safe pop function.
*
* @warning Debug builds will assert if a thread safety issue is detected.
*
* @returns the first item removed from the queue, or `nullptr` if the queue is empty.
*/
T* popSC()
{
#if CARB_ASSERT_ENABLED
// For debug builds, swap with a mediator to ensure that another thread is not in this function
static T* const mediator = reinterpret_cast<T*>(size_t(-1));
T* h = m_head.exchange(mediator, std::memory_order_acquire);
CARB_ASSERT(
h != mediator, "LocklessQueue: Another thread is racing with popSC(). Use popMC() for multi-consumer.");
while (CARB_UNLIKELY(!h))
{
h = m_head.exchange(nullptr, std::memory_order_release);
if (h == mediator)
{
// We successfully swapped a nullptr for the mediator we put there.
return nullptr;
}
// Another thread in push() could've put something else here, so check it again.
}
#else
// If head is null the queue is empty
T* h = m_head.load(std::memory_order_acquire);
if (CARB_UNLIKELY(!h))
{
return nullptr;
}
#endif
// Load the next item and store into the head
T* n = next(h).load(std::memory_order_acquire);
m_head.store(n, std::memory_order_relaxed);
T* e = h;
if (CARB_UNLIKELY(!n && !m_tail.compare_exchange_strong(
e, nullptr, std::memory_order_release, std::memory_order_relaxed)))
{
// The next item was null, but we failed to write null to the tail, so another thread must have added
// something. Read the next value from `h` and store it in the _head.
n = next(h).load(std::memory_order_acquire);
if (CARB_UNLIKELY(!n))
n = waitForEnqueue(next(h));
m_head.store(n, std::memory_order_relaxed);
}
// This isn't really necessary but prevents dangling pointers.
next(h).store(nullptr, std::memory_order_relaxed);
return h;
}
/**
* Pop first entry (Multiple-consumer).
*
* @ref popSC() is the single-consumer variant of this function and performs better in a single-consumer
* environment.
* @note In a highly-contentious situation, this function will back off and attempt to sleep in order to resolve the
* contention.
*
* @returns the first item removed from the queue, or `nullptr` if the queue is empty.
*/
T* popMC()
{
static T* const mediator = reinterpret_cast<T*>(size_t(-1));
T* head;
for (;;)
{
// The mediator acts as both a lock and a signal
head = m_head.exchange(mediator, std::memory_order_relaxed);
if (CARB_UNLIKELY(!head))
{
// The first xchg on the tail will tell the enqueuing thread that it is safe to blindly write out to the
// head pointer. A cmpxchg honors the algorithm.
T* m = mediator;
if (CARB_UNLIKELY(!m_head.compare_exchange_strong(
m, nullptr, std::memory_order_relaxed, std::memory_order_relaxed)))
{
// Couldn't write a nullptr back. Try again.
continue;
}
if (CARB_UNLIKELY(!!m_tail.load(std::memory_order_relaxed)))
{
bool isNull;
// Wait for consistency
this_thread::spinWaitWithBackoff([&] { return this->consistent(isNull); });
if (!isNull)
{
// Try again.
continue;
}
}
// Nothing on the queue.
return nullptr;
}
if (CARB_UNLIKELY(head == mediator))
{
// Another thread is in a pop function. Wait until m_head is no longer the mediator.
this_thread::spinWaitWithBackoff([&] { return this->mediated(); });
// Try again.
continue;
}
break;
}
// Restore the head pointer to a sane value before returning.
// If 'next' is nullptr, then this item _might_ be the last item.
T* n = next(head).load(std::memory_order_relaxed);
if (CARB_UNLIKELY(!n))
{
m_head.store(nullptr, std::memory_order_relaxed);
// Try to clear the tail to ensure the queue is now empty.
T* h = head;
if (m_tail.compare_exchange_strong(h, nullptr, std::memory_order_release, std::memory_order_relaxed))
{
// Both head and tail are nullptr now.
// Clear head's next pointer so that it's not dangling
next(head).store(nullptr, std::memory_order_relaxed);
return head;
}
// There must be a next item now.
n = next(head).load(std::memory_order_acquire);
if (CARB_UNLIKELY(!n))
n = waitForEnqueue(next(head));
}
m_head.store(n, std::memory_order_relaxed);
// Clear head's next pointer so that it's not dangling
next(head).store(nullptr, std::memory_order_relaxed);
return head;
}
//! @copydoc popMC()
T* pop()
{
return popMC();
}
/**
* Pushes an item onto the queue and notifies a waiting listener.
*
* Equivalent to doing `auto b = push(p); notifyOne(); return b;`.
*
* @see push(), notifyOne()
*
* @param p The item to push.
* @returns `true` if LocklessQueue was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
bool pushNotify(T* p)
{
bool b = push(p);
notifyOne();
return b;
}
/**
* Blocks the calling thread until an item is available and returns it (Single-consumer).
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @thread_safety May only be done in a single thread and is mutually exclusive with all other functions that modify
* LocklessQueue *except* push(). Use popMC() for a thread-safe pop function.
*
* @warning Debug builds will assert if a thread safety issue is detected.
*
* @see popSC(), wait()
*
* @returns The first item popped from the queue.
*/
T* popSCWait()
{
T* p = popSC();
while (!p)
{
wait();
p = popSC();
}
return p;
}
/**
* Blocks the calling thread until an item is available and returns it (Single-consumer) or a timeout elapses.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @thread_safety May only be done in a single thread and is mutually exclusive with all other functions that modify
* LocklessQueue *except* push(). Use popMC() for a thread-safe pop function.
*
* @warning Debug builds will assert if a thread safety issue is detected.
*
* @see popSC(), waitFor()
*
* @param dur The duration to wait for an item to become available.
* @returns The first item popped from the queue or `nullptr` if the timeout period elapses.
*/
template <class Rep, class Period>
T* popSCWaitFor(const std::chrono::duration<Rep, Period>& dur)
{
return popSCWaitUntil(std::chrono::steady_clock::now() + dur);
}
/**
* Blocks the calling thread until an item is available and returns it (Single-consumer) or the clock reaches a time
* point.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @thread_safety May only be done in a single thread and is mutually exclusive with all other functions that modify
* LocklessQueue *except* push(). Use popMC() for a thread-safe pop function.
*
* @warning Debug builds will assert if a thread safety issue is detected.
*
* @see popSC(), waitUntil()
*
* @param tp The time to wait until for an item to become available.
* @returns The first item popped from the queue or `nullptr` if the timeout period elapses.
*/
template <class Clock, class Duration>
T* popSCWaitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
T* p = popSC();
while (!p)
{
if (!waitUntil(tp))
{
return popSC();
}
p = popSC();
}
return p;
}
/**
* Blocks the calling thread until an item is available and returns it (Multiple-consumer).
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @note In a highly-contentious situation, this function will back off and attempt to sleep in order to resolve the
* contention.
*
* @see popMC(), wait()
*
* @returns the first item removed from the queue.
*/
T* popMCWait()
{
T* p = popMC();
while (!p)
{
wait();
p = popMC();
}
return p;
}
/**
* Blocks the calling thread until an item is available and returns it (Multiple-consumer) or a timeout elapses.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @note In a highly-contentious situation, this function will back off and attempt to sleep in order to resolve the
* contention.
*
* @see popMC(), waitFor()
*
* @param dur The duration to wait for an item to become available.
* @returns the first item removed from the queue or `nullptr` if the timeout period elapses.
*/
template <class Rep, class Period>
T* popMCWaitFor(const std::chrono::duration<Rep, Period>& dur)
{
return popMCWaitUntil(std::chrono::steady_clock::now() + dur);
}
/**
* Blocks the calling thread until an item is available and returns it (Multiple-consumer) or the clock reaches a
* time point.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @note In a highly-contentious situation, this function will back off and attempt to sleep in order to resolve the
* contention.
*
* @see popMC(), waitUntil()
*
* @param tp The time to wait until for an item to become available.
* @returns the first item removed from the queue or `nullptr` if the timeout period elapses.
*/
template <class Clock, class Duration>
T* popMCWaitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
T* p = popMC();
while (!p)
{
if (!waitUntil(tp))
{
return popMC();
}
p = popMC();
}
return p;
}
/**
* Waits until the queue is non-empty.
*
* @note Requires notification that the queue is non-empty, such as from pushNotify(), notifyOne() or notifyAll().
*
* @note Though wait() returns, another thread may have popped the available item making the queue empty again. Use
* popSCWait() / popMCWait() if it is desired to ensure that the current thread can obtain an item.
*/
void wait()
{
m_tail.wait(nullptr, std::memory_order_relaxed);
}
/**
* Waits until LocklessQueue is non-empty or a specified duration has passed.
*
* @note Though waitFor() returns `true`, another thread may have popped the available item making the queue empty
* again. Use popSCWaitFor() / popMCWaitFor() if it is desired to ensure that the current thread can obtain an item.
*
* @note Requires notification that the queue is non-empty, such as from pushNotify(), notifyOne() or notifyAll().
*
* @param dur The duration to wait for an item to become available.
* @returns `true` if an item appears to be available; `false` if the timeout elapses.
*/
template <class Rep, class Period>
bool waitFor(const std::chrono::duration<Rep, Period>& dur)
{
return m_tail.wait_for(nullptr, dur, std::memory_order_relaxed);
}
/**
* Waits until LocklessQueue is non-empty or a specific time is reached.
*
* @note Though waitUntil() returns `true`, another thread may have popped the available item making the queue empty
* again. Use popSCWaitUntil() / popMCWaitUntil() if it is desired to ensure that the current thread can obtain an
* item.
*
* @note Requires notification that the queue is non-empty, such as from pushNotify(), notifyOne() or notifyAll().
*
* @param tp The time to wait until for an item to become available.
* @returns `true` if an item appears to be available; `false` if the time is reached.
*/
template <class Clock, class Duration>
bool waitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
return m_tail.wait_until(nullptr, tp, std::memory_order_relaxed);
}
/**
* Notifies a single waiting thread.
*
* Notifies a single thread waiting in wait(), waitFor(), waitUntil(), popSCWait(), popMCWait(), popSCWaitFor(),
* popMCWaitFor(), popSCWaitUntil(), or popMCWaitUntil() to wake and check the queue.
*/
void notifyOne()
{
m_tail.notify_one();
}
/**
* Notifies all waiting threads.
*
* Notifies all threads waiting in wait(), waitFor(), waitUntil(), popSCWait(), popMCWait(), popSCWaitFor(),
* popMCWaitFor(), popSCWaitUntil(), or popMCWaitUntil() to wake and check the queue.
*/
void notifyAll()
{
m_tail.notify_all();
}
private:
CARB_VIZ cpp::atomic<T*> m_head;
CARB_VIZ cpp::atomic<T*> m_tail;
constexpr static unsigned kWaitSpins = 1024;
bool _push(T* first, T* last)
{
// Swap the tail with our new last item
T* token = m_tail.exchange(last, std::memory_order_release);
CARB_ASSERT(token != last);
if (CARB_LIKELY(token))
{
// The previous tail item now points to our new first item.
next(token).store(first, std::memory_order_relaxed);
return false;
}
else
{
// Queue was empty; head points to our first item
m_head.store(first, std::memory_order_relaxed);
return true;
}
}
// This function name breaks naming paradigms so that it shows up prominently in stack traces.
CARB_NOINLINE T* __WAIT_FOR_ENQUEUE__(std::atomic<T*>& ptr)
{
T* val;
int spins = 0;
while ((val = ptr.load(std::memory_order_relaxed)) == nullptr)
{
spins++;
CARB_UNUSED(spins);
std::this_thread::yield();
}
return val;
}
T* waitForEnqueue(std::atomic<T*>& ptr)
{
unsigned spins = kWaitSpins;
T* val;
while (CARB_UNLIKELY(spins-- > 0))
{
if (CARB_LIKELY((val = ptr.load(std::memory_order_relaxed)) != nullptr))
return val;
CARB_HARDWARE_PAUSE();
}
return __WAIT_FOR_ENQUEUE__(ptr);
}
// Predicate: returns `false` until m_head and m_tail are both null or non-null
bool consistent(bool& isNull) const
{
T* h = m_head.load(std::memory_order_relaxed);
T* t = m_tail.load(std::memory_order_relaxed);
isNull = !t;
return !h == !t;
}
// Predicate: returns Ready when _head is no longer the mediator
bool mediated() const
{
static T* const mediator = reinterpret_cast<T*>(size_t(-1));
return m_head.load(std::memory_order_relaxed) != mediator;
}
static std::atomic<T*>& next(T* p)
{
return (p->*U).m_next;
}
};
} // namespace container
} // namespace carb
| 32,489 | C | 34.940265 | 133 | 0.582289 |
omniverse-code/kit/include/carb/container/RHUnorderedMap.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite Robin-hood Unordered Map container.
#pragma once
#include "RobinHoodImpl.h"
namespace carb
{
namespace container
{
/**
* Implements an Unordered Map, that is: a container that contains a mapping of keys to values where all keys must be
* unique. There is no defined order to the set of keys.
*
* \copydetails detail::RobinHood
*
* @warning This container is similar to, but not a drop-in replacement for `std::unordered_map` due to differences in
* iterator invalidation and memory layout.
*
* Iterator/reference/pointer invalidation (note differences from `std::unordered_map`):
* Operation | Invalidates
* --------- | -----------
* All read operations: Never
* `clear`, `rehash`, `reserve`, `operator=`, `insert`, `emplace`, `try_emplace`, `operator[]` | Always
* `erase` | Only the element removed
* `swap` | All iterators, no pointers/references
*
* @tparam Key The key type
* @tparam Value The mapped type to be associated with `Key`
* @tparam Hasher A functor to use as a hashing function for \c Key
* @tparam Equals A functor to use to compare two \c Key values for equality
* @tparam LoadFactorMax100 The load factor to use for the table. This value must be in the range `[10, 100]` and
* represents the percentage of entries in the hash table that will be filled before resizing. Open-addressing hash maps
* with 100% usage have better memory usage but worse performance since they need "gaps" in the hash table to terminate
* runs.
*/
template <class Key, class Value, class Hasher = std::hash<Key>, class Equals = std::equal_to<Key>, size_t LoadFactorMax100 = 80>
class RHUnorderedMap
: public detail::
RobinHood<LoadFactorMax100, Key, std::pair<const Key, Value>, detail::Select1st<Key, std::pair<const Key, Value>>, Hasher, Equals>
{
using Base = detail::
RobinHood<LoadFactorMax100, Key, std::pair<const Key, Value>, detail::Select1st<Key, std::pair<const Key, Value>>, Hasher, Equals>;
public:
//! The key type
using key_type = typename Base::key_type;
//! The mapped value type
using mapped_type = Value;
//! The value type (effectively `std::pair<const key_type, mapped_type>`)
using value_type = typename Base::value_type;
//! Unsigned integer type (typically \c size_t)
using size_type = typename Base::size_type;
//! Signed integer type (typically \c ptrdiff_t)
using difference_type = typename Base::difference_type;
//! The hash function
using hasher = typename Base::hasher;
//! The key-equals function
using key_equal = typename Base::key_equal;
//! \c value_type&
using reference = typename Base::reference;
//! `const value_type&`
using const_reference = typename Base::const_reference;
//! \c value_type*
using pointer = typename Base::pointer;
//! `const value_type*`
using const_pointer = typename Base::const_pointer;
//! A \a LegacyForwardIterator to \c value_type
using iterator = typename Base::iterator;
//! A \a LegacyForwardIterator to `const value_type`
using const_iterator = typename Base::const_iterator;
//! A \a LegacyForwardIterator to \c value_type that proceeds to the next matching key when incremented.
using find_iterator = typename Base::find_iterator;
//! A \a LegacyForwardIterator to `const value_type` that proceeds to the next matching key when incremented.
using const_find_iterator = typename Base::const_find_iterator;
/**
* Constructs empty container.
*/
constexpr RHUnorderedMap() noexcept = default;
/**
* Copy constructor. Copies elements from another container.
*
* @note \c *this may have a different \ref carb::container::detail::RobinHood::capacity()
* than \p other.
* @param other The other container to copy entries from.
*/
RHUnorderedMap(const RHUnorderedMap& other) : Base(other)
{
}
/**
* Move constructor. Moves elements from another container.
*
* @note No move constructors on contained elements are invoked. \p other will be
* \ref carb::container::detail::RobinHood::empty() after this operation.
* @param other The other container to move entries from.
*/
RHUnorderedMap(RHUnorderedMap&& other) : Base(std::move(other))
{
}
/**
* Destructor. Destroys all contained elements and frees memory.
*/
~RHUnorderedMap() = default;
/**
* Copy-assign operator. Destroys all currently stored elements and copies elements from another container.
*
* @param other The other container to copy entries from.
* @returns \c *this
*/
RHUnorderedMap& operator=(const RHUnorderedMap& other)
{
Base::operator=(other);
return *this;
}
/**
* Move-assign operator. Effectively swaps with another container.
*
* @param other The other container to copy entries from.
* @returns \c *this
*/
RHUnorderedMap& operator=(RHUnorderedMap&& other)
{
Base::operator=(std::move(other));
return *this;
}
/**
* Inserts an element into the container.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param value The value to insert by copying.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
std::pair<iterator, bool> insert(const value_type& value)
{
return this->insert_unique(value);
}
/**
* Inserts an element into the container.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param value The value to insert by moving.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
std::pair<iterator, bool> insert(value_type&& value)
{
return this->insert_unique(std::move(value));
}
/**
* Inserts an element into the container. Only participates in overload resolution if
* `std::is_constructible_v<value_type, P&&>` is true.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param value The value to insert by constructing via `std::forward<P>(value)`.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
template <class P>
std::pair<iterator, bool> insert(std::enable_if_t<std::is_constructible<value_type, P&&>::value, P&&> value)
{
return insert(value_type{ std::forward<P>(value) });
}
/**
* Constructs an element in-place.
*
* If insertion is successful, all iterators, references and pointers are invalidated.
*
* @param args The arguments to pass to the \c value_type constructor.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
template <class... Args>
std::pair<iterator, bool> emplace(Args&&... args)
{
// We need the key, so just construct the item here
return insert(value_type{ std::forward<Args>(args)... });
}
/**
* Inserts in-place if the key does not exist; does nothing if the key already exists.
*
* Inserts a new element into the container with key \p key and value constructed with \p args if there is no
* element with the key in the container. If the key does not exist and the insert succeeds, constructs `value_type`
* as `value_type{std::piecewise_construct, std::forward_as_tuple(key),
* std::forward_as_tuple(std::forward<Args>(args)...}`.
*
* @param key The key used to look up existing and insert if not found.
* @param args The args used to construct \ref mapped_type.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
template <class... Args>
std::pair<iterator, bool> try_emplace(const key_type& key, Args&&... args)
{
auto result = this->internal_insert(key);
if (result.second)
new (result.first) value_type(std::piecewise_construct, std::forward_as_tuple(key),
std::forward_as_tuple(std::forward<Args>(args)...));
return std::make_pair(this->make_iter(result.first), result.second);
}
/**
* Inserts in-place if the key does not exist; does nothing if the key already exists.
*
* Inserts a new element into the container with key \p key and value constructed with \p args if there is no
* element with the key in the container. If the key does not exist and the insert succeeds, constructs `value_type`
* as `value_type{std::piecewise_construct, std::forward_as_tuple(std::move(key)),
* std::forward_as_tuple(std::forward<Args>(args)...}`.
*
* @param key The key used to look up existing and insert if not found.
* @param args The args used to construct \ref mapped_type.
* @returns A \c pair consisting of an iterator to the inserted element (or the existing element that prevented the
* insertion) and a \c bool that will be \c true if insertion took place or \c false if insertion did \a not take
* place.
*/
template <class... Args>
std::pair<iterator, bool> try_emplace(key_type&& key, Args&&... args)
{
auto result = this->internal_insert(key);
if (result.second)
new (result.first) value_type(std::piecewise_construct, std::forward_as_tuple(std::move(key)),
std::forward_as_tuple(std::forward<Args>(args)...));
return std::make_pair(this->make_iter(result.first), result.second);
}
/**
* Removes elements with the given key.
*
* References, pointers and iterators to the erase element are invalidated. All other iterators, pointers and
* references remain valid.
*
* @param key the key value of elements to remove
* @returns the number of elements removed (either 1 or 0).
*/
size_type erase(const key_type& key)
{
auto vt = this->internal_find(key);
if (vt)
{
this->internal_erase(vt);
return 1;
}
return 0;
}
#if CARB_EXCEPTIONS_ENABLED || defined(DOXYGEN_BUILD)
/**
* Access specified element with bounds checking.
*
* This function is only available if exceptions are enabled.
*
* @param key The key of the element to find.
* @returns a reference to the mapped value of the element with key equivalent to \p key.
* @throws std::out_of_range if no such element exists.
*/
mapped_type& at(const key_type& key)
{
auto vt = this->internal_find(key);
if (vt)
return vt->second;
throw std::out_of_range("key not found");
}
/**
* Access specified element with bounds checking.
*
* This function is only available if exceptions are enabled.
*
* @param key The key of the element to find.
* @returns a reference to the mapped value of the element with key equivalent to \p key.
* @throws std::out_of_range if no such element exists.
*/
const mapped_type& at(const key_type& key) const
{
auto vt = this->internal_find(key);
if (vt)
return vt->second;
throw std::out_of_range("key not found");
}
#endif
/**
* Returns a reference to a value that is mapped to the given key, performing an insertion if such key does not
* already exist.
*
* If \p key does not exist, inserts a \c value_type constructed in-place from
* `std::piecewise_construct, std::forward_as_tuple(key), std::tuple<>()`.
*
* \ref key_type must be \a CopyConstructible and \ref mapped_type must be \a DefaultConstructible.
* @param key the key of the element to find or insert
* @returns a reference to the \ref mapped_type mapped to \p key.
*/
mapped_type& operator[](const key_type& key)
{
auto result = this->internal_insert(key);
if (result.second)
new (result.first) value_type(std::piecewise_construct, std::forward_as_tuple(key), std::tuple<>());
return result.first->second;
}
/**
* Returns a reference to a value that is mapped to the given key, performing an insertion if such key does not
* already exist.
*
* If \p key does not exist, inserts a \c value_type constructed in-place from
* `std::piecewise_construct, std::forward_as_tuple(std::move(key)), std::tuple<>()`.
*
* \ref key_type must be \a CopyConstructible and \ref mapped_type must be \a DefaultConstructible.
* @param key the key of the element to find or insert
* @returns a reference to the \ref mapped_type mapped to \p key.
*/
mapped_type& operator[](key_type&& key)
{
auto result = this->internal_insert(key);
if (result.second)
new (result.first) value_type(std::piecewise_construct, std::forward_as_tuple(key), std::tuple<>());
return result.first->second;
}
/**
* Returns the number of elements matching the specified key.
*
* @param key The key to check for.
* @returns The number of elements with the given key (either 1 or 0).
*/
size_t count(const key_type& key) const
{
return !!this->internal_find(key);
}
#ifndef DOXYGEN_BUILD
using Base::begin;
using Base::cbegin;
using Base::cend;
using Base::end;
using Base::capacity;
using Base::empty;
using Base::max_size;
using Base::size;
using Base::clear;
using Base::erase;
using Base::swap;
using Base::contains;
using Base::equal_range;
using Base::find;
using Base::rehash;
using Base::reserve;
#endif
};
} // namespace container
} // namespace carb
| 15,183 | C | 38.235142 | 140 | 0.652177 |
omniverse-code/kit/include/carb/container/BufferedObject.h | // Copyright (c) 2021-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//! @brief Defines the BufferedObject class
#pragma once
#include "../Defines.h"
#include "../cpp/Utility.h"
#include "../cpp/Atomic.h"
#include <array>
#include <cstdint>
#include <utility>
namespace carb
{
namespace container
{
/**
* Lock-Free Asynchronous Buffer
* Supports only 1 producer, 1 consumer
*
* BufferedObject is used when you have 1 producer and 1 consumer and both
* the producer and consumer are operating at different frequencies.
* The consumer only ever cares to see the latest data available.
*
* Examples:
*
* BufferedObject<int> b;
* assert(b.front() == 0);
* b.emplace_back(42);
* assert(b.front() == 0);
* b.pop_front();
* assert(b.front() == 42);
*
* BufferedObject<uint32_t> b{ in_place, 1U, 2U, 3U };
* assert(b.front() == 3U);
* b.pop_front(); // do nothing, as nothing was pushed
* assert(b.front() == 3U);
* b.push_back(42U);
* assert(b.front() == 3U);
* b.pop_front();
* assert(b.front() == 42U);
*/
template <typename T>
class BufferedObject final
{
CARB_PREVENT_COPY_AND_MOVE(BufferedObject);
enum Flags : uint8_t
{
eFlagsCreate = 0x06, // Field0=0, Field1=0, Field2=1, Field3=2
eFlagsDestroy = 0x00,
eDataAvailable = 0x40, // Field0=1
eField0Mask = 0xc0,
eField1Mask = 0x30,
eField2Mask = 0x0c,
eField3Mask = 0x03,
};
public:
/**
* Create an async buffer from an array of 3 items using default ctors
*/
BufferedObject() : m_flags(eFlagsCreate), m_buffer{}
{
}
/**
* Create an async buffer from an array of 3 items
*
* @param args arguments to forward to construct the elements of the buffer
*/
template <typename... TArgs>
constexpr explicit BufferedObject(carb::cpp::in_place_t, TArgs&&... args)
: m_flags(eFlagsCreate), m_buffer{ std::forward<TArgs>(args)... }
{
}
/**
* Destroy async buffer.
*/
~BufferedObject()
{
m_flags = eFlagsDestroy;
}
/**
* Insert a new item into the container constructed in-place with the given args
*
* @param args arguments to forward to construct newly produced value and move it onto the buffer
*/
template <typename... TArgs>
void emplace_back(TArgs&&... args)
{
uint8_t flagsNow;
uint8_t newFlags;
// place item in buffer in producer index/slot
m_buffer[(m_flags.load(std::memory_order_acquire) & eField1Mask) >> 4] = { std::forward<TArgs>(args)... };
//
// to produce a new value we need to:
// 1. set field 0 in flags to 1 (using mask eNewDataMask)
// 2. swap fields 1 and 2 ((flagsNow & eField2Mask) << 2) | ((flagsNow & eField1Mask) >> 2)
// 3. leave field 3 unchanged (flagsNow & eField3Mask)
//
do
{
flagsNow = m_flags.load(std::memory_order_acquire);
newFlags = eDataAvailable | ((flagsNow & eField2Mask) << 2) | ((flagsNow & eField1Mask) >> 2) |
(flagsNow & eField3Mask);
} while (
!m_flags.compare_exchange_strong(flagsNow, newFlags, std::memory_order_acq_rel, std::memory_order_relaxed));
}
/**
* Insert a new item into the container by moving item
*
* @param item item to insert/move
*/
void push_back(T&& item)
{
emplace_back(std::move(item));
}
/**
* Insert a new item into the container by copying item
*
* @param item item to copy
*/
void push_back(T const& item)
{
emplace_back(item);
}
/**
* Get reference to the latest item.
*
* @return reference to latest item
*/
T& front()
{
return m_buffer[m_flags.load(std::memory_order_acquire) & eField3Mask];
}
/**
* Attempt to replace the front element of the container with a newly produced value.
* If no new value was pushed/emplaced, this function does nothing.
*/
void pop_front()
{
uint8_t flagsNow;
uint8_t newFlags;
//
// to consume a new value:
// 1. check if new data available bit is set, if not just return previous data
// 2. remove the new data available bit
// 3. swap fields 2 and 3 ((flagsNow & eField3Mask) << 2) | ((flagsNow & eField2Mask) >> 2)
// 4. leave field 1 unchanged (flagsNow & eField1Mask)
//
do
{
flagsNow = m_flags.load(std::memory_order_acquire);
// check new data available bit set first
if ((flagsNow & eDataAvailable) == 0)
{
break;
}
newFlags = (flagsNow & eField1Mask) | ((flagsNow & eField3Mask) << 2) | ((flagsNow & eField2Mask) >> 2);
} while (
!m_flags.compare_exchange_strong(flagsNow, newFlags, std::memory_order_acq_rel, std::memory_order_relaxed));
}
private:
/*
* 8-bits of flags (2-bits per field)
*
* 0 1 2 3
* +--+--+--+--+
* |00|00|00|00|
* +--+--+--+--+
*
* Field 0: Is new data available? 0 == no, 1 == yes
* Field 1: Index into m_buffer that new values are pushed/emplaced into via push_back()/emplace_back()
* Field 2: Index into m_buffer that is the buffer between producer and consumer
* Field 3: Index into m_buffer that represents front()
*
* When the producer pushes a new value to m_buffer[field1], it will then atomically swap
* Field 1 and Field 2 and set Field 0 to 1 (to indicate new data is available)
*
* When the consumer calls front(), it just returns m_buffer[field3]. Since the producer
* never changes field3 value, the consumer is safe to call front() without any locks, even
* if the producer is pushing new values.
*
* When the consumer calls pop_front(), it will atomically swap
* Field 3 and Field 2 and set Field 0 back to 0 (to indicate middle buffer was drained)
*
* Producer
* * only ever sets Field 0 to 1
* * only ever writes to m_buffer[field1]
* * only ever swaps Field 1 and Field 2
*
* Consumer
* * only ever sets Field 0 to 0
* * only ever reads to m_buffer[field3]
* * only ever swaps Field 2 and Field 3
*/
std::atomic<uint8_t> m_flags;
std::array<T, 3> m_buffer;
};
} // namespace container
} // namespace carb
| 6,889 | C | 29.087336 | 120 | 0.599071 |
omniverse-code/kit/include/carb/container/LocklessStack.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Defines the LocklessStack class.
#pragma once
#include "../Defines.h"
#include "../cpp/Atomic.h"
#include "../thread/Mutex.h"
#include "../thread/Util.h"
#include <algorithm>
#include <atomic>
#include <chrono>
#include <thread>
#if CARB_POSIX
# include <dlfcn.h>
#endif
#if CARB_PLATFORM_WINDOWS || defined(DOXYGEN_BUILD)
//! On non-Windows platforms we fallback to a non-Lockless version that uses a mutex. This is because handling a pop()
//! requires potentially catching a SIGSEGV to restart the operation (similar to a cmpxchg failing). On Windows this is
//! easily done with SEH (Structured Exception Handling), but on Linux this requires a signal handler. If this file is
//! compiled into multiple dynamic objects then multiple signal handlers will be registered. Furthermore, the signal
//! handler of the currently active LocklessStack needs to be at the beginning of the handler chain. This is untenable
//! from a performance perspective. Therefore we use a mutex to ensure that all reads will be safe.
# define CARB_LOCKLESSSTACK_IS_LOCKLESS 1
#else
# define CARB_LOCKLESSSTACK_IS_LOCKLESS 0
#endif
namespace carb
{
namespace container
{
template <class T>
class LocklessStackLink;
template <class T, LocklessStackLink<T> T::*U>
class LocklessStack;
#ifndef DOXYGEN_BUILD
namespace detail
{
template <class T, LocklessStackLink<T> T::*U>
class LocklessStackHelpers;
template <class T, LocklessStackLink<T> T::*U>
class LocklessStackBase;
} // namespace detail
#endif
/**
* Defines the link object. Each class contained in LocklessStack must have a member of type LocklessStackLink<T>. A
* pointer to this member is required as the second parameter for LocklessStack.
*/
template <class T>
class LocklessStackLink
{
public:
/**
* Default constructor.
*/
constexpr LocklessStackLink() = default;
private:
CARB_VIZ LocklessStackLink<T>* m_next;
friend T;
template <class U, LocklessStackLink<U> U::*V>
friend class detail::LocklessStackHelpers;
template <class U, LocklessStackLink<U> U::*V>
friend class detail::LocklessStackBase;
template <class U, LocklessStackLink<U> U::*V>
friend class LocklessStack;
};
#if !defined(DOXYGEN_BUILD)
namespace detail
{
# if CARB_LOCKLESSSTACK_IS_LOCKLESS
class SignalHandler
{
public:
static bool readNext(void** out, void* in)
{
// We do this in a SEH block (on Windows) because it's possible (though rare) that another thread could have
// already popped and destroyed `cur` which would cause EXCEPTION_ACCESS_VIOLATION. By handling it in an
// exception handler, we recover cleanly and try again. On 64-bit Windows, there is zero cost unless an
// exception is thrown, at which point the kernel will find the Exception info and Unwind Info for the function
// that we're in.
__try
{
*out = *(void**)in;
return true;
}
__except (1)
{
return false;
}
}
};
# endif
template <class T, LocklessStackLink<T> T::*U>
class LocklessStackHelpers
{
public:
// Access the LocklessStackLink member of `p`
static LocklessStackLink<T>* link(T* p)
{
return std::addressof(p->*U);
}
// Converts a LocklessStackLink to the containing object
static T* convert(LocklessStackLink<T>* p)
{
// We need to calculate the offset of our link member and calculate where T is.
// Note that this doesn't work if T uses virtual inheritance
size_t offset = (size_t) reinterpret_cast<char*>(&(((T*)0)->*U));
return reinterpret_cast<T*>(reinterpret_cast<char*>(p) - offset);
}
};
// Base implementations
# if !CARB_LOCKLESSSTACK_IS_LOCKLESS
template <class T, LocklessStackLink<T> T::*U>
class LocklessStackBase : protected LocklessStackHelpers<T, U>
{
using Base = LocklessStackHelpers<T, U>;
public:
bool _isEmpty() const
{
return !m_head.load();
}
bool _push(T* first, T* last)
{
std::lock_guard<Lock> g(m_lock);
// Relaxed because under the lock
Base::link(last)->m_next = m_head.load(std::memory_order_relaxed);
bool const wasEmpty = !m_head.load(std::memory_order_relaxed);
m_head.store(Base::link(first), std::memory_order_relaxed);
return wasEmpty;
}
T* _popOne()
{
std::unique_lock<Lock> g(m_lock);
// Relaxed because under the lock
auto cur = m_head.load(std::memory_order_relaxed);
if (!cur)
{
return nullptr;
}
m_head.store(cur->m_next, std::memory_order_relaxed);
return Base::convert(cur);
}
T* _popAll()
{
std::lock_guard<Lock> g(m_lock);
// Relaxed because under the lock
LocklessStackLink<T>* head = m_head.exchange(nullptr, std::memory_order_relaxed);
return head ? Base::convert(head) : nullptr;
}
void _wait()
{
auto p = m_head.load();
while (!p)
{
m_head.wait(p);
p = m_head.load();
}
}
template <class Rep, class Period>
bool _waitFor(const std::chrono::duration<Rep, Period>& dur)
{
return _waitUntil(std::chrono::steady_clock::now() + dur);
}
template <class Clock, class Duration>
bool _waitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
auto p = m_head.load();
while (!p)
{
if (!m_head.wait_until(p, tp))
return false;
p = m_head.load();
}
return true;
}
void _notifyOne()
{
m_head.notify_one();
}
void _notifyAll()
{
m_head.notify_all();
}
private:
// Cannot be lockless if we don't have SEH
// Testing reveals that mutex is significantly faster than spinlock in highly-contended cases.
using Lock = carb::thread::mutex;
Lock m_lock;
cpp::atomic<LocklessStackLink<T>*> m_head{ nullptr };
};
# else
// Windows implementation: requires SEH and relies upon the fact that aligned pointers on modern OSes don't
// use at least 10 bits of the 64-bit space, so it uses those bits as a sequence number to ensure uniqueness between
// different threads competing to pop.
template <class T, LocklessStackLink<T> T::*U>
class LocklessStackBase : protected LocklessStackHelpers<T, U>
{
using Base = LocklessStackHelpers<T, U>;
public:
constexpr LocklessStackBase()
{
}
bool _isEmpty() const
{
return !decode(m_head.load(std::memory_order_acquire));
}
bool _push(T* first, T* last)
{
// All OS bits should either be zero or one, and it needs to be 8-byte-aligned.
LocklessStackLink<T>* lnk = Base::link(first);
CARB_ASSERT((size_t(lnk) & kCPUMask) == 0 || (size_t(lnk) & kCPUMask) == kCPUMask, "Unexpected OS bits set");
CARB_ASSERT((size_t(lnk) & ((1 << 3) - 1)) == 0, "Pointer not aligned properly");
uint16_t seq;
uint64_t expected = m_head.load(std::memory_order_acquire), temp;
decltype(lnk) next;
do
{
next = decode(expected, seq);
Base::link(last)->m_next = next;
temp = encode(lnk, seq + 1); // Increase sequence
} while (CARB_UNLIKELY(
!m_head.compare_exchange_strong(expected, temp, std::memory_order_release, std::memory_order_relaxed)));
return !next;
}
T* _popOne()
{
uint64_t expected = m_head.load(std::memory_order_acquire);
LocklessStackLink<T>* cur;
uint16_t seq;
bool isNull = false;
this_thread::spinWaitWithBackoff([&] {
cur = decode(expected, seq);
if (!cur)
{
// End attempts because the stack is empty
isNull = true;
return true;
}
// Attempt to read the next value
LocklessStackLink<T>* newhead;
if (!detail::SignalHandler::readNext((void**)&newhead, cur))
{
// Another thread changed `cur`, so reload and try again.
expected = m_head.load(std::memory_order_acquire);
return false;
}
// Only push needs to increase `seq`
uint64_t temp = encode(newhead, seq);
return m_head.compare_exchange_strong(expected, temp, std::memory_order_release, std::memory_order_relaxed);
});
return isNull ? nullptr : Base::convert(cur);
}
T* _popAll()
{
uint16_t seq;
uint64_t expected = m_head.load(std::memory_order_acquire), temp;
for (;;)
{
LocklessStackLink<T>* head = decode(expected, seq);
if (!head)
{
return nullptr;
}
// Keep the same sequence since only push() needs to increment the sequence
temp = encode(nullptr, seq);
if (CARB_LIKELY(
m_head.compare_exchange_weak(expected, temp, std::memory_order_release, std::memory_order_relaxed)))
{
return Base::convert(head);
}
}
}
void _wait()
{
uint64_t head = m_head.load(std::memory_order_acquire);
while (!decode(head))
{
m_head.wait(head, std::memory_order_relaxed);
head = m_head.load(std::memory_order_acquire);
}
}
template <class Rep, class Period>
bool _waitFor(const std::chrono::duration<Rep, Period>& dur)
{
return _waitUntil(std::chrono::steady_clock::now() + dur);
}
template <class Clock, class Duration>
bool _waitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
uint64_t head = m_head.load(std::memory_order_acquire);
while (!decode(head))
{
if (!m_head.wait_until(head, tp, std::memory_order_relaxed))
{
return false;
}
head = m_head.load(std::memory_order_acquire);
}
return true;
}
void _notifyOne()
{
m_head.notify_one();
}
void _notifyAll()
{
m_head.notify_all();
}
private:
// On 64-bit architectures, we make use of the fact that CPUs only use a certain number of address bits.
// Intel CPUs require that these 8 to 16 most-significant-bits match (all 1s or 0s). Since 8 appears to be the
// lowest common denominator, we steal 7 bits (to save the value of one of the bits so that they can match) for a
// sequence number. The sequence is important as it causes the resulting stored value to change even if the stack is
// pushing and popping the same value.
//
// Pointer compression drops the `m` and `z` bits from the pointer. `m` are expected to be consistent (all 1 or 0)
// and match the most-significant `P` bit. `z` are expected to be zeros:
//
// 63 ------------------------------ BITS ------------------------------ 0
// mmmmmmmP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPzzz
//
// `m_head` is encoded as the shifted compressed pointer bits `P` with sequence bits `s`:
// 63 ------------------------------ BITS ------------------------------ 0
// PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPPP PPPPPPss ssssssss
static_assert(sizeof(size_t) == 8, "64-bit only");
CARB_VIZ constexpr const static size_t kCpuBits = 7; // MSBs that are limited by CPU hardware and must match the
// 56th bit
constexpr const static size_t kCPUMask = ((size_t(1) << (kCpuBits + 1)) - 1) << (63 - kCpuBits);
CARB_VIZ constexpr const static size_t kSeqBits = kCpuBits + 3; // We also use the lowest 3 bits as part of the
// sequence
CARB_VIZ constexpr const static size_t kSeqMask = (size_t(1) << kSeqBits) - 1;
CARB_VIZ cpp::atomic_uint64_t m_head{ 0 };
static LocklessStackLink<T>* decode(size_t val)
{
// Clear the `s` sequence bits and shift as a signed value to sign-extend so that the `m` bits are filled in to
// match the most-significant `P` bit.
return reinterpret_cast<LocklessStackLink<T>*>(ptrdiff_t(val & ~kSeqMask) >> kCpuBits);
}
static LocklessStackLink<T>* decode(size_t val, uint16_t& seq)
{
seq = val & kSeqMask;
return decode(val);
}
static size_t encode(LocklessStackLink<T>* p, uint16_t seq)
{
// Shift the pointer value, dropping the most significant `m` bits and write the sequence number over the `z`
// and space created in the least-significant area.
return ((reinterpret_cast<size_t>(p) << kCpuBits) & ~kSeqMask) + (seq & uint16_t(kSeqMask));
}
};
# endif
} // namespace detail
#endif
/**
* @brief Implements a lockless stack: a LIFO container that is thread-safe yet requires no kernel involvement.
*
* LocklessStack is designed to be easy-to-use. For a class `Foo` that you want to be contained in a LocklessStack, it
* must have a member of type LocklessStackLink<Foo>. This member is what the LocklessStack will use for tracking data.
*
* Pushing to LocklessStack is simply done through LocklessStack::push(), which is entirely thread-safe. LocklessStack
* ensures last-in-first-out (LIFO) for each producer pushing to LocklessStack. Multiple producers may be pushing to
* LocklessStack simultaneously, so their items can become mingled, but each producer's pushed items will be strongly
* ordered.
*
* Popping is done through LocklessStack::pop(), which is also entirely thread-safe. Multiple threads may all attempt to
* pop from the same LocklessStack simultaneously.
*
* Simple example:
* ```cpp
* class Foo
* {
* public:
* LocklessStackLink<Foo> m_link;
* };
*
* LocklessStack<Foo, &Foo::m_link> stack;
* stack.push(new Foo);
* Foo* p = stack.pop();
* delete p;
* ```
*
* @thread_safety LocklessStack is entirely thread-safe except where declared otherwise. No allocation happens with a
* LocklessStack; instead the caller is responsible for construction/destruction of contained objects.
*
* \warning LocklessStack on non-Windows implementations is not Lockless (i.e. uses a mutex to synchronize). For an
* explanation as to why, see \ref CARB_LOCKLESSSTACK_IS_LOCKLESS.
*
* @tparam T The type to contain.
* @tparam U A pointer-to-member of a LocklessStackLink member within T (see above example).
*/
template <class T, LocklessStackLink<T> T::*U>
class LocklessStack final : protected detail::LocklessStackBase<T, U>
{
using Base = detail::LocklessStackBase<T, U>;
public:
/**
* Constructor.
*/
constexpr LocklessStack() = default;
/**
* Destructor.
*
* Asserts that isEmpty() returns true.
*/
~LocklessStack()
{
// Ensure the stack is empty
CARB_ASSERT(isEmpty());
}
/**
* Indicates whether the stack is empty.
*
* @warning Another thread may have modified the LocklessStack before this function returns.
*
* @returns `true` if the stack appears empty; `false` if items appear to exist in the stack.
*/
bool isEmpty() const
{
return Base::_isEmpty();
}
/**
* Pushes an item onto the stack.
*
* @param p The item to push onto the stack.
*
* @return `true` if the stack was previously empty prior to push; `false` otherwise. Note that this is atomically
* correct as opposed to checking isEmpty() before push().
*/
bool push(T* p)
{
return Base::_push(p, p);
}
/**
* Pushes a contiguous block of entries from [ @p begin, @p end) onto the stack.
*
* @note All of the entries are guaranteed to remain strongly ordered and will not be interspersed with entries from
* other threads. @p begin will be popped from the stack first.
*
* @param begin An <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">InputIterator</a> of the
* first item to push. `*begin` must resolve to a `T&`.
* @param end An off-the-end InputIterator after the last item to push.
* @returns `true` if the stack was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
#ifndef DOXYGEN_BUILD
template <class InputItRef,
std::enable_if_t<std::is_convertible<decltype(std::declval<InputItRef&>()++, *std::declval<InputItRef&>()), T&>::value,
bool> = false>
#else
template <class InputItRef>
#endif
bool push(InputItRef begin, InputItRef end)
{
if (begin == end)
{
return false;
}
// Walk the list and have them point to each other
InputItRef last = begin;
InputItRef iter = begin;
for (iter++; iter != end; last = iter++)
{
Base::link(std::addressof(*last))->m_next = Base::link(std::addressof(*iter));
}
return Base::_push(std::addressof(*begin), std::addressof(*last));
}
/**
* Pushes a block of pointers-to-entries from [ @p begin, @p end) onto the stack.
*
* @note All of the entries are guaranteed to remain strongly ordered and will not be interspersed with entries from
* other threads. @p begin will be popped from the stack first.
*
* @param begin An <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">InputIterator</a> of the
* first item to push. `*begin` must resolve to a `T*`.
* @param end An off-the-end InputIterator after the last item to push.
* @returns `true` if the stack was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
#ifndef DOXYGEN_BUILD
template <class InputItPtr,
std::enable_if_t<std::is_convertible<decltype(std::declval<InputItPtr&>()++, *std::declval<InputItPtr&>()), T*>::value,
bool> = true>
#else
template <class InputItPtr>
#endif
bool push(InputItPtr begin, InputItPtr end)
{
if (begin == end)
{
return false;
}
// Walk the list and have them point to each other
InputItPtr last = begin;
InputItPtr iter = begin;
for (iter++; iter != end; last = iter++)
{
Base::link(*last)->m_next = Base::link(*iter);
}
return Base::_push(*begin, *last);
}
/**
* Pops an item from the top of the stack if available.
*
* @return An item popped from the stack. If the stack was empty, then `nullptr` is returned.
*/
T* pop()
{
return Base::_popOne();
}
/**
* Empties the stack.
*
* @note To perform an action on each item as it is popped, use forEach() instead.
*/
void popAll()
{
Base::_popAll();
}
/**
* Pops all available items from the stack calling a functionish object on each.
*
* First, pops all available items from `*this` and then calls @p f on each.
*
* @note As the pop is the first thing that happens, any new entries that get pushed while the function is executing
* will NOT be popped and will remain in the stack when this function returns.
*
* @param f A functionish object that accepts a `T*` parameter. Called for each item that was popped from the stack.
*/
template <class Func>
void forEach(Func&& f)
{
T* p = Base::_popAll();
LocklessStackLink<T>* h = p ? Base::link(p) : nullptr;
while (h)
{
p = Base::convert(h);
h = h->m_next;
f(p);
}
}
/**
* Pushes an item onto the stack and notifies a waiting listener.
*
* Equivalent to doing `auto b = push(p); notifyOne(); return b;`.
*
* @see push(), notifyOne()
*
* @param p The item to push.
* @returns `true` if the stack was empty prior to push; `false` otherwise. Note that this is atomically correct
* as opposed to calling isEmpty() before push().
*/
bool pushNotify(T* p)
{
bool b = push(p);
notifyOne();
return b;
}
/**
* Blocks the calling thread until an item is available and returns it.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @see pop(), wait()
*
* @returns The first item popped from the stack.
*/
T* popWait()
{
T* p = pop();
while (!p)
{
wait();
p = pop();
}
return p;
}
/**
* Blocks the calling thread until an item is available and returns it or a timeout elapses.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @see pop(), waitFor()
*
* @param dur The duration to wait for an item to become available.
* @returns the first item removed from the stack or `nullptr` if the timeout period elapses.
*/
template <class Rep, class Period>
T* popWaitFor(const std::chrono::duration<Rep, Period>& dur)
{
return popWaitUntil(std::chrono::steady_clock::now() + dur);
}
/**
* Blocks the calling thread until an item is available and returns it or the clock reaches a time point.
*
* Requires the item to be pushed with pushNotify(), notifyOne() or notifyAll().
*
* @see pop(), waitUntil()
*
* @param tp The time to wait until for an item to become available.
* @returns the first item removed from the stack or `nullptr` if the timeout period elapses.
*/
template <class Clock, class Duration>
T* popWaitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
T* p = pop();
while (!p)
{
if (!waitUntil(tp))
{
return pop();
}
p = pop();
}
return p;
}
/**
* Waits until the stack is non-empty.
*
* @note Requires notification that the stack is non-empty, such as from pushNotify(), notifyOne() or notifyAll().
*
* @note Though wait() returns, another thread may have popped the available item making the stack empty again. Use
* popWait() if it is desired to ensure that the current thread can obtain an item.
*/
void wait()
{
Base::_wait();
}
/**
* Waits until the stack is non-empty or a specified duration has passed.
*
* @note Though waitFor() returns `true`, another thread may have popped the available item making the stack empty
* again. Use popWaitFor() if it is desired to ensure that the current thread can obtain an item.
*
* @note Requires notification that the stack is non-empty, such as from pushNotify(), notifyOne() or notifyAll().
*
* @param dur The duration to wait for an item to become available.
* @returns `true` if an item appears to be available; `false` if the timeout elapses.
*/
template <class Rep, class Period>
bool waitFor(const std::chrono::duration<Rep, Period>& dur)
{
return Base::_waitFor(dur);
}
/**
* Waits until the stack is non-empty or a specific time is reached.
*
* @note Though waitUntil() returns `true`, another thread may have popped the available item making the stack empty
* again. Use popWaitUntil() if it is desired to ensure that the current thread can obtain an item.
*
* @note Requires notification that the stack is non-empty, such as from pushNotify(), notifyOne() or notifyAll().
*
* @param tp The time to wait until for an item to become available.
* @returns `true` if an item appears to be available; `false` if the time is reached.
*/
template <class Clock, class Duration>
bool waitUntil(const std::chrono::time_point<Clock, Duration>& tp)
{
return Base::_waitUntil(tp);
}
/**
* Notifies a single waiting thread.
*
* Notifies a single thread waiting in wait(), waitFor(), waitUntil(), popWait(), popWaitFor(), or popWaitUntil() to
* wake and check the stack.
*/
void notifyOne()
{
Base::_notifyOne();
}
/**
* Notifies all waiting threads.
*
* Notifies all threads waiting in wait(), waitFor(), waitUntil(), popWait(), popWaitFor(), or popWaitUntil() to
* wake and check the stack.
*/
void notifyAll()
{
Base::_notifyAll();
}
};
} // namespace container
} // namespace carb
| 25,297 | C | 32.286842 | 133 | 0.611733 |
omniverse-code/kit/include/carb/container/IntrusiveUnorderedMultimap.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite intrusive unordered multi-map container.
#pragma once
#include "../Defines.h"
#include "../cpp/Bit.h"
#include <cmath>
#include <functional>
#include <iterator>
#include <memory>
namespace carb
{
namespace container
{
template <class Key, class T>
class IntrusiveUnorderedMultimapLink;
template <class Key, class T, IntrusiveUnorderedMultimapLink<Key, T> T::*U, class Hash, class Pred>
class IntrusiveUnorderedMultimap;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
struct NontrivialDummyType
{
constexpr NontrivialDummyType() noexcept
{
}
};
static_assert(!std::is_trivially_default_constructible<NontrivialDummyType>::value, "Invalid assumption");
template <class Key, class T>
class IntrusiveUnorderedMultimapLinkBase
{
public:
using KeyType = const Key;
using MappedType = T;
using ValueType = std::pair<const Key, T&>;
constexpr IntrusiveUnorderedMultimapLinkBase() noexcept = default;
~IntrusiveUnorderedMultimapLinkBase()
{
// Shouldn't be contained at destruction time
CARB_ASSERT(!isContained());
}
bool isContained() const noexcept
{
return m_next != nullptr;
}
private:
template <class Key2, class U, IntrusiveUnorderedMultimapLink<Key2, U> U::*V, class Hash, class Pred>
friend class ::carb::container::IntrusiveUnorderedMultimap;
IntrusiveUnorderedMultimapLink<Key, T>* m_next{ nullptr };
IntrusiveUnorderedMultimapLink<Key, T>* m_prev{ nullptr };
CARB_PREVENT_COPY_AND_MOVE(IntrusiveUnorderedMultimapLinkBase);
constexpr IntrusiveUnorderedMultimapLinkBase(IntrusiveUnorderedMultimapLink<Key, T>* init) noexcept
: m_next(init), m_prev(init)
{
}
};
} // namespace detail
#endif
/**
* Defines a "link node" that \ref IntrusiveUnorderedMultimap will use for tracking data for the contained type.
*/
template <class Key, class T>
class IntrusiveUnorderedMultimapLink : public detail::IntrusiveUnorderedMultimapLinkBase<Key, T>
{
using Base = detail::IntrusiveUnorderedMultimapLinkBase<Key, T>;
public:
//! Constructor.
constexpr IntrusiveUnorderedMultimapLink() noexcept : empty{}
{
}
//! Destructor. Asserts that the link is not contained in an @ref IntrusiveUnorderedMultimap.
~IntrusiveUnorderedMultimapLink()
{
// Shouldn't be contained at destruction time
CARB_ASSERT(!this->isContained());
}
private:
template <class Key2, class U, IntrusiveUnorderedMultimapLink<Key2, U> U::*V, class Hash, class Pred>
friend class IntrusiveUnorderedMultimap;
union
{
detail::NontrivialDummyType empty;
typename Base::ValueType value;
};
CARB_PREVENT_COPY_AND_MOVE(IntrusiveUnorderedMultimapLink);
};
/**
* IntrusiveUnorderedMultimap is a closed-addressing hash table very similar to std::unordered_multimap, but requires
* the tracking information to be contained within the stored type `T`, rather than built around it. In other words, the
* tracking information is "intrusive" in the type `T` by way of the IntrusiveUnorderedMultimapLink type.
* IntrusiveUnorderedMultimap does no allocation of the `T` type; all allocation is done outside of the context of
* IntrusiveUnorderedMultimap, which allows stored items to be on the stack, grouped with other items, etc.
*
* The impetus behind intrusive containers is specifically to allow the application to own the allocation patterns for a
* type, but still be able to store them in a container. For `std::unordered_multimap`, everything goes through an
* `Allocator` type, but in a real application some stored instances may be on the stack while others are on the heap,
* which makes using `std::unordered_multimap` impractical. Furthermore, a stored type may which to be removed from one
* list and inserted into another. With `std::unordered_multimap`, this would require heap interaction to erase from one
* list and insert into another. With IntrusiveUnorderedMultimap, this operation would not require any heap interaction
* and would be done very quickly (O(1)).
*
* Another example is a `std::unordered_multimap` of polymorphic types. For `std::unordered_multimap` the mapped type
* would have to be a pointer or pointer-like type which is an inefficient use of space, cache, etc. The
* \c IntrusiveUnorderedMultimapLink can be part of the contained object which is a more efficient use of space.
*
* Since IntrusiveUnorderedMultimap doesn't require any form of `Allocator`, the allocation strategy is completely left
* up to the application. This means that items could be allocated on the stack, pooled, or items mixed between stack
* and heap.
*
* An intrusive unique-map (i.e. an intrusive equivalent to `std::unordered_map`) is impractical because allocation is
* not the responsibility of the container. For `std::unordered_map::insert`, if a matching key already exists, a new
* entry is not created and an iterator to the existing entry is returned. Conversely, with the intrusive container, the
* insert function is being given an already-created object that cannot be destroyed. It is therefore up to the
* application to ensure uniqueness if desired. Similarly, the existence of an intrusive (multi-)set is impractical
* since a type `T` is required to be contained and a custom hasher/equality-predicate would have to be written to
* support it--it would be simpler to use @ref carb::container::IntrusiveList.
*
* It is important to select a good hashing function in order to reduce collisions that may sap performance. Generally
* \c std::hash is used which is typically based on the FNV-1a hash algorithm. Hash computation is only done for finding
* the bucket that would contain an item. Once the bucket is selected, the \c Pred template parameter is used to compare
* keys until a match is found. A truly ideal hash at the default load factor of \c 1.0 results in a single entry per
* bucket; however, this is not always true in practice. Hash collisions cause multiple items to fall into the same
* bucket, increasing the amount of work that must be done to find an item.
*
* Iterator invalidation mirrors that of `std::unordered_multimap`: rehashing invalidates iterators and may cause
* elements to be rearranged into different buckets, but does not invalidate references or pointers to keys or the
* mapped type.
*
* IntrusiveUnorderedMultimap matches `std::unordered_multimap` with the following exceptions:
* - The `iterator` and `initializer_list` constructor variants are not present in IntrusiveUnorderedMultimap.
* - The `iterator` and `initializer_list` insert() variants are not present in IntrusiveUnorderedMultimap.
* - IntrusiveUnorderedMultimap cannot be copied (though may still be moved).
* - IntrusiveUnorderedMultimap does not have `erase()` to erase an item from the list, but instead has remove() which
* will remove an item from the container. It is up to the caller to manage the memory for the item.
* - Likewise, clear() functions as a "remove all" and does not destroy items in the container.
* - iter_from_value() is a new function that translates an item contained in IntrusiveUnorderedMultimap into an
* iterator.
* - `local_iterator` and `begin(size_type)`/`end(size_type)` are not implemented.
*
* Example:
* @code{.cpp}
* class Subscription {
* public:
* IntrusiveUnorderedMultimapLink<std::string, Subscription> link;
* void notify();
* };
*
* IntrusiveUnorderedMultimap<std::string, &Subscription::link> map;
*
* Subscription sub;
* map.emplace("my subscription", sub);
*
* // Notify all subscriptions:
* for (auto& entry : map)
* entry.second.notify();
*
* map.remove("my subscription");
* @endcode
*
* @tparam Key A key to associate with the mapped data.
* @tparam T The mapped data, referred to by `Key`.
* @tparam U A pointer-to-member of `T` that must be of type @ref IntrusiveUnorderedMultimapLink. This member will be
* used by the IntrusiveUnorderedMultimap for storing the key type and tracking the contained object.
* @tparam Hash A class that is used to hash the key value. Better hashing functions produce better performance.
* @tparam Pred A class that is used to equality-compare two key values.
*/
template <class Key, class T, IntrusiveUnorderedMultimapLink<Key, T> T::*U, class Hash = ::std::hash<Key>, class Pred = ::std::equal_to<Key>>
class IntrusiveUnorderedMultimap
{
using BaseLink = detail::IntrusiveUnorderedMultimapLinkBase<Key, T>;
public:
//! The type of the key; type `Key`
using KeyType = const Key;
//! The type of the mapped data; type `T`
using MappedType = T;
//! The type of the @ref IntrusiveUnorderedMultimapLink that must be a member of MappedType.
using Link = IntrusiveUnorderedMultimapLink<Key, T>;
//! Helper definition for `std::pair<const Key, T&>`.
using ValueType = typename Link::ValueType;
// Iterator support
// clang-format off
//! A LegacyForwardIterator to `const ValueType`.
//! @see <a href="https://en.cppreference.com/w/cpp/named_req/ForwardIterator">LegacyForwardIterator</a>
class const_iterator
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using iterator_category = std::forward_iterator_tag;
using value_type = ValueType;
using difference_type = ptrdiff_t;
using pointer = const value_type*;
using reference = const value_type&;
const_iterator() noexcept = default;
reference operator * () const { assertNotEnd(); return m_where->value; }
pointer operator -> () const { assertNotEnd(); return std::addressof(operator*()); }
const_iterator& operator ++ () noexcept /* ++iter */ { assertNotEnd(); incr(); return *this; }
const_iterator operator ++ (int) noexcept /* iter++ */ { assertNotEnd(); const_iterator i{ *this }; incr(); return i; }
bool operator == (const const_iterator& rhs) const noexcept { assertSameOwner(rhs); return m_where == rhs.m_where; }
bool operator != (const const_iterator& rhs) const noexcept { assertSameOwner(rhs); return m_where != rhs.m_where; }
protected:
friend class IntrusiveUnorderedMultimap;
Link* m_where{ nullptr };
#if CARB_ASSERT_ENABLED
const IntrusiveUnorderedMultimap* m_owner{ nullptr };
const_iterator(Link* where, const IntrusiveUnorderedMultimap* owner) noexcept : m_where(where), m_owner(owner) {}
void assertOwner(const IntrusiveUnorderedMultimap* other) const noexcept
{
CARB_ASSERT(m_owner == other, "IntrusiveUnorderedMultimap iterator for invalid container");
}
void assertSameOwner(const const_iterator& rhs) const noexcept
{
CARB_ASSERT(m_owner == rhs.m_owner, "IntrusiveUnorderedMultimap iterators are from different containers");
}
void assertNotEnd() const noexcept
{
CARB_ASSERT(m_where != m_owner->_end(), "Invalid operation on IntrusiveUnorderedMultimap::end() iterator");
}
#else
const_iterator(Link* where, const IntrusiveUnorderedMultimap*) noexcept : m_where(where) {}
void assertOwner(const IntrusiveUnorderedMultimap* other) const noexcept
{
CARB_UNUSED(other);
}
void assertSameOwner(const const_iterator& rhs) const noexcept
{
CARB_UNUSED(rhs);
}
void assertNotEnd() const noexcept {}
#endif // !CARB_ASSERT_ENABLED
void incr() noexcept { m_where = m_where->m_next; }
#endif // !DOXYGEN_SHOULD_SKIP_THIS
};
//! A LegacyForwardIterator to `ValueType`.
//! @see <a href="https://en.cppreference.com/w/cpp/named_req/ForwardIterator">LegacyForwardIterator</a>
class iterator : public const_iterator
{
using Base = const_iterator;
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using iterator_category = std::forward_iterator_tag;
using value_type = ValueType;
using difference_type = ptrdiff_t;
using pointer = value_type*;
using reference = value_type&;
iterator() noexcept = default;
reference operator * () const { this->assertNotEnd(); return this->m_where->value; }
pointer operator -> () const { this->assertNotEnd(); return std::addressof(operator*()); }
iterator& operator ++ () noexcept /* ++iter */ { this->assertNotEnd(); this->incr(); return *this; }
iterator operator ++ (int) noexcept /* iter++ */ { this->assertNotEnd(); iterator i{ *this }; this->incr(); return i; }
private:
friend class IntrusiveUnorderedMultimap;
iterator(Link* where, const IntrusiveUnorderedMultimap* owner) : Base(where, owner) {}
#endif
};
// clang-format on
CARB_PREVENT_COPY(IntrusiveUnorderedMultimap);
//! Constructor. Initializes `*this` to be empty().
constexpr IntrusiveUnorderedMultimap() : m_list(_end())
{
}
//! Move-construct. Moves all entries to `*this` from @p other and leaves it empty.
//! @param other Another IntrusiveUnorderedMultimap to move entries from.
IntrusiveUnorderedMultimap(IntrusiveUnorderedMultimap&& other) noexcept : m_list(_end())
{
swap(other);
}
//! Destructor. Implies clear().
~IntrusiveUnorderedMultimap()
{
clear();
m_list.m_next = m_list.m_prev = nullptr; // Prevents the assert
}
//! Move-assign. Moves all entries from @p other and leaves @p other in a valid but possibly non-empty state.
//! @param other Another IntrusiveUnorderedMultimap to move entries from.
IntrusiveUnorderedMultimap& operator=(IntrusiveUnorderedMultimap&& other) noexcept
{
swap(other);
return *this;
}
//! Checks whether the container is empty.
//! @returns `true` if `*this` is empty; `false` otherwise.
bool empty() const noexcept
{
return !m_size;
}
//! Returns the number of elements contained.
//! @returns The number of elements contained.
size_t size() const noexcept
{
return m_size;
}
//! Returns the maximum possible number of elements.
//! @returns The maximum possible number of elements.
size_t max_size() const noexcept
{
return size_t(-1);
}
// Iterator support
//! Returns an iterator to the beginning.
//! @returns An iterator to the beginning.
iterator begin() noexcept
{
return iterator(_head(), this);
}
//! Returns an iterator to the end.
//! @returns An iterator to the end.
iterator end() noexcept
{
return iterator(_end(), this);
}
//! Returns a const_iterator to the beginning.
//! @returns A const_iterator to the beginning.
const_iterator cbegin() const noexcept
{
return const_iterator(_head(), this);
}
//! Returns a const_iterator to the end.
//! @returns A const_iterator to the end.
const_iterator cend() const noexcept
{
return const_iterator(_end(), this);
}
//! Returns a const_iterator to the beginning.
//! @returns A const_iterator to the beginning.
const_iterator begin() const noexcept
{
return cbegin();
}
//! Returns a const_iterator to the end.
//! @returns A const_iterator to the end.
const_iterator end() const noexcept
{
return cend();
}
//! Returns an iterator to the given value if it is contained in `*this`, otherwise returns `end()`. O(n).
//! @param value The value to check for.
//! @returns An @ref iterator to @p value if contained in `*this`; end() otherwise.
iterator locate(T& value) noexcept
{
Link* l = _link(value);
return iterator(l->isContained() ? _listfind(value) : _end(), this);
}
//! Returns an iterator to the given value if it is contained in `*this`, otherwise returns `end()`. O(n).
//! @param value The value to check for.
//! @returns A @ref const_iterator to @p value if contained in `*this`; end() otherwise.
const_iterator locate(T& value) const noexcept
{
Link* l = _link(value);
return const_iterator(l->isContained() ? _listfind(value) : _end(), this);
}
//! Naively produces an @ref iterator for @p value within `*this`.
//! @warning Undefined behavior results if @p value is not contained within `*this`. Use locate() to safely check.
//! @param value The value to convert.
//! @returns An @ref iterator to @p value.
iterator iter_from_value(T& value)
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained() || _listfind(value) != _end());
return iterator(l->isContained() ? l : _end(), this);
}
//! Naively produces an @ref iterator for @p value within `*this`.
//! @warning Undefined behavior results if @p value is not contained within `*this`. Use locate() to safely check.
//! @param value The value to convert.
//! @returns A @ref const_iterator to @p value.
const_iterator iter_from_value(T& value) const
{
Link* l = _link(value);
CARB_ASSERT(!l->isContained() || _listfind(value) != _end());
return const_iterator(l->isContained() ? l : _end(), this);
}
//! Removes all elements.
//! @note Postcondition: `*this` is empty().
void clear()
{
if (_head() != _end())
{
do
{
Link* p = _head();
p->value.~ValueType(); // Destruct the key
m_list.m_next = p->m_next;
p->m_next = p->m_prev = nullptr;
} while (_head() != _end());
m_list.m_prev = _end();
m_size = 0;
// Clear the buckets
memset(m_buckets.get(), 0, sizeof(LinkPair) * m_bucketCount);
}
}
//! Inserts an element.
//! @note No uniqueness checking is performed; multiple values with the same `Key` may be inserted.
//! @note Precondition: `value.second` must not be contained (via `U`) in this or any other
//! IntrusiveUnorderedMultimap.
//! @param value The pair of `[key, value reference]` to insert.
//! @returns An @ref iterator to the newly-inserted @p value.
iterator insert(ValueType value)
{
T& val = value.second;
Link* l = _link(val);
CARB_ASSERT(!l->isContained());
// Construct the key
new (&l->value) ValueType(std::move(value));
// Hash
size_t const hash = Hash{}(l->value.first);
++m_size;
// Find insertion point
reserve(size());
LinkPair& bucket = m_buckets[_bucket(hash)];
if (bucket.first)
{
// Need to see if there's a matching value in the bucket so that we group all keys together
Pred pred{};
Link* const end = bucket.second->m_next;
for (Link* p = bucket.first; p != end; p = p->m_next)
{
if (pred(l->value.first, p->value.first))
{
// Match! Insert here.
l->m_prev = p->m_prev;
l->m_next = p;
l->m_prev->m_next = l;
l->m_next->m_prev = l;
if (p == bucket.first)
{
bucket.first = l;
}
return iterator(l, this);
}
}
// Didn't find a match within the bucket. Just add to the end of the bucket
l->m_prev = bucket.second;
l->m_next = end;
l->m_prev->m_next = l;
l->m_next->m_prev = l;
bucket.second = l;
}
else
{
// Insert at end of the list
l->m_prev = _tail();
l->m_next = _end();
l->m_prev->m_next = l;
l->m_next->m_prev = l;
bucket.first = bucket.second = l;
}
return iterator(l, this);
}
//! Inserts an element while allowing key emplacement.
//! @note No uniqueness checking is performed; multiple values with the same `Key` may be inserted.
//! @note Precondition: The `second` member of the constructed `pair` must not be contained (via `U`) in this or any
//! other IntrusiveUnorderedMultimap.
//! @param args Arguments passed to `std::pair<KeyType, MappedType>` to insert.
//! @returns An @ref iterator to the newly-inserted value.
template <class... Args>
iterator emplace(Args&&... args)
{
return insert(ValueType{ std::forward<Args>(args)... });
}
//! Finds an element with a specific key.
//! @param key The key that identifies an element.
//! @returns An @ref iterator to the element, if found; end() otherwise.
iterator find(const Key& key)
{
if (empty())
{
return end();
}
size_t const hash = Hash{}(key);
LinkPair& pair = m_buckets[_bucket(hash)];
if (!pair.first)
{
return end();
}
Pred pred{};
for (Link* p = pair.first; p != pair.second->m_next; p = p->m_next)
{
if (pred(p->value.first, key))
{
return iterator(p, this);
}
}
// Not found
return end();
}
//! Finds an element with a specific key.
//! @param key The key that identifies an element.
//! @returns A @ref const_iterator to the element, if found; end() otherwise.
const_iterator find(const Key& key) const
{
if (empty())
{
return cend();
}
size_t const hash = Hash{}(key);
LinkPair& pair = m_buckets[_bucket(hash)];
if (!pair.first)
{
return cend();
}
Pred pred{};
Link* const bucketEnd = pair.second->m_next;
for (Link* p = pair.first; p != bucketEnd; p = p->m_next)
{
if (pred(p->value.first, key))
{
return const_iterator(p, this);
}
}
return cend();
}
//! Finds a range of elements matching the given key.
//! @param key The key that identifies an element.
//! @returns A `pair` of @ref iterator objects that define a range: the `first` iterator is the first item in the
//! range and the `second` iterator is immediately past the end of the range. If no elements exist with @p key,
//! `std::pair(end(), end())` is returned.
std::pair<iterator, iterator> equal_range(const Key& key)
{
if (empty())
{
return std::make_pair(end(), end());
}
size_t const hash = Hash{}(key);
LinkPair& pair = m_buckets[_bucket(hash)];
if (!pair.first)
{
return std::make_pair(end(), end());
}
Pred pred{};
Link* p = pair.first;
Link* const bucketEnd = pair.second->m_next;
for (; p != bucketEnd; p = p->m_next)
{
if (pred(p->value.first, key))
{
// Inner loop: terminates when no longer matches or bucket ends
Link* first = p;
p = p->m_next;
for (; p != bucketEnd; p = p->m_next)
{
if (!pred(p->value.first, key))
{
break;
}
}
return std::make_pair(iterator(first, this), iterator(p, this));
}
}
return std::make_pair(end(), end());
}
//! Finds a range of elements matching the given key.
//! @param key The key that identifies an element.
//! @returns A `pair` of @ref const_iterator objects that define a range: the `first` const_iterator is the first
//! item in the range and the `second` const_iterator is immediately past the end of the range. If no elements
//! exist with @p key, `std::pair(end(), end())` is returned.
std::pair<const_iterator, const_iterator> equal_range(const Key& key) const
{
if (empty())
{
return std::make_pair(cend(), cend());
}
size_t const hash = Hash{}(key);
LinkPair& pair = m_buckets[_bucket(hash)];
if (!pair.first)
{
return std::make_pair(cend(), cend());
}
Pred pred{};
Link* p = pair.first;
Link* const bucketEnd = pair.second->m_next;
for (; p != bucketEnd; p = p->m_next)
{
if (pred(p->value.first, key))
{
// Inner loop: terminates when no longer matches or bucket ends
Link* first = p;
p = p->m_next;
for (; p != bucketEnd; p = p->m_next)
{
if (!pred(p->value.first, key))
{
break;
}
}
return std::make_pair(const_iterator(first, this), const_iterator(p, this));
}
}
return std::make_pair(cend(), cend());
}
//! Returns the number of elements matching a specific key.
//! @param key The key to search for.
//! @returns The number of elements matching the given key.
size_t count(const Key& key) const
{
if (empty())
{
return 0;
}
size_t const hash = Hash{}(key);
LinkPair& pair = m_buckets[_bucket(hash)];
if (!pair.first)
{
return 0;
}
Pred pred{};
Link* p = pair.first;
Link* const bucketEnd = pair.second->m_next;
for (; p != bucketEnd; p = p->m_next)
{
if (pred(p->value.first, key))
{
// Inner loop: terminates when no longer matches or bucket ends
size_t count = 1;
p = p->m_next;
for (; p != bucketEnd; p = p->m_next)
{
if (!pred(p->value.first, key))
{
break;
}
++count;
}
return count;
}
}
return 0;
}
//! Removes an element by iterator.
//! @note Precondition: @p pos must be a valid const_iterator of `*this` and may not be end().
//! @param pos A @ref const_iterator to the element to remove.
//! @returns A @ref iterator to the element immediately following @p pos, or end() if no elements followed it.
iterator remove(const_iterator pos)
{
CARB_ASSERT(!empty());
pos.assertNotEnd();
pos.assertOwner(this);
Link* l = pos.m_where;
Link* next = l->m_next;
// Fix up bucket if necessary
LinkPair& pair = m_buckets[_bucket(Hash{}(l->value.first))];
if (pair.first == l)
{
if (pair.second == l)
{
// Empty bucket now
pair.first = pair.second = nullptr;
}
else
{
pair.first = next;
}
}
else if (pair.second == l)
{
pair.second = l->m_prev;
}
l->m_prev->m_next = l->m_next;
l->m_next->m_prev = l->m_prev;
l->m_next = l->m_prev = nullptr;
--m_size;
// Destruct value
l->value.~ValueType();
return iterator(next, this);
}
//! Removes an element by reference.
//! @note Precondition: @p value must be contained in `*this`.
//! @param value The element to remove.
//! @returns @p value for convenience.
T& remove(T& value)
{
Link* l = _link(value);
if (l->isContained())
{
CARB_ASSERT(!empty());
CARB_ASSERT(_listfind(value) != _end());
// Fix up bucket if necessary
LinkPair& pair = m_buckets[_bucket(Hash{}(l->value.first))];
if (pair.first == l)
{
if (pair.second == l)
{
// Empty bucket now
pair.first = pair.second = nullptr;
}
else
{
pair.first = l->m_next;
}
}
else if (pair.second == l)
{
pair.second = l->m_prev;
}
l->m_prev->m_next = l->m_next;
l->m_next->m_prev = l->m_prev;
l->m_next = l->m_prev = nullptr;
--m_size;
// Destruct value
l->value.~ValueType();
}
return value;
}
//! Removes all elements matching a specific key.
//! @param key The key to search for.
//! @returns The number of elements that were removed.
size_t remove(const Key& key)
{
size_t count{ 0 };
auto pair = equal_range(key);
while (pair.first != pair.second)
{
remove(pair.first++);
++count;
}
return count;
}
//! Swaps the contents of `*this` with another IntrusiveUnorderedMultimap.
//! @param other The other IntrusiveUnorderedMultimap to swap with.
void swap(IntrusiveUnorderedMultimap& other) noexcept
{
if (this != std::addressof(other))
{
// Fix up the end iterators first
Link *&lhead = _head()->m_prev, *<ail = _tail()->m_next;
Link *&rhead = other._head()->m_prev, *&rtail = other._tail()->m_next;
lhead = ltail = other._end();
rhead = rtail = _end();
// Now swap everything else
std::swap(m_buckets, other.m_buckets);
std::swap(m_bucketCount, other.m_bucketCount);
std::swap(_end()->m_next, other._end()->m_next);
std::swap(_end()->m_prev, other._end()->m_prev);
std::swap(m_size, other.m_size);
std::swap(m_maxLoadFactor, other.m_maxLoadFactor);
}
}
//! Returns the number of buckets.
//! @returns The number of buckets.
size_t bucket_count() const noexcept
{
return m_bucketCount;
}
//! Returns the maximum number of buckets.
//! @returns The maximum number of buckets.
size_t max_bucket_count() const noexcept
{
return size_t(-1);
}
//! Returns the bucket index for a specific key.
//! @param key The key to hash.
//! @returns A bucket index in the range `[0, bucket_count())`.
size_t bucket(const Key& key) const
{
return _bucket(Hash{}(key));
}
//! Returns the average number of elements per bucket.
//! @returns The average number of elements per bucket.
float load_factor() const
{
return bucket_count() ? float(size()) / float(bucket_count()) : 0.f;
}
//! Returns the max load factor for `*this`.
//! @returns The max load factor for `*this`. The default is 1.0.
float max_load_factor() const noexcept
{
return m_maxLoadFactor;
}
//! Sets the maximum load factor for `*this`.
//! @note Precondition: @p ml must be greater than 0.
//! @note Changes do not take effect until the hash table is re-generated.
//! @param ml The new maximum load factor for `*this`.
void max_load_factor(float ml)
{
CARB_ASSERT(ml > 0.f);
m_maxLoadFactor = ml;
}
//! Reserves space for at least the specified number of elements and re-generates the hash table.
//! @param count The minimum number of elements to reserve space for.
void reserve(size_t count)
{
rehash(size_t(std::ceil(count / max_load_factor())));
}
//! Reserves at least the specified number of buckets and re-generates the hash table.
//! @param buckets The minimum number of buckets required.
void rehash(size_t buckets)
{
if (buckets > m_bucketCount)
{
constexpr static size_t kMinBuckets(8);
static_assert(carb::cpp::has_single_bit(kMinBuckets), "Invalid assumption");
buckets = carb::cpp::bit_ceil(::carb_max(buckets, kMinBuckets));
CARB_ASSERT(carb::cpp::has_single_bit(buckets));
m_buckets.reset(new LinkPair[buckets]);
memset(m_buckets.get(), 0, sizeof(LinkPair) * buckets);
m_bucketCount = buckets;
// Walk through the list backwards and rehash everything. Things that have equal keys and are already
// grouped together will remain so.
Link* cur = _tail();
m_list.m_prev = m_list.m_next = _end();
Link* next;
Hash hasher;
for (; cur != _end(); cur = next)
{
next = cur->m_prev;
LinkPair& bucket = m_buckets[_bucket(hasher(cur->value.first))];
if (bucket.first)
{
// Insert in front of whatever was in the bucket
cur->m_prev = bucket.first->m_prev;
cur->m_next = bucket.first;
cur->m_prev->m_next = cur;
cur->m_next->m_prev = cur;
bucket.first = cur;
}
else
{
// Insert at the front of the list and the beginning of the bucket
cur->m_prev = _end();
cur->m_next = _head();
cur->m_prev->m_next = cur;
cur->m_next->m_prev = cur;
bucket.first = bucket.second = cur;
}
}
}
}
private:
struct LinkPair
{
Link* first;
Link* second;
};
std::unique_ptr<LinkPair[]> m_buckets{};
size_t m_bucketCount{ 0 };
BaseLink m_list;
size_t m_size{ 0 };
float m_maxLoadFactor{ 1.f };
size_t _bucket(size_t hash) const
{
// bucket count is always a power of 2
return hash & (m_bucketCount - 1);
}
Link* _listfind(T& value) const
{
Link* find = _link(value);
Link* p = _head();
for (; p != _end(); p = p->m_next)
{
if (p == find)
{
return p;
}
}
return _end();
}
static Link* _link(T& value) noexcept
{
return std::addressof(value.*U);
}
static T& _value(Link& l) noexcept
{
// Need to calculate the offset of our link member which will allow adjusting the pointer to where T is.
// This will not work if T uses virtual inheritance. Also, offsetof() cannot be used because we have a pointer
// to the member
size_t offset = size_t(reinterpret_cast<uint8_t*>(&(((T*)0)->*U)));
return *reinterpret_cast<T*>(reinterpret_cast<uint8_t*>(std::addressof(l)) - offset);
}
static const T& _value(const Link& l) noexcept
{
// Need to calculate the offset of our link member which will allow adjusting the pointer to where T is.
// This will not work if T uses virtual inheritance. Also, offsetof() cannot be used because we have a pointer
// to the member
size_t offset = size_t(reinterpret_cast<uint8_t*>(&(((T*)0)->*U)));
return *reinterpret_cast<const T*>(reinterpret_cast<const uint8_t*>(std::addressof(l)) - offset);
}
constexpr Link* _head() const noexcept
{
return const_cast<Link*>(m_list.m_next);
}
constexpr Link* _tail() const noexcept
{
return const_cast<Link*>(m_list.m_prev);
}
constexpr Link* _end() const noexcept
{
return static_cast<Link*>(const_cast<BaseLink*>(&m_list));
}
};
} // namespace container
} // namespace carb
| 36,421 | C | 35.240796 | 141 | 0.589687 |
omniverse-code/kit/include/carb/process/Util.h | // Copyright (c) 2021-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite process utilities.
#pragma once
#include "../Defines.h"
#include "../extras/ScopeExit.h"
#if CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
#elif CARB_POSIX
# include <unistd.h>
# include <fcntl.h>
# if CARB_PLATFORM_MACOS
# include <sys/errno.h>
# include <sys/sysctl.h>
# endif
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
#include <vector>
namespace carb
{
//! Namespace for Carbonite process utilities.
namespace process
{
/** The type for a process ID. */
using ProcessId = uint32_t;
#if CARB_PLATFORM_WINDOWS
static_assert(sizeof(ProcessId) >= sizeof(DWORD), "ProcessId type is too small");
#elif CARB_POSIX
static_assert(sizeof(ProcessId) >= sizeof(pid_t), "ProcessId type is too small");
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
/** The printf format macro to print a process ID. */
#define OMNI_PRIpid PRIu32
/** The printf format macro to print a process ID in hexadecimal. */
#define OMNI_PRIxpid PRIx32
} // namespace process
/**
* Namespace for utilities that operate on the current thread specifically.
*/
namespace this_process
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
# if CARB_PLATFORM_WINDOWS
// Returns the process creation time as a Windows FILETIME (number of 100ns units since Jan 1, 1600 GMT).
inline uint64_t getCreationTime()
{
CARBWIN_FILETIME creationTime{}, exitTime{}, kernelTime{}, userTime{};
BOOL b = ::GetProcessTimes(::GetCurrentProcess(), (LPFILETIME)&creationTime, (LPFILETIME)&exitTime,
(LPFILETIME)&kernelTime, (LPFILETIME)&userTime);
CARB_ASSERT(b);
CARB_UNUSED(b);
return (uint64_t(creationTime.dwHighDateTime) << 32) + creationTime.dwLowDateTime;
}
// Converts a time_t (Unix epoch - seconds since Jan 1, 1970 GMT) to a Windows FILETIME
// (100ns units since Jan 1, 1600 GMT).
inline uint64_t timeTtoFileTime(time_t val)
{
// Multiply by 10 million to convert to 100ns units, then add a constant that is the number of 100ns units between
// Jan 1, 1600 GMT and Jan 1, 1970 GMT
return uint64_t(val) * 10'000'000 + 116444736000000000;
}
// Parses the system startup time from the Windows event log as a Unix time (seconds since Jan 1, 1970 GMT).
// Adapted from https://docs.microsoft.com/en-us/windows/win32/eventlog/querying-for-event-source-messages
// Another possibility would be to use WMI's LastBootupTime, but it is affected by hibernation and clock sync.
inline time_t parseSystemStartupTime()
{
// Open the system event log
HANDLE hEventLog = ::OpenEventLogW(NULL, L"System");
CARB_ASSERT(hEventLog);
if (!hEventLog)
return time_t(0);
// Make sure to close the handle when we're finished
CARB_SCOPE_EXIT
{
CloseEventLog(hEventLog);
};
constexpr static size_t kBufferSize = 65536; // Start with a fairly large buffer
std::vector<uint8_t> bytes(kBufferSize);
// A lambda that will find the "Event Log Started" record from a buffer
auto findRecord = [](const uint8_t* bytes, DWORD bytesRead) -> const CARBWIN_EVENTLOGRECORD* {
constexpr static wchar_t kDesiredSourceName[] = L"EventLog";
constexpr static DWORD kDesiredEventId = 6005; // Event Log Started
const uint8_t* const end = bytes + bytesRead;
while (bytes < end)
{
auto record = reinterpret_cast<const CARBWIN_EVENTLOGRECORD*>(bytes);
// Check the SourceName (first field after the event log record)
auto SourceName = reinterpret_cast<const WCHAR*>(bytes + sizeof(CARBWIN_EVENTLOGRECORD));
if (0 == memcmp(SourceName, kDesiredSourceName, sizeof(kDesiredSourceName)))
{
if ((record->EventID & 0xFFFF) == kDesiredEventId)
{
// Found it!
return record;
}
}
bytes += record->Length;
}
return nullptr;
};
for (;;)
{
DWORD dwBytesRead, dwMinimumBytesNeeded;
if (!ReadEventLogW(hEventLog, CARBWIN_EVENTLOG_SEQUENTIAL_READ | CARBWIN_EVENTLOG_BACKWARDS_READ, 0,
bytes.data(), (DWORD)bytes.size(), &dwBytesRead, &dwMinimumBytesNeeded))
{
DWORD err = GetLastError();
if (err == CARBWIN_ERROR_INSUFFICIENT_BUFFER)
{
// Insufficient buffer.
bytes.resize(dwMinimumBytesNeeded);
}
else
{
// Error
return time_t(0);
}
}
else
{
if (auto record = findRecord(bytes.data(), dwBytesRead))
{
// Found the record!
return time_t(record->TimeGenerated);
}
}
}
}
// Gets the system startup time as a Unix time (seconds since Jan 1, 1970 GMT).
inline time_t getSystemStartupTime()
{
static time_t systemStartupTime = parseSystemStartupTime();
return systemStartupTime;
}
# endif
} // namespace detail
#endif
/**
* Returns the ID of the currently executing process.
* @returns The current ID of the process.
*/
inline process::ProcessId getId()
{
#if CARB_PLATFORM_WINDOWS
return GetCurrentProcessId();
#elif CARB_POSIX
return getpid();
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Get the ID of the currently executing process.
* @note Linux: This value is cached, so this can be unsafe if you are using fork() or clone() without calling exec()
* after. This should be safe if you're only using @ref carb::launcher::ILauncher to launch processes.
* @returns The current ID of the process.
*/
inline process::ProcessId getIdCached()
{
#if CARB_PLATFORM_WINDOWS
return GetCurrentProcessId();
#elif CARB_POSIX
// glibc (since 2.25) does not cache the result of getpid() due to potential
// edge cases where a fork() syscall was done without the glibc wrapper, so
// we'll cache it here.
static pid_t cached = getpid();
return cached;
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Returns an ID uniquely identifying this process at least for the uptime of the machine.
*
* Process IDs aren't unique; they can be reused. They are great at identifying a process at a given point in time, but
* not on a timeline that includes the future and the past. That's what this function seeks to do: give an ultra-high
* probability that the generated ID has never been in use on this system since the last restart.
*
* This function accomplishes this by combining PID with process creation time.
*
* On Windows, 30 bits are available for process IDs and the remaining 34 bits are used for the timestamp in 32ms units.
* For a collision to happen, either 17.4 years would have to pass for rollover or a process would have to start, finish
* and the process ID be reused by the system within the same 32ms unit.
*
* For Linux, up to 22 bits are available for process IDs (but most systems use the default of 15 bits). The remaining
* 42 bits are used for the timestamp. The timestamp is based on the kernel frequency (ticks per second). A kernel
* frequency of 100 will result in using 10ms units for the timestamp and the rollover period is 1,394 years. The
* maximum resolution used for the timer will result in using 1 ms units for the timestamp and a rollover period of
* 139.4 years. For a collision to happen, either the rollover period would have to pass or a process would have to
* start, finish and the process ID be reused by the system within the timestamp unit (1 ms - 10 ms).
*
* @warning This function is frozen to maintain @rstref{ABI compatibility <abi-compatibility>} over plugins that may be
* built at different times. Do not change the results of this function, ever! Instead, add a different function.
*
* @note The first call to this function within a module may be slow as additional information is obtained from the
* system. That information is then cached and subsequent calls within the module are very fast.
*
* @returns A unique identifier for this process from the last restart until the system is rebooted.
*/
inline uint64_t getUniqueId()
{
#if CARB_PLATFORM_WINDOWS
// See: https://stackoverflow.com/questions/17868218/what-is-the-maximum-process-id-on-windows
// Range 00000000 - FFFFFFFC, but aligned to 4 bytes, so 30 significant bits
const static DWORD pid = GetCurrentProcessId();
// creationTime is the number of 32ms units since system startup until this process started.
// 34 bits of 32ms units gives us ~17.4 years of time until rollover. It is highly unlikely that a process ID would
// be reused by the system within the same 32ms timeframe that the process started.
const static uint64_t creationTime =
((detail::getCreationTime() - detail::timeTtoFileTime(detail::getSystemStartupTime())) / 320'000) &
0x3ffffffff; // mask
CARB_ASSERT((pid & 0x3) == 0); // Test assumption
return (uint64_t(pid) << 32) + creationTime;
#elif CARB_PLATFORM_LINUX
// We need to retrieve this from /proc. Unfortunately, because of fork(), the PID can change but if the PID changes
// then the creation time will change too. According to https://man7.org/linux/man-pages/man5/proc.5.html the
// maximum value for a pid is 1<<22 or ~4 million. That gives us 42 bits for timing information.
// NOTE: This is not thread-safe static initialization. However, this is okay because every thread in a process will
// arrive at the same value, so it doesn't matter if multiple threads write the same value.
static uint64_t cachedValue{};
// Read the pid every time as it can change if we fork().
process::ProcessId pid = getId();
if (CARB_UNLIKELY((cachedValue >> 42) != pid))
{
CARB_ASSERT((pid & 0xffc00000) == 0); // Only 22 bits are used for PIDs
// PID changed (or first time). Read the process start time from /proc
int fd = open("/proc/self/stat", O_RDONLY);
CARB_FATAL_UNLESS(fd != -1, "Failed to open /proc/self/stat: {%d/%s}", errno, strerror(errno));
char buf[4096];
ssize_t bytes = CARB_RETRY_EINTR(read(fd, buf, CARB_COUNTOF(buf) - 1));
CARB_FATAL_UNLESS(bytes >= 0, "Failed to read from /proc/self/stat");
CARB_ASSERT(size_t(bytes) < (CARB_COUNTOF(buf) - 1)); // We should have read everything
close(fd);
buf[bytes] = '\0';
unsigned long long starttime; // time (in clock ticks) since system boot when the process started
// See https://man7.org/linux/man-pages/man5/proc.5.html
// the starttime value is the 22nd value so skip all of the other values.
// Someone evil (read: me when testing) could have a space or parens as part of the binary name. So look for the
// last close parenthesis and start from there. Hopefully no other fields get added to /proc/[pid]/stat that use
// parentheses.
const char* start = strrchr(buf, ')');
CARB_ASSERT(start);
int match = sscanf(
start, ") %*c %*d %*d %*d %*d %*d %*u %*u %*u %*u %*u %*u %*u %*d %*d %*d %*d %*d %*d %llu", &starttime);
CARB_FATAL_UNLESS(match == 1, "Failed to parse process start time from /proc/self/stat");
static long ticksPerSec = sysconf(_SC_CLK_TCK);
long divisor;
if (ticksPerSec <= 0)
divisor = 1;
else if (ticksPerSec < 1000)
divisor = ticksPerSec;
else
divisor = ticksPerSec / 1000;
// Compute the cached value.
cachedValue = (uint64_t(pid) << 42) + ((starttime / divisor) & 0x3ffffffffff);
}
CARB_ASSERT(cachedValue != 0);
return cachedValue;
#elif CARB_PLATFORM_MACOS
// MacOS has a maximum process ID of 99998 and a minimum of 100. This can fit into 17 bits.
// The remaining 47 bits are used for the process creation timestamp.
static uint64_t cachedValue{};
process::ProcessId pid = getId();
if (CARB_UNLIKELY((cachedValue >> 47) != pid))
{
struct kinfo_proc info;
struct timeval startTime;
int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PID, (int)pid };
size_t length = sizeof(info);
int result;
CARB_ASSERT((pid & 0xfffe0000) == 0); // Only 17 bits are used for PIDs.
// retrieve the process start time.
memset(&info, 0, sizeof(info));
result = sysctl(mib, CARB_COUNTOF(mib), &info, &length, nullptr, 0);
CARB_FATAL_UNLESS(result == 0, "failed to retrieve the process information.");
startTime = info.kp_proc.p_starttime;
// create the unique ID by converting the process creation time to a number of 10ms units
// then adding in the process ID in the high bits.
cachedValue = (((((uint64_t)startTime.tv_sec * 1'000'000) + startTime.tv_usec) / 10'000) & 0x7fffffffffffull) +
(((uint64_t)pid) << 47);
}
CARB_ASSERT(cachedValue != 0);
return cachedValue;
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
} // namespace this_process
} // namespace carb
| 13,586 | C | 38.497093 | 120 | 0.666569 |
omniverse-code/kit/include/carb/audio/AudioUtils.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Inline utility functions for audio processing.
*/
#pragma once
#ifndef DOXYGEN_SHOULD_SKIP_THIS
# define _USE_MATH_DEFINES
#endif
#include "../Framework.h"
#include "../logging/Log.h"
#include "../math/Util.h"
#include "AudioTypes.h"
#include "IAudioData.h"
#include "IAudioPlayback.h"
#include "IAudioUtils.h"
#include "IAudioCapture.h"
#include <atomic>
#include <limits.h>
#include <math.h>
#include <string.h>
#if CARB_PLATFORM_WINDOWS
# define strdup _strdup
#endif
namespace carb
{
namespace audio
{
/** converts an angle in degrees to an angle in radians.
*
* @param[in] degrees the angle in degrees to be converted.
* @returns the requested angle in radians.
*/
template <typename T>
constexpr float degreesToRadians(T degrees)
{
return degrees * (float(M_PI) / 180.f);
}
/** converts an angle in degrees to an angle in radians.
*
* @param[in] degrees the angle in degrees to be converted.
* @returns the requested angle in radians.
*/
constexpr double degreesToRadians(double degrees)
{
return degrees * (M_PI / 180.0);
}
/** converts an angle in radians to an angle in degrees.
*
* @param[in] radians the angle in radians to be converted.
* @returns the requested angle in degrees.
*/
template <typename T>
constexpr float radiansToDegrees(T radians)
{
return (radians * (180.f / float(M_PI)));
}
/** converts an angle in radians to an angle in degrees.
*
* @param[in] radians the angle in radians to be converted.
* @returns the requested angle in degrees.
*/
constexpr double radiansToDegrees(double radians)
{
return (radians * (180.0 / M_PI));
}
/** counts the number of set bits in a bit flag set.
*
* @param[in] value_ the value to count set bits in.
* @returns the number of set bits in the given value.
*/
template <typename T>
size_t getSetBitCount(T value_)
{
return math::popCount(value_);
}
/** Retrieves the total number of speakers for a given speaker mode.
*
* @param[in] mode the speaker mode to retrieve the speaker count for.
* @returns the number of speakers expected for the requested speaker mode.
* @returns 0 if an unknown speaker count is passed in.
* @returns 0 if @ref kSpeakerModeDefault is passed in.
*/
constexpr size_t getSpeakerCountForMode(SpeakerMode mode)
{
switch (mode)
{
case kSpeakerModeDefault:
return 0;
case kSpeakerModeMono:
return 1;
case kSpeakerModeStereo:
return 2;
case kSpeakerModeQuad:
return 4;
case kSpeakerModeFourPointOne:
return 5;
case kSpeakerModeFivePointOne:
return 6;
case kSpeakerModeSixPointOne:
return 7;
case kSpeakerModeSevenPointOne:
return 8;
case kSpeakerModeNinePointOne:
return 10;
case kSpeakerModeSevenPointOnePointFour:
return 12;
case kSpeakerModeNinePointOnePointFour:
return 14;
case kSpeakerModeNinePointOnePointSix:
return 16;
default:
return getSetBitCount(mode);
}
}
/** retrieves a default speaker mode for a given channel count.
* @param[in] channels the number of channels to get the default speaker mode for.
* @returns a standard speaker mode with the requested channel count.
* @retval kSpeakerModeDefault if no standard speaker mode is defined for the given channel
* count.
*/
constexpr SpeakerMode getSpeakerModeForCount(size_t channels)
{
switch (channels)
{
case 1:
return kSpeakerModeMono;
case 2:
return kSpeakerModeStereo;
case 3:
return kSpeakerModeTwoPointOne;
case 4:
return kSpeakerModeQuad;
case 5:
return kSpeakerModeFourPointOne;
case 6:
return kSpeakerModeFivePointOne;
case 7:
return kSpeakerModeSixPointOne;
case 8:
return kSpeakerModeSevenPointOne;
case 10:
return kSpeakerModeNinePointOne;
case 12:
return kSpeakerModeSevenPointOnePointFour;
case 14:
return kSpeakerModeNinePointOnePointFour;
case 16:
return kSpeakerModeNinePointOnePointSix;
default:
return kSpeakerModeDefault;
}
}
/** calculates a set of speaker flags for a channel count.
*
* @param[in] channels the number of channels to calculate the speaker flags for. This
* should be less than or equal to @ref kMaxChannels.
* @returns a set of speaker flags as a SpeakerMode value representing the number of channels
* that was requested. Note that this will not necessarily be a standard speaker
* mode layout for the given channel count. This should only be used in cases where
* getSpeakerModeForCount() returns @ref kSpeakerModeDefault and a speaker mode value
* other than kSpeakerModeDefault is strictly needed.
*/
constexpr SpeakerMode getSpeakerFlagsForCount(size_t channels)
{
if (channels >= kMaxChannels)
return 0xffffffffffffffffull;
return (1ull << channels) - 1;
}
/** retrieves a speaker name from a single speaker mode flag.
*
* @param[in] flag a single speaker flag to convert to a speaker name. This must be one of
* the fSpeakerFlag* speaker flags.
* @returns one of the @ref Speaker names if converted successfully.
* @retval Speaker::eCount if an invalid speaker flag is passed in.
*/
constexpr Speaker getSpeakerFromSpeakerFlag(SpeakerMode flag)
{
switch (flag)
{
case fSpeakerFlagFrontLeft:
return Speaker::eFrontLeft;
case fSpeakerFlagFrontRight:
return Speaker::eFrontRight;
case fSpeakerFlagFrontCenter:
return Speaker::eFrontCenter;
case fSpeakerFlagLowFrequencyEffect:
return Speaker::eLowFrequencyEffect;
case fSpeakerFlagSideLeft:
return Speaker::eSideLeft;
case fSpeakerFlagSideRight:
return Speaker::eSideRight;
case fSpeakerFlagBackLeft:
return Speaker::eBackLeft;
case fSpeakerFlagBackRight:
return Speaker::eBackRight;
case fSpeakerFlagBackCenter:
return Speaker::eBackCenter;
case fSpeakerFlagTopFrontLeft:
return Speaker::eTopFrontLeft;
case fSpeakerFlagTopFrontRight:
return Speaker::eTopFrontRight;
case fSpeakerFlagTopBackLeft:
return Speaker::eTopBackLeft;
case fSpeakerFlagTopBackRight:
return Speaker::eTopBackRight;
case fSpeakerFlagFrontLeftWide:
return Speaker::eFrontLeftWide;
case fSpeakerFlagFrontRightWide:
return Speaker::eFrontRightWide;
case fSpeakerFlagTopLeft:
return Speaker::eTopLeft;
case fSpeakerFlagTopRight:
return Speaker::eTopRight;
default:
return Speaker::eCount;
}
}
/** retrieves an indexed speaker name from a speaker mode mask.
*
* @param[in] channelMask the channel mask to retrieve one of the speaker names from. This must
* be a combination of one or more of the fSpeakerFlag* flags.
* @param[in] index the zero based index of the speaker name to retrieve. This indicates
* which of the set speaker bits in the channel mask will be converted
* and returned.
* @returns the index of the speaker name of the @p index-th speaker set in the given channel
* mask. This may be cast to a @ref Speaker name if it is less than
* @ref Speaker::eCount. If it is greater than or equal to @ref Speaker::eCount, this
* would represent a custom unnamed speaker in the channel mask. This would be the
* index of the channel's sample in each frame of output data for the given channel
* mask.
* @retval kInvalidSpeakerName if the index is out of range of the number of speakers in
* the given channel mask.
*/
constexpr size_t getSpeakerFromSpeakerMode(SpeakerMode channelMask, size_t index)
{
// no bits set in the channel mask -> nothing to do => fail.
if (channelMask == 0)
return kInvalidSpeakerName;
SpeakerMode bit = 1;
size_t i = 0;
// walk through the channel mask searching for set bits.
for (; bit != 0; bit <<= 1, i++)
{
// no speaker set for this bit => skip it.
if ((channelMask & bit) == 0)
continue;
if (index == 0)
return i;
index--;
}
return kInvalidSpeakerName;
}
/**
* retrieves the number of bits per channel for a given sample format.
*
* @param[in] fmt the sample format to retrieve the bit count for. This may be any of the
* SampleFormat::ePcm* formats. There is no defined bit count for the raw
* and default formats.
* @returns the number of bits per sample associated with the requested sample format.
*/
constexpr size_t sampleFormatToBitsPerSample(SampleFormat fmt)
{
switch (fmt)
{
case SampleFormat::ePcm8:
return 8;
case SampleFormat::ePcm16:
return 16;
case SampleFormat::ePcm24:
return 24;
case SampleFormat::ePcm32:
return 32;
case SampleFormat::ePcmFloat:
return 32;
default:
return 0;
}
}
/** converts a bits per sample count to an integer PCM sample format.
*
* @param[in] bps the bits per sample to convert.
* @returns the integer PCM sample format that corresponds to the requested bit count.
* @retval SampleFormat::eCount if no supported sample format matches the requested
* bit count.
*/
constexpr SampleFormat bitsPerSampleToIntegerPcmSampleFormat(size_t bps)
{
switch (bps)
{
case 8:
return SampleFormat::ePcm8;
case 16:
return SampleFormat::ePcm16;
case 24:
return SampleFormat::ePcm24;
case 32:
return SampleFormat::ePcm32;
default:
return SampleFormat::eCount;
}
}
/**
* converts a time in milliseconds to a frame count.
*
* @param[in] timeInMilliseconds the time in milliseconds to be converted to a frame count.
* @param[in] frameRate the frame rate of the audio that needs a frame count calculated.
* @returns the minimum number of frames required to cover the requested number of milliseconds
* at the requested frame rate. Note that if the time isn't exactly divisible by
* the frame rate, a partial frame may be truncated.
*/
constexpr size_t millisecondsToFrames(size_t timeInMilliseconds, size_t frameRate)
{
return (frameRate * timeInMilliseconds) / 1000;
}
/**
* converts a time in microseconds to a frame count.
*
* @param[in] timeInMicroseconds the time in microseconds to be converted to a frame count.
* @param[in] frameRate the frame rate of the audio that needs a frame count calculated.
* @returns the minimum number of frames required to cover the requested number of microseconds
* at the requested frame rate. Note that if the time isn't exactly divisible by
* the frame rate, a partial frame may be truncated.
*/
constexpr size_t microsecondsToFrames(size_t timeInMicroseconds, size_t frameRate)
{
return (frameRate * timeInMicroseconds) / 1000000;
}
/**
* converts a time in milliseconds to a frame count.
*
* @param[in] timeInMilliseconds the time in milliseconds to be converted to a frame count.
* @param[in] format the format information block for the sound data this time is
* being converted for.
* @returns the minimum number of frames required to cover the requested number of milliseconds
* at the requested frame rate. Note that if the time isn't exactly divisible by
* the frame rate, a partial frame may be truncated.
*/
inline size_t millisecondsToFrames(size_t timeInMilliseconds, const SoundFormat* format)
{
return millisecondsToFrames(timeInMilliseconds, format->frameRate);
}
/**
* converts a time in microseconds to a frame count.
*
* @param[in] timeInMicroseconds the time in microseconds to be converted to a frame count.
* @param[in] format the format information block for the sound data this time is
* being converted for.
* @returns the minimum number of frames required to cover the requested number of microseconds
* at the requested frame rate. Note that if the time isn't exactly divisible by
* the frame rate, a partial frame may be truncated.
*/
inline size_t microsecondsToFrames(size_t timeInMicroseconds, const SoundFormat* format)
{
return microsecondsToFrames(timeInMicroseconds, format->frameRate);
}
/**
* converts a time in milliseconds to a byte count.
*
* @param[in] timeInMilliseconds the time in milliseconds to be converted to a frame count.
* @param[in] frameRate the frame rate of the audio that needs a frame count calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24,
* or 32. This does not properly handle byte offset calculations for
* compressed audio formats.
* @returns the approximate number of bytes of audio data required to fill the requested number
* of milliseconds. Note that this will not be an exact value because the data format
* may not divide evenly into the requested number of milliseconds.
*/
constexpr size_t millisecondsToBytes(size_t timeInMilliseconds, size_t frameRate, size_t channels, size_t bps)
{
return (timeInMilliseconds * frameRate * channels * bps) / (1000 * CHAR_BIT);
}
/**
* converts a time in microseconds to a byte count.
*
* @param[in] timeInMicroseconds the time in microseconds to be converted to a frame count.
* @param[in] frameRate the frame rate of the audio that needs a frame count calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24,
* or 32. This does not properly handle byte offset calculations for
* compressed audio formats.
* @returns the approximate number of bytes of audio data required to fill the requested number
* of microseconds. Note that this will not be an exact value because the data format
* may not divide evenly into the requested number of microseconds.
*/
constexpr size_t microsecondsToBytes(size_t timeInMicroseconds, size_t frameRate, size_t channels, size_t bps)
{
return (timeInMicroseconds * frameRate * channels * bps) / (1000000 * CHAR_BIT);
}
/**
* converts a time in milliseconds to a byte count.
*
* @param[in] timeInMilliseconds the time in milliseconds to be converted to a frame count.
* @param[in] frameRate the frame rate of the audio that needs a frame count calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format for the data. This must be a PCM sample format.
* @returns the approximate number of bytes of audio data required to fill the requested number
* of milliseconds. Note that this will not be an exact value because the data format
* may not divide evenly into the requested number of milliseconds.
*/
constexpr size_t millisecondsToBytes(size_t timeInMilliseconds, size_t frameRate, size_t channels, SampleFormat format)
{
return millisecondsToBytes(timeInMilliseconds, frameRate, channels, sampleFormatToBitsPerSample(format));
}
/**
* converts a time in microseconds to a byte count.
*
* @param[in] timeInMicroseconds the time in microseconds to be converted to a frame count.
* @param[in] frameRate the frame rate of the audio that needs a frame count calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format for the data. This must be a PCM sample format.
* @returns the approximate number of bytes of audio data required to fill the requested number
* of microseconds. Note that this will not be an exact value because the data format
* may not divide evenly into the requested number of microseconds.
*/
constexpr size_t microsecondsToBytes(size_t timeInMicroseconds, size_t frameRate, size_t channels, SampleFormat format)
{
return microsecondsToBytes(timeInMicroseconds, frameRate, channels, sampleFormatToBitsPerSample(format));
}
/**
* converts a time in milliseconds to a byte count.
*
* @param[in] timeInMilliseconds the time in milliseconds to be converted to a frame count.
* @param[in] format the format information block for the sound data this time is
* being converted for.
* @returns the approximate number of bytes of audio data required to fill the requested number
* of milliseconds. Note that this will not be an exact value because the data format
* may not divide evenly into the requested number of milliseconds.
*/
inline size_t millisecondsToBytes(size_t timeInMilliseconds, const SoundFormat* format)
{
return millisecondsToBytes(timeInMilliseconds, format->frameRate, format->channels, format->bitsPerSample);
}
/**
* converts a time in microseconds to a byte count.
*
* @param[in] timeInMicroseconds the time in microseconds to be converted to a frame count.
* @param[in] format the format information block for the sound data this time is
* being converted for.
* @returns the approximate number of bytes of audio data required to fill the requested number
* of microseconds. Note that this will not be an exact value because the data format
* may not divide evenly into the requested number of microseconds.
*/
inline size_t microsecondsToBytes(size_t timeInMicroseconds, const SoundFormat* format)
{
return microsecondsToBytes(timeInMicroseconds, format->frameRate, format->channels, format->bitsPerSample);
}
/**
* converts a frame count at a given frame rate to a time in milliseconds.
*
* @param[in] frames the frame count to be converted.
* @param[in] frameRate the frame rate of the audio that needs a time calculated.
* @returns the time in milliseconds associated with the given number of frames playing at the
* requested frame rate.
*/
constexpr size_t framesToMilliseconds(size_t frames, size_t frameRate)
{
return (frames * 1000) / frameRate;
}
/**
* converts a frame count at a given frame rate to a time in microseconds.
*
* @param[in] frames the frame count to be converted.
* @param[in] frameRate the frame rate of the audio that needs a time calculated.
* @returns the time in microseconds associated with the given number of frames playing at the
* requested frame rate.
*/
constexpr size_t framesToMicroseconds(size_t frames, size_t frameRate)
{
return (frames * 1000000) / frameRate;
}
/**
* converts a frame count at a given frame rate to a time in milliseconds.
*
* @param[in] frames the frame count to be converted.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the time in milliseconds associated with the given number of frames playing at the
* requested frame rate.
*/
inline size_t framesToMilliseconds(size_t frames, const SoundFormat* format)
{
return framesToMilliseconds(frames, format->frameRate);
}
/**
* converts a frame count at a given frame rate to a time in microseconds.
*
* @param[in] frames the frame count to be converted.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the time in microseconds associated with the given number of frames playing at the
* requested frame rate.
*/
inline size_t framesToMicroseconds(size_t frames, const SoundFormat* format)
{
return framesToMicroseconds(frames, format->frameRate);
}
/**
* converts a frame count to a byte offset.
*
* @param[in] frames the frame count to be converted to a byte count.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24, or
* 32. This does not properly handle byte offset calculations for compressed
* audio formats.
* @returns the calculated byte offset to the start of the requested frame of audio data.
*/
constexpr size_t framesToBytes(size_t frames, size_t channels, size_t bps)
{
return (frames * channels * bps) / CHAR_BIT;
}
/**
* converts a frame count to a byte offset.
*
* @param[in] frames the frame count to be converted to a byte count.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format of the data. This must be a PCM sample format.
* @returns the calculated byte offset to the start of the requested frame of audio data.
*/
constexpr size_t framesToBytes(size_t frames, size_t channels, SampleFormat format)
{
return framesToBytes(frames, channels, sampleFormatToBitsPerSample(format));
}
/**
* converts a frame count to a byte offset.
*
* @param[in] frames the frame count to be converted to a byte count.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the calculated byte offset to the start of the requested frame of audio data.
*/
inline size_t framesToBytes(size_t frames, const SoundFormat* format)
{
return framesToBytes(frames, format->channels, format->bitsPerSample);
}
/**
* converts a byte count to a frame count.
*
* @param[in] bytes the number of bytes to be converted to a frame count. Note that this byte
* count is expected to be frame aligned. If it is not frame aligned, the
* return value will be the offset for the frame that includes the requested
* byte offset.
* @param[in] channels the number of channels in the audio data format.
* This may not be 0.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24, or
* 32. This does not properly handle byte offset calculations for compressed
* audio formats.
* This may not be 0.
* @returns the calculated frame offset that will contain the requested byte offset.
*/
constexpr size_t bytesToFrames(size_t bytes, size_t channels, size_t bps)
{
return (bytes * CHAR_BIT) / (channels * bps);
}
/**
* converts a byte count to a frame count.
*
* @param[in] bytes the number of bytes to be converted to a frame count. Note that this byte
* count is expected to be frame aligned. If it is not frame aligned, the
* return value will be the offset for the frame that includes the requested
* byte offset.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format of the data. This must be a PCM sample format.
* @returns the calculated frame offset that will contain the requested byte offset.
*/
constexpr size_t bytesToFrames(size_t bytes, size_t channels, SampleFormat format)
{
size_t bps = sampleFormatToBitsPerSample(format);
if (bps == 0)
{
CARB_LOG_ERROR("attempting to convert bytes to frames in a variable bitrate format (%d), return 0", int(format));
return 0;
}
return bytesToFrames(bytes, channels, bps);
}
/**
* converts a byte count to a frame count.
*
* @param[in] bytes the number of bytes to be converted to a frame count. Note that this byte
* count is expected to be frame aligned. If it is not frame aligned, the
* return value will be the offset for the frame that includes the requested
* byte offset.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* This must be a PCM sample format.
* @returns the calculated frame offset that will contain the requested byte offset.
*/
inline size_t bytesToFrames(size_t bytes, const SoundFormat* format)
{
if (format->bitsPerSample == 0)
{
CARB_LOG_ERROR(
"attempting to convert bytes to frames in a variable bitrate format (%d), return 0", int(format->format));
return 0;
}
return bytesToFrames(bytes, format->channels, format->bitsPerSample);
}
/**
* converts a byte count to an approximate time in milliseconds.
*
* @param[in] bytes the number of bytes to be converted to a time in milliseconds. Note that
* this byte count is expected to be frame aligned.
* @param[in] frameRate the frame rate of the audio that needs a time calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24, or
* 32. This does not properly handle byte offset calculations for compressed
* audio formats.
* @returns the approximate number of milliseconds of audio data that the requested byte count
* represents for the given format.
*/
constexpr size_t bytesToMilliseconds(size_t bytes, size_t frameRate, size_t channels, size_t bps)
{
return (bytesToFrames(bytes * 1000, channels, bps)) / frameRate;
}
/**
* converts a byte count to an approximate time in microseconds.
*
* @param[in] bytes the number of bytes to be converted to a time in microseconds. Note that
* this byte count is expected to be frame aligned.
* @param[in] frameRate the frame rate of the audio that needs a time calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24, or
* 32. This does not properly handle byte offset calculations for compressed
* audio formats.
* @returns the approximate number of microseconds of audio data that the requested byte count
* represents for the given format.
*/
constexpr size_t bytesToMicroseconds(size_t bytes, size_t frameRate, size_t channels, size_t bps)
{
return bytesToFrames(bytes * 1000000, channels, bps) / frameRate;
}
/**
* converts a byte count to an approximate time in milliseconds.
*
* @param[in] bytes the number of bytes to be converted to a time in milliseconds. Note that
* this byte count is expected to be frame aligned.
* @param[in] frameRate the frame rate of the audio that needs a time calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format of the data. This must be a PCM sample format.
* @returns the approximate number of milliseconds of audio data that the requested byte count
* represents for the given format.
*/
constexpr size_t bytesToMilliseconds(size_t bytes, size_t frameRate, size_t channels, SampleFormat format)
{
return bytesToMilliseconds(bytes, frameRate, channels, sampleFormatToBitsPerSample(format));
}
/**
* converts a byte count to an approximate time in microseconds.
*
* @param[in] bytes the number of bytes to be converted to a time in microseconds. Note that
* this byte count is expected to be frame aligned.
* @param[in] frameRate the frame rate of the audio that needs a time calculated.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format of the data. This must be a PCM sample format.
* @returns the approximate number of microseconds of audio data that the requested byte count
* represents for the given format.
*/
constexpr size_t bytesToMicroseconds(size_t bytes, size_t frameRate, size_t channels, SampleFormat format)
{
return bytesToMicroseconds(bytes, frameRate, channels, sampleFormatToBitsPerSample(format));
}
/**
* converts a byte count to an approximate time in milliseconds.
*
* @param[in] bytes the number of bytes to be converted to a time in milliseconds. Note that
* this byte count is expected to be frame aligned.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the approximate number of milliseconds of audio data that the requested byte count
* represents for the given format.
*/
inline size_t bytesToMilliseconds(size_t bytes, const SoundFormat* format)
{
return bytesToMilliseconds(bytes, format->frameRate, format->channels, format->bitsPerSample);
}
/**
* converts a byte count to an approximate time in microseconds.
*
* @param[in] bytes the number of bytes to be converted to a time in microseconds. Note that
* this byte count is expected to be frame aligned.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the approximate number of microseconds of audio data that the requested byte count
* represents for the given format.
*/
inline size_t bytesToMicroseconds(size_t bytes, const SoundFormat* format)
{
return bytesToMicroseconds(bytes, format->frameRate, format->channels, format->bitsPerSample);
}
/**
* converts an input value from one unit to another.
*
* @param[in] input the input value to be converted.
* @param[in] inputUnits the units to convert the @p input value from.
* @param[in] outputUnits the units to convert the @p input value to.
* @param[in] format the format information for the sound that the input value is being
* converted for. This may not be nullptr.
* @returns the converted value in the requested output units.
* @returns 0 if an invalid input or output unit value was given.
*/
inline size_t convertUnits(size_t input, UnitType inputUnits, UnitType outputUnits, const SoundFormat* format)
{
CARB_ASSERT(format != nullptr);
switch (inputUnits)
{
case UnitType::eBytes:
switch (outputUnits)
{
case UnitType::eBytes:
return input;
case UnitType::eFrames:
return bytesToFrames(input, format);
case UnitType::eMilliseconds:
return bytesToMilliseconds(input, format);
case UnitType::eMicroseconds:
return bytesToMicroseconds(input, format);
default:
break;
}
break;
case UnitType::eFrames:
switch (outputUnits)
{
case UnitType::eBytes:
return framesToBytes(input, format);
case UnitType::eFrames:
return input;
case UnitType::eMilliseconds:
return framesToMilliseconds(input, format);
case UnitType::eMicroseconds:
return framesToMicroseconds(input, format);
default:
break;
}
break;
case UnitType::eMilliseconds:
switch (outputUnits)
{
case UnitType::eBytes:
return millisecondsToBytes(input, format);
case UnitType::eFrames:
return millisecondsToFrames(input, format);
case UnitType::eMilliseconds:
return input;
case UnitType::eMicroseconds:
return input * 1000;
default:
break;
}
break;
case UnitType::eMicroseconds:
switch (outputUnits)
{
case UnitType::eBytes:
return microsecondsToBytes(input, format);
case UnitType::eFrames:
return microsecondsToFrames(input, format);
case UnitType::eMilliseconds:
return input / 1000;
case UnitType::eMicroseconds:
return input;
default:
break;
}
break;
default:
break;
}
return 0;
}
/**
* aligns a byte count to a frame boundary for an audio data format.
*
* @param[in] bytes the byte count to align to a frame boundary. This will be aligned to the
* next higher frame boundary if it is not already aligned.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24, or
* 32. This does not properly handle byte offset calculations for compressed
* audio formats.
* @returns the requested byte count aligned to the next frame boundary if it is not already
* aligned.
* @returns the requested byte count unmodified if it is already aligned to a frame boundary.
*/
constexpr size_t alignBytesToFrameCeil(size_t bytes, size_t channels, size_t bps)
{
size_t blockSize = (channels * bps) / CHAR_BIT;
size_t count = bytes + (blockSize - 1);
return count - (count % blockSize);
}
/**
* aligns a byte count to a frame boundary for an audio data format.
*
* @param[in] bytes the byte count to align to a frame boundary. This will be aligned to the
* next higher frame boundary if it is not already aligned.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format of the data. This must be a PCM sample format.
* @returns the requested byte count aligned to the next frame boundary if it is not already
* aligned.
* @returns the requested byte count unmodified if it is already aligned to a frame boundary.
*/
inline size_t alignBytesToFrameCeil(size_t bytes, size_t channels, SampleFormat format)
{
return alignBytesToFrameCeil(bytes, channels, sampleFormatToBitsPerSample(format));
}
/**
* aligns a byte count to a frame boundary for an audio data format.
*
* @param[in] bytes the byte count to align to a frame boundary. This will be aligned to the
* next higher frame boundary if it is not already aligned.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the requested byte count aligned to the next frame boundary if it is not already
* aligned.
* @returns the requested byte count unmodified if it is already aligned to a frame boundary.
*/
inline size_t alignBytesToFrameCeil(size_t bytes, const SoundFormat* format)
{
return alignBytesToFrameCeil(bytes, format->channels, format->bitsPerSample);
}
/**
* aligns a byte count to a frame boundary for an audio data format.
*
* @param[in] bytes the byte count to align to a frame boundary. This will be aligned to the
* previous frame boundary if it is not already aligned.
* @param[in] channels the number of channels in the audio data format.
* @param[in] bps the number of bits per sample of audio data. This must be 8, 16, 24, or
* 32. This does not properly handle byte offset calculations for compressed
* audio formats.
* @returns the requested byte count aligned to the previous frame boundary if it is not already
* aligned.
* @returns the requested byte count unmodified if it is already aligned to a frame boundary.
*/
constexpr size_t alignBytesToFrameFloor(size_t bytes, size_t channels, size_t bps)
{
size_t blockSize = (channels * bps) / CHAR_BIT;
return bytes - (bytes % blockSize);
}
/**
* aligns a byte count to a frame boundary for an audio data format.
*
* @param[in] bytes the byte count to align to a frame boundary. This will be aligned to the
* previous frame boundary if it is not already aligned.
* @param[in] channels the number of channels in the audio data format.
* @param[in] format the sample format of the data. This must be a PCM sample format.
* @returns the requested byte count aligned to the previous frame boundary if it is not already
* aligned.
* @returns the requested byte count unmodified if it is already aligned to a frame boundary.
*/
constexpr size_t alignBytesToFrameFloor(size_t bytes, size_t channels, SampleFormat format)
{
return alignBytesToFrameFloor(bytes, channels, sampleFormatToBitsPerSample(format));
}
/**
* aligns a byte count to a frame boundary for an audio data format.
*
* @param[in] bytes the byte count to align to a frame boundary. This will be aligned to the
* previous frame boundary if it is not already aligned.
* @param[in] format the format information block for the sound data this time is being
* converted for.
* @returns the requested byte count aligned to the previous frame boundary if it is not already
* aligned.
* @returns the requested byte count unmodified if it is already aligned to a frame boundary.
*/
inline size_t alignBytesToFrameFloor(size_t bytes, const SoundFormat* format)
{
return alignBytesToFrameFloor(bytes, format->channels, format->bitsPerSample);
}
/**
* Generates a SoundFormat based on the 4 parameters given.
* @param[out] out The SoundFormat to generate.
* @param[in] format The format of the samples in the sound.
* @param[in] frameRate The frame rate of t
* @param[in] channels The number of channels in the sound.
* @param[in] mask The speaker mask of the sound.
*/
inline void generateSoundFormat(
SoundFormat* out, SampleFormat format, size_t channels, size_t frameRate, SpeakerMode mask = kSpeakerModeDefault)
{
out->channels = channels;
out->format = format;
out->frameRate = frameRate;
out->bitsPerSample = sampleFormatToBitsPerSample(out->format);
out->frameSize = out->bitsPerSample / CHAR_BIT * out->channels;
out->blockSize = out->frameSize; // PCM is 1 frame per block
out->framesPerBlock = 1;
out->channelMask = mask;
out->validBitsPerSample = out->bitsPerSample;
}
/**
* Initialize a SoundDataLoadDesc to its defaults.
* @param[out] desc The desc to initialize.
*
* @remarks This initializes @p desc to a set of default values.
* This is useful for cases where only a small subset of members need
* to be changed, since this will initialize the entire struct to
* no-op values. For example, when loading a sound from a file name,
* only @p desc->name and @p desc->flags need to be modified.
*
* @note This function is deprecated and should no longer be used. This
* can be replaced by simply initializing the descriptor with "= {}".
*/
inline void getSoundDataLoadDescDefaults(SoundDataLoadDesc* desc)
{
*desc = {};
}
/**
* Initialize a PlaySoundDesc to its defaults.
* @param[out] desc The desc to initialize.
*
* @remarks This initializes @p desc to a set of default values.
* This is useful for cases where only a small subset of members need
* to be changed, since this will initialize the entire struct to
* no-op values. For example, when playing a one shot sound, only
* @p desc->sound will need to be modified.
*
* @note This function is deprecated and should no longer be used. This
* can be replaced by simply initializing the descriptor with "= {}".
*/
inline void getPlaySoundDescDefaults(PlaySoundDesc* desc)
{
*desc = {};
}
/** fills a cone descriptor with the default cone values.
*
* @param[out] cone the cone descriptor to fill in.
* @returns no return value.
*
* @remarks This fills in a cone descriptor with the default values. Note that the cone
* descriptor doesn't have an implicit constructor because it is intended to be
* a sparse struct that generally does not need to be fully initialized.
*/
inline void getConeDefaults(EntityCone* cone)
{
cone->insideAngle = kConeAngleOmnidirectional;
cone->outsideAngle = kConeAngleOmnidirectional;
cone->volume = { 1.0f, 0.0f };
cone->lowPassFilter = { 0.0f, 1.0f };
cone->reverb = { 0.0f, 1.0f };
cone->ext = nullptr;
}
/** fills a rolloff descriptor with the default rolloff values.
*
* @param[out] desc the rolloff descriptor to fill in.
* @returns no return value.
*
* @remarks This fills in a rolloff descriptor with the default values. Note that the
* rolloff descriptor doesn't have an implicit constructor because it is intended
* to be a sparse struct that generally does not need to be fully initialized.
*/
inline void getRolloffDefaults(RolloffDesc* desc)
{
desc->type = RolloffType::eInverse;
desc->nearDistance = 0.0f;
desc->farDistance = 10000.0f;
desc->volume = nullptr;
desc->lowFrequency = nullptr;
desc->lowPassDirect = nullptr;
desc->lowPassReverb = nullptr;
desc->reverb = nullptr;
desc->ext = nullptr;
}
/** Create an empty SoundData of a specific length.
* @param[in] iface The IAudioData interface to use.
* @param[in] fmt The sample format for the sound.
* @param[in] frameRate The frame rate of the sound.
* @param[in] channels The number of channels for the sound.
* @param[in] bufferLength The length of the sound's buffer as a measure of @p unitType.
* @param[in] unitType The unit type to use for @p bufferLength.
* @param[in] name The name to give the sound, if desired.
*
* @returns The created sound with empty buffer with the valid length set to 0.
* The valid length should be set after the sound's buffer is filled.
* @returns nullptr if @p fmt, @p frameRate or @p channels are invalid or out
* of range.
* @returns nullptr if creation failed unexpectedly (such as out of memory).
*
*/
inline SoundData* createEmptySound(const IAudioData* iface,
SampleFormat fmt,
size_t frameRate,
size_t channels,
size_t bufferLength,
UnitType unitType = UnitType::eFrames,
const char* name = nullptr)
{
SoundDataLoadDesc desc = {};
desc.flags |= fDataFlagEmpty;
if (name == nullptr)
desc.flags |= fDataFlagNoName;
desc.name = name;
desc.pcmFormat = fmt;
desc.frameRate = frameRate;
desc.channels = channels;
desc.bufferLength = bufferLength;
desc.bufferLengthType = unitType;
return iface->createData(&desc);
}
/** Convert a sound to a new sample format.
* @param[in] iface The IAudioData interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] newFmt The new format to set the sound to.
* This can be any valid format; setting this to a PCM format
* will cause the output to be a blob of PCM data.
* @returns The new sound data created. @p snd and the returned value must both
* be released after this call once the caller is finished with them.
* @returns nullptr if the operation failed or the specified format was invalid.
*
* @note When converting to any format with specific encoder settings, these
* will be left at their defaults.
*/
inline SoundData* convertSoundFormat(const IAudioUtils* iface, SoundData* snd, SampleFormat newFmt)
{
ConversionDesc desc = {};
desc.flags = fConvertFlagCopy;
desc.soundData = snd;
desc.newFormat = newFmt;
return iface->convert(&desc);
}
/** Convert a sound to Vorbis.
* @param[in] iface The IAudioData interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] quality @copydoc VorbisEncoderSettings::quality
* @param[in] nativeChannelOrder @copydoc VorbisEncoderSettings::nativeChannelOrder
*
* @returns The new sound data created. @p snd and the returned value must both
* be released after this call once the caller is finished with them.
* @returns nullptr if the operation failed.
*/
inline SoundData* convertToVorbis(const IAudioUtils* iface,
SoundData* snd,
float quality = 0.9f,
bool nativeChannelOrder = false)
{
VorbisEncoderSettings vorbis = {};
ConversionDesc desc = {};
desc.flags = fConvertFlagCopy;
desc.soundData = snd;
desc.newFormat = SampleFormat::eVorbis;
desc.encoderSettings = &vorbis;
vorbis.quality = quality;
vorbis.nativeChannelOrder = nativeChannelOrder;
return iface->convert(&desc);
}
/** Convert a sound to FLAC.
* @param[in] iface The IAudioData interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] compressionLevel Compression level.
* See @ref FlacEncoderSettings::compressionLevel.
* @param[in] bitsPerSample Bit precision of each audio sample.
* 0 will automatically choose the appropriate
* value for the input sample type.
* See @ref FlacEncoderSettings::bitsPerSample.
* @param[in] fileType File container type.
* See @ref FlacEncoderSettings::fileType.
* @param[in] streamableSubset Whether the streamable subset is used.
* Using the default value is recommended.
* See @ref FlacEncoderSettings::streamableSubset.
* @param[in] blockSize Block size used by the encoder.
* 0 will let the encoder choose.
* Letting the encoder choose is recommended.
* See @ref FlacEncoderSettings::blockSize.
* @param[in] verifyOutput Whether output Verification should be enabled.
* See @ref FlacEncoderSettings::verifyOutput.
*
* @returns The new sound data created. @p snd and the returned value must both
* be released after this call once the caller is finished with them.
* @returns nullptr if the operation failed.
* @returns nullptr if the encoding parameters were invalid.
*
* @note It is not recommended to set the encoder settings, apart from
* @p compressionLevel, to anything other than their defaults under most
* circumstances.
*/
inline SoundData* convertToFlac(const IAudioUtils* iface,
SoundData* snd,
uint32_t compressionLevel = 5,
uint32_t bitsPerSample = 0,
FlacFileType fileType = FlacFileType::eFlac,
bool streamableSubset = true,
uint32_t blockSize = 0,
bool verifyOutput = false)
{
FlacEncoderSettings flac = {};
ConversionDesc desc = {};
desc.flags = fConvertFlagCopy;
desc.soundData = snd;
desc.newFormat = SampleFormat::eFlac;
desc.encoderSettings = &flac;
flac.compressionLevel = compressionLevel;
flac.bitsPerSample = bitsPerSample;
flac.fileType = fileType;
flac.streamableSubset = streamableSubset;
flac.blockSize = blockSize;
flac.verifyOutput = verifyOutput;
return iface->convert(&desc);
}
/** Save a sound to disk.
* @param[in] iface The IAudioUtils interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] fileName The path to the file on disk to save this to.
* @param[in] fmt The format to save the sound as.
* This can be any valid format.
* @param[in] flags Flags to alter the behavior of this function.
* @returns true if the sound was successfully saved.
* @returns false if the operation failed.
*
* @note When converting to any format with specific encoder settings, these
* will be left at their defaults.
*/
inline bool saveSoundToDisk(const IAudioUtils* iface,
SoundData* snd,
const char* fileName,
SampleFormat fmt = SampleFormat::eDefault,
SaveFlags flags = 0)
{
SoundDataSaveDesc desc = {};
desc.flags = flags;
desc.format = fmt;
desc.soundData = snd;
desc.filename = fileName;
return iface->saveToFile(&desc);
}
/** Save a sound to disk as Vorbis.
* @param[in] iface The IAudioUtils interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] fileName The path to the file on disk to save this to.
* @param[in] quality @copydoc VorbisEncoderSettings::quality
* @param[in] nativeChannelOrder @copydoc VorbisEncoderSettings::nativeChannelOrder
* @param[in] flags Flags to alter the behavior of this function.
*
* @returns true if the sound was successfully saved.
* @returns false if the operation failed.
*/
inline bool saveToDiskAsVorbis(const IAudioUtils* iface,
SoundData* snd,
const char* fileName,
float quality = 0.9f,
bool nativeChannelOrder = false,
SaveFlags flags = 0)
{
VorbisEncoderSettings vorbis = {};
SoundDataSaveDesc desc = {};
desc.flags = flags;
desc.format = SampleFormat::eVorbis;
desc.soundData = snd;
desc.filename = fileName;
desc.encoderSettings = &vorbis;
vorbis.quality = quality;
vorbis.nativeChannelOrder = nativeChannelOrder;
return iface->saveToFile(&desc);
}
/** Convert a sound to FLAC.
* @param[in] iface The IAudioData interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] fileName The name of the file on disk to create the
* new sound data object from.
* This may not be nullptr.
* @param[in] compressionLevel Compression level.
* See @ref FlacEncoderSettings::compressionLevel.
* @param[in] bitsPerSample Bit precision of each audio sample.
* 0 will automatically choose the appropriate
* value for the input sample type.
* See @ref FlacEncoderSettings::bitsPerSample.
* @param[in] fileType File container type.
* See @ref FlacEncoderSettings::fileType.
* @param[in] streamableSubset Whether the streamable subset is used.
* Using the default value is recommended.
* See @ref FlacEncoderSettings::streamableSubset.
* @param[in] blockSize Block size used by the encoder.
* 0 will let the encoder choose.
* Letting the encoder choose is recommended.
* See @ref FlacEncoderSettings::blockSize.
* @param[in] verifyOutput Whether output Verification should be enabled.
* See @ref FlacEncoderSettings::verifyOutput.
* @param[in] flags Flags to alter the behavior of this function.
*
*
* @returns true if the sound was successfully saved.
* @returns false if the operation failed.
*
* @note It is not recommended to set the encoder settings, apart from
* @p compressionLevel, to anything other than their defaults under most
* circumstances.
*/
inline bool saveToDiskAsFlac(const IAudioUtils* iface,
SoundData* snd,
const char* fileName,
uint32_t compressionLevel = 5,
uint32_t bitsPerSample = 0,
FlacFileType fileType = FlacFileType::eFlac,
bool streamableSubset = true,
uint32_t blockSize = 0,
bool verifyOutput = false,
SaveFlags flags = 0)
{
FlacEncoderSettings flac = {};
carb::audio::SoundDataSaveDesc desc = {};
desc.flags = flags;
desc.format = SampleFormat::eFlac;
desc.soundData = snd;
desc.filename = fileName;
desc.encoderSettings = &flac;
flac.compressionLevel = compressionLevel;
flac.bitsPerSample = bitsPerSample;
flac.fileType = fileType;
flac.streamableSubset = streamableSubset;
flac.blockSize = blockSize;
flac.verifyOutput = verifyOutput;
return iface->saveToFile(&desc);
}
/** Convert a sound to Opus.
* @param[in] iface The IAudioData interface to use.
* @param[in] snd The sound to convert to a new format.
* This may not be nullptr.
* @param[in] fileName The name of the file on disk to create the
* new sound data object from.
* This may not be nullptr.
* @param[in] bitrate @copydoc OpusEncoderSettings::bitrate
* @param[in] usage @copydoc OpusEncoderSettings::usage
* @param[in] complexity @copydoc OpusEncoderSettings::complexity
* @param[in] bitDepth @copydoc OpusEncoderSettings::bitDepth
* @param[in] blockSize @copydoc OpusEncoderSettings::blockSize
* @param[in] bandwidth @copydoc OpusEncoderSettings::bandwidth
* @param[in] outputGain @copydoc OpusEncoderSettings::outputGain
* @param[in] packetLoss @copydoc OpusEncoderSettings::packetLoss
* @param[in] flags @copydoc OpusEncoderSettings::flags
* @param[in] saveFlags Flags to alter the behavior of this function.
*
* @returns true if the sound was successfully saved.
* @returns false if the operation failed.
*
* @note For general purpose audio use (e.g. saving recorded audio to disk for
* storage), you should at most modify @p bitrate, @p usage and @p complexity.
* For storing very heavily compressed audio, you may also want to set
* @p bandwidth and @p bitDepth.
* The rest of the options are mainly for encoding you intend to transmit
* over a network or miscellaneous purposes.
*/
inline bool saveToDiskAsOpus(const IAudioUtils* iface,
SoundData* snd,
const char* fileName,
uint32_t bitrate = 0,
OpusCodecUsage usage = OpusCodecUsage::eGeneral,
int8_t complexity = -1,
uint8_t blockSize = 48,
uint8_t packetLoss = 0,
uint8_t bandwidth = 20,
uint8_t bitDepth = 0,
int16_t outputGain = 0,
OpusEncoderFlags flags = 0,
SaveFlags saveFlags = 0)
{
OpusEncoderSettings opus = {};
carb::audio::SoundDataSaveDesc desc = {};
desc.flags = saveFlags;
desc.format = SampleFormat::eOpus;
desc.soundData = snd;
desc.filename = fileName;
desc.encoderSettings = &opus;
opus.flags = flags;
opus.bitrate = bitrate;
opus.usage = usage;
opus.complexity = complexity;
opus.blockSize = blockSize;
opus.packetLoss = packetLoss;
opus.bandwidth = bandwidth;
opus.bitDepth = bitDepth;
opus.outputGain = outputGain;
return iface->saveToFile(&desc);
}
/** create a sound data object from a file on disk.
*
* @param[in] iface The IAudioData interface to use.
* @param[in] filename The name of the file on disk to create the new sound
* data object from. This may not be nullptr.
* @param[in] streaming set to true to create a streaming sound. This will
* be decoded as it plays. Set to false to decode the
* sound immediately on load.
* @param[in] autoStream The threshold in bytes at which the new sound data
* object will decide to stream instead of decode into
* memory. If the decoded size of the sound will be
* larger than this value, it will be streamed from its
* original source instead of decoded. Set this to 0
* to disable auto-streaming.
* @param[in] fmt The format the sound should be decoded into. By
* default, the decoder choose its preferred format.
* @param[in] flags Optional flags to change the behavior.
* This can be any of: @ref fDataFlagSkipMetaData,
* @ref fDataFlagSkipEventPoints or @ref fDataFlagCalcPeaks.
* @returns The new sound data if successfully created and loaded. This
* object must be released once it is no longer needed.
* @returns nullptr if the operation failed. This may include the file
* not being accessible, the file's data not being the correct
* format, or a decoding error occurs.
*/
inline SoundData* createSoundFromFile(const IAudioData* iface,
const char* filename,
bool streaming = false,
size_t autoStream = 0,
SampleFormat fmt = SampleFormat::eDefault,
DataFlags flags = 0)
{
constexpr DataFlags kValidFlags = fDataFlagSkipMetaData | fDataFlagSkipEventPoints | fDataFlagCalcPeaks;
SoundDataLoadDesc desc = {};
if ((flags & ~kValidFlags) != 0)
{
CARB_LOG_ERROR("invalid flags 0x%08" PRIx32, flags);
return nullptr;
}
desc.flags = flags;
desc.name = filename;
desc.pcmFormat = fmt;
desc.autoStreamThreshold = autoStream;
if (streaming)
desc.flags |= fDataFlagStream;
else
desc.flags |= fDataFlagDecode;
return iface->createData(&desc);
}
/** create a sound data object from a blob in memory.
*
* @param[in] iface The IAudioData interface to use.
* @param[in] dataBlob the blob of data to load the asset from. This may
* not be nullptr. This should include the entire
* contents of the original asset file.
* @param[in] dataLength the length of the data blob in bytes. This may not
* be zero.
* @param[in] streaming set to true to create a streaming sound. This will
* be decoded as it plays. Set to false to decode the
* sound immediately on load.
* @param[in] autoStream The threshold in bytes at which the new sound data
* object will decide to stream instead of decode into
* memory. If the decoded size of the sound will be
* larger than this value, it will be streamed from its
* original source instead of decoded. Set this to 0
* to disable auto-streaming. This will be ignored if
* the data is already uncompressed PCM.
* @param[in] fmt The format the sound should be decoded into. By
* default, the decoder choose its preferred format.
* @param[in] flags Optional flags to change the behavior.
* This can be any of: @ref fDataFlagSkipMetaData,
* @ref fDataFlagSkipEventPoints, @ref fDataFlagCalcPeaks
* or @ref fDataFlagUserMemory.
*
*
* @returns The new sound data if successfully created and loaded. This
* object must be released once it is no longer needed.
* @returns nullptr if the operation failed. This may include the file
* not being accessible, the file's data not being the correct
* format, or a decoding error occurs.
*/
inline SoundData* createSoundFromBlob(const IAudioData* iface,
const void* dataBlob,
size_t dataLength,
bool streaming = false,
size_t autoStream = 0,
SampleFormat fmt = SampleFormat::eDefault,
DataFlags flags = 0)
{
constexpr DataFlags kValidFlags =
fDataFlagSkipMetaData | fDataFlagSkipEventPoints | fDataFlagCalcPeaks | fDataFlagUserMemory;
SoundDataLoadDesc desc = {};
if ((flags & ~kValidFlags) != 0)
{
CARB_LOG_ERROR("invalid flags 0x%08" PRIx32, flags);
return nullptr;
}
desc.flags = fDataFlagInMemory | flags;
desc.dataBlob = dataBlob;
desc.dataBlobLengthInBytes = dataLength;
desc.pcmFormat = fmt;
desc.autoStreamThreshold = autoStream;
if (streaming)
desc.flags |= fDataFlagStream;
else
desc.flags |= fDataFlagDecode;
return iface->createData(&desc);
}
/** Creates a sound data object from a blob of memory.
* @param[in] iface The audio data interface to use.
* @param[in] dataBlob The buffer of data to use to create a sound data object.
* @param[in] dataLength The length of @p buffer in bytes.
* @param[in] frames The number of frames of data in @p buffer.
* @param[in] format The data format to use to interpret the data in @p buffer.
* @returns A new sound data object containing the data in @p buffer if successfully created.
* @returns nullptr if a new sound data object could not be created.
*/
inline SoundData* createSoundFromRawPcmBlob(
const IAudioData* iface, const void* dataBlob, size_t dataLength, size_t frames, const SoundFormat* format)
{
SoundDataLoadDesc desc = {};
desc.flags = carb::audio::fDataFlagFormatRaw | carb::audio::fDataFlagInMemory;
desc.dataBlob = dataBlob;
desc.dataBlobLengthInBytes = dataLength;
desc.channels = format->channels;
desc.frameRate = format->frameRate;
desc.encodedFormat = format->format;
desc.pcmFormat = format->format;
desc.bufferLength = frames;
desc.bufferLengthType = carb::audio::UnitType::eFrames;
return iface->createData(&desc);
}
/** Play a sound with no special parameters.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] ctx The context to play the sound on.
* @param[in] snd The sound to play.
* @param[in] spatial This chooses whether the sound is played as spatial or non-spatial.
*/
inline Voice* playOneShotSound(const IAudioPlayback* iface, Context* ctx, SoundData* snd, bool spatial = false)
{
PlaySoundDesc desc = {};
VoiceParams params = {};
// desc to play the sound once fully in a non-spatial manner
desc.sound = snd;
if (spatial)
{
desc.validParams = fVoiceParamPlaybackMode;
desc.params = ¶ms;
params.playbackMode = fPlaybackModeSpatial;
}
return iface->playSound(ctx, &desc);
}
/** Play a sound sound that loops.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] ctx The context to play the sound on.
* @param[in] snd The sound to play.
* @param[in] loopCount The number of times the sound will loop.
* @param[in] spatial This chooses whether the sound is played as spatial or non-spatial.
* @remarks This plays a sound which loops through the full sound a given
* number of times (or an infinite number of times if desired).
*/
inline Voice* playLoopingSound(const IAudioPlayback* iface,
Context* ctx,
SoundData* snd,
size_t loopCount = kEventPointLoopInfinite,
bool spatial = false)
{
EventPoint loopPoint = {};
PlaySoundDesc desc = {};
VoiceParams params = {};
// desc to play the sound once fully in a non-spatial manner
desc.sound = snd;
desc.loopPoint.loopPoint = &loopPoint;
loopPoint.loopCount = loopCount;
if (spatial)
{
desc.validParams = fVoiceParamPlaybackMode;
desc.params = ¶ms;
params.playbackMode = fPlaybackModeSpatial;
}
return iface->playSound(ctx, &desc);
}
/** Set the volume of a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to alter.
* @param[in] volume The new volume to set on @p voice.
*/
inline void setVoiceVolume(const IAudioPlayback* iface, Voice* voice, float volume)
{
carb::audio::VoiceParams params = {};
params.volume = volume;
iface->setVoiceParameters(voice, fVoiceParamVolume, ¶ms);
}
/** Set the frequencyRatio of a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to alter.
* @param[in] frequencyRatio The new volume to set on @p voice.
*/
inline void setVoiceFrequencyRatio(const IAudioPlayback* iface, Voice* voice, float frequencyRatio)
{
carb::audio::VoiceParams params = {};
params.frequencyRatio = frequencyRatio;
iface->setVoiceParameters(voice, fVoiceParamFrequencyRatio, ¶ms);
}
/** Pause a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to pause.
*/
inline void pauseVoice(const IAudioPlayback* iface, Voice* voice)
{
carb::audio::VoiceParams params = {};
params.playbackMode = fPlaybackModePaused;
iface->setVoiceParameters(voice, fVoiceParamPause, ¶ms);
}
/** Unpause a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to unpause.
*/
inline void unpauseVoice(const IAudioPlayback* iface, Voice* voice)
{
carb::audio::VoiceParams params = {};
iface->setVoiceParameters(voice, fVoiceParamPause, ¶ms);
}
/** Mute a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to mute.
*/
inline void muteVoice(const IAudioPlayback* iface, Voice* voice)
{
carb::audio::VoiceParams params = {};
params.playbackMode = fPlaybackModeMuted;
iface->setVoiceParameters(voice, fVoiceParamMute, ¶ms);
}
/** Unmute a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to unmute.
*/
inline void unmuteVoice(const IAudioPlayback* iface, Voice* voice)
{
carb::audio::VoiceParams params = {};
iface->setVoiceParameters(voice, fVoiceParamMute, ¶ms);
}
/** Set the matrix of a voice.
* @param[in] iface The IAudioPlayback interface to use.
* @param[in] voice The voice to alter.
* @param[in] matrix The new matrix to set on @p voice.
* This can be nullptr to revert to a default matrix.
*/
inline void setVoiceMatrix(const IAudioPlayback* iface, Voice* voice, const float* matrix)
{
carb::audio::VoiceParams params = {};
params.matrix = matrix;
iface->setVoiceParameters(voice, fVoiceParamMatrix, ¶ms);
}
/** Calculate the gain parameter for an Opus encoder from a floating point gain.
* @param[in] gain The floating point gain to convert to an Opus gain parameter.
* This must be between [-128, 128] or it will be clamped.
*
* @returns A gain value that can be used as a parameter to an Opus encoder.
* This is a signed 16 bit fixed point value with 8 fractional bits.
*/
inline int16_t calculateOpusGain(float gain)
{
// multiply by 256 to convert this into a s7.8 fixed point value.
// IEEE754 float has 23 bits in the mantissa, so we can represent the 16
// bit range losslessly with a float
gain *= 256.f;
// clamp the result in case the gain was too large, then truncate the
// fractional part
return int16_t(CARB_CLAMP(gain, float(INT16_MIN), float(INT16_MAX)));
}
/** Calculate a decibel gain value from a linear volume scale.
* @param[in] linear The linear float scale value to convert to a gain value.
*
* @returns The gain value that will produce a linear volume scale of @p linear.
*/
inline float calculateGainFromLinearScale(float linear)
{
// gain is calculated as 20 * log10(linear)
return 20.f * log10f(linear);
}
/** Calculate the linear volume scale from a decibel gain level.
* @param[in] gain The gain value to be converted to a linear scale.
* This parameter should be a fairly small number; for
* example, -186.64 is approximately the decibel gain level
* of the noise floor for 32 bit audio.
*
* @returns The linear volume scale produced by gain @p gain.
*/
inline float calculateLinearScaleFromGain(float gain)
{
return powf(10, gain * (1.f / 20.f));
}
/** Increment a counter with a non-power-of-2 modulo.
* @param[in] counter The counter value to increment.
* This must be less than @p modulo.
* @param[in] modulo The value to perform a modulo by.
* This may not be 0.
*
* @returns @p counter incremented and wrapped around @p modulo.
*
* @remarks This function exists to perform a modulo around a non-power-of-2
* modulo without having to duplicate the wrap code in multiple places.
* Note that this is considerably more efficient than use of the %
* operator where a power-of-2 optimization cannot be made.
*/
inline size_t incrementWithWrap(size_t counter, size_t modulo)
{
CARB_ASSERT(modulo > 0);
CARB_ASSERT(counter < modulo);
return (counter + 1 == modulo) ? 0 : counter + 1;
}
/** Decrement a counter with a non-power-of-2 modulo.
* @param[in] counter The counter value to increment.
* This must be less than or equal to @p modulo.
* @p counter == @p modulo is allowed for some edge cases
* where it's useful.
* @param[in] modulo The value to perform a modulo by.
* This may not be 0.
*
* @returns @p counter incremented and wrapped around @p modulo.
*
* @remarks This function exists to perform a modulo around a non-power-of-2
* modulo without having to duplicate the wrap code in multiple places.
* Note that % does not work for decrementing with a non-power-of-2 modulo.
*/
inline size_t decrementWithWrap(size_t counter, size_t modulo)
{
CARB_ASSERT(modulo > 0);
CARB_ASSERT(counter <= modulo);
return (counter == 0) ? modulo - 1 : counter - 1;
}
/** Calculates an estimate of the current level of video latency.
*
* @param[in] fps The current video frame rate in frames per second. The caller
* is responsible for accurately retrieving and calculating this.
* @param[in] framesInFlight The current number of video frames currently in flight. This
* is the number of frames that have been produced by the renderer
* but have not been displayed to the user yet (or has been presented
* but not realized on screen yet). The frame being produced would
* represent the simulation time (where a synchronized sound is
* expected to start playing), and the other buffered frames are
* ones that go back further in time (ie: older frames as far as
* the simulation is concerned). This may need to be an estimate
* the caller can retrieve from the renderer.
* @param[in] perceptibleDelay A limit below which a zero latency will be calculated. If the
* total calculated latency is less than this threshold, the latency
* will be zeroed out. If total calculated latency is larger than
* this limit, a delay estimate will be calculated. This value is
* given in microseconds. This defaults to 200,000 microseconds.
* @returns The calculated latency estimate in microseconds.
*
* @remarks This is used to calculate an estimate of the current video latency level. This
* value can be used to set the @ref ContextParams2::videoLatency value based on the
* current performance of the video rendering system. This value is used by the audio
* engine to delay the queuing of new voices by a given amount of time.
*/
inline int64_t estimateVideoLatency(double fps, double framesInFlight, int64_t perceptibleDelay = kImperceptibleDelay)
{
constexpr int64_t kMinLatency = 20'000;
double usPerFrame;
if (fps == 0.0)
return 0;
usPerFrame = 1'000'000.0 / fps;
// the current delay is less than the requested perceptible latency time => clamp the
// estimated delay down to zero.
if (usPerFrame * framesInFlight <= perceptibleDelay)
return 0;
// calculate the estimated delay in microseconds. Note that this will fudge the calculated
// total latency by a small amount because there is an expected minimum small latency in
// queuing a new voice already.
return (int64_t)((usPerFrame * framesInFlight) - CARB_MIN(perceptibleDelay / 2, kMinLatency));
}
} // namespace audio
} // namespace carb
| 76,316 | C | 39.898714 | 121 | 0.638175 |
omniverse-code/kit/include/carb/audio/IAudioUtils.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief General audio utilities.
*/
#pragma once
#include "../Interface.h"
#include "AudioTypes.h"
#include "IAudioData.h"
namespace carb
{
namespace audio
{
/************************************* Interface Objects *****************************************/
/** a handle to an open output stream. This is created by openOutputStream(). This holds the
* current state of the output stream and allows it to be written out in multiple chunks.
*/
struct OutputStream;
/********************************* Sound Data Conversion Objects *********************************/
/** flags to control the behavior of a conversion operation.
*
* @{
*/
/** container type for conversion operation flags. */
typedef uint32_t ConvertFlags;
/** convert the sound data object in-place. The old buffer data will be replaced with the
* converted data and all of the object's format information will be updated accordingly.
* This is the default behavior if no flags are given. Note that if the source and
* destination formats are the same and this flag is used, a new reference will be taken
* on the original sound data object. The returned object will be the same as the input
* object, but both will need to be released (just the same as if a new object had been
* returned).
*/
constexpr ConvertFlags fConvertFlagInPlace = 0x00000001;
/** convert the sound data object and return a new copy of the data. The previous sound
* data object will be unmodified and still valid. The new object will contain the same
* audio data, just converted to the new format. The new object needs to be destroyed
* with destroySoundData() when it is no longer needed.
*/
constexpr ConvertFlags fConvertFlagCopy = 0x00000002;
/** when duplicating a sound data object and no conversion is necessary, this allows the
* new object to reference the same data pointer as the original object. It is the
* caller's responsibility to ensure that the original object remains valid for the life
* time of the copied object. This flag will be ignored if a conversion needs to occur.
* This flag is useful when the original sound data object already references user memory
* instead of copying the data. If this flag is not used, the data buffer will always
* be copied from the original buffer.
*/
constexpr ConvertFlags fConvertFlagReferenceData = 0x00000004;
/** forces an operation to copy or decode the input data
* into a new sound data object.
* If the @ref fConvertFlagInPlace is specified and the sound data object is in memory,
* then the object is decoded in place. If the sound is in a file, then this creates a
* new sound data object containing the decoded sound.
* If the @ref fConvertFlagCopy is specified, then a new sound data object
* will be created to contain the converted sound.
* If neither the @ref fConvertFlagCopy nor the @ref fConvertFlagInPlace are specified,
* then the @ref fConvertFlagCopy flag will be implied.
*
* @note Using this flag on a compressed format will cause a re-encode and that
* could cause quality degradation.
*/
constexpr ConvertFlags fConvertFlagForceCopy = 0x00000008;
/** @} */
/** a descriptor of a data type conversion operation. This provides the information needed to
* convert a sound data object from its current format to another data format. Not all data
* formats may be supported as destination formats. The conversion operation will fail if the
* destination format is not supported for encoding. The conversion operation may either be
* performed in-place on the sound data object itself or it may output a copy of the sound
* data object converted to the new format.
*
* Note that this conversion operation will not change the length (mostly), frame rate, or
* channel count of the data, just its sample format. The length of the stream may increase
* by a few frames for some block oriented compression or encoding formats so that the stream
* can be block aligned in length. PCM data will always remain the same length as the input
* since the frames per block count for PCM data is always 1.
*/
struct ConversionDesc
{
/** flags to control how the conversion proceeds. This may be zero or more of the
* fConvertFlag* flags.
*/
ConvertFlags flags = 0;
/** the sound data to be converted. This object may or may not be modified depending on
* which flags are used. The converted data will be equivalent to the original data,
* just in the new requested format. Note that some destination formats may cause some
* information to be lost due to their compression or encoding methods. The converted
* data will contain at least the same number of frames and channels as the original data.
* Some block oriented compression formats may pad the stream with silent frames so that
* a full block can be written out. This may not be nullptr.
*/
SoundData* soundData;
/** the requested destination format for the conversion operation. For some formats,
* this may result in data or quality loss. If this format is not supported for
* encoding, the operation will fail. This can be @ref SampleFormat::eDefault to
* use the same as the original format. This is useful when also using the
* @ref fConvertFlagCopy to duplicate a sound data object.
*
* Note that if this new format matches the existing format this will be a no-op
* unless the @ref fConvertFlagCopy flag is specified. If the 'copy' flag is used,
* this will simply duplicate the existing object. The new object will still need
* to be destroyed with release() when it is no longer needed.
*/
SampleFormat newFormat = SampleFormat::eDefault;
/** additional output format dependent encoder settings. This should be nullptr for PCM
* data formats. Additional objects will be defined for encoder formats that require
* additional parameters (optional or otherwise). For formats that require additional
* settings, this may not be nullptr. Use getCodecFormatInfo() to retrieve the info
* for the codec to find out if the additional settings are required or not.
*/
void* encoderSettings = nullptr;
/** an opaque context value that will be passed to the readCallback and setPosCallback
* functions each time they are called. This value is a caller-specified object that
* is expected to contain the necessary decoding state for a user decoded stream. This
* value is only necessary if the @ref fDataFlagUserDecode flag was used when creating
* the sound data object being converted.
*/
void* readCallbackContext = nullptr;
/** An optional callback that gets fired when the SoundData's final
* reference is released. This is intended to make it easier to perform
* cleanup of a SoundData in cases where @ref fDataFlagUserMemory is used.
* This is intended to be used in cases where the SoundData is using some
* resource that needs to be released after the SoundData is destroyed.
*/
SoundDataDestructionCallback destructionCallback = nullptr;
/** An opaque context value that will be passed to @ref destructionCallback
* when the last reference to the SoundData is released.
* This will not be called if the SoundData is not created successfully.
*/
void* destructionCallbackContext = nullptr;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** Flags that alter the behavior of a PCM transcoding operation.
*/
typedef uint32_t TranscodeFlags;
/** A descriptor for transcoding between PCM formats, which is used for the
* transcodePcm() function
*/
struct TranscodeDesc
{
/** Flags for the transcoding operation.
* This must be 0 as no flags are currently defined.
*/
TranscodeFlags flags = 0;
/** The format of the input data.
* This must be a PCM format.
*/
SampleFormat inFormat;
/** The data format that will be written into @p outBuffer.
* This must be a PCM format.
*/
SampleFormat outFormat;
/** The input buffer to be transcoded.
* Audio in this buffer is interpreted as @ref inFormat.
* This must be long enough to hold @ref samples samples of audio data in
* @ref inFormat.
*/
const void* inBuffer;
/** The output buffer to receive the transcoded data.
* Audio will be transcoded from @ref inBuffer into @ref outBuffer in
* @ref outFormat.
* This must be long enough to hold @ref samples samples of audio data in
* @ref outFormat.
* This may not alias or overlap @ref inBuffer.
*/
void* outBuffer;
/** The number of samples of audio to transcode.
* Note that for multichannel audio, this is the number of frames
* multiplied by the channel count.
*/
size_t samples;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/*********************************** Sound Data Output Objects ***********************************/
/** Flags used for the saveToFile() function. These control how the the sound data object
* is written to the file. Zero or more of these flags may be combined to alter the behavior.
* @{
*/
typedef uint32_t SaveFlags;
/** Default save behavior. */
constexpr SaveFlags fSaveFlagDefault = 0x00000000;
/** Don't write the metadata information into the file.
*/
constexpr SaveFlags fSaveFlagStripMetaData = 0x00000001;
/** Don't write the event point information into the file.
*/
constexpr SaveFlags fSaveFlagStripEventPoints = 0x00000002;
/** Don't write the peaks information into the file.
*/
constexpr SaveFlags fSaveFlagStripPeaks = 0x00000004;
/** a descriptor of how a sound data object should be written out to file. This can optionally
* convert the audio data to a different format. Note that transcoding the audio data could
* result in a loss in quality depending on both the source and destination formats.
*/
struct SoundDataSaveDesc
{
/** Flags that alter the behavior of saving the file.
* These may indicate to the file writer that certain elements in the file
* should be stripped, for example.
*/
SaveFlags flags = 0;
/** the format that the sound data object should be saved in. Note that if the data was
* fully decoded on load, this may still result in some quality loss if the data needs to
* be re-encoded. This may be @ref SampleFormat::eDefault to write the sound to file in
* the sound's encoded format.
*/
SampleFormat format = SampleFormat::eDefault;
/** the sound data to be written out to file. This may not be nullptr. Depending on
* the data's original format and flags and the requested destination format, there
* may be some quality loss if the data needs to be decoded or re-encoded.
* This may not be a streaming sound.
*/
const SoundData* soundData;
/** the destination filename for the sound data. This may be a relative or absolute
* path. For relative paths, these will be resolved according to the rules of the
* IFileSystem interface. This may not be nullptr.
*/
const char* filename;
/** additional output format dependent encoder settings. This should be nullptr for PCM
* data formats. Additional objects will be defined for encoder formats that require
* additional parameters (optional or otherwise). For formats that require additional
* settings, this may not be nullptr. Use getCodecFormatInfo() to retrieve the info
* for the codec to find out if the additional settings are required or not.
*/
void* encoderSettings = nullptr;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** base type for all output stream flags. */
typedef uint32_t OutputStreamFlags;
/** flag to indicate that an output stream should flush its file after each buffer is successfully
* written to it. By default, the stream will not be forced to be flushed until it is closed.
*/
constexpr OutputStreamFlags fStreamFlagFlushAfterWrite = 0x00000001;
/** flag to indicate that the stream should disable itself if an error is encountered writing a
* buffer of audio to the output. And example of a failure could be that the output file fails
* to be opened (ie: permissions issue, path doesn't exist, etc), or there was an encoding error
* with the chosen output format (extremely rare but possible). If such a failure occurs, the
* output stream will simply ignore new incoming data until the stream is closed. If this flag
* is not used, the default behavior is to continue trying to write to the stream. In this
* case, it is possible that the stream could recover and continue writing output again (ie:
* the folder containing the file suddenly was created), however doing so could lead to an
* audible artifact being introduced to the output stream.
*/
constexpr OutputStreamFlags fStreamFlagDisableOnFailure = 0x00000002;
/** a descriptor for opening an output file stream. This allows sound data to be written to a
* file in multiple chunks. The output stream will remain open and able to accept more input
* until it is closed. The output data can be encoded as it is written to the file for certain
* formats. Attempting to open the stream with a format that doesn't support encoding will
* cause the stream to fail.
*/
struct OutputStreamDesc
{
/** flags to control the behavior of the output stream. This may be 0 to specify default
* behavior.
*/
OutputStreamFlags flags = 0;
/** the filename to write the stream to. This may be a relative or absolute path. If a
* relative path is used, it will be resolved according to the rules of the IFileSystem
* interface. If the filename does not include a file extension, one will be added
* according to the requested output format. If no file extension is desired, the
* filename should end with a period ('.'). This may not be nullptr.
*/
const char* filename;
/** the input sample format for the stream. This will be the format of the data that is
* passed in the buffers to writeDataToStream().
* This must be a PCM format (one of SampleFormat::ePcm*).
*/
SampleFormat inputFormat;
/** the output sample format for the stream. This will be the format of the data that is
* written to the output file. If this matches the input data format, the buffer will
* simply be written to the file stream. This may be @ref SampleFormat::eDefault to use
* the same format as @ref inputFormat for the output.
*/
SampleFormat outputFormat = SampleFormat::eDefault;
/** the data rate of the stream in frames per second. This value is recorded to the
* stream but does not affect the actual consumption of data from the buffers.
*/
size_t frameRate;
/** the number of channels in each frame of the stream. */
size_t channels;
/** additional output format dependent encoder settings. This should be nullptr for PCM
* data formats. Additional objects will be defined for encoder formats that require
* additional parameters (optional or otherwise). For formats that require additional
* settings, this may not be nullptr. Use getCodecFormatInfo() to retrieve the info
* for the codec to find out if the additional settings are required or not.
*/
void* encoderSettings = nullptr;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/********************************* Audio Visualization Objects ***********************************/
/** Flags for @ref AudioImageDesc. */
using AudioImageFlags = uint32_t;
/** Don't clear out the image buffer with the background color before drawing.
* This is useful when drawing waveforms onto the same image buffer over
* multiple calls.
*/
constexpr AudioImageFlags fAudioImageNoClear = 0x01;
/** Draw lines between the individual samples when rendering. */
constexpr AudioImageFlags fAudioImageUseLines = 0x02;
/** Randomize The colors used for each sample. */
constexpr AudioImageFlags fAudioImageNoiseColor = 0x04;
/** Draw all the audio channels in the image on top of each other, rather than
* drawing one individual channel.
*/
constexpr AudioImageFlags fAudioImageMultiChannel = 0x08;
/** Perform alpha blending when drawing the samples/lines, rather than
* overwriting the pixels.
*/
constexpr AudioImageFlags fAudioImageAlphaBlend = 0x10;
/** Draw each audio channel as a separate waveform, organized vertically. */
constexpr AudioImageFlags fAudioImageSplitChannels = 0x20;
/** A descriptor for IAudioData::drawWaveform(). */
struct AudioImageDesc
{
/** Flags that alter the drawing style. */
AudioImageFlags flags;
/** The sound to render into the waveform. */
const SoundData* sound;
/** The length of @ref sound to render as an image.
* This may be 0 to render the entire sound.
*/
size_t length;
/** The offset into the sound to start visualizing.
* The region visualized will start at @ref offset and end at @ref offset
* + @ref length. If the region extends beyond the end of the sound, it
* will be internally clamped to the end of the sound.
* If this value is negative, then this is treated as an offset relative
* to the end of the file, rather than the start.
* This may be 0 to render the entire sound.
*/
int64_t offset;
/** The unit type of @ref length and @ref offset.
* Note that using @ref UnitType::eBytes with a variable bitrate format will
* not provide very accurate results.
*/
UnitType lengthType;
/** This specifies which audio channel from @ref sound will be rendered.
* This is ignored when @ref fAudioImageMultiChannel is set on @ref flags.
*/
size_t channel;
/** The buffer that holds the image data.
* The image format is RGBA8888.
* This must be @ref height * @ref pitch bytes long.
* This may not be nullptr.
*/
void* image;
/** The width of the image in pixels. */
size_t width;
/** The width of the image buffer in bytes.
* This can be set to 0 to use 4 * @ref width as the pitch.
* This may be used for applications such as writing a subimage or an
* image that needs some specific alignment.
*/
size_t pitch;
/** The height of the image in pixels. */
size_t height;
/** The background color to write to the image in normalized RGBA color.
* The alpha channel in this color is not used to blend this color with
* the existing data in @ref image; use @ref fAudioImageNoClear if you
* want to render on top of an existing image.
* This value is ignored when @ref fAudioImageNoClear is set on @ref flags.
*/
Float4 background;
/** The colors to use for the image in normalized RGBA colors.
* If @ref fAudioImageMultiChannel, each element in this array maps to each
* channel in the output audio data; otherwise, element 0 is used as the
* color for the single channel.
*/
Float4 colors[kMaxChannels];
};
/** General audio utilities.
* This interface contains a bunch of miscellaneous audio functionality that
* many audio applications can make use of.
*/
struct IAudioUtils
{
CARB_PLUGIN_INTERFACE("carb::audio::IAudioUtils", 1, 0)
/*************************** Sound Data Object Modifications ********************************/
/** clears a sound data object to silence.
*
* @param[in] sound the sound data object to clear. This may not be nullptr.
* @returns true if the clearing operation was successful.
* @returns false if the clearing operation was not successful.
* @note this will remove the SDO from user memory.
* @note this will clear the entire buffer, not just the valid portion.
* @note this will be a lossy operation for some formats.
*/
bool(CARB_ABI* clearToSilence)(SoundData* sound);
/**************************** Sound Data Saving and Streaming ********************************/
/** save a sound data object to a file.
*
* @param[in] desc a descriptor of how the sound data should be saved to file and which
* data format it should be written in. This may not be nullptr.
* @returns true if the sound data is successfully written out to file.
* @returns false if the sound data could not be written to file. This may include being
* unable to open or create the file, or if the requested output format could
* not be supported by the encoder.
*
* @remarks This attempts to save a sound data object to file. The destination data format
* in the file does not necessarily have to match the original sound data object.
* However, if the destination format does not match, the encoder for that format
* must be supported otherwise the operation will fail. Support for the requested
* encoder format may be queried with isCodecFormatSupported() to avoid exposing
* user facing functionality for formats that cannot be encoded.
*/
bool(CARB_ABI* saveToFile)(const SoundDataSaveDesc* desc);
/** opens a new output stream object.
*
* @param[in] desc a descriptor of how the stream should be opened. This may not be
* nullptr.
* @returns a new output stream handle if successfully created. This object must be closed
* with closeOutputStream() when it is no longer needed.
* @returns nullptr if the output stream could not be created. This may include being unable
* to open or create the file, or if the requested output format could not be
* supported by the encoder.
*
* @remarks This opens a new output stream and prepares it to receive buffers of data from
* the stream. The header will be written to the file, but it will initially
* represent an empty stream. The destination data format in the file does not
* necessarily have to match the original sound data object. However, if the
* destination format does not match, the encoder for that format must be supported
* otherwise the operation will fail. Support for the requested encoder format may
* be queried with isCodecFormatSupported() to avoid exposing user facing
* functionality for formats that cannot be encoded.
*/
OutputStream*(CARB_ABI* openOutputStream)(const OutputStreamDesc* desc);
/** closes an output stream.
*
* @param[in] stream the stream to be closed. This may not be nullptr. This must have
* been returned from a previous call to openOutputStream(). This
* object will no longer be valid upon return.
* @returns no return value.
*
* @remarks This closes an output stream object. The header for the file will always be
* updated so that it reflects the actual written stream size. Any additional
* updates for the chosen data format will be written to the file before closing
* as well.
*/
void(CARB_ABI* closeOutputStream)(OutputStream* stream);
/** writes a single buffer of data to an output stream.
*
* @param[in] stream the stream to write the buffer to. This handle must have
* been returned by a previous call to openOutputStream() and
* must not have been closed yet. This may not be nullptr.
* @param[in] data the buffer of data to write to the file. The data in this
* buffer is expected to be in data format specified when the
* output stream was opened. This buffer must be block aligned
* for the given input format. This may not be nullptr.
* @param[in] lengthInFrames the size of the buffer to write in frames. All frames in
* the buffer must be complete. Partial frames will neither
* be detected nor handled.
* @returns true if the buffer is successfully encoded and written to the stream.
* @returns false if the buffer could not be encoded or an error occurs writing it to the
* stream.
*
* @remarks This writes a single buffer of data to an open output stream. It is the caller's
* responsibility to ensure this new buffer is the logical continuation of any of
* the previous buffers that were written to the stream. The buffer will always be
* encoded and written to the stream in its entirety. If any extra frames of data
* do not fit into one of the output format's blocks, the remaining data will be
* cached in the encoder and added to by the next buffer. If the stream ends and
* the encoder still has a partial block waiting, it will be padded with silence
* and written to the stream when it is closed.
*/
bool(CARB_ABI* writeDataToStream)(OutputStream* stream, const void* data, size_t lengthInFrames);
/***************************** Sound Data Format Conversion **********************************/
/** converts a sound data object from one format to another.
*
* @param[in] desc the descriptor of how the conversion operation should be performed.
* This may not be nullptr.
* @returns the converted sound data object.
* @returns nullptr if the conversion could not occur.
*
* @remarks This converts a sound data object from one format to another or duplicates an
* object. The conversion operation may be performed on the same sound data object
* or it may create a new object. The returned sound data object always needs to
* be released with release() when it is no longer needed. This is true
* whether the original object was copied or not.
*
* @note The destruction callback is not copied to the returned SoundData
* even if an in-place conversion is requested.
*
* @note If @ref fConvertFlagInPlace is passed and the internal buffer
* of the input SoundData is being replaced, the original
* destruction callback on the input SoundData will be called.
*/
carb::audio::SoundData*(CARB_ABI* convert)(const ConversionDesc* desc);
/** duplicates a sound data object.
*
* @param[in] sound the sound data object to duplicate. This may not be nullptr.
* @returns the duplicated sound data object. This must be destroyed when it is no longer
* needed with a call to release().
*
* @remarks This duplicates a sound data object. The new object will have the same format
* and data content as the original. If the original referenced user memory, the
* new object will get a copy of its data, not the original pointer. If the new
* object should reference the original data instead, convert() should be
* used instead.
*/
carb::audio::SoundData*(CARB_ABI* duplicate)(const SoundData* sound);
/** A helper function to transcode between PCM formats.
*
* @param[in] desc The descriptor of how the conversion operation should be
* performed.
* This may not be nullptr.
* @returns true if the data is successfully transcoded.
* @returns false if an invalid parameter is passed in or the conversion was not possible.
* @returns false if the input buffer or the output buffer are misaligned for their
* specified sample format.
* createData() be used in cases where a misaligned buffer needs to be used
* (for example when reading raw PCM data from a memory-mapped file).
*
* @remarks This function is a simpler alternative to decodeData() for
* cases where it is known that both the input and output formats
* are PCM formats.
*
* @note There is no requirement for the alignment of @ref TranscodeDesc::inBuffer
* or @ref TranscodeDesc::outBuffer, but the operation is most
* efficient when both are 32 byte aligned
* (e.g. `(static_cast<uintptr_t>(inBuffer) & 0x1F) == 0`).
*
* @note It is valid for @ref TranscodeDesc::inFormat to be the same as
* @ref TranscodeDesc::outFormat; this is equivalent to calling
* memcpy().
*/
bool(CARB_ABI* transcodePcm)(const TranscodeDesc* desc);
/***************************** Audio Visualization *******************************************/
/** Render a SoundData's waveform as an image.
* @param[in] desc The descriptor for the audio waveform input and output.
*
* @returns true if visualization was successful.
* @returns false if no sound was specified.
* @returns false if the input image dimensions corresponded to a 0-size image
* or the buffer for the image was nullptr.
* @returns false if the region of the sound to visualize was 0 length.
* @returns false if the image pitch specified was non-zero and too small
* to fit an RGBA888 image of the desired width.
* @returns false if the specified channel to visualize was invalid.
*
* @remarks This function can be used to visualize the audio samples in a
* sound buffer as an uncompressed RGBA8888 image.
*/
bool(CARB_ABI* drawWaveform)(const AudioImageDesc* desc);
};
} // namespace audio
} // namespace carb
| 30,838 | C | 46.886646 | 101 | 0.676049 |
omniverse-code/kit/include/carb/audio/AudioBindingsPython.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "IAudioPlayback.h"
#include "IAudioData.h"
#include "IAudioUtils.h"
#include "AudioUtils.h"
namespace carb
{
namespace audio
{
/** A helper class to wrap the Voice* object for python.
* There is no way to actually create Voices from these bindings yet.
*
* @note This wrapper only exposes functions to alter voice parameters at the
* moment. This is done because IAudioPlayback is not thread-safe yet
* and allowing other changes would cause thread safety issues with
* Omniverse Kit.
*/
class PythonVoice
{
public:
PythonVoice(IAudioPlayback* iface, audio::Voice* voice)
{
m_iface = iface;
m_voice = voice;
}
void stop()
{
m_iface->stopVoice(m_voice);
}
bool isPlaying()
{
return m_iface->isPlaying(m_voice);
}
bool setLoopPoint(const LoopPointDesc* desc)
{
return m_iface->setLoopPoint(m_voice, desc);
}
size_t getPlayCursor(UnitType type)
{
return m_iface->getPlayCursor(m_voice, type);
}
void setParameters(VoiceParamFlags paramsToSet, const VoiceParams* params)
{
m_iface->setVoiceParameters(m_voice, paramsToSet, params);
}
void getParameters(VoiceParamFlags paramsToGet, VoiceParams* params)
{
m_iface->getVoiceParameters(m_voice, paramsToGet, params);
}
void setPlaybackMode(PlaybackModeFlags mode)
{
VoiceParams params = {};
params.playbackMode = mode;
m_iface->setVoiceParameters(m_voice, fVoiceParamPlaybackMode, ¶ms);
}
void setVolume(float volume)
{
VoiceParams params = {};
params.volume = volume;
m_iface->setVoiceParameters(m_voice, fVoiceParamVolume, ¶ms);
}
void setMute(bool muted)
{
VoiceParams params = {};
params.playbackMode = muted ? fPlaybackModeMuted : 0;
m_iface->setVoiceParameters(m_voice, fVoiceParamMute, ¶ms);
}
void setBalance(float pan, float fade)
{
VoiceParams params = {};
params.balance.pan = pan;
params.balance.fade = fade;
m_iface->setVoiceParameters(m_voice, fVoiceParamBalance, ¶ms);
}
void setFrequencyRatio(float ratio)
{
VoiceParams params = {};
params.frequencyRatio = ratio;
m_iface->setVoiceParameters(m_voice, fVoiceParamFrequencyRatio, ¶ms);
}
void setPriority(int32_t priority)
{
VoiceParams params = {};
params.priority = priority;
m_iface->setVoiceParameters(m_voice, fVoiceParamPriority, ¶ms);
}
void setSpatialMixLevel(float level)
{
VoiceParams params = {};
params.spatialMixLevel = level;
m_iface->setVoiceParameters(m_voice, fVoiceParamSpatialMixLevel, ¶ms);
}
void setDopplerScale(float scale)
{
VoiceParams params = {};
params.dopplerScale = scale;
m_iface->setVoiceParameters(m_voice, fVoiceParamDopplerScale, ¶ms);
}
void setOcclusion(float direct, float reverb)
{
VoiceParams params = {};
params.occlusion.direct = direct;
params.occlusion.reverb = reverb;
m_iface->setVoiceParameters(m_voice, fVoiceParamOcclusionFactor, ¶ms);
}
void setMatrix(std::vector<float> matrix)
{
// FIXME: This should probably validate the source/destination channels.
// We can get the source channels by retrieving the currently playing sound,
// but we have no way to retrieve the context's channel count here.
VoiceParams params = {};
params.matrix = matrix.data();
m_iface->setVoiceParameters(m_voice, fVoiceParamMatrix, ¶ms);
}
void setPosition(Float3 position)
{
VoiceParams params = {};
params.emitter.flags = fEntityFlagPosition;
params.emitter.position = position;
m_iface->setVoiceParameters(m_voice, fVoiceParamEmitter, ¶ms);
}
void setVelocity(Float3 velocity)
{
VoiceParams params = {};
params.emitter.flags = fEntityFlagVelocity;
params.emitter.velocity = velocity;
m_iface->setVoiceParameters(m_voice, fVoiceParamEmitter, ¶ms);
}
void setRolloffCurve(RolloffType type,
float nearDistance,
float farDistance,
std::vector<Float2>& volume,
std::vector<Float2>& lowFrequency,
std::vector<Float2>& lowPassDirect,
std::vector<Float2>& lowPassReverb,
std::vector<Float2>& reverb)
{
RolloffCurve volumeCurve = {};
RolloffCurve lowFrequencyCurve = {};
RolloffCurve lowPassDirectCurve = {};
RolloffCurve lowPassReverbCurve = {};
RolloffCurve reverbCurve = {};
VoiceParams params = {};
params.emitter.flags = fEntityFlagRolloff;
params.emitter.rolloff.type = type;
params.emitter.rolloff.nearDistance = nearDistance;
params.emitter.rolloff.farDistance = farDistance;
if (!volume.empty())
{
volumeCurve.points = volume.data();
volumeCurve.pointCount = volume.size();
params.emitter.rolloff.volume = &volumeCurve;
}
if (!lowFrequency.empty())
{
lowFrequencyCurve.points = lowFrequency.data();
lowFrequencyCurve.pointCount = lowFrequency.size();
params.emitter.rolloff.lowFrequency = &lowFrequencyCurve;
}
if (!lowPassDirect.empty())
{
lowPassDirectCurve.points = lowPassDirect.data();
lowPassDirectCurve.pointCount = lowPassDirect.size();
params.emitter.rolloff.lowPassDirect = &lowPassDirectCurve;
}
if (!lowPassReverb.empty())
{
lowPassReverbCurve.points = lowPassReverb.data();
lowPassReverbCurve.pointCount = lowPassReverb.size();
params.emitter.rolloff.lowPassReverb = &lowPassReverbCurve;
}
if (!reverb.empty())
{
reverbCurve.points = reverb.data();
reverbCurve.pointCount = reverb.size();
params.emitter.rolloff.reverb = &reverbCurve;
}
m_iface->setVoiceParameters(m_voice, fVoiceParamEmitter, ¶ms);
}
private:
Voice* m_voice;
IAudioPlayback* m_iface;
};
class PythonSoundData
{
public:
PythonSoundData(IAudioData* iface, SoundData* data) noexcept
{
m_iface = iface;
m_data = data;
m_utils = carb::getFramework()->acquireInterface<IAudioUtils>();
}
~PythonSoundData() noexcept
{
m_iface->release(m_data);
}
static PythonSoundData* fromRawBlob(IAudioData* iface,
const void* blob,
size_t samples,
SampleFormat format,
size_t channels,
size_t frameRate,
SpeakerMode channelMask)
{
SoundFormat fmt;
size_t bytes = samples * sampleFormatToBitsPerSample(format) / CHAR_BIT;
SoundData* tmp;
generateSoundFormat(&fmt, format, channels, frameRate, channelMask);
tmp = createSoundFromRawPcmBlob(iface, blob, bytes, bytesToFrames(bytes, &fmt), &fmt);
if (tmp == nullptr)
throw std::runtime_error("failed to create a SoundData object");
return new PythonSoundData(iface, tmp);
}
const char* getName()
{
return m_iface->getName(m_data);
}
bool isDecoded()
{
return (m_iface->getFlags(m_data) & fDataFlagStream) == 0;
}
SoundFormat getFormat()
{
SoundFormat fmt;
m_iface->getFormat(m_data, CodecPart::eEncoder, &fmt);
return fmt;
}
size_t getLength(UnitType units)
{
return m_iface->getLength(m_data, units);
}
void setValidLength(size_t length, UnitType units)
{
m_iface->setValidLength(m_data, length, units);
}
size_t getValidLength(UnitType units)
{
return m_iface->getValidLength(m_data, units);
}
std::vector<uint8_t> getBufferU8(size_t offset, size_t length, UnitType units)
{
return getBuffer<uint8_t>(offset, length, units);
}
std::vector<int16_t> getBufferS16(size_t offset, size_t length, UnitType units)
{
return getBuffer<int16_t>(offset, length, units);
}
std::vector<int32_t> getBufferS32(size_t offset, size_t length, UnitType units)
{
return getBuffer<int32_t>(offset, length, units);
}
std::vector<float> getBufferFloat(size_t offset, size_t length, UnitType units)
{
return getBuffer<float>(offset, length, units);
}
void writeBufferU8(const std::vector<uint8_t>& data, size_t offset, UnitType units)
{
return writeBuffer<uint8_t>(data, offset, units);
}
void writeBufferS16(const std::vector<int16_t>& data, size_t offset, UnitType units)
{
return writeBuffer<int16_t>(data, offset, units);
}
void writeBufferS32(const std::vector<int32_t>& data, size_t offset, UnitType units)
{
return writeBuffer<int32_t>(data, offset, units);
}
void writeBufferFloat(const std::vector<float>& data, size_t offset, UnitType units)
{
return writeBuffer<float>(data, offset, units);
}
size_t getMemoryUsed()
{
return m_iface->getMemoryUsed(m_data);
}
uint32_t getMaxInstances()
{
return m_iface->getMaxInstances(m_data);
}
void setMaxInstances(uint32_t limit)
{
m_iface->setMaxInstances(m_data, limit);
}
PeakVolumes getPeakLevel()
{
PeakVolumes vol;
if (!m_iface->getPeakLevel(m_data, &vol))
{
throw std::runtime_error("this sound has no peak volume information");
}
return vol;
}
std::vector<EventPoint> getEventPoints()
{
size_t count = m_iface->getEventPoints(m_data, nullptr, 0);
size_t retrieved;
std::vector<EventPoint> out;
out.resize(count);
retrieved = m_iface->getEventPoints(m_data, out.data(), count);
if (retrieved < count)
{
CARB_LOG_ERROR("retrieved fewer event points than expected (%zu < %zu)\n", retrieved, count);
out.resize(retrieved);
}
return out;
}
const EventPoint* getEventPointById(EventPointId id)
{
return wrapEventPoint(m_iface->getEventPointById(m_data, id));
}
const EventPoint* getEventPointByIndex(size_t index)
{
return wrapEventPoint(m_iface->getEventPointByIndex(m_data, index));
}
const EventPoint* getEventPointByPlayIndex(size_t index)
{
return wrapEventPoint(m_iface->getEventPointByPlayIndex(m_data, index));
}
size_t getEventPointMaxPlayIndex()
{
return m_iface->getEventPointMaxPlayIndex(m_data);
}
bool setEventPoints(std::vector<EventPoint> eventPoints)
{
// text does not work properly in bindings
for (size_t i = 0; i < eventPoints.size(); i++)
{
eventPoints[i].label = nullptr;
eventPoints[i].text = nullptr;
}
return m_iface->setEventPoints(m_data, eventPoints.data(), eventPoints.size());
}
void clearEventPoints()
{
m_iface->setEventPoints(m_data, kEventPointTableClear, 0);
}
std::pair<const char*, const char*> getMetaDataByIndex(size_t index)
{
const char* value;
const char* key = m_iface->getMetaDataTagName(m_data, index, &value);
return std::pair<const char*, const char*>(key, value);
}
const char* getMetaData(const char* tagName)
{
return m_iface->getMetaData(m_data, tagName);
}
bool setMetaData(const char* tagName, const char* tagValue)
{
return m_iface->setMetaData(m_data, tagName, tagValue);
}
bool saveToFile(const char* fileName, SampleFormat format = SampleFormat::eDefault, SaveFlags flags = 0)
{
return saveSoundToDisk(m_utils, m_data, fileName, format, flags);
}
SoundData* getNativeObject()
{
return m_data;
}
private:
EventPoint* wrapEventPoint(const EventPoint* point)
{
if (point == nullptr)
return nullptr;
EventPoint* out = new EventPoint;
*out = *point;
return out;
}
template <typename T>
SampleFormat getFormatFromType()
{
// I'd do this with template specialization but GCC won't accept that
// for some reason
if (std::is_same<T, uint8_t>::value)
{
return SampleFormat::ePcm8;
}
else if (std::is_same<T, int16_t>::value)
{
return SampleFormat::ePcm16;
}
else if (std::is_same<T, int32_t>::value)
{
return SampleFormat::ePcm32;
}
else if (std::is_same<T, float>::value)
{
return SampleFormat::ePcmFloat;
}
else
{
return SampleFormat::eDefault;
}
}
template <typename T>
std::vector<T> getBuffer(size_t offset, size_t length, UnitType units)
{
size_t samples;
size_t soundLength = getValidLength(UnitType::eFrames);
SoundFormat fmt = getFormat();
std::vector<T> out;
if (units == UnitType::eBytes && offset % fmt.frameSize != 0)
{
throw std::runtime_error("byte offset was not aligned correctly for the data type");
}
length = convertUnits(length, units, UnitType::eFrames, &fmt);
offset = convertUnits(offset, units, UnitType::eFrames, &fmt);
if (length == 0 || length > soundLength)
length = soundLength;
if (length == 0)
return {};
offset = CARB_MIN(soundLength - 1, offset);
if (offset + length > soundLength)
{
length = soundLength - offset;
}
samples = length * fmt.channels;
out.resize(samples);
if (isDecoded())
{
size_t byteOffset = convertUnits(offset, UnitType::eFrames, UnitType::eBytes, &fmt);
const void* buffer = m_iface->getReadBuffer(m_data);
writeGenericBuffer(static_cast<const uint8_t*>(buffer) + byteOffset, out.data(), fmt.format,
getFormatFromType<T>(), samples);
}
else
{
size_t decoded = 0;
CodecState* state = nullptr;
CodecStateDesc desc = {};
desc.part = CodecPart::eDecoder;
desc.decode.flags =
fDecodeStateFlagCoarseSeek | fDecodeStateFlagSkipMetaData | fDecodeStateFlagSkipEventPoints;
desc.decode.soundData = m_data;
desc.decode.outputFormat = getFormatFromType<T>();
desc.decode.readCallbackContext = nullptr;
desc.decode.ext = nullptr;
state = m_iface->createCodecState(&desc);
if (state == nullptr)
{
m_iface->destroyCodecState(state);
throw std::runtime_error("failed to initialize the decoder");
}
if (offset != 0 && !m_iface->setCodecPosition(state, offset, UnitType::eFrames))
{
m_iface->destroyCodecState(state);
throw std::runtime_error("failed to seek into the sound");
}
if (m_iface->decodeData(state, out.data(), length, &decoded) == nullptr)
{
m_iface->destroyCodecState(state);
throw std::runtime_error("failed to decode the sound");
}
if (decoded < length)
{
CARB_LOG_ERROR("decoded fewer frames that expected (%zu < %zu)\n", decoded, length);
out.resize(decoded * fmt.channels);
}
m_iface->destroyCodecState(state);
}
return out;
}
template <typename T>
void writeBuffer(const std::vector<T>& data, size_t offset, UnitType units)
{
SoundFormat fmt = getFormat();
void* buffer = m_iface->getBuffer(m_data);
size_t length = data.size();
size_t maxLength = getLength(UnitType::eBytes);
if (!isDecoded())
{
throw std::runtime_error("this SoundData object is read-only");
}
if (units == UnitType::eBytes && offset % fmt.frameSize != 0)
{
throw std::runtime_error("byte offset was not aligned correctly for the data type");
}
offset = convertUnits(offset, units, UnitType::eBytes, &fmt);
if (offset + length > maxLength)
{
length = maxLength - offset;
}
writeGenericBuffer(
data.data(), static_cast<uint8_t*>(buffer) + offset, getFormatFromType<T>(), fmt.format, length);
}
void writeGenericBuffer(const void* in, void* out, SampleFormat inFmt, SampleFormat outFmt, size_t samples)
{
if (inFmt != outFmt)
{
TranscodeDesc desc = {};
desc.inFormat = inFmt;
desc.outFormat = outFmt;
desc.inBuffer = in;
desc.outBuffer = out;
desc.samples = samples;
if (!m_utils->transcodePcm(&desc))
throw std::runtime_error("PCM transcoding failed unexpectedly");
}
else
{
memcpy(out, in, samples * sampleFormatToBitsPerSample(inFmt) / CHAR_BIT);
}
}
IAudioData* m_iface;
IAudioUtils* m_utils;
SoundData* m_data;
};
/** A helper class to wrap the Context* object for python.
* There is no way to actually create or destroy the Context* object in these
* bindings yet.
*
* @note This wrapper only exposes functions to alter Context parameters at the
* moment. This is done because IAudioPlayback is not thread-safe yet
* and allowing other changes would cause thread safety issues with
* Omniverse Kit.
*/
class PythonContext
{
public:
PythonContext(IAudioPlayback* iface, Context* context) : m_context(context), m_iface(iface)
{
}
/** Wrappers for IAudioPlayback functions @{ */
const ContextCaps* getContextCaps()
{
return m_iface->getContextCaps(m_context);
}
void setContextParameters(ContextParamFlags paramsToSet, const ContextParams* params)
{
m_iface->setContextParameters(m_context, paramsToSet, params);
}
void getContextParameters(ContextParamFlags paramsToGet, ContextParams* params)
{
m_iface->getContextParameters(m_context, paramsToGet, params);
}
PythonVoice* playSound(PythonSoundData* sound,
PlayFlags flags,
VoiceParamFlags validParams,
VoiceParams* params,
EventPoint* loopPoint,
size_t playStart,
size_t playLength,
UnitType playUnits)
{
PlaySoundDesc desc = {};
desc.flags = flags;
desc.sound = sound->getNativeObject();
desc.validParams = validParams;
desc.params = params;
desc.loopPoint.loopPoint = loopPoint;
if (loopPoint != nullptr)
{
desc.loopPoint.loopPointIndex = 0;
}
desc.playStart = playStart;
desc.playLength = playLength;
desc.playUnits = playUnits;
return new PythonVoice(m_iface, m_iface->playSound(m_context, &desc));
}
/** @} */
private:
Context* m_context;
IAudioPlayback* m_iface;
};
inline void definePythonModule(py::module& m)
{
const char* docString;
/////// AudioTypes.h ///////
m.attr("MAX_NAME_LENGTH") = py::int_(kMaxNameLength);
m.attr("MAX_CHANNELS") = py::int_(kMaxChannels);
m.attr("MIN_CHANNELS") = py::int_(kMinChannels);
m.attr("MAX_FRAMERATE") = py::int_(kMaxFrameRate);
m.attr("MIN_FRAMERATE") = py::int_(kMinFrameRate);
py::enum_<AudioResult>(m, "AudioResult")
.value("OK", AudioResult::eOk)
.value("DEVICE_DISCONNECTED", AudioResult::eDeviceDisconnected)
.value("DEVICE_LOST", AudioResult::eDeviceLost)
.value("DEVICE_NOT_OPEN", AudioResult::eDeviceNotOpen)
.value("DEVICE_OPEN", AudioResult::eDeviceOpen)
.value("OUT_OF_RANGE", AudioResult::eOutOfRange)
.value("TRY_AGAIN", AudioResult::eTryAgain)
.value("OUT_OF_MEMORY", AudioResult::eOutOfMemory)
.value("INVALID_PARAMETER", AudioResult::eInvalidParameter)
.value("NOT_ALLOWED", AudioResult::eNotAllowed)
.value("NOT_FOUND", AudioResult::eNotFound)
.value("IO_ERROR", AudioResult::eIoError)
.value("INVALID_FORMAT", AudioResult::eInvalidFormat)
.value("NOT_SUPPORTED", AudioResult::eNotSupported);
py::enum_<Speaker>(m, "Speaker")
.value("FRONT_LEFT", Speaker::eFrontLeft)
.value("FRONT_RIGHT", Speaker::eFrontRight)
.value("FRONT_CENTER", Speaker::eFrontCenter)
.value("LOW_FREQUENCY_EFFECT", Speaker::eLowFrequencyEffect)
.value("BACK_LEFT", Speaker::eBackLeft)
.value("BACK_RIGHT", Speaker::eBackRight)
.value("BACK_CENTER", Speaker::eBackCenter)
.value("SIDE_LEFT", Speaker::eSideLeft)
.value("SIDE_RIGHT", Speaker::eSideRight)
.value("TOP_FRONT_LEFT", Speaker::eTopFrontLeft)
.value("TOP_FRONT_RIGHT", Speaker::eTopFrontRight)
.value("TOP_BACK_LEFT", Speaker::eTopBackLeft)
.value("TOP_BACK_RIGHT", Speaker::eTopBackRight)
.value("FRONT_LEFT_WIDE", Speaker::eFrontLeftWide)
.value("FRONT_RIGHT_WIDE", Speaker::eFrontRightWide)
.value("TOP_LEFT", Speaker::eTopLeft)
.value("TOP_RIGHT", Speaker::eTopRight)
.value("COUNT", Speaker::eCount);
m.attr("SPEAKER_FLAG_FRONT_LEFT") = py::int_(fSpeakerFlagFrontLeft);
m.attr("SPEAKER_FLAG_FRONT_RIGHT") = py::int_(fSpeakerFlagFrontRight);
m.attr("SPEAKER_FLAG_FRONT_CENTER") = py::int_(fSpeakerFlagFrontCenter);
m.attr("SPEAKER_FLAG_LOW_FREQUENCY_EFFECT") = py::int_(fSpeakerFlagLowFrequencyEffect);
m.attr("SPEAKER_FLAG_BACK_LEFT") = py::int_(fSpeakerFlagSideLeft);
m.attr("SPEAKER_FLAG_BACK_RIGHT") = py::int_(fSpeakerFlagSideRight);
m.attr("SPEAKER_FLAG_BACK_CENTER") = py::int_(fSpeakerFlagBackLeft);
m.attr("SPEAKER_FLAG_SIDE_LEFT") = py::int_(fSpeakerFlagBackRight);
m.attr("SPEAKER_FLAG_SIDE_RIGHT") = py::int_(fSpeakerFlagBackCenter);
m.attr("SPEAKER_FLAG_TOP_FRONT_LEFT") = py::int_(fSpeakerFlagTopFrontLeft);
m.attr("SPEAKER_FLAG_TOP_FRONT_RIGHT") = py::int_(fSpeakerFlagTopFrontRight);
m.attr("SPEAKER_FLAG_TOP_BACK_LEFT") = py::int_(fSpeakerFlagTopBackLeft);
m.attr("SPEAKER_FLAG_TOP_BACK_RIGHT") = py::int_(fSpeakerFlagTopBackRight);
m.attr("SPEAKER_FLAG_FRONT_LEFT_WIDE") = py::int_(fSpeakerFlagFrontLeftWide);
m.attr("SPEAKER_FLAG_FRONT_RIGHT_WIDE") = py::int_(fSpeakerFlagFrontRightWide);
m.attr("SPEAKER_FLAG_TOP_LEFT") = py::int_(fSpeakerFlagTopLeft);
m.attr("SPEAKER_FLAG_TOP_RIGHT") = py::int_(fSpeakerFlagTopRight);
m.attr("INVALID_SPEAKER_NAME") = py::int_(kInvalidSpeakerName);
m.attr("SPEAKER_MODE_DEFAULT") = py::int_(kSpeakerModeDefault);
m.attr("SPEAKER_MODE_MONO") = py::int_(kSpeakerModeMono);
m.attr("SPEAKER_MODE_STEREO") = py::int_(kSpeakerModeStereo);
m.attr("SPEAKER_MODE_TWO_POINT_ONE") = py::int_(kSpeakerModeTwoPointOne);
m.attr("SPEAKER_MODE_QUAD") = py::int_(kSpeakerModeQuad);
m.attr("SPEAKER_MODE_FOUR_POINT_ONE") = py::int_(kSpeakerModeFourPointOne);
m.attr("SPEAKER_MODE_FIVE_POINT_ONE") = py::int_(kSpeakerModeFivePointOne);
m.attr("SPEAKER_MODE_SIX_POINT_ONE") = py::int_(kSpeakerModeSixPointOne);
m.attr("SPEAKER_MODE_SEVEN_POINT_ONE") = py::int_(kSpeakerModeSevenPointOne);
m.attr("SPEAKER_MODE_NINE_POINT_ONE") = py::int_(kSpeakerModeNinePointOne);
m.attr("SPEAKER_MODE_SEVEN_POINT_ONE_POINT_FOUR") = py::int_(kSpeakerModeSevenPointOnePointFour);
m.attr("SPEAKER_MODE_NINE_POINT_ONE_POINT_FOUR") = py::int_(kSpeakerModeNinePointOnePointFour);
m.attr("SPEAKER_MODE_NINE_POINT_ONE_POINT_SIX") = py::int_(kSpeakerModeNinePointOnePointSix);
m.attr("SPEAKER_MODE_THREE_POINT_ZERO") = py::int_(kSpeakerModeThreePointZero);
m.attr("SPEAKER_MODE_FIVE_POINT_ZERO") = py::int_(kSpeakerModeFivePointZero);
m.attr("SPEAKER_MODE_COUNT") = py::int_(kSpeakerModeCount);
m.attr("SPEAKER_MODE_VALID_BITS") = py::int_(fSpeakerModeValidBits);
m.attr("DEVICE_FLAG_NOT_OPEN") = py::int_(fDeviceFlagNotOpen);
m.attr("DEVICE_FLAG_CONNECTED") = py::int_(fDeviceFlagConnected);
m.attr("DEVICE_FLAG_DEFAULT") = py::int_(fDeviceFlagDefault);
m.attr("DEVICE_FLAG_STREAMER") = py::int_(fDeviceFlagStreamer);
// TODO: bind UserData
py::enum_<SampleFormat>(m, "SampleFormat")
.value("PCM8", SampleFormat::ePcm8)
.value("PCM16", SampleFormat::ePcm16)
.value("PCM24", SampleFormat::ePcm24)
.value("PCM32", SampleFormat::ePcm32)
.value("PCM_FLOAT", SampleFormat::ePcmFloat)
.value("PCM_COUNT", SampleFormat::ePcmCount)
.value("VORBIS", SampleFormat::eVorbis)
.value("FLAC", SampleFormat::eFlac)
.value("OPUS", SampleFormat::eOpus)
.value("MP3", SampleFormat::eMp3)
.value("RAW", SampleFormat::eRaw)
.value("DEFAULT", SampleFormat::eDefault)
.value("COUNT", SampleFormat::eCount);
// this is intentionally not bound since there is currently no python
// functionality that could make use of this behavior
// m.attr("AUDIO_IMAGE_FLAG_NO_CLEAR") = py::int_(fAudioImageNoClear);
m.attr("AUDIO_IMAGE_FLAG_USE_LINES") = py::int_(fAudioImageUseLines);
m.attr("AUDIO_IMAGE_FLAG_NOISE_COLOR") = py::int_(fAudioImageNoiseColor);
m.attr("AUDIO_IMAGE_FLAG_MULTI_CHANNEL") = py::int_(fAudioImageMultiChannel);
m.attr("AUDIO_IMAGE_FLAG_ALPHA_BLEND") = py::int_(fAudioImageAlphaBlend);
m.attr("AUDIO_IMAGE_FLAG_SPLIT_CHANNELS") = py::int_(fAudioImageSplitChannels);
py::class_<SoundFormat>(m, "SoundFormat")
.def_readwrite("channels", &SoundFormat::channels)
.def_readwrite("bits_per_sample", &SoundFormat::bitsPerSample)
.def_readwrite("frame_size", &SoundFormat::frameSize)
.def_readwrite("block_size", &SoundFormat::blockSize)
.def_readwrite("frames_per_block", &SoundFormat::framesPerBlock)
.def_readwrite("frame_rate", &SoundFormat::frameRate)
.def_readwrite("channel_mask", &SoundFormat::channelMask)
.def_readwrite("valid_bits_per_sample", &SoundFormat::validBitsPerSample)
.def_readwrite("format", &SoundFormat::format);
m.attr("INVALID_DEVICE_INDEX") = py::int_(kInvalidDeviceIndex);
// DeviceCaps::thisSize isn't readable and is always constructed to sizeof(DeviceCaps)
py::class_<DeviceCaps>(m, "DeviceCaps")
.def_readwrite("index", &DeviceCaps::index)
.def_readwrite("flags", &DeviceCaps::flags)
.def_readwrite("guid", &DeviceCaps::guid)
.def_readwrite("channels", &DeviceCaps::channels)
.def_readwrite("frame_rate", &DeviceCaps::frameRate)
.def_readwrite("format", &DeviceCaps::format)
// python doesn't seem to like it when an array member is exposed
.def("get_name", [](const DeviceCaps* self) -> const char* { return self->name; });
m.attr("DEFAULT_FRAME_RATE") = py::int_(kDefaultFrameRate);
m.attr("DEFAULT_CHANNEL_COUNT") = py::int_(kDefaultChannelCount);
// FIXME: this doesn't work
// m.attr("DEFAULT_FORMAT") = py::enum_<SampleFormat>(kDefaultFormat);
/////// IAudioPlayback.h ///////
m.attr("CONTEXT_PARAM_ALL") = py::int_(fContextParamAll);
m.attr("CONTEXT_PARAM_SPEED_OF_SOUND") = py::int_(fContextParamSpeedOfSound);
m.attr("CONTEXT_PARAM_WORLD_UNIT_SCALE") = py::int_(fContextParamWorldUnitScale);
m.attr("CONTEXT_PARAM_LISTENER") = py::int_(fContextParamListener);
m.attr("CONTEXT_PARAM_DOPPLER_SCALE") = py::int_(fContextParamDopplerScale);
m.attr("CONTEXT_PARAM_VIRTUALIZATION_THRESHOLD") = py::int_(fContextParamVirtualizationThreshold);
m.attr("CONTEXT_PARAM_SPATIAL_FREQUENCY_RATIO") = py::int_(fContextParamSpatialFrequencyRatio);
m.attr("CONTEXT_PARAM_NON_SPATIAL_FREQUENCY_RATIO") = py::int_(fContextParamNonSpatialFrequencyRatio);
m.attr("CONTEXT_PARAM_MASTER_VOLUME") = py::int_(fContextParamMasterVolume);
m.attr("CONTEXT_PARAM_SPATIAL_VOLUME") = py::int_(fContextParamSpatialVolume);
m.attr("CONTEXT_PARAM_NON_SPATIAL_VOLUME") = py::int_(fContextParamNonSpatialVolume);
m.attr("CONTEXT_PARAM_DOPPLER_LIMIT") = py::int_(fContextParamDopplerLimit);
m.attr("CONTEXT_PARAM_DEFAULT_PLAYBACK_MODE") = py::int_(fContextParamDefaultPlaybackMode);
m.attr("CONTEXT_PARAM_VIDEO_LATENCY") = py::int_(fContextParamVideoLatency);
m.attr("DEFAULT_SPEED_OF_SOUND") = py::float_(kDefaultSpeedOfSound);
m.attr("VOICE_PARAM_ALL") = py::int_(fVoiceParamAll);
m.attr("VOICE_PARAM_PLAYBACK_MODE") = py::int_(fVoiceParamPlaybackMode);
m.attr("VOICE_PARAM_VOLUME") = py::int_(fVoiceParamVolume);
m.attr("VOICE_PARAM_MUTE") = py::int_(fVoiceParamMute);
m.attr("VOICE_PARAM_BALANCE") = py::int_(fVoiceParamBalance);
m.attr("VOICE_PARAM_FREQUENCY_RATIO") = py::int_(fVoiceParamFrequencyRatio);
m.attr("VOICE_PARAM_PRIORITY") = py::int_(fVoiceParamPriority);
m.attr("VOICE_PARAM_PAUSE") = py::int_(fVoiceParamPause);
m.attr("VOICE_PARAM_SPATIAL_MIX_LEVEL") = py::int_(fVoiceParamSpatialMixLevel);
m.attr("VOICE_PARAM_DOPPLER_SCALE") = py::int_(fVoiceParamDopplerScale);
m.attr("VOICE_PARAM_OCCLUSION_FACTOR") = py::int_(fVoiceParamOcclusionFactor);
m.attr("VOICE_PARAM_EMITTER") = py::int_(fVoiceParamEmitter);
m.attr("VOICE_PARAM_MATRIX") = py::int_(fVoiceParamMatrix);
m.attr("PLAYBACK_MODE_SPATIAL") = py::int_(fPlaybackModeSpatial);
m.attr("PLAYBACK_MODE_LISTENER_RELATIVE") = py::int_(fPlaybackModeListenerRelative);
m.attr("PLAYBACK_MODE_DISTANCE_DELAY") = py::int_(fPlaybackModeDistanceDelay);
m.attr("PLAYBACK_MODE_INTERAURAL_DELAY") = py::int_(fPlaybackModeInterauralDelay);
m.attr("PLAYBACK_MODE_USE_DOPPLER") = py::int_(fPlaybackModeUseDoppler);
m.attr("PLAYBACK_MODE_USE_REVERB") = py::int_(fPlaybackModeUseReverb);
m.attr("PLAYBACK_MODE_USE_FILTERS") = py::int_(fPlaybackModeUseFilters);
m.attr("PLAYBACK_MODE_MUTED") = py::int_(fPlaybackModeMuted);
m.attr("PLAYBACK_MODE_PAUSED") = py::int_(fPlaybackModePaused);
m.attr("PLAYBACK_MODE_FADE_IN") = py::int_(fPlaybackModeFadeIn);
m.attr("PLAYBACK_MODE_SIMULATE_POSITION") = py::int_(fPlaybackModeSimulatePosition);
m.attr("PLAYBACK_MODE_NO_POSITION_SIMULATION") = py::int_(fPlaybackModeNoPositionSimulation);
m.attr("PLAYBACK_MODE_SPATIAL_MIX_LEVEL_MATRIX") = py::int_(fPlaybackModeSpatialMixLevelMatrix);
m.attr("PLAYBACK_MODE_NO_SPATIAL_LOW_FREQUENCY_EFFECT") = py::int_(fPlaybackModeNoSpatialLowFrequencyEffect);
m.attr("PLAYBACK_MODE_STOP_ON_SIMULATION") = py::int_(fPlaybackModeStopOnSimulation);
m.attr("PLAYBACK_MODE_DEFAULT_USE_DOPPLER") = py::int_(fPlaybackModeDefaultUseDoppler);
m.attr("PLAYBACK_MODE_DEFAULT_DISTANCE_DELAY") = py::int_(fPlaybackModeDefaultDistanceDelay);
m.attr("PLAYBACK_MODE_DEFAULT_INTERAURAL_DELAY") = py::int_(fPlaybackModeDefaultInterauralDelay);
m.attr("PLAYBACK_MODE_DEFAULT_USE_REVERB") = py::int_(fPlaybackModeDefaultUseReverb);
m.attr("PLAYBACK_MODE_DEFAULT_USE_FILTERS") = py::int_(fPlaybackModeDefaultUseFilters);
m.attr("ENTITY_FLAG_ALL") = py::int_(fEntityFlagAll);
m.attr("ENTITY_FLAG_POSITION") = py::int_(fEntityFlagPosition);
m.attr("ENTITY_FLAG_VELOCITY") = py::int_(fEntityFlagVelocity);
m.attr("ENTITY_FLAG_FORWARD") = py::int_(fEntityFlagForward);
m.attr("ENTITY_FLAG_UP") = py::int_(fEntityFlagUp);
m.attr("ENTITY_FLAG_CONE") = py::int_(fEntityFlagCone);
m.attr("ENTITY_FLAG_ROLLOFF") = py::int_(fEntityFlagRolloff);
m.attr("ENTITY_FLAG_MAKE_PERP") = py::int_(fEntityFlagMakePerp);
m.attr("ENTITY_FLAG_NORMALIZE") = py::int_(fEntityFlagNormalize);
py::enum_<RolloffType>(m, "RolloffType")
.value("INVERSE", RolloffType::eInverse)
.value("LINEAR", RolloffType::eLinear)
.value("LINEAR_SQUARE", RolloffType::eLinearSquare);
m.attr("INSTANCES_UNLIMITED") = py::int_(kInstancesUnlimited);
// this won't be done through flags in python
// m.attr("DATA_FLAG_FORMAT_MASK") = py::int_(fDataFlagFormatMask);
// m.attr("DATA_FLAG_FORMAT_AUTO") = py::int_(fDataFlagFormatAuto);
// m.attr("DATA_FLAG_FORMAT_RAW") = py::int_(fDataFlagFormatRaw);
// m.attr("DATA_FLAG_IN_MEMORY") = py::int_(fDataFlagInMemory);
// m.attr("DATA_FLAG_STREAM") = py::int_(fDataFlagStream);
// m.attr("DATA_FLAG_DECODE") = py::int_(fDataFlagDecode);
// m.attr("DATA_FLAG_FORMAT_PCM") = py::int_(fDataFlagFormatPcm);
// m.attr("DATA_FLAG_EMPTY") = py::int_(fDataFlagEmpty);
// m.attr("DATA_FLAG_NO_NAME") = py::int_(fDataFlagNoName);
// this won't ever be supported in python
// m.attr("DATA_FLAG_USER_MEMORY") = py::int_(fDataFlagUserMemory);
// not supported yet - we may not support it
// m.attr("DATA_FLAG_USER_DECODE") = py::int_(fDataFlagUserDecode);
m.attr("DATA_FLAG_SKIP_METADATA") = py::int_(fDataFlagSkipMetaData);
m.attr("DATA_FLAG_SKIP_EVENT_POINTS") = py::int_(fDataFlagSkipEventPoints);
m.attr("DATA_FLAG_CALC_PEAKS") = py::int_(fDataFlagCalcPeaks);
m.attr("SAVE_FLAG_DEFAULT") = py::int_(fSaveFlagDefault);
m.attr("SAVE_FLAG_STRIP_METADATA") = py::int_(fSaveFlagStripMetaData);
m.attr("SAVE_FLAG_STRIP_EVENT_POINTS") = py::int_(fSaveFlagStripEventPoints);
m.attr("SAVE_FLAG_STRIP_PEAKS") = py::int_(fSaveFlagStripPeaks);
m.attr("MEMORY_LIMIT_THRESHOLD") = py::int_(kMemoryLimitThreshold);
m.attr("META_DATA_TAG_ARCHIVAL_LOCATION") = std::string(kMetaDataTagArchivalLocation);
m.attr("META_DATA_TAG_COMMISSIONED") = std::string(kMetaDataTagCommissioned);
m.attr("META_DATA_TAG_CROPPED") = std::string(kMetaDataTagCropped);
m.attr("META_DATA_TAG_DIMENSIONS") = std::string(kMetaDataTagDimensions);
m.attr("META_DATA_TAG_DISC") = std::string(kMetaDataTagDisc);
m.attr("META_DATA_TAG_DPI") = std::string(kMetaDataTagDpi);
m.attr("META_DATA_TAG_EDITOR") = std::string(kMetaDataTagEditor);
m.attr("META_DATA_TAG_ENGINEER") = std::string(kMetaDataTagEngineer);
m.attr("META_DATA_TAG_KEYWORDS") = std::string(kMetaDataTagKeywords);
m.attr("META_DATA_TAG_LANGUAGE") = std::string(kMetaDataTagLanguage);
m.attr("META_DATA_TAG_LIGHTNESS") = std::string(kMetaDataTagLightness);
m.attr("META_DATA_TAG_MEDIUM") = std::string(kMetaDataTagMedium);
m.attr("META_DATA_TAG_PALETTE_SETTING") = std::string(kMetaDataTagPaletteSetting);
m.attr("META_DATA_TAG_SUBJECT") = std::string(kMetaDataTagSubject);
m.attr("META_DATA_TAG_SOURCE_FORM") = std::string(kMetaDataTagSourceForm);
m.attr("META_DATA_TAG_SHARPNESS") = std::string(kMetaDataTagSharpness);
m.attr("META_DATA_TAG_TECHNICIAN") = std::string(kMetaDataTagTechnician);
m.attr("META_DATA_TAG_WRITER") = std::string(kMetaDataTagWriter);
m.attr("META_DATA_TAG_ALBUM") = std::string(kMetaDataTagAlbum);
m.attr("META_DATA_TAG_ARTIST") = std::string(kMetaDataTagArtist);
m.attr("META_DATA_TAG_COPYRIGHT") = std::string(kMetaDataTagCopyright);
m.attr("META_DATA_TAG_CREATION_DATE") = std::string(kMetaDataTagCreationDate);
m.attr("META_DATA_TAG_DESCRIPTION") = std::string(kMetaDataTagDescription);
m.attr("META_DATA_TAG_GENRE") = std::string(kMetaDataTagGenre);
m.attr("META_DATA_TAG_ORGANIZATION") = std::string(kMetaDataTagOrganization);
m.attr("META_DATA_TAG_TITLE") = std::string(kMetaDataTagTitle);
m.attr("META_DATA_TAG_TRACK_NUMBER") = std::string(kMetaDataTagTrackNumber);
m.attr("META_DATA_TAG_ENCODER") = std::string(kMetaDataTagEncoder);
m.attr("META_DATA_TAG_ISRC") = std::string(kMetaDataTagISRC);
m.attr("META_DATA_TAG_LICENSE") = std::string(kMetaDataTagLicense);
m.attr("META_DATA_TAG_PERFORMER") = std::string(kMetaDataTagPerformer);
m.attr("META_DATA_TAG_VERSION") = std::string(kMetaDataTagVersion);
m.attr("META_DATA_TAG_LOCATION") = std::string(kMetaDataTagLocation);
m.attr("META_DATA_TAG_CONTACT") = std::string(kMetaDataTagContact);
m.attr("META_DATA_TAG_COMMENT") = std::string(kMetaDataTagComment);
m.attr("META_DATA_TAG_SPEED") = std::string(kMetaDataTagSpeed);
m.attr("META_DATA_TAG_START_TIME") = std::string(kMetaDataTagStartTime);
m.attr("META_DATA_TAG_END_TIME") = std::string(kMetaDataTagEndTime);
m.attr("META_DATA_TAG_SUBGENRE") = std::string(kMetaDataTagSubGenre);
m.attr("META_DATA_TAG_BPM") = std::string(kMetaDataTagBpm);
m.attr("META_DATA_TAG_PLAYLIST_DELAY") = std::string(kMetaDataTagPlaylistDelay);
m.attr("META_DATA_TAG_FILE_NAME") = std::string(kMetaDataTagFileName);
m.attr("META_DATA_TAG_ALBUM") = std::string(kMetaDataTagOriginalAlbum);
m.attr("META_DATA_TAG_WRITER") = std::string(kMetaDataTagOriginalWriter);
m.attr("META_DATA_TAG_PERFORMER") = std::string(kMetaDataTagOriginalPerformer);
m.attr("META_DATA_TAG_ORIGINAL_YEAR") = std::string(kMetaDataTagOriginalYear);
m.attr("META_DATA_TAG_PUBLISHER") = std::string(kMetaDataTagPublisher);
m.attr("META_DATA_TAG_RECORDING_DATE") = std::string(kMetaDataTagRecordingDate);
m.attr("META_DATA_TAG_INTERNET_RADIO_STATION_NAME") = std::string(kMetaDataTagInternetRadioStationName);
m.attr("META_DATA_TAG_INTERNET_RADIO_STATION_OWNER") = std::string(kMetaDataTagInternetRadioStationOwner);
m.attr("META_DATA_TAG_INTERNET_RADIO_STATION_URL") = std::string(kMetaDataTagInternetRadioStationUrl);
m.attr("META_DATA_TAG_PAYMENT_URL") = std::string(kMetaDataTagPaymentUrl);
m.attr("META_DATA_TAG_INTERNET_COMMERCIAL_INFORMATION_URL") =
std::string(kMetaDataTagInternetCommercialInformationUrl);
m.attr("META_DATA_TAG_INTERNET_COPYRIGHT_URL") = std::string(kMetaDataTagInternetCopyrightUrl);
m.attr("META_DATA_TAG_WEBSITE") = std::string(kMetaDataTagWebsite);
m.attr("META_DATA_TAG_INTERNET_ARTIST_WEBSITE") = std::string(kMetaDataTagInternetArtistWebsite);
m.attr("META_DATA_TAG_AUDIO_SOURCE_WEBSITE") = std::string(kMetaDataTagAudioSourceWebsite);
m.attr("META_DATA_TAG_COMPOSER") = std::string(kMetaDataTagComposer);
m.attr("META_DATA_TAG_OWNER") = std::string(kMetaDataTagOwner);
m.attr("META_DATA_TAG_TERMS_OF_USE") = std::string(kMetaDataTagTermsOfUse);
m.attr("META_DATA_TAG_INITIAL_KEY") = std::string(kMetaDataTagInitialKey);
m.attr("META_DATA_TAG_CLEAR_ALL_TAGS") = kMetaDataTagClearAllTags;
py::class_<PeakVolumes>(m, "PeakVolumes")
.def_readwrite("channels", &PeakVolumes::channels)
//.def_readwrite("frame", &PeakVolumes::frame)
//.def_readwrite("peak", &PeakVolumes::peak)
.def_readwrite("peak_frame", &PeakVolumes::peakFrame)
.def_readwrite("peak_volume", &PeakVolumes::peakVolume);
m.attr("EVENT_POINT_INVALID_FRAME") = py::int_(kEventPointInvalidFrame);
m.attr("EVENT_POINT_LOOP_INFINITE") = py::int_(kEventPointLoopInfinite);
py::class_<EventPoint>(m, "EventPoint")
.def(py::init<>())
.def_readwrite("id", &EventPoint::id)
.def_readwrite("frame", &EventPoint::frame)
//.def_readwrite("label", &EventPoint::label)
//.def_readwrite("text", &EventPoint::text)
.def_readwrite("length", &EventPoint::length)
.def_readwrite("loop_count", &EventPoint::loopCount)
.def_readwrite("play_index", &EventPoint::playIndex);
// FIXME: maybe we want to bind userdata
py::enum_<UnitType>(m, "UnitType")
.value("BYTES", UnitType::eBytes)
.value("FRAMES", UnitType::eFrames)
.value("MILLISECONDS", UnitType::eMilliseconds)
.value("MICROSECONDS", UnitType::eMicroseconds);
m.doc() = R"(
This module contains bindings for the IAudioPlayback interface.
This is the low-level audio playback interface for Carbonite.
)";
py::class_<ContextCaps> ctxCaps(m, "ContextCaps");
ctxCaps.doc() = R"(
The capabilities of the context object. Some of these values are set
at the creation time of the context object. Others are updated when
speaker positions are set or an output device is opened.
)";
py::class_<ContextParams> ctxParams(m, "ContextParams");
ctxParams.doc() = R"(
Context parameters block. This can potentially contain all of a
context's parameters and their current values. This is used to both
set and retrieve one or more of a context's parameters in a single
call. The set of fContextParam* flags that are passed to
getContextParameter() or setContextParameter() indicates which values
in the block are guaranteed to be valid.
)";
py::class_<ContextParams2> ctxParams2(m, "ContextParams2");
ctxParams2.doc() = R"(
Extended context parameters block. This is used to set and retrieve
extended context parameters and their current values. This object
must be attached to the 'ContextParams.ext' value and the
'ContextParams.flags' value must have one or more flags related
to the extended parameters set for them to be modified or retrieved.
)";
py::class_<LoopPointDesc> loopPointDesc(m, "LoopPointDesc");
loopPointDesc.doc() = R"(
Descriptor of a loop point to set on a voice. This may be specified
to change the current loop point on a voice with set_Loop_Point().
)";
py::class_<DspValuePair> dspValuePair(m, "DspValuePair");
dspValuePair.def_readwrite("inner", &DspValuePair::inner);
dspValuePair.def_readwrite("outer", &DspValuePair::outer);
py::class_<EntityCone> cone(m, "EntityCone");
cone.def_readwrite("inside_angle", &EntityCone::insideAngle);
cone.def_readwrite("outside_angle", &EntityCone::outsideAngle);
cone.def_readwrite("volume", &EntityCone::volume);
cone.def_readwrite("low_pass_filter", &EntityCone::lowPassFilter);
cone.def_readwrite("reverb", &EntityCone::reverb);
cone.doc() = R"(
defines a sound cone relative to an entity's front vector. It is defined by two angles -
the inner and outer angles. When the angle between an emitter and the listener (relative
to the entity's front vector) is smaller than the inner angle, the resulting DSP value
will be the 'inner' value. When the emitter-listener angle is larger than the outer
angle, the resulting DSP value will be the 'outer' value. For emitter-listener angles
that are between the inner and outer angles, the DSP value will be interpolated between
the inner and outer angles. If a cone is valid for an entity, the @ref fEntityFlagCone
flag should be set in @ref EntityAttributes::flags.
Note that a cone's effect on the spatial volume of a sound is purely related to the angle
between the emitter and listener. Any distance attenuation is handled separately.
)";
py::class_<EntityAttributes> entityAttributes(m, "EntityAttributes");
entityAttributes.def_readwrite("flags", &EntityAttributes::flags);
entityAttributes.def_readwrite("position", &EntityAttributes::position);
entityAttributes.def_readwrite("velocity", &EntityAttributes::velocity);
entityAttributes.def_readwrite("forward", &EntityAttributes::forward);
entityAttributes.def_readwrite("up", &EntityAttributes::up);
entityAttributes.def_readwrite("cone", &EntityAttributes::cone);
entityAttributes.doc() = R"(
base spatial attributes of the entity. This includes its position, orientation, and velocity
and an optional cone.
)";
py::class_<RolloffDesc> rolloffDesc(m, "RolloffDesc");
rolloffDesc.def_readwrite("type", &RolloffDesc::type);
rolloffDesc.def_readwrite("near_distance", &RolloffDesc::nearDistance);
rolloffDesc.def_readwrite("far_distance", &RolloffDesc::farDistance);
rolloffDesc.doc() = R"(
Descriptor of the rolloff mode and range.
The C++ API allows rolloff curves to be set through this struct, but in
python you need to use voice.set_rolloff_curve() to do this instead.
)";
py::class_<EmitterAttributes> emitterAttributes(m, "EmitterAttributes");
emitterAttributes.def_readwrite("flags", &EmitterAttributes::flags);
emitterAttributes.def_readwrite("position", &EmitterAttributes::position);
emitterAttributes.def_readwrite("velocity", &EmitterAttributes::velocity);
emitterAttributes.def_readwrite("forward", &EmitterAttributes::forward);
emitterAttributes.def_readwrite("up", &EmitterAttributes::up);
emitterAttributes.def_readwrite("cone", &EmitterAttributes::cone);
emitterAttributes.def_readwrite("rolloff", &EmitterAttributes::rolloff);
py::class_<VoiceParams::VoiceParamBalance> voiceParamBalance(m, "VoiceParamBalance");
voiceParamBalance.def_readwrite("pan", &VoiceParams::VoiceParamBalance::pan);
voiceParamBalance.def_readwrite("fade", &VoiceParams::VoiceParamBalance::fade);
py::class_<VoiceParams::VoiceParamOcclusion> voiceParamOcclusion(m, "VoiceParamOcclusion");
voiceParamOcclusion.def_readwrite("direct", &VoiceParams::VoiceParamOcclusion::direct);
voiceParamOcclusion.def_readwrite("reverb", &VoiceParams::VoiceParamOcclusion::reverb);
py::class_<VoiceParams> voiceParams(m, "VoiceParams");
voiceParams.def_readwrite("playback_mode", &VoiceParams::playbackMode);
voiceParams.def_readwrite("volume", &VoiceParams::volume);
voiceParams.def_readwrite("balance", &VoiceParams::balance);
voiceParams.def_readwrite("frequency_ratio", &VoiceParams::frequencyRatio);
voiceParams.def_readwrite("priority", &VoiceParams::priority);
voiceParams.def_readwrite("spatial_mix_level", &VoiceParams::spatialMixLevel);
voiceParams.def_readwrite("doppler_scale", &VoiceParams::dopplerScale);
voiceParams.def_readwrite("occlusion", &VoiceParams::occlusion);
voiceParams.def_readwrite("emitter", &VoiceParams::emitter);
voiceParams.doc() = R"(
Voice parameters block. This can potentially contain all of a voice's
parameters and their current values. This is used to both set and
retrieve one or more of a voice's parameters in a single call. The
VOICE_PARAM_* flags that are passed to set_voice_parameters() or
get_voice_parameters() determine which values in this block are
guaranteed to be valid.
The matrix parameter isn't available from this struct due to limitations
in python; use voice.set_matrix() instead.
)";
py::class_<PythonContext> ctx(m, "Context");
ctx.doc() = R"(
The Context object for the audio system.
Each individual Context represents an instance of the IAudioPlayback
interface, as well as an individual connection to the system audio
mixer/device. Only a small number of these can be opened for a given
process.
)";
docString = R"(
retrieves the current capabilities and settings for a context object.
This retrieves the current capabilities and settings for a context
object. Some of these settings may change depending on whether the
context has opened an output device or not.
Args:
No arguments.
Returns:
the context's current capabilities and settings. This includes the
speaker mode, speaker positions, maximum bus count, and information
about the output device that is opened (if any).
)";
ctx.def("get_caps", [](PythonContext* self) -> ContextCaps { return *self->getContextCaps(); }, docString,
py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets one or more parameters on a context.
This sets one or more context parameters in a single call. Only
parameters that have their corresponding flag set in paramsToSet will
be modified. If a change is to be relative to the context's current
parameter value, the current value should be retrieved first, modified,
then set.
Args:
paramsToSet: The set of flags to indicate which parameters in the
parameter block params are valid and should be set
on the context. This may be zero or more of the
CONTEXT_PARAM_* bitflags. If this is 0, the call will be
treated as a no-op.
params: The parameter(s) to be set on the context. The flags
indicating which parameters need to be set are given
in paramsToSet. Undefined behavior may occur if
a flag is set but its corresponding value(s) have not
been properly initialized. This may not be None.
Returns:
No return value.
)";
ctx.def("set_parameters", &PythonContext::setContextParameters, docString, py::arg("paramsToSet"),
py::arg("params"), py::call_guard<py::gil_scoped_release>());
docString = R"(
Retrieves one or more parameters for a context.
This retrieves the current values of one or more of a context's
parameters. Only the parameter values listed in paramsToGet flags
will be guaranteed to be valid upon return.
Args:
ParamsToGet: Flags indicating which parameter values need to be retrieved.
This should be a combination of the CONTEXT_PARAM_* bitflags.
Returns:
The requested parameters in a ContextParams struct. Everything else is default-initialized.
)";
ctx.def("get_parameters",
[](PythonContext* self, ContextParamFlags paramsToGet) -> ContextParams {
ContextParams tmp = {};
self->getContextParameters(paramsToGet, &tmp);
return tmp;
},
docString, py::arg("paramsToGet"), py::call_guard<py::gil_scoped_release>());
docString = R"(
Schedules a sound to be played on a voice.
This schedules a sound object to be played on a voice. The sounds current
settings (ie: volume, pitch, playback frame rate, pan, etc) will be assigned to
the voice as 'defaults' before playing. Further changes can be made to the
voice's state at a later time without affecting the sound's default settings.
Once the sound finishes playing, it will be implicitly unassigned from the
voice. If the sound or voice have a callback set, a notification will be
received for the sound having ended.
If the playback of this sound needs to be stopped, it must be explicitly stopped
from the returned voice object using stopVoice(). This can be called on a
single voice or a voice group.
Args:
sound: The sound to schedule.
flags: Flags that alter playback behavior. Must be a combination of PLAY_FLAG_* constants.
valid_params: Which parameters in the params argument to use.
params: The starting parameters for the voice. This conditionally used based on valid_params.
loop_point: A descriptor for how to repeatedly play the sound. This can be None to only play once.
play_start: The start offset to begin playing the sound at. This is measured in play_units.
play_end: The stop offset to finish playing the sound at. This is measured in play_units.
play_units: The units in which play_start and play_stop are measured.
Returns:
A new voice handle representing the playing sound. Note that if no buses are
currently available to play on or the voice's initial parameters indicated that
it is not currently audible, the voice will be virtual and will not be played.
The voice handle will still be valid in this case and can be operated on, but
no sound will be heard from it until it is determined that it should be converted
to a real voice. This can only occur when the update() function is called.
This voice handle does not need to be closed or destroyed. If the voice finishes
its play task, any future calls attempting to modify the voice will simply fail.
None if the requested sound is already at or above its instance limit and the
PLAY_FLAG_MAX_INSTANCES_SIMULATE flag is not used.
None if the play task was invalid or could not be started properly. This can
most often occur in the case of streaming sounds if the sound's original data
could not be opened or decoded properly.
)";
ctx.def("play_sound", &PythonContext::playSound, docString, py::arg("sound"), py::arg("flags") = 0,
py::arg("valid_params") = 0, py::arg("params") = nullptr, py::arg("loop_point") = nullptr,
py::arg("play_start") = 0, py::arg("play_end") = 0, py::arg("play_units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
py::class_<carb::audio::PythonVoice> voice(m, "Voice");
voice.doc() = R"(
Represents a single instance of a playing sound. A single sound object
may be playing on multiple voices at the same time, however each voice
may only be playing a single sound at any given time.
)";
docString = R"(
Stops playback on a voice.
This stops a voice from playing its current sound. This will be
silently ignored for any voice that is already stopped or for an
invalid voice handle. Once stopped, the voice will be returned to a
'free' state and its sound data object unassigned from it. The voice
will be immediately available to be assigned a new sound object to play
from.
This will only schedule the voice to be stopped. Its volume will be
implicitly set to silence to avoid a popping artifact on stop. The
voice will continue to play for one more engine cycle until the volume
level reaches zero, then the voice will be fully stopped and recycled.
At most, 1ms of additional audio will be played from the voice's sound.
Args:
No Arguments.
Returns:
No return value.
)";
voice.def("stop", &PythonVoice::stop, docString, py::call_guard<py::gil_scoped_release>());
docString = R"(
Checks the playing state of a voice.
This checks if a voice is currently playing. A voice is considered
playing if it has a currently active sound data object assigned to it
and it is not paused.
Args:
Voice: The voice to check the playing state for.
Returns:
True if the requested voice is playing.
False if the requested voice is not playing or is paused.
False if the given voice handle is no longer valid.
)";
voice.def("is_playing", &PythonVoice::isPlaying, docString, py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets a new loop point as current on a voice.
This sets a new loop point for a playing voice. This allows for behavior
such as sound atlases or sound playlists to be played out on a single
voice.
When desc is None or the contents of the descriptor do not specify a new
loop point, this will immediately break the loop that is currently playing
on the voice. This will have the effect of setting the voice's current
loop count to zero. The sound on the voice will continue to play out its
current loop iteration, but will not loop again when it reaches its end.
This is useful for stopping a voice that is playing an infinite loop or to
prematurely stop a voice that was set to loop a specific number of times.
This call will effectively be ignored if passed in a voice that is not
currently looping.
For streaming voices, updating a loop point will have a delay due to
buffering the decoded data. The sound will loop an extra time if the loop
point is changed after the buffering has started to consume another loop.
The default buffer time for streaming sounds is currently 200 milliseconds,
so this is the minimum slack time that needs to be given for a loop change.
Args:
voice: the voice to set the loop point on. This may not be nullptr.
point: descriptor of the new loop point to set. This may contain a loop
or event point from the sound itself or an explicitly specified
loop point. This may be nullptr to indicate that the current loop
point should be removed and the current loop broken. Similarly,
an empty loop point descriptor could be passed in to remove the
current loop point.
Returns:
True if the new loop point is successfully set.
False if the voice handle is invalid or the voice has already stopped
on its own.
False if the new loop point is invalid, not found in the sound data
object, or specifies a starting point or length that is outside the
range of the sound data object's buffer.
)";
voice.def("set_loop_point", &PythonVoice::setLoopPoint, docString, py::arg("point"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Retrieves the current play cursor position of a voice.
This retrieves the current play position for a voice. This is not
necessarily the position in the buffer being played, but rather the
position in the sound data object's stream. For streaming sounds, this
will be the offset from the start of the stream. For non-streaming sounds,
this will be the offset from the beginning of the sound data object's
buffer.
If the loop point for the voice changes during playback, the results of
this call can be unexpected. Once the loop point changes, there is no
longer a consistent time base for the voice and the results will reflect
the current position based off of the original loop's time base. As long
as the voice's original loop point remains (ie: setLoopPoint() is never
called on the voice), the calculated position should be correct.
It is the caller's responsibility to ensure that this is not called at the
same time as changing the loop point on the voice or stopping the voice.
Args:
type: The units to retrieve the current position in.
Returns:
The current position of the voice in the requested units.
0 if the voice has stopped playing.
The last play cursor position if the voice is paused.
)";
voice.def("get_play_cursor", &PythonVoice::getPlayCursor, docString, py::arg("type"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets one or more parameters on a voice.
This sets one or more voice parameters in a single call. Only parameters that
have their corresponding flag set in paramToSet will be modified.
If a change is to be relative to the voice's current parameter value, the current
value should be retrieved first, modified, then set.
Args:
paramsToSet: Flags to indicate which of the parameters need to be updated.
This may be one or more of the fVoiceParam* flags. If this is
0, this will simply be a no-op.
params: The parameter(s) to be set on the voice. The flags indicating
which parameters need to be set must be set in
paramToSet by the caller. Undefined behavior
may occur if a flag is set but its corresponding value(s) have
not been properly initialized. This may not be None.
Returns:
No return value.
)";
voice.def("set_parameters", &PythonVoice::setParameters, docString, py::arg("params_to_set"), py::arg("params"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Retrieves one or more parameters for a voice.
This retrieves the current values of one or more of a voice's parameters.
Only the parameter values listed in paramsToGet flags will be guaranteed
to be valid upon return.
Args:
paramsToGet: Flags indicating which parameter values need to be retrieved.
Returns:
The requested parameters in a VoiceParams struct. Everything else is default-initialized.
)";
voice.def("get_parameters",
[](PythonVoice* self, VoiceParamFlags paramsToGet) -> VoiceParams {
VoiceParams tmp = {};
self->getParameters(paramsToGet, &tmp);
return tmp;
},
docString, py::arg("params_to_get") = fVoiceParamAll, py::call_guard<py::gil_scoped_release>());
docString = R"(
Set flags to indicate how a sound is to be played back.
This controls whether the sound is played as a spatial or non-spatial
sound and how the emitter's attributes will be interpreted (ie: either
world coordinates or listener relative).
PLAYBACK_MODE_MUTED and PLAYBACK_MODE_PAUSED are ignored here; you'll
need to use voice.set_mute() or voice.pause() to mute or pause the voice.
Args:
playback_mode: The playback mode flag set to set.
Returns:
None
)";
voice.def("set_playback_mode", &PythonVoice::setPlaybackMode, docString, py::arg("playback_mode"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
The volume level for the voice.
Args:
volume: The volume to set.
This should be 0.0 for silence or 1.0 for normal volume.
A negative value may be used to invert the signal.
A value greater than 1.0 will amplify the signal.
The volume level can be interpreted as a linear scale where
a value of 0.5 is half volume and 2.0 is double volume.
Any volume values in decibels must first be converted to a
linear volume scale before setting this value.
Returns:
None
)";
voice.def(
"set_volume", &PythonVoice::setVolume, docString, py::arg("volume"), py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets the mute state for a voice.
Args:
mute: When this is set to true, the voice's output will be muted.
When this is set to false, the voice's volume will be
restored to its previous level.
This is useful for temporarily silencing a voice without
having to clobber its current volume level or affect its
emitter attributes.
Returns:
None
)";
voice.def("set_mute", &PythonVoice::setMute, docString, py::arg("mute"), py::call_guard<py::gil_scoped_release>());
docString = R"(
Non-spatial sound positioning.
These provide pan and fade values for the voice to give the impression
that the sound is located closer to one of the quadrants of the
acoustic space versus the others.
These values are ignored for spatial sounds.
Args:
pan: The non-spatial panning value for a voice.
This is 0.0 to have the sound "centered" in all speakers.
This is -1.0 to have the sound balanced to the left side.
This is 1.0 to have the sound balanced to the right side.
The way the sound is balanced depends on the number of channels.
For example, a mono sound will be balanced between the left
and right sides according to the panning value, but a stereo
sound will just have the left or right channels' volumes
turned down according to the panning value.
This value is ignored for spatial sounds.
The default value is 0.0.
Note that panning on non-spatial sounds should only be used
for mono or stereo sounds.
When it is applied to sounds with more channels, the results
are often undefined or may sound odd.
fade: The non-spatial fade value for a voice.
This is 0.0 to have the sound "centered" in all speakers.
This is -1.0 to have the sound balanced to the back side.
This is 1.0 to have the sound balanced to the front side.
The way the sound is balanced depends on the number of channels.
For example, a mono sound will be balanced between the front
and back speakers according to the fade value, but a 5.1
sound will just have the front or back channels' volumes
turned down according to the fade value.
This value is ignored for spatial sounds.
The default value is 0.0.
Note that using fade on non-spatial sounds should only be
used for mono or stereo sounds.
When it is applied to sounds with more channels, the results
are often undefined or may sound odd.
Returns:
None
)";
voice.def("set_balance", &PythonVoice::setBalance, docString, py::arg("pan"), py::arg("fade"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Set The frequency ratio for a voice.
Args:
ratio: This will be 1.0 to play back a sound at its normal rate, a
value less than 1.0 to lower the pitch and play it back more
slowly, and a value higher than 1.0 to increase the pitch
and play it back faster.
For example, a pitch scale of 0.5 will play back at half the
pitch (ie: lower frequency, takes twice the time to play
versus normal), and a pitch scale of 2.0 will play back at
double the pitch (ie: higher frequency, takes half the time
to play versus normal).
The default value is 1.0.
On some platforms, the frequency ratio may be silently
clamped to an acceptable range internally.
For example, a value of 0.0 is not allowed.
This will be clamped to the minimum supported value instead.
Note that the even though the frequency ratio *can* be set
to any value in the range from 1/1024 to 1024, this very
large range should only be used in cases where it is well
known that the particular sound being operated on will still
sound valid after the change.
In
the real world, some of these extreme frequency ratios may
make sense, but in the digital world, extreme frequency
ratios can result in audio corruption or even silence.
This
happens because the new frequency falls outside of the range
that is faithfully representable by either the audio device
or sound data itself.
For example, a 4KHz tone being played at a frequency ratio
larger than 6.0 will be above the maximum representable
frequency for a 48KHz device or sound file.
This case will result in a form of corruption known as
aliasing, where the frequency components above the maximum
representable frequency will become audio artifacts.
Similarly, an 800Hz tone being played at a frequency ratio
smaller than 1/40 will be inaudible because it falls below
the frequency range of the human ear.
In general, most use cases will find that the frequency
ratio range of [0.1, 10] is more than sufficient for their
needs.
Further, for many cases, the range from [0.2, 4] would
suffice.
Care should be taken to appropriately cap the used range for
this value.
Returns:
None
)";
voice.def("set_frequency_ratio", &PythonVoice::setFrequencyRatio, docString, py::arg("ratio"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Set the playback priority of this voice.
Args:
priority: This is an arbitrary value whose scale is defined by the
host app.
A value of 0 is the default priority.
Negative values indicate lower priorities and positive
values indicate higher priorities.
This priority value helps to determine which voices are
the most important to be audible at any given time.
When all buses are busy, this value will be used to
compare against other playing voices to see if it should
steal a bus from another lower priority sound or if it
can wait until another bus finishes first.
Higher priority sounds will be ensured a bus to play on
over lower priority sounds.
If multiple sounds have the same priority levels, the
louder sound(s) will take priority.
When a higher priority sound is queued, it will try to
steal a bus from the quietest sound with lower or equal
priority.
Returns:
None
)";
voice.def("set_priority", &PythonVoice::setPriority, docString, py::arg("priority"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets the spatial mix level for the voice.
Args:
level: The mix between the results of a voice's spatial sound
calculations and its non-spatial calculations. When this is
set to 1.0, only the spatial sound calculations will affect
the voice's playback.
This is the default when state.
When set to 0.0, only the non-spatial sound calculations
will affect the voice's
playback.
When set to a value between 0.0 and 1.0, the results of the
spatial and non-spatial sound calculations will be mixed
with the weighting according to this value.
This value will be ignored if PLAYBACK_MODE_SPATIAL is not
set.
The default value is 1.0. Values above 1.0 will be treated
as 1.0.
Values below 0.0 will be treated as 0.0.
PLAYBACK_MODE_SPATIAL_MIX_LEVEL_MATRIX affects the
non-spatial mixing behavior of this parameter for
multi-channel voices.
By default, a multi-channel spatial voice's non-spatial
component will treat each channel as a separate mono voice.
With the PLAYBACK_MODE_SPATIAL_MIX_LEVEL_MATRIX flag set,
the non-spatial component will be set with the specified
output matrix or the default output matrix.
Returns:
None
)";
voice.def("set_spatial_mix_level", &PythonVoice::setSpatialMixLevel, docString, py::arg("level"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets the doppler scale value for the voice.
This allows the result of internal doppler calculations to be scaled to emulate
a time warping effect.
Args:
scale: This should be near 0.0 to greatly reduce the effect of the
doppler calculations, and up to 5.0 to exaggerate the
doppler effect.
A value of 1.0 will leave the calculated doppler factors
unmodified.
The default value is 1.0.
Returns:
None
)";
voice.def("set_doppler_scale", &PythonVoice::setDopplerScale, docString, py::arg("scale"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Sets the occlusion factors for a voice.
These values control automatic low pass filters that get applied to the
Sets spatial sounds to simulate object occlusion between the emitter
and listener positions.
Args:
direct: The occlusion factor for the direct path of the sound.
This is the path directly from the emitter to the listener.
This factor describes how occluded the sound's path
actually is.
A value of 1.0 means that the sound is fully occluded by an
object between the voice and the listener.
A value of 0.0 means that the sound is not occluded by any
object at all.
This defaults to 0.0.
This factor multiplies by EntityCone.low_pass_filter, if a
cone with a non 1.0 lowPassFilter value is specified.
Setting this to a value outside of [0.0, 1.0] will result
in an undefined low pass filter value being used.
reverb: The occlusion factor for the reverb path of the sound.
This is the path taken for sounds reflecting back to the
listener after hitting a wall or other object.
A value of 1.0 means that the sound is fully occluded by an
object between the listener and the object that the sound
reflected off of.
A value of 0.0 means that the sound is not occluded by any
object at all.
This defaults to 1.0.
Returns:
None
)";
voice.def("set_occlusion", &PythonVoice::setOcclusion, docString, py::arg("direct"), py::arg("reverb"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Set the channel mixing matrix to use for this voice.
Args:
matrix: The matrix to set.
The rows of this matrix represent
each output channel from this voice and the columns of this
matrix represent the input channels of this voice (e.g.
this is a inputChannels x outputChannels matrix).
Note that setting the matrix to be smaller than needed will
result in undefined behavior.
The output channel count will always be the number of audio
channels set on the context.
Each cell in the matrix should be a value from 0.0-1.0 to
specify the volume that this input channel should be mixed
into the output channel.
Setting negative values will invert the signal.
Setting values above 1.0 will amplify the signal past unity
gain when being mixed.
This setting is mutually exclusive with balance; setting
one will disable the other.
This setting is only available for spatial sounds if
PLAYBACK_MODE_SPATIAL_MIX_LEVEL_MATRIX if set in the
playback mode parameter.
Multi-channel spatial audio is interpreted as multiple
emitters existing at the same point in space, so a purely
spatial voice cannot have an output matrix specified.
Setting this to None will reset the matrix to the default
for the given channel count.
The following table shows the speaker modes that are used
for the default output matrices.
Voices with a speaker mode that is not in the following
table will use the default output matrix for the speaker
mode in the following table that has the same number of
channels.
If there is no default matrix for the channel count of the
@ref Voice, the output matrix will have 1.0 in the any cell
(i, j) where i == j and 0.0 in all other cells.
Returns:
None
)";
voice.def(
"set_matrix", &PythonVoice::setMatrix, docString, py::arg("matrix"), py::call_guard<py::gil_scoped_release>());
docString = R"(
Set the voice's position.
Args:
position: The current position of the voice in world units.
This should only be expressed in meters if the world
units scale is set to 1.0 for this context.
Returns:
None
)";
voice.def("set_position", &PythonVoice::setPosition, docString, py::arg("position"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Set the voice's velocity.
Args:
velocity: The current velocity of the voice in world units per second.
This should only be expressed in meters per second if the
world units scale is set to 1.0 with for the context.
The magnitude of this vector will be taken as the
listener's current speed and the vector's direction will
indicate the listener's current direction. This vector
should not be normalized unless the listener's speed is
actually 1.0 units per second.
This may be a zero vector if the listener is not moving.
Returns:
None
)";
voice.def("set_velocity", &PythonVoice::setVelocity, docString, py::arg("velocity"),
py::call_guard<py::gil_scoped_release>());
docString = R"(
Set custom rolloff curves on the voice.
Args:
type: The default type of rolloff calculation to use for all DSP
values that are not overridden by a custom curve.
near_distance: The near distance range for the sound.
This is specified in arbitrary world units.
When a custom curve is used, this near distance will
map to a distance of 0.0 on the curve.
This must be less than the far_distance distance.
The near distance is the closest distance that the
emitter's attributes start to rolloff at.
At distances closer than this value, the calculated
DSP values will always be the same as if they were
at the near distance.
far_distance: The far distance range for the sound.
This is specified in arbitrary world units.
When a custom curve is used, this far distance will
map to a distance of 1.0 on the curve. This must be
greater than the @ref nearDistance distance.
The far distance is the furthest distance that the
emitters attributes will rolloff at.
At distances further than this value, the calculated
DSP values will always be the same as if they were at
the far distance (usually silence).
Emitters further than this distance will often become
inactive in the scene since they cannot be heard any
more.
volume: The custom curve used to calculate volume attenuation over
distance.
This must be a normalized curve such that a distance of 0.0
maps to the near_distance distance and a distance of 1.0
maps to the far_distance distance.
When specified, this overrides the rolloff calculation
specified by type when calculating volume attenuation.
If this is an empty array, the parameter will be ignored.
low_frequency: The custom curve used to calculate low frequency
effect volume over distance.
This must be a normalized curve such that a distance
of 0.0 maps to the near_distance distance and a
distance of 1.0 maps to the far_distance distance.
When specified, this overrides the rolloff
calculation specified by type when calculating
the low frequency effect volume.
If this is an empty array, the parameter will be
ignored.
low_pass_reverb: The custom curve used to calculate low pass filter
parameter on the direct path over distance.
This must be a normalized curve such that a
distance of 0.0 maps to the near_distance distance
and a distance of 1.0 maps to the far_distance
distance.
When specified, this overrides the rolloff
calculation specified by type when calculating the
low pass filter parameter.
If this is an empty array, the parameter will be
ignored.
low_pass_reverb: The custom curve used to calculate low pass filter
parameter on the reverb path over distance.
This must be a normalized curve such that a
distance of 0.0 maps to the near_distance distance
and a distance of 1.0 maps to the far_distance
distance.
When specified, this overrides the rolloff
calculation specified by type when calculating the
low pass filter parameter.
If this is an empty array, the parameter will be
ignored.
reverb: The custom curve used to calculate reverb mix level over
distance.
This must be a normalized curve such that a distance of 0.0
maps to the near_distance distance and a distance of 1.0
maps to the @ref farDistance distance.
When specified, this overrides the rolloff calculation
specified by type when calculating the low pass filter
parameter.
If this is an empty array, the parameter will be ignored.
returns:
None
)";
voice.def("set_rolloff_curve", &PythonVoice::setRolloffCurve, docString, py::arg("type"), py::arg("near_distance"),
py::arg("far_distance"), py::arg("volume") = std::vector<Float2>(),
py::arg("low_frequency") = std::vector<Float2>(), py::arg("low_pass_direct") = std::vector<Float2>(),
py::arg("low_pass_reverb") = std::vector<Float2>(), py::arg("reverb") = std::vector<Float2>());
py::class_<carb::audio::PlaybackContextDesc> playbackContextDesc(m, "PlaybackContextDesc");
carb::defineInterfaceClass<IAudioPlayback>(m, "IAudioPlayback", "acquire_playback_interface")
.def("create_context",
[](IAudioPlayback* self, PlaybackContextDesc desc) -> PythonContext {
Context* ctx = self->createContext(&desc);
return PythonContext(self, ctx);
},
py::arg("desc") = PlaybackContextDesc());
carb::defineInterfaceClass<IAudioData>(m, "IAudioData", "acquire_data_interface")
.def("create_sound_from_file",
[](IAudioData* self, const char* fileName, SampleFormat decodedFormat, DataFlags flags, bool streaming,
size_t autoStream) -> PythonSoundData* {
SoundData* tmp = createSoundFromFile(self, fileName, streaming, autoStream, decodedFormat, flags);
if (tmp == nullptr)
throw std::runtime_error("failed to create a SoundData object");
return new PythonSoundData(self, tmp);
},
R"( Create a SoundData object from a file on disk.
Args:
filename The name of the file on disk to create the new sound
data object from.
decodedFormat The format you want the audio to be decoded into.
Although you can retrieve the sound's data through python
in any format, the data will be internally stored as this
format. This is only important if you aren't creating a
decoded sound. This defaults to SampleFormat.DEFAULT,
which will decode the sound to float for now.
flags Optional flags to change the behavior. This can be any
of: DATA_FLAG_SKIP_METADATA, DATA_FLAG_SKIP_EVENT_POINTS
or DATA_FLAG_CALC_PEAKS.
streaming Set to True to create a streaming sound. Streaming
sounds aren't loaded into memory; they remain on disk and
are decoded in chunks as needed. This defaults to False.
autoStream The threshold in bytes at which the new sound data
object will decide to stream instead of decode into
memory. If the decoded size of the sound will be
larger than this value, it will be streamed from its
original source instead of decoded. Set this to 0
to disable auto-streaming. This defaults to 0.
Returns:
The new sound data if successfully created and loaded.
An exception is thrown if the sound could not be loaded. This could
happen if the file does not exist, the file is not a supported type,
the file is corrupt or some other error occurred during decode.
)",
py::arg("fileName"), py::arg("decodedFormat") = SampleFormat::eDefault, py::arg("flags") = 0,
py::arg("streaming") = false, py::arg("autoStream") = 0, py::call_guard<py::gil_scoped_release>())
.def("create_sound_from_blob",
[](IAudioData* self, const py::bytes blob, SampleFormat decodedFormat, DataFlags flags, bool streaming,
size_t autoStream) -> PythonSoundData* {
// this is extremely inefficient, but this appears to be the only way to get the data
std::string s = blob;
SoundData* tmp =
createSoundFromBlob(self, s.c_str(), s.length(), streaming, autoStream, decodedFormat, flags);
if (tmp == nullptr)
throw std::runtime_error("failed to create a SoundData object");
return new PythonSoundData(self, tmp);
},
R"( Create a SoundData object from a data blob in memory
Args:
blob A bytes object which contains the raw data for an audio
file which has some sort of header. Raw PCM data will
not work with this function. Note that due to the way
python works, these bytes will be copied into the
SoundData object's internal buffer if the sound is
streaming.
decodedFormat The format you want the audio to be decoded into.
Although you can retrieve the sound's data through python
in any format, the data will be internally stored as this
format. This is only important if you aren't creating a
decoded sound. This defaults to SampleFormat.DEFAULT,
which will decode the sound to float for now.
flags Optional flags to change the behavior. This can be any
of: DATA_FLAG_SKIP_METADATA, DATA_FLAG_SKIP_EVENT_POINTS
or DATA_FLAG_CALC_PEAKS.
streaming Set to True to create a streaming sound. Streaming
sounds aren't loaded into memory; the audio data remains
in its encoded form in memory and are decoded in chunks
as needed. This is mainly useful for compressed formats
which will expand when decoded. This defaults to False.
autoStream The threshold in bytes at which the new sound data
object will decide to stream instead of decode into
memory. If the decoded size of the sound will be
larger than this value, it will be streamed from its
original source instead of decoded. Set this to 0
to disable auto-streaming. This defaults to 0.
Returns:
The new sound data if successfully created and loaded.
An exception is thrown if the sound could not be loaded. This could
happen if the blob is an unsupported audio format, the blob is corrupt
or some other error during decoding.
)",
py::arg("blob"), py::arg("decodedFormat") = SampleFormat::eDefault, py::arg("flags") = 0,
py::arg("streaming") = false, py::arg("autoStream") = 0, py::call_guard<py::gil_scoped_release>())
.def("create_sound_from_uint8_pcm",
[](IAudioData* self, const std::vector<uint8_t>& pcm, size_t channels, size_t frameRate,
SpeakerMode channelMask) -> PythonSoundData* {
return PythonSoundData::fromRawBlob(
self, pcm.data(), pcm.size(), SampleFormat::ePcm8, channels, frameRate, channelMask);
},
R"( Create a SoundData object from raw 8 bit unsigned integer PCM data.
Args:
pcm The audio data to load into the SoundData object.
This will be copied to an internal buffer in the object.
channels The number of channels of data in each frame of the audio
data.
frame_rate The number of frames per second that must be played back
for the audio data to sound 'normal' (ie: the way it was
recorded or produced).
channel_mask the channel mask for the audio data. This specifies which
speakers the stream is intended for and will be a
combination of one or more of the Speaker names or a
SpeakerMode name. The channel mapping will be set to the
defaults if set to SPEAKER_MODE_DEFAULT, which is the
default value for this parameter.
Returns:
The new sound data if successfully created and loaded.
An exception may be thrown if an out-of-memory situation occurs or some
other error occurs while creating the object.
)",
py::arg("pcm"), py::arg("channels"), py::arg("frame_rate"), py::arg("channel_mask") = kSpeakerModeDefault,
py::call_guard<py::gil_scoped_release>())
.def("create_sound_from_int16_pcm",
[](IAudioData* self, const std::vector<int16_t>& pcm, size_t channels, size_t frameRate,
SpeakerMode channelMask) -> PythonSoundData* {
return PythonSoundData::fromRawBlob(
self, pcm.data(), pcm.size(), SampleFormat::ePcm16, channels, frameRate, channelMask);
},
R"( Create a SoundData object from raw 16 bit signed integer PCM data.
Args:
pcm The audio data to load into the SoundData object.
This will be copied to an internal buffer in the object.
channels The number of channels of data in each frame of the audio
data.
frame_rate The number of frames per second that must be played back
for the audio data to sound 'normal' (ie: the way it was
recorded or produced).
channel_mask the channel mask for the audio data. This specifies which
speakers the stream is intended for and will be a
combination of one or more of the Speaker names or a
SpeakerMode name. The channel mapping will be set to the
defaults if set to SPEAKER_MODE_DEFAULT, which is the
default value for this parameter.
Returns:
The new sound data if successfully created and loaded.
An exception may be thrown if an out-of-memory situation occurs or some
other error occurs while creating the object.
)",
py::arg("pcm"), py::arg("channels"), py::arg("frame_rate"), py::arg("channel_mask") = kSpeakerModeDefault,
py::call_guard<py::gil_scoped_release>())
.def("create_sound_from_int32_pcm",
[](IAudioData* self, const std::vector<int32_t>& pcm, size_t channels, size_t frameRate,
SpeakerMode channelMask) -> PythonSoundData* {
return PythonSoundData::fromRawBlob(
self, pcm.data(), pcm.size(), SampleFormat::ePcm32, channels, frameRate, channelMask);
},
R"( Create a SoundData object from raw 32 bit signed integer PCM data.
Args:
pcm The audio data to load into the SoundData object.
This will be copied to an internal buffer in the object.
channels The number of channels of data in each frame of the audio
data.
frame_rate The number of frames per second that must be played back
for the audio data to sound 'normal' (ie: the way it was
recorded or produced).
channel_mask the channel mask for the audio data. This specifies which
speakers the stream is intended for and will be a
combination of one or more of the Speaker names or a
SpeakerMode name. The channel mapping will be set to the
defaults if set to SPEAKER_MODE_DEFAULT, which is the
default value for this parameter.
Returns:
The new sound data if successfully created and loaded.
An exception may be thrown if an out-of-memory situation occurs or some
other error occurs while creating the object.
)",
py::arg("pcm"), py::arg("channels"), py::arg("frame_rate"), py::arg("channel_mask") = kSpeakerModeDefault,
py::call_guard<py::gil_scoped_release>())
.def("create_sound_from_float_pcm",
[](IAudioData* self, const std::vector<float>& pcm, size_t channels, size_t frameRate,
SpeakerMode channelMask) -> PythonSoundData* {
return PythonSoundData::fromRawBlob(
self, pcm.data(), pcm.size(), SampleFormat::ePcmFloat, channels, frameRate, channelMask);
},
R"( Create a SoundData object from raw 32 bit float PCM data.
Args:
pcm The audio data to load into the SoundData object.
This will be copied to an internal buffer in the object.
channels The number of channels of data in each frame of the audio
data.
frame_rate The number of frames per second that must be played back
for the audio data to sound 'normal' (ie: the way it was
recorded or produced).
channel_mask the channel mask for the audio data. This specifies which
speakers the stream is intended for and will be a
combination of one or more of the Speaker names or a
SpeakerMode name. The channel mapping will be set to the
defaults if set to SPEAKER_MODE_DEFAULT, which is the
default value for this parameter.
Returns:
The new sound data if successfully created and loaded.
An exception may be thrown if an out-of-memory situation occurs or some
other error occurs while creating the object.
)",
py::arg("pcm"), py::arg("channels"), py::arg("frame_rate"), py::arg("channel_mask") = kSpeakerModeDefault,
py::call_guard<py::gil_scoped_release>())
.def("create_empty_sound",
[](IAudioData* self, SampleFormat format, size_t channels, size_t frameRate, size_t bufferLength,
UnitType units, const char* name, SpeakerMode channelMask) -> PythonSoundData* {
(void)channelMask; // FIXME: channelMask!?
SoundData* tmp = createEmptySound(self, format, frameRate, channels, bufferLength, units, name);
if (tmp == nullptr)
throw std::runtime_error("failed to create a SoundData object");
return new PythonSoundData(self, tmp);
},
R"( Create a SoundData object with an empty buffer that can be written to.
After creating a SoundData object with this, you will need to call one of
the write_buffer_*() functions to load your data into the object, then you
will need to call set_valid_length() to indicate how much of the sound now
contains valid data.
Args:
decodedFormat The format for the SoundData object's buffer.
Although you can retrieve the sound's data through python
in any format, the data will be internally stored as this
format. This defaults to SampleFormat.DEFAULT, which will
use float for the buffer.
channels The number of channels of data in each frame of the audio
data.
frame_rate The number of frames per second that must be played back
for the audio data to sound 'normal' (ie: the way it was
recorded or produced).
buffer_length How long you want the buffer to be.
units How buffer_length will be interpreted. This defaults to
UnitType.FRAMES.
name An optional name that can be given to the SoundData
object to make it easier to track. This can be None if it
is not needed. This defaults to None.
channel_mask The channel mask for the audio data. This specifies which
speakers the stream is intended for and will be a
combination of one or more of the Speaker names or a
SpeakerMode name. The channel mapping will be set to the
defaults if set to SPEAKER_MODE_DEFAULT, which is the
default value for this parameter.
Returns:
The new sound data if successfully created and loaded.
An exception may be thrown if an out-of-memory situation occurs or some
other error occurs while creating the object.
)",
py::arg("format"), py::arg("channels"), py::arg("frame_rate"), py::arg("buffer_length"),
py::arg("units") = UnitType::eFrames, py::arg("name") = nullptr,
py::arg("channel_mask") = kSpeakerModeDefault, py::call_guard<py::gil_scoped_release>());
py::class_<PythonSoundData> sound(m, "SoundData");
sound.def("get_name", &PythonSoundData::getName,
R"( Retrieve the name of a SoundData object.
Returns:
The name that was given to the object.
This will return None if the object has no name.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("is_decoded", &PythonSoundData::isDecoded,
R"( Query if the SoundData object is decoded or streaming.
Returns:
True if the object is decoded.
False if the object is streaming.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("get_format", &PythonSoundData::getFormat,
R"( Query the SoundData object's format.
Returns:
For a sound that was decoded on load, this represents the format of the
audio data in the SoundData object's buffer.
For a streaming sound, this returns the format of the underlying sound
asset that is being streamed.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("get_length", &PythonSoundData::getLength,
R"( Query the SoundData object's buffer length.
Args:
units The unit type that will be returned. This defaults to UnitType.FRAMES.
Returns:
The length of the SoundData object's buffer.
)",
py::arg("units") = UnitType::eFrames, py::call_guard<py::gil_scoped_release>());
sound.def("set_valid_length", &PythonSoundData::setValidLength,
R"( Set the length of the valid portion of the SoundData object's buffer.
Args:
length The new valid length to be set.
units How length will be interpreted. This defaults to UnitType.FRAMES.
Returns:
The length of the SoundData object's buffer.
)",
py::arg("length"), py::arg("units") = UnitType::eFrames, py::call_guard<py::gil_scoped_release>());
sound.def("get_valid_length", &PythonSoundData::getValidLength,
R"( Query the SoundData object's buffer length.
Args:
units The unit type that will be returned. This defaults to
UnitType.FRAMES.
Returns:
The length of the SoundData object's buffer.
)",
py::arg("units") = UnitType::eFrames, py::call_guard<py::gil_scoped_release>());
sound.def("get_buffer_as_uint8", &PythonSoundData::getBufferU8,
R"( Retrieve a buffer of audio from the SoundData object in unsigned 8 bit
integer PCM.
Args:
length The length of the buffer you want to retrieve.
This will be clamped if the SoundData object does not have this
much data available.
offset The offset in the SoundData object to start reading from.
units How length and offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
A buffer of audio data from the SoundData object in unsigned 8 bit
integer format. The format is a list containing integer data with
values in the range [0, 255].
)",
py::arg("length") = 0, py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("get_buffer_as_int16", &PythonSoundData::getBufferS16,
R"( Retrieve a buffer of audio from the SoundData object in signed 16 bit
integer PCM.
Args:
length The length of the buffer you want to retrieve.
This will be clamped if the SoundData object does not have this
much data available.
offset The offset in the SoundData object to start reading from.
units How length and offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
A buffer of audio data from the SoundData object in signed 16 bit
integer format. The format is a list containing integer data with
values in the range [-32768, 32767].
)",
py::arg("length") = 0, py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("get_buffer_as_int32", &PythonSoundData::getBufferS32,
R"( Retrieve a buffer of audio from the SoundData object in signed 32 bit
integer PCM.
Args:
length The length of the buffer you want to retrieve.
This will be clamped if the SoundData object does not have this
much data available.
offset The offset in the SoundData object to start reading from.
units How length and offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
A buffer of audio data from the SoundData object in signed 32 bit
integer format. The format is a list containing integer data with
values in the range [-2147483648, 2147483647].
)",
py::arg("length") = 0, py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("get_buffer_as_float", &PythonSoundData::getBufferFloat,
R"( Retrieve a buffer of audio from the SoundData object in 32 bit float PCM.
Args:
length The length of the buffer you want to retrieve.
This will be clamped if the SoundData object does not have this
much data available.
offset The offset in the SoundData object to start reading from.
units How length and offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
A buffer of audio data from the SoundData object in signed 32 bit
integer format. The format is a list containing integer data with
values in the range [-1.0, 1.0].
)",
py::arg("length") = 0, py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("write_buffer_with_uint8", &PythonSoundData::writeBufferU8,
R"( Write a buffer of audio to the SoundData object with unsigned 8 bit PCM
data.
Args:
data The buffer of data to write to the SoundData object.
This must be a list of integer values representable as uint8_t.
offset The offset in the SoundData object to start reading from.
units How offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
No return value.
This will throw an exception if this is not a writable sound object.
Only sounds that were created empty or from raw PCM data are writable.
)",
py::arg("data"), py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("write_buffer_with_int16", &PythonSoundData::writeBufferS16,
R"( Write a buffer of audio to the SoundData object with signed 16 bit PCM
data.
Args:
data The buffer of data to write to the SoundData object.
This must be a list of integer values representable as int16_t.
offset The offset in the SoundData object to start reading from.
units How offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
No return value.
This will throw an exception if this is not a writable sound object.
Only sounds that were created empty or from raw PCM data are writable.
)",
py::arg("data"), py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("write_buffer_with_int32", &PythonSoundData::writeBufferS32,
R"( Write a buffer of audio to the SoundData object with signed 32 bit PCM
data.
Args:
data The buffer of data to write to the SoundData object.
This must be a list of integer values representable as int32_t.
offset The offset in the SoundData object to start reading from.
units How offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
No return value.
This will throw an exception if this is not a writable sound object.
Only sounds that were created empty or from raw PCM data are writable.
)",
py::arg("data"), py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("write_buffer_with_float", &PythonSoundData::writeBufferFloat,
R"( Write a buffer of audio to the SoundData object with 32 bit float PCM
data.
Args:
data The buffer of data to write to the SoundData object.
This must be a list of integer values representable as float.
offset The offset in the SoundData object to start reading from.
units How offset will be interpreted. This defaults to
UnitType.FRAMES.
Returns:
No return value.
This will throw an exception if this is not a writable sound object.
Only sounds that were created empty or from raw PCM data are writable.
)",
py::arg("data"), py::arg("offset") = 0, py::arg("units") = UnitType::eFrames,
py::call_guard<py::gil_scoped_release>());
sound.def("get_memory_used", &PythonSoundData::getMemoryUsed,
R"( Query the amount of memory that's in use by a SoundData object.
This retrieves the amount of memory used by a single sound data object. This
will include all memory required to store the audio data itself, to store the
object and all its parameters, and the original filename (if any). This
information is useful for profiling purposes to investigate how much memory
the audio system is using for a particular scene.
Returns:
The amount of memory in use by this sound, in bytes.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("get_max_instances", &PythonSoundData::getMaxInstances,
R"( Query the SoundData object's max instance count.
This retrieves the current maximum instance count for a sound. This limit
is used to prevent too many instances of a sound from being played
simultaneously. With the limit set to unlimited, playing too many
instances can result in serious performance penalties and serious clipping
artifacts caused by too much constructive interference.
Returns:
The SoundData object's max instance count.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("set_max_instances", &PythonSoundData::setMaxInstances,
R"( Set the SoundData object's max instance count.
This sets the new maximum playing instance count for a sound. This limit will
prevent the sound from being played until another instance of it finishes playing
or simply cause the play request to be ignored completely. This should be used
to limit the use of frequently played sounds so that they do not cause too much
of a processing burden in a scene or cause too much constructive interference
that could lead to clipping artifacts. This is especially useful for short
sounds that are played often (ie: gun shots, foot steps, etc). At some [small]
number of instances, most users will not be able to tell if a new copy of the
sound played or not.
Args:
limit The max instance count to set.
)",
py::arg("limit"), py::call_guard<py::gil_scoped_release>());
sound.def("get_peak_level", &PythonSoundData::getPeakLevel,
R"( Retrieves or calculates the peak volume levels for a sound if possible.
This retrieves the peak volume level information for a sound. This information
is either loaded from the sound's original source file or is calculated if
the sound is decoded into memory at load time. This information will not be
calculated if the sound is streamed from disk or memory.
Returns:
The peak level information from the SoundData object.
This will throw if peak level information is not embedded in the sound.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("get_event_points", &PythonSoundData::getEventPoints,
R"( Retrieves embedded event point information from a sound data object.
This retrieves event point information that was embedded in the sound file that
was used to create a sound data object. The event points are optional in the
data file and may not be present. If they are parsed from the file, they will
also be saved out to any destination file that the same sound data object is
written to, provided the destination format supports embedded event point
information.
Returns:
The list of event points that are embedded in this SoundData object.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("get_event_point_by_id", &PythonSoundData::getEventPointById,
R"( Retrieves a single event point object by its identifier.
Args:
id The ID of the event point to retrieve.
Returns:
The event point is retrieved if it exists.
None is returned if there was no event point found.
)",
py::arg("id"), py::call_guard<py::gil_scoped_release>());
sound.def("get_event_point_by_index", &PythonSoundData::getEventPointByIndex,
R"( Retrieves a single event point object by its index.
Event point indices are contiguous, so this can be used to enumerate event
points alternatively.
Args:
index The index of the event point to retrieve.
Returns:
The event point is retrieved if it exists.
None is returned if there was no event point found.
)",
py::arg("index"), py::call_guard<py::gil_scoped_release>());
sound.def("get_event_point_by_play_index", &PythonSoundData::getEventPointByPlayIndex,
R"( Retrieves a single event point object by its playlist index.
Event point playlist indices are contiguous, so this can be used to
enumerate the playlist.
Args:
index The playlist index of the event point to retrieve.
Returns:
The event point is retrieved if it exists.
None is returned if there was no event point found.
)",
py::arg("index"), py::call_guard<py::gil_scoped_release>());
sound.def("get_event_point_max_play_index", &PythonSoundData::getEventPointMaxPlayIndex,
R"( Retrieve the maximum play index value for the sound.
Returns:
This returns the max play index for this SoundData object.
This will be 0 if no event points have a play index.
This is also the number of event points with playlist indexes,
since the playlist index range is contiguous.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("set_event_points", &PythonSoundData::setEventPoints,
R"( Modifies, adds or removes event points in a SoundData object.
This modifies, adds or removed one or more event points in a sound data
object. An event point will be modified if one with the same ID already
exists. A new event point will be added if it has an ID that is not
already present in the sound data object and its frame offset is valid. An
event point will be removed if it has an ID that is present in the sound
data object but the frame offset for it is set to
EVENT_POINT_INVALID_FRAME. Any other event points with invalid frame
offsets (ie: out of the bounds of the stream) will be skipped and cause the
function to fail.
If an event point is modified or removed such that the playlist
indexes of the event points are no longer contiguous, this function
will adjust the play indexes of all event points to prevent any
gaps.
Args:
eventPoints: The event point(s) to be modified or added. The
operation that is performed for each event point in the
table depends on whether an event point with the same ID
already exists in the sound data object. The event points
in this table do not need to be sorted in any order.
Returns:
True if all of the event points in the table are updated successfully.
False if not all event points could be updated. This includes a
failure to allocate memory or an event point with an invalid frame
offset. Note that this failing doesn't mean that all the event points
failed. This just means that at least failed to be set properly. The
new set of event points may be retrieved and compared to the list set
here to determine which one failed to be updated.
)",
py::arg("eventPoints"), py::call_guard<py::gil_scoped_release>());
sound.def("clear_event_points", &PythonSoundData::clearEventPoints,
R"( Removes all event points from a SoundData object.
Returns:
No return value.
)",
py::call_guard<py::gil_scoped_release>());
sound.def("get_metadata_by_index", &PythonSoundData::getMetaDataByIndex,
R"( Retrieve a metadata tag from a SoundData object by its index.
Args:
index The index of the metadata tag.
Returns:
This returns a tuple: (metadata tag name, metadata tag value).
This returns (None, None) if there was no tag at the specified index.
)",
py::arg("index"), py::call_guard<py::gil_scoped_release>());
sound.def("get_metadata", &PythonSoundData::getMetaData,
R"( Retrieve a metadata value from a SoundData object by its tag name.
Args:
tag_name The metadata tag's name.
Returns:
This returns the metadata tag value for tag_name.
This returns None if there is no tag under tag_name.
)",
py::arg("tag_name"), py::call_guard<py::gil_scoped_release>());
sound.def("set_metadata", &PythonSoundData::setMetaData,
R"( Add a metadata tag to a SoundData object.
Metadata tag names are not case sensitive.
It is not guaranteed that a given file type will be able to store arbitrary
key-value pairs. RIFF files (.wav), for example, store metadata tags under
4 character codes, so only metadata tags that are known to this plugin,
such as META_DATA_TAG_ARTIST or tags that are 4 characters in length can be
stored. Note this means that storing 4 character tags beginning with 'I'
runs the risk of colliding with the known tag names (e.g. 'IART' will
collide with META_DATA_TAG_ARTIST when writing a RIFF file).
tag_name must not contain the character '=' when the output format encodes
its metadata in the Vorbis Comment format (SampleFormat.VORBIS and
SampleFormat.FLAC do this). '=' will be replaced with '_' when
encoding these formats to avoid the metadata being encoded incorrectly.
Additionally, the Vorbis Comment standard states that tag names must only
contain characters from 0x20 to 0x7D (excluding '=') when encoding these
formats.
Args:
tag_name The metadata tag's name.
tag_value The metadata tag's value.
Returns:
No return value.
)",
py::arg("tag_name"), py::arg("tag_value"), py::call_guard<py::gil_scoped_release>());
sound.def("save_to_file", &PythonSoundData::saveToFile,
R"( Save a SoundData object to disk as a playable audio file.
Args:
file_name The path to save this file as.
format The audio format to use when saving this file.
PCM formats will save as a WAVE file (.wav).
flags Flags to alter the behavior of this function.
This is a bitmask of SAVE_FLAG_* flags.
Returns:
True if the SoundData object was saved to disk successfully.
False if saving to disk failed.
)",
py::arg("file_name"), py::arg("format") = SampleFormat::eDefault, py::arg("flags") = 0);
}
} // namespace audio
} // namespace carb
| 122,136 | C | 46.321581 | 119 | 0.627988 |
omniverse-code/kit/include/carb/audio/IAudioDevice.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The audio device enumeration interface.
*/
#pragma once
#include "../Interface.h"
#include "AudioTypes.h"
namespace carb
{
namespace audio
{
/** the direction to collect device information for. */
enum class DeviceType
{
ePlayback, /**< Audio playback devices (e.g. headphones) */
eCapture, /**< Audio capture devices (e.g. microphone) */
};
/** Which device backend is being used for audio.
*
* @note @ref IAudioCapture will always use DirectSound as a backend on Windows.
* This behavior will be changed eventually so that @ref IAudioCapture uses
* the same device backend as other systems.
*/
enum class DeviceBackend
{
/** The null audio device backend was selected.
* Audio playback and capture will still function as expected, but the
* output audio will be dropped and input audio will be silence.
* This will only be used if manually selected via the `audio/deviceBackend`
* settings key or in the case where a system is missing its core audio libraries.
*/
eNull,
/** Windows Audio Services device API (aka WASAPI).
* This is the only device backend on Windows.
* This is fairly user-friendly and should not require any special handling.
*/
eWindowsAudioServices,
/** Pulse Audio sound server for Linux.
* This is the standard sound server on Linux for consumer audio.
* This API is fairly user-friendly and should not require any special handling.
* Each of the audio streams through Pulse Audio will be visible through
* programs such as `pavucontrol` (volume control program).
* The name of these streams can be set for @ref IAudioPlayback with
* @ref PlaybackContextDesc::outputDisplayName; if that was not set, a generic
* name will be used.
*/
ePulseAudio,
/** Advance Linux Audio System (ALSA).
* This is the underlying kernel sound system as well as an array of plugins.
* Some users may use ALSA so they can use the JACK plugin for professional
* audio applications.
* Some users also prefer to use the `dmix` and `dsnoop` sound servers
* instead of Pulse Audio.
* ALSA is not user-friendly, so the following issues may appear:
* - ALSA devices are sensitive to latency because, for the most part,
* they use a fixed-size ring buffer, so it is possible to get audio
* underruns or overruns on a heavily loaded system or a device
* configured with an extremely small buffer.
* - Some ALSA devices are exclusive access, so there is no guaranteed that
* they will open properly.
* - Multiple configurations of each physical device show up as a separate
* audio device, so a system with two audio devices will have ~40 ALSA
* devices.
* - Opening an ALSA device can take hundreds of milliseconds.
* Combined with the huge device count, this can mean that manually
* enumerating all devices on the system can take several seconds.
* - Some versions of libasound will automatically create devices with
* invalid configurations, such as `dmix` devices that are flagged as
* supporting playback and capture but will fail to open for capture.
* - ALSA devices can be configured with some formats that carb.audio
* does not support, such as big endian formats, ULAW or 64 bit float.
* Users should use a `plug` (format conversion) plugin for ALSA if they
* need to use a device that requires a format such as this.
*/
eAlsa,
/** The Mac OS CoreAudio system.
* This is the standard sound system used on Mac OS.
* This is fairly user-friendly and should not require any special handling.
*/
eCoreAudio,
};
/** A callback that is performed when a device notification occurs.
* @param[in] ctx The context value this notification was registered with.
*
* @remarks This notification will occur on every device change that @p ctx
* registered to. No information about what changed is provided.
*/
typedef void (*DeviceNotifyCallback)(void* ctx);
/** A device change notification context.
* This instance exists to track the lifetime of a device change notification
* subscription.
*/
class DeviceChangeNotifier;
/** An interface to provide simple audio device enumeration functionality, as
* well as device change notifications. This is able to enumerate all audio
* devices attached to the system at any given point and collect the
* information for each device. This is able to collect information and
* provide notifications for both playback and capture devices.
*/
struct IAudioDevice
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
CARB_PLUGIN_INTERFACE("carb::audio::IAudioDevice", 1, 1);
#endif
/** retrieves the total number of devices attached to the system of a requested type.
*
* @param[in] dir the audio direction to get the device count for.
* @returns the total number of connected audio devices of the requested type.
* @returns 0 if no audio devices are connected to the system.
*/
size_t(CARB_ABI* getDeviceCount)(DeviceType dir);
/** Retrieve the capabilities of a device.
* @param[in] dir The audio direction of the device.
* @param[in] index The index of the device to retrieve the description for. This
* should be between 0 and one less than the most recent return
* value of getDeviceCount().
* @param[inout] caps The capabilities of this device.
* `caps->thisSize` must be set to `sizeof(*caps)`
* before passing it.
* @returns @ref AudioResult::eOk if the device info was successfully retrieved.
* @returns @ref AudioResult::eInvalidParameter if the @a thisSize value is not properly
* initialized in @p caps or @p caps is nullptr.
* @returns @ref AudioResult::eOutOfRange if the requested device index is out of range of
* the system's current device count.
* @returns @ref AudioResult::eNotSupported if a device is found but it requires an
* unsupported sample format.
* @returns an AudioResult::* error code if another failure occurred.
*/
AudioResult(CARB_ABI* getDeviceCaps)(DeviceType dir, size_t index, carb::audio::DeviceCaps* caps);
/** Create a device notification object.
* @param[in] type The device type to fire the callback for.
* @param[in] callback The callback that will be fired when a device change occurs.
* This must not be nullptr.
* @param[in] context The object passed to the parameter of @p callback.
*
* @returns A valid device notifier object if successful.
* This must be destroyed with destroyNotifier() when device
* notifications are no longer needed.
* @returns nullptr if an error occurred.
*/
DeviceChangeNotifier*(CARB_ABI* createNotifier)(DeviceType type, DeviceNotifyCallback callback, void* context);
/** Destroy a device notification object.
* @param[in] notifier The notification object to free.
* Device notification callbacks for this object will
* no longer occur.
*/
void(CARB_ABI* destroyNotifier)(DeviceChangeNotifier* notifier);
/** Query the device backend that's currently in use.
* @returns The device backend in use.
* @note This returned value is cached internally, so these calls are inexpensive.
* @note The value this returns will not change until carb.audio reloads.
*/
DeviceBackend(CARB_ABI* getBackend)();
/** Retrieve a minimal set of device properties.
* @param[in] dir The audio direction of the device.
* @param[in] index The index of the device to retrieve the description for. This
* should be between 0 and one less than the most recent return
* value of getDeviceCount().
* @param[inout] caps The basic properties of this device.
* @ref DeviceCaps::name and @ref DeviceCaps::guid will
* be written to this.
* @ref DeviceCaps::flags will have @ref fDeviceFlagDefault
* set if this is the default device, but no other flags
* will be set.
* All other members of this struct will be set to default
* values.
* `caps->thisSize` must be set to `sizeof(*caps)`
* before passing it.
*
* @retval AudioResult::eOk on success.
* @retval AudioResult::eInvalidParameter if @p caps had an invalid `thisSize` member or was `nullptr`.
* @retval AudioResult::eOutOfRange if @p index was past the end of the device list.
*/
AudioResult(CARB_ABI* getDeviceName)(DeviceType type, size_t index, DeviceCaps* caps);
/** Retrieve the capabilities of a device.
* @param[in] dir The audio direction of the device.
* @param[in] guid The guid of the device to retrieve the description for.
* @param[inout] caps The capabilities of this device.
* `caps->thisSize` must be set to `sizeof(*caps)`
* before passing it.
* @returns @ref AudioResult::eOk if the device info was successfully retrieved.
* @returns @ref AudioResult::eInvalidParameter if the @a thisSize value is not properly
* initialized in @p caps, @p caps is `nullptr` or @p guid is `nullptr`.
* @returns @ref AudioResult::eOutOfRange if @p guid did not correspond to a device.
* @returns @ref AudioResult::eNotSupported if a device is found but it requires an
* unsupported sample format.
* @returns an AudioResult::* error code if another failure occurred.
*/
AudioResult(CARB_ABI* getDeviceCapsByGuid)(DeviceType dir,
const carb::extras::Guid* guid,
carb::audio::DeviceCaps* caps);
/** Retrieve a minimal set of device properties.
* @param[in] dir The audio direction of the device.
* @param[in] guid The guid of the device to retrieve the description for.
* @param[inout] caps The basic properties of this device.
* @ref DeviceCaps::name and @ref DeviceCaps::guid will
* be written to this.
* @ref DeviceCaps::flags will have @ref fDeviceFlagDefault
* set if this is the default device, but no other flags
* will be set.
* All other members of this struct will be set to default
* values.
* `caps->thisSize` must be set to `sizeof(*caps)`
* before passing it.
*
* @retval AudioResult::eOk on success.
* @retval AudioResult::eInvalidParameter if the @a thisSize value is not properly
* initialized in @p caps, @p caps is `nullptr` or @p guid is `nullptr`.
* @retval AudioResult::eOutOfRange if @p guid did not correspond to a device.
*/
AudioResult(CARB_ABI* getDeviceNameByGuid)(DeviceType dir,
const carb::extras::Guid* guid,
carb::audio::DeviceCaps* caps);
};
} // namespace audio
} // namespace carb
| 12,206 | C | 48.82449 | 115 | 0.642225 |
omniverse-code/kit/include/carb/audio/IAudioData.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The audio data management interface.
*/
#pragma once
#include "../Interface.h"
#include "../assets/IAssets.h"
#include "AudioTypes.h"
namespace carb
{
namespace audio
{
/************************************* Interface Objects *****************************************/
/** a buffer of sound data. This includes all of the information about the data's format and the
* sound data itself. This data may be in a decoded PCM stream or an encoded/compressed format.
* Note that much of the information in this object can be accessed through the IAudioData interface.
* This includes (but is not limited to) extra decoding information about the compression format.
*/
struct SoundData DOXYGEN_EMPTY_CLASS;
/** stores information on the current decoding or encoding state of a @ref SoundData object.
* This object is kept separate from the sound data to avoid the limitation that streaming from
* a SoundData object or encoding a single sound to multiple targets can only have one
* simultaneous instance. The information stored in this object determines how the sound
* data is decoded (ie: streamed from disk, streamed from memory, etc) and holds state
* information about the decoding process itself.
*/
struct CodecState DOXYGEN_EMPTY_CLASS;
/********************************* Sound Data Object Creation ************************************/
/** special value to indicate that the maximum instance count for a sound or sound group is
* unlimited. This can be passed to setMaxInstances() or can be returned from getMaxInstances().
*/
constexpr uint32_t kInstancesUnlimited = 0;
/** flags used for the createData() function. These control how the the sound data object is
* created or loaded. Zero or more of these flags may be combined to change the way the audio
* data is loaded. Only one of the fDataFlagFormat* flags may be used since they are all mutually
* exclusive.
*
* Note that not all of these flags can be used when loading a sound object through the asset
* system. Some flags require additional information in order to function properly and that
* information cannot be passed in through the asset system's loadAsset() function.
*
* @{
*/
/** base type used to specify the fDataFlag* flags for createData(). */
typedef uint32_t DataFlags;
/** mask to indicate which flag bits are reserved to specify the file format flags. These flags
* allow the loaded format of file data to be forced instead of auto-detected from the file's
* header. All of the format flags except for @ref fDataFlagFormatRaw may be used with the
* asset system loader. Note that the format values within this mask are all mutually exclusive,
* not individual flag bits. This mask can be used to determine the loaded format of a sound
* data object after it is loaded and the load-time flags retrieved with getFlags().
*/
constexpr DataFlags fDataFlagFormatMask = 0x000000ff;
/** auto detect the format from the file header data. This may only be used when the data is
* coming from a full audio file (on disk or in memory). The format information in the file's
* header will always be used regardless of the filename extension. This format flag is mutually
* exclusive from all other fDataFlagFormat* flags. Once a sound data object is successfully
* created, this flag will be replaced with one that better represents the actual encoded data
* in the sound.
*/
constexpr DataFlags fDataFlagFormatAuto = 0x00000000;
/** force raw PCM data to be loaded. This flag must be specified if the data stream does not
* have any format information present in it. When this format flag is used the data stream
* is expected to just be the raw decodable data for the specified format. There should not
* be any kind of header or chunk signature before the data. This format flag is mutually
* exclusive from all other fDataFlagFormat* flags.
*/
constexpr DataFlags fDataFlagFormatRaw = 0x00000001;
/** the data was loaded as WAV PCM. This flag will be added to the sound data object upon
* load to indicate that the original data was loaded from a PCM WAV/RIFF file. If specified
* before load, this flag will be ignored and the load will behave as though the data format
* flag were specified as @ref fDataFlagFormatAuto. This format flag is mutually exclusive
* from all other fDataFlagFormat* flags.
*/
constexpr DataFlags fDataFlagFormatPcm = 0x00000002;
/** This flag indicates that the metadata should be ignored when opening the sound.
* This is only relevant on sounds that need to be decoded from a file format that
* can store metadata.
* This is intended to be used in cases where the metadata won't be needed.
* Note that subsequent calls to createCodecState() which decode the loaded
* sound will not decode the metadata unless the @ref fDecodeStateFlagForceParse
* flag is used.
*/
constexpr DataFlags fDataFlagSkipMetaData = 0x00200000;
/** This flag indicates that the event points should be ignored when decoding the sound.
* This is only relevant on sounds that need to be decoded from a file format that
* can store event points
* This is intended to be used in cases where the event points won't be needed.
* Note that subsequent calls to createCodecState() which decode the loaded
* sound will not decode the event points unless the @ref fDecodeStateFlagForceParse
* flag is used.
*/
constexpr DataFlags fDataFlagSkipEventPoints = 0x00400000;
/** flag to indicate that the peak volumes for each channel should be calculated for the sound
* data object as its data is decoded at creation time or when streaming into the sound data
* object. This does not have any affect on decode operations that occur while playing back
* the sound data. This may be specified when creating an empty sound. This may be specified
* when the sound data object is loaded through the asset loader system.
*/
constexpr DataFlags fDataFlagCalcPeaks = 0x01000000;
/** load the file data from a blob in memory. The blob of file data is specified in the
* @ref SoundDataLoadDesc::dataBlob value and the blob's size is specified in the
* @ref SoundDataLoadDesc::dataBlobLengthInBytes value. Depending on the other flags used,
* this blob may be copied into the new sound data object or it may be decoded into the
* new object. As long as the @ref fDataFlagUserMemory flag is not also used, the blob
* data may be discarded upon return from createData(). This flag is always implied
* when loading a sound data object through the asset loader system.
*/
constexpr DataFlags fDataFlagInMemory = 0x02000000;
/** when the @ref fDataFlagInMemory flag is also used, this indicates that the original memory
* blob should be directly referenced in the new sound data object instead of copying it. When
* this flag is used, it is the caller's responsibility to ensure the memory blob remains valid
* for the entire lifetime of the sound data object. Note that if the @ref fDataFlagDecode flag
* is specified and the sound is encoded as a PCM format (either in a WAVE file or raw PCM loaded
* with @ref fDataFlagFormatRaw), the original memory blob will still be referenced. Using
* @ref fDataFlagDecode with any other format, such as @ref SampleFormat::eVorbis, will decode
* the audio into a new buffer and the original blob will no longer be needed.
*
* This flag is useful for creating sound data objects that reference audio data in a sound
* bank or sound atlas type object that exists for the lifetime of a scene. The original
* data in the bank or atlas can be referenced directly instead of having to copy it and
* use twice the memory (and time to copy it).
*/
constexpr DataFlags fDataFlagUserMemory = 0x04000000;
/** create the sound data object as empty. The buffer will be allocated to the size
* specified in @ref SoundDataLoadDesc::bufferLength and will be filled with silence.
* The data format information also must be filled out in the SoundDataLoadDesc
* descriptor before calling createData(). All other flags except for the
* @ref fDataFlagNoName and @ref fDataFlagCalcPeaks flags will be ignored when this
* flag is used. This flag is not allowed if specified through the asset loader
* system since it requires extra information.
*/
constexpr DataFlags fDataFlagEmpty = 0x08000000;
/** use the user-decode callbacks when loading or streaming this data. In this case, the
* format of the original sound is unspecified and unknown. The decode callback will be
* used to convert all of the object's data to PCM data when streaming or loading (depending
* on the other flags used). When this flag is used, the decoded format information in the
* SoundDataLoadDesc descriptor must be specified. This flag is not allowed if specified
* through the asset loader system since it requires extra information.
*
* In addition to allowing additional audio formats to be decoded, the user decode callbacks
* can also act as a simple abstract datasource; this may be useful when wanting to read data
* from a pack file without having to copy the full file blob out to memory.
*/
constexpr DataFlags fDataFlagUserDecode = 0x10000000;
/** stream the audio data at runtime. The behavior when using this flag greatly depends
* on some of the other flags and the format of the source data. For example, if the
* @ref fDataFlagInMemory flag is not used, the data will be streamed from disk. If
* that flag is used, the encoded/compressed data will be loaded into the sound data
* object and it will be decoded at runtime as it is needed. This flag may not be
* combined with the @ref fDataFlagDecode flag. If it is, this flag will be ignored
* and the full data will be decoded into PCM at load time. If neither this flag nor
* @ref fDataFlagDecode is specified, the @ref fDataFlagDecode flag will be implied.
* This flag is valid to specify when loading a sound data object through the asset
* loader system.
*/
constexpr DataFlags fDataFlagStream = 0x20000000;
/** decode the sound's full data into PCM at load time. The full stream will be converted
* to PCM data immediately when the new sound data object is created. The destination
* PCM format will be chosen by the decoder if the @ref SoundDataLoadDesc::pcmFormat value
* is set to @ref SampleFormat::eDefault. If it is set to one of the SampleFormat::ePcm*
* formats, the stream will be decoded into that format instead. This flag is valid to
* specify when loading a sound data object through the asset loader system. However,
* if it is used when loading an asset, the original asset data will only be referenced
* if it was already in a PCM format. Otherwise, it will be decoded into a new buffer
* in the new sound data object. If both this flag and @ref fDataFlagStream are specified,
* this flag will take precedence. If neither flag is specified, this one will be implied.
*/
constexpr DataFlags fDataFlagDecode = 0x40000000;
/** don't store the asset name or filename in the new sound data object. This allows some
* memory to to be saved by not storing the original filename or asset name when loading a
* sound data object from file, through the asset system, or when creating an empty object.
* This will also be ignored if the @ref fDataFlagStream flag is used when streaming from
* file since the original filename will be needed to reopen the stream for each new playing
* instance. This flag is valid to specify when loading a sound data object through the
* asset loader system.
*/
constexpr DataFlags fDataFlagNoName = 0x80000000;
/** @} */
/**
* callback function prototype for reading data for fDataFlagUserDecode sound data objects.
*
* @param[in] soundData the sound object to read the sound data for. This object will be
* valid and can be accessed to get information about the decoding
* format. The object's data buffer should not be accessed from
* the callback, but the provided @p data buffer should be used instead.
* This may not be nullptr.
* @param[out] data the buffer that will receive the decoded audio data. This buffer will be
* large enough to hold @p dataLength bytes. This may be nullptr to indicate
* that the remaining number of bytes in the stream should be returned in
* @p dataLength instead of the number of bytes read.
* @param[inout] dataLength on input, this contains the length of the @p data buffer in bytes.
* On output, if @p data was not nullptr, this will contain the
* number of bytes actually written to the buffer. If @p data
* was nullptr, this will contain the number of bytes remaining to be
* read in the stream. All data written to the buffer must be frame
* aligned.
* @param[in] context the callback context value specified in the SoundDataLoadDesc object.
* This is passed in unmodified.
* @returns AudioResult.eOk if the read operation is successful.
* @returns AudioResult.eTryAgain if the read operation was not able to fill an entire buffer and
* should be called again. This return code should be used when new data is not yet
* available but is expected soon.
* @returns AudioResult.eOutOfMemory if the full audio stream has been decoded (if it decides
* not to loop). This indicates that there is nothing left to decode.
* @returns an AudioResult.* error code if the callback could not produce its data for any
* other reason.
*
* @remarks This is used to either decode data that is in a proprietary format or to produce
* dynamic data as needed. The time and frequency at which this callback is performed
* depends on the flags that were originally passed to createData() when the sound
* data object was created. If the @ref fDataFlagDecode flag is used, this would
* only be performed at load time to decode the entire stream.
*
* @remarks When using a decoding callback, the data written to the buffer must be PCM data in
* the format expected by the sound data object. It is the host app's responsibility
* to know the sound format information before calling createData() and to fill
* that information into the @ref SoundDataLoadDesc object.
*/
typedef AudioResult(CARB_ABI* SoundDataReadCallback)(const SoundData* soundData,
void* data,
size_t* dataLength,
void* context);
/**
* an optional callback to reposition the data pointer for a user decoded stream.
*
* @param[in] soundData the sound data object to set the position for. This object will be
* valid and can be used to read data format information. Note that the
* host app is expected to know how to convert the requested decoded
* position into an encoded position. This may not be nullptr.
* @param[in] position the new position to set for the stream. This value must be greater than
* or equal to 0, and less than the length of the sound (as returned from
* getLength()). This value is interpreted according to the @p type value.
* @param[in] type the units to interpret the new read cursor position in. Note that if this
* is specified in milliseconds, the actual position that it seeks to may not
* be accurate. Similarly, if a position in bytes is given, it will be
* rounded up to the next frame boundary.
* @param[in] context the callback context value specified in the @ref SoundDataLoadDesc object.
* This is passed in unmodified.
* @returns AudioResult.eOk if the positioning operation was successful.
* @returns AudioResult.eInvalidParameter if the requested offset is outside the range of the
* active sound.
* @returns an AudioResult.* error code if the operation fails for any other reason.
*
* @remarks This is used to handle operations to reposition the read cursor for user decoded
* sounds. This callback occurs when a sound being decoded loops or when the current
* playback/decode position is explicitly changed. The callback will perform the actual
* work of positioning the decode cursor and the new decoding state information should
* be updated on the host app side. The return value may be returned directly from
* the function that caused the read cursor position to change in the first place.
*/
typedef AudioResult(CARB_ABI* SoundDataSetPosCallback)(const SoundData* soundData,
size_t position,
UnitType type,
void* context);
/** An optional callback that gets fired when the SoundData's final reference is released.
* @param[in] soundData The sound data object to set the destructor for.
* This object will still be valid during this callback,
* but immediately after this callback returns, @p soundData
* will be invalid.
* @param[in] context the callback context value specified in the @ref SoundDataLoadDesc object.
* This is passed in unmodified.
*/
typedef void(CARB_ABI* SoundDataDestructionCallback)(const SoundData* soundData, void* context);
/** the memory limit threshold for determining if a sound should be decoded into memory.
* When the fDataFlagDecode flag is used and the size of the decoded sound is over this limit,
* the sound will not be decoded into memory.
*/
constexpr size_t kMemoryLimitThreshold = 1ull << 31;
/** a descriptor for the sound data to be loaded. This is a flexible loading method that allows
* sound data to be loaded from file, memory, streamed from disk, loaded as raw PCM data, loaded
* from a proprietary data format, decoded or decompressed at load time, or even created as an
* empty sound buffer. The loading method depends on the flags used. For data loaded from file
* or a blob in memory, the data format can be auto detected for known supported formats.
*
* Not all members in this object are used on each loading path. For example, the data format
* information will be ignored when loading from a file that already contains format information
* in its header. Regardless of whether a particular value is ignored, it is still the caller's
* responsibility to appropriately initialize all members of this object.
*
* Sound data is loaded using this descriptor through a single loader function. Because there
* are more than 60 possible combinations of flags that can be used when loading sound data,
* it's not feasible to create a separate loader function for each possible method.
*/
struct SoundDataLoadDesc
{
/** flags to control how the sound data is loaded and decoded (if at all). This is a
* combination of zero or more of the fDataFlag* flags. By default, the sound data's
* format will attempt to be auto detected and will be fully loaded and decoded into memory.
* This value must be initialized before calling createData().
*/
DataFlags flags = 0;
/** Dummy member to enforce padding. */
uint32_t padding1{ 0 };
/** filename or asset name for the new object. This may be specified regardless of whether
* the @ref fDataFlagInMemory flag is used. When that flag is used, this can be used to
* give an asset name to the sound object. The name will not be used for any purpose
* except as a way to identify it to a user in that case. When loading the data from
* a file, this represents the filename to load from. When the @ref fDataFlagInMemory
* flag is not used, this must be the filename to load from. This may be nullptr only
* if the audio data is being loaded from a blob in memory.
*/
const char* name = nullptr;
/** when the @ref fDataFlagInMemory flag is used, this is the blob of data to load from
* memory. If the flag is not specified, this value will be ignored. When loading from
* memory, the @ref dataBlobLengthInBytes will indicate the size of the data blob in bytes.
* Specifying a data blob with @ref fDataFlagFormatRaw with a pointer that is misaligned for
* its sample type is allowed; the effects of @ref fDataFlagUserMemory will be disabled so
* a properly aligned local buffer can be allocated.
* The effects of @ref fDataFlagUserMemory will also be disabled when specifying a wave file
* blob where the data chunk is misaligned for its sample type (this is only possible for 32
* bit formats).
*/
const void* dataBlob = nullptr;
/** when the @ref fDataFlagInMemory flag is used, this value specifies the size of
* the data blob to load in bytes. When the flag is not used, this value is ignored.
*/
size_t dataBlobLengthInBytes = 0;
/** the number of channels to create the sound data with. This value is ignored if the sound
* data itself contains an embedded channel count (ie: when loading from file). This must be
* initialized to a non-zero value when the @ref fDataFlagFormatRaw, @ref fDataFlagEmpty,
* or @ref fDataFlagUserDecode flags are used.
* If @ref fDataFlagUserDecode is used and @ref encodedFormat is a non-PCM format, this will
* be ignored.
*/
size_t channels = kDefaultChannelCount;
/** a mask that maps speaker channels to speakers. All channels in the stream are interleaved
* according to standard SMPTE order. This mask indicates which of those channels are
* present in the stream. This may be @ref kSpeakerModeDefault to allow a standard speaker
* mode to be chosen from the given channel count.
*/
SpeakerMode channelMask = kSpeakerModeDefault;
/** the rate in frames per second that the sound was originally mastered at. This will be the
* default rate that it is processed at. This value is ignored if the sound data itself
* contains an embedded frame rate value (ie: when loading from file). This must be
* initialized to a non-zero value when the @ref fDataFlagFormatRaw, @ref fDataFlagEmpty,
* or @ref fDataFlagUserDecode flags are used.
* If @ref fDataFlagUserDecode is used and @ref encodedFormat is a non-PCM format, this will
* be ignored.
*/
size_t frameRate = kDefaultFrameRate;
/** the data format of each sample in the sound. This value is ignored if the sound data
* itself contains an embedded data format value (ie: when loading from file). This must be
* initialized to a non-zero value when the @ref fDataFlagFormatRaw, @ref fDataFlagEmpty,
* or @ref fDataFlagUserDecode flags are used. This represents the encoded sample format
* of the sound.
*
* If the @ref fDataFlagUserDecode flag is used, this will be the format produced by the
* user decode callback.
* Note that PCM data produced from a user decode callback must be raw PCM data rather than
* a WAVE file blob.
* The user decode callback does not need to provide whole frames/blocks of this sample type,
* since this effectively acts as an arbitrary data source.
* This allows you to specify that the user decode callback returns data in a non-PCM format
* and have it decoded to the PCM format specified by @ref pcmFormat.
*
* If the @ref fDataFlagEmpty flag is used and this is set to @ref SampleFormat::eDefault,
* this will be set to the same sample format as the @ref pcmFormat format.
*/
SampleFormat encodedFormat = SampleFormat::eDefault;
/** the decoded or preferred intermediate PCM format of the sound. This value should be set
* to @ref SampleFormat::eDefault to allow the intermediate format to be chosen by the
* decoder. Otherwise, this should be set to one of the SampleFormat::ePcm* formats to
* force the decoder to use a specific intermediate or internal representation of the sound.
* This is useful for saving memory on large decoded sounds by forcing a smaller format.
*
* When the @ref fDataFlagDecode flag is used, this will be the PCM format that the data is
* decoded into.
*
* When the @ref fDataFlagEmpty flag is used and this is set to @ref SampleFormat::eDefault,
* the decoder will choose the PCM format. If the @ref encodedFormat value is also set to
* @ref SampleFormat::eDefault, it will also use the decoder's preferred PCM format.
*/
SampleFormat pcmFormat = SampleFormat::eDefault;
/** specifies the desired length of an empty sound data buffer, a raw buffer, or user decode
* buffer. This value is interpreted according to the units in @ref bufferLengthType. This
* value is ignored if the sound data itself contains embedded length information (ie: when
* loading from file). This must be initialized to a non-zero value when either the
* @ref fDataFlagFormatRaw, @ref fDataFlagEmpty, or @ref fDataFlagUserDecode flags are used.
* When using this with @ref fDataFlagEmpty, the sound data object will initially be marked
* as containing zero valid frames of data. If played, this will always decode silence.
* If the host app writes new data into the buffer, it must also update the valid data size
* with setValidLength() so that the new data can be played.
*/
size_t bufferLength = 0;
/** determines how the @ref bufferLength value should be interpreted. This value is ignored
* in the same cases @ref bufferLength are ignored in. For @ref fDataFlagEmpty, this may be
* any valid unit type. For @ref fDataFlagFormatRaw and @ref fDataFlagUserDecode, this may
* only be @ref UnitType::eFrames or @ref UnitType::eBytes.
*/
UnitType bufferLengthType = UnitType::eFrames;
/** Dummy member to enforce padding. */
uint32_t padding2{ 0 };
/** a callback function to provide decoded PCM data from a user-decoded data format. This
* value is ignored unless the @ref fDataFlagUserDecode flag is used. This callback
* is responsible for decoding its data into the PCM format specified by the rest of the
* information in this descriptor. The callback function or caller are responsible for
* knowing the decoded format before calling createData() and providing it in this
* object.
*/
SoundDataReadCallback readCallback = nullptr;
/** an optional callback function to provide a way to reposition the decoder in a user
* decoded stream. This value is ignored unless the @ref fDataFlagUserDecode flag
* is used. Even when the flag is used, this callback is only necessary if the
* @ref fDataFlagStream flag is also used and the voice playing it expects to either
* loop the sound or be able to reposition it on command during playback. If this callback
* is not provided, attempts to play this sound on a looping voice or attempts to change
* the streaming playback position will simply fail.
*/
SoundDataSetPosCallback setPosCallback = nullptr;
/** an opaque context value that will be passed to the readCallback and setPosCallback
* functions each time they are called. This value is a caller-specified object that
* is expected to contain the necessary decoding state for a user decoded stream. This
* value is only necessary if the @ref fDataFlagUserDecode flag is used. This value
* will only be used at load time on a user decoded stream if the @ref fDataFlagDecode
* flag is used (ie: causing the full sound to be decoded into memory at load time). If
* the sound is created to be streamed, this will not be used.
*/
void* readCallbackContext = nullptr;
/** An optional callback that gets fired when the SoundData's final
* reference is released. This is intended to make it easier to perform
* cleanup of a SoundData in cases where @ref fDataFlagUserMemory is used.
*/
SoundDataDestructionCallback destructionCallback = nullptr;
/** An opaque context value that will be passed to @ref destructionCallback
* when the last reference to the SoundData is released.
* This will not be called if the SoundData is not created successfully.
*/
void* destructionCallbackContext = nullptr;
/** Reserved for future expansion for options to be used when @ref fDataFlagDecode
* is specified.
*/
void* encoderSettings = nullptr;
/** the maximum number of simultaneous playing instances that this sound can have. This
* can be @ref kInstancesUnlimited to indicate that there should not be a play limit.
* This can be any other value to limit the number of times this sound can be played
* at any one time.
*/
uint32_t maxInstances = kInstancesUnlimited;
/** Dummy member to enforce padding. */
uint32_t padding3{ 0 };
/** the size in bytes at which to decide whether to decode or stream this sound. This
* will only affect compressed non-PCM sound formats. This value will be ignored for
* any PCM format regardless of size. This can be zero to just decide to stream or
* decode based on the @ref fDataFlagDecode or @ref fDataFlagStream flags. If this
* is non-zero, the sound will be streamed if its PCM size is larger than this limit.
* The sound will be fully decoded if its PCM size is smaller than this limit. In
* this case, the @ref fDataFlagDecode flag and @ref fDataFlagStream flag will be ignored.
*
* Note that if this is non-zero, this will always override the stream and decode flags'
* behavior.
*/
size_t autoStreamThreshold = 0;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** additional load parameters for sound data objects. These are passed through to the asset
* loader as a way of passing additional options beyond just the filename and flags. These
* additional options will persist for the lifetime of the loaded asset and will be passed
* to the loader function each time that asset needs to be reloaded from its original data
* source. Any shallow copied objects in here must be guaranteed persistent by the caller
* for the entire period the asset is valid. It is the host app's responsibility to clean
* up any resources in this object once the asset it was used for has been unloaded.
*
* In general, it is best practice not to fill in any of the pointer members of this struct
* and to allow them to just use their default behavior.
*/
struct SoundLoadParameters : public carb::assets::LoadParameters
{
/** additional parameters to pass to the asset loader. The values in here will follow
* all the same rules as using the @ref SoundDataLoadDesc structure to directly load
* a sound data object, except that the @a dataBlob and @a dataBlobLengthInBytes values
* will be ignored (since they are provided by the asset loader system). The other
* behavior that will be ignored will be that the @ref fDataFlagInMemory flag will
* always be used. Loading a sound data object through the asset system does not
* support loading from a disk filename (the asset system itself will handle that
* if the data source supports it).
*
* @note most of the values in this parameter block are still optional. Whether
* each value is needed or not often depends on the flags that are specified.
*
* @note most the pointer members in this parameter block should be set to nullptr
* for safety and ease of cleanup. This includes the @a name, @a dataBlob, and
* @a encoderSettings values. Setting the @a readCallbackContext and
* @a destructionCallbackContext values is acceptable because the host app is
* always expected to manage those objects' lifetimes anyway.
*/
SoundDataLoadDesc params = {};
};
/************************************* Codec State Objects ***************************************/
/** names to identify the different parts of a codec. These are used to indicate which type of
* codec state needs to be created or to indicate which type of sound format to retrieve.
*/
enum class CodecPart
{
/** identifies the decoder part of the codec or that the decoded sound format should be
* retrieved. When retrieving a format, this will be the information for the PCM format
* for the sound. When creating a codec state, this will expect that the decoder descriptor
* information has been filled in.
*/
eDecoder,
/** identifies the encoder part of the codec or that the encoded sound format should be
* retrieved. When retrieving a format, this will be the information for the encoded
* format for the sound. When creating a codec state, this will expect that the encoder
* descriptor information has been filled in.
*/
eEncoder,
};
/** Flags that alter the decoding behavior for SoundData objects.
*/
typedef uint64_t DecodeStateFlags;
/** If this flag is set, the header information of the file will be parsed
* every time createCodecState() is called.
* If this flag is not set, the header information of the file will be cached
* if possible.
*/
constexpr DecodeStateFlags fDecodeStateFlagForceParse = 0x00000001;
/** If this flag is set and the encoded format supports this behavior, indexes
* for seek optimization will be generated when the CodecState is created.
* For a streaming sound on disk, this means that the entire sound will be
* read off disk when creating this index; the sound will not be decoded or
* fully loaded into memory, however.
* This will reduce the time spent when seeking within a SoundData object.
* This will increase the time spent initializing the decoding stream, and this
* will use some additional memory.
* This option currently only affects @ref SampleFormat::eVorbis and
* @ref SampleFormat::eOpus.
* This will clear the metadata and event points from the sound being decoded
* unless the corresponding flag is used to skip the parsing of those elements.
*/
constexpr DecodeStateFlags fDecodeStateFlagOptimizeSeek = 0x00000002;
/** This flag indicates that frame accurate seeking is not needed and the decoder
* may skip additional work that is required for frame-accurate seeking.
* An example usage of this would be a music player; seeking is required, but
* frame-accurate seeking is not required.
* Additionally, this may be useful in cases where the only seeking needed is
* to seek back to the beginning of the sound, since that can always be done
* with perfect accuracy.
*
* This only affects @ref SampleFormat::eVorbis, @ref SampleFormat::eOpus and
* @ref SampleFormat::eMp3.
* For @ref SampleFormat::eVorbis, @ref SampleFormat::eOpus, this will cause
* the decoder to seek to the start of the page containing the target frame,
* rather than trying to skip through that page to find the exact target frame.
*
* For @ref SampleFormat::eMp3, this flag will skip the generation of an index
* upon opening the file.
* This may result in the file length being reported incorrectly, depending on
* how the file was encoded.
* This will also result in seeking being performed by estimating the target
* frame's location (this will be very inaccurate for variable bitrate files).
*/
constexpr DecodeStateFlags fDecodeStateFlagCoarseSeek = 0x00000004;
/** This flag indicates that the metadata should be ignored when decoding the
* sound. This is intended to be used in cases where the metadata won't be
* used, such as decoding audio for playback.
* Note that this only takes effect when @ref fDecodeStateFlagForceParse is
* used.
*/
constexpr DecodeStateFlags fDecodeStateFlagSkipMetaData = 0x00000008;
/** This flag indicates that the event points should be ignored when decoding the
* sound. This is intended to be used in cases where the event points won't be
* used, such as decoding audio for playback.
* Note that this only takes effect when @ref fDecodeStateFlagForceParse is
* used.
*/
constexpr DecodeStateFlags fDecodeStateFlagSkipEventPoints = 0x00000010;
/** a descriptor of how to create a sound decode state object with createCodecState(). By
* separating this object from the sound data itself, this allows the sound to be trivially
* streamed or decoded to multiple voices simultaneously without having to worry about
* managing access to the sound data or loading it multiple times.
*/
struct DecodeStateDesc
{
/** flags to control the behavior of the decoder. This may be 0 or a
* combination of the kDecodeState* flags.
*/
DecodeStateFlags flags;
/** the sound data object to create the decoder state object for. The size and content
* of the decoder object depends on the type of data contained within this object.
* This may not be nullptr. Note that in some cases, the format and length information
* in this object may be updated by the decoder. This would only occur in cases where
* the data were being streamed from disk. If streaming from memory the cached header
* information will be used instead. If this is used at load time (internally), the
* sound data object will always be modified to cache all the important information about
* the sound's format and length.
*/
SoundData* soundData;
/** the desired output format from the decoder.
* This can be SampleFormat::eDefault to use the format from @p soundData;
* otherwise, this must be one of the SampleFormat::ePcm* formats.
*/
SampleFormat outputFormat;
/** an opaque context value that will be passed to the readCallback and setPosCallback
* functions each time they are called. This value is a caller-specified object that
* is expected to contain the necessary decoding state for a user decoded stream. This
* value is only necessary if the @ref fDataFlagUserDecode flag was used when the
* sound data object was created. By specifying this separately from the sound data,
* this allows multiple voices to be able to play a user decoded stream simultaneously.
* It is up to the caller to provide a unique decode state object here for each playing
* instance of the user decoded stream if there is an expectation of multiple instances.
*/
void* readCallbackContext;
/** reserved for future expansion. This must be set to nullptr. */
void* ext;
};
/** flags to control the behavior of the encoder.
*
* @{
*/
/** base type for the encoder descriptor flags. */
typedef uint64_t EncodeStateFlags;
/** Avoid expanding the target @ref SoundData if it runs out of space. The
* encoder will simply start to fail when the buffer is full if this flag is
* used. Note that for some formats this may cause the last block in the
* stream to be missing if the buffer is not block aligned in size.
*/
constexpr EncodeStateFlags fEncodeStateFlagNoExpandBuffer = 0x00000001;
/** Don't copy the metadata information into the target @ref SoundData.
*/
constexpr EncodeStateFlags fEncodeStateFlagStripMetaData = 0x00000002;
/** Don't copy the event point information into the target @ref SoundData.
*/
constexpr EncodeStateFlags fEncodeStateFlagStripEventPoints = 0x00000004;
/** Don't copy the peaks information into the target @ref SoundData.
*/
constexpr EncodeStateFlags fEncodeStateFlagStripPeaks = 0x00000008;
/** @} */
/** a descriptor for creating an encoder state object. This can encode the data into either a
* stream object or a sound data object. Additional encoder settings depend on the output
* format that is chosen.
*/
struct EncodeStateDesc
{
/** flags to control the behavior of the encoder. At least one of the kEncodeStateTarget*
* flags must be specified.
*/
EncodeStateFlags flags;
/** The SoundData this encoding is associated with, if any.
* The Metadata and event points will be copied from this to the header
* of the encoded data.
* This can be set to nullptr if there is no SoundData associated with this
* encoding.
*/
const SoundData* soundData;
/** The target for the encoder.
* This may not be nullptr.
* Note that the target's format information will be retrieved to
* determine the expected format for the encoder's output. At least for
* the channel count and frame rate, this information must also match that
* of the encoder's input stream. The sample format is the only part of
* the format information that the encoder may change.
* @ref target is treated as if it were empty. Any existing valid
* length will be ignored and the encoder will begin writing at the
* start of the buffer. If the metadata or event points are set to be
* copied, from @ref soundData, then those elements of @ref target will
* be cleared first. Passing @ref fEncodeStateFlagStripMetaData or
* @ref fEncodeStateFlagStripEventPoints will also clear the metadata
* and event points, respectively.
*/
SoundData* target;
/** the expected input format to the encoder. This must be one of the SampleFormat::ePcm*
* formats.
*/
SampleFormat inputFormat;
/** additional output format dependent encoder settings. This should be nullptr for PCM
* data formats. Additional objects will be defined for encoder formats that require
* additional parameters (optional or otherwise). For formats that require additional
* settings, this may not be nullptr. Use getCodecFormatInfo() to retrieve the info
* for the codec to find out if the additional settings are required or not.
*/
void* encoderSettings;
/** reserved for future expansion. This must be set to nullptr. */
void* ext;
};
/** a descriptor for the codec state that should be created. This contains the state information
* descriptors for both the encoder and decoder parts of the codec. Only one part may be valid
* at any given point. The part that is specified will indicate which kind of codec state object
* is created.
*/
struct CodecStateDesc
{
/** the codec part that indicates both which type of state object will be created and which
* part of the descriptor is valid.
*/
CodecPart part;
/** the specific codec state descriptors. */
union
{
DecodeStateDesc decode; ///< filled in when creating a decoder state.
EncodeStateDesc encode; ///< filled in when creating an encoder state.
};
/** reserved for future expansion. This must be set to nullptr. */
void* ext;
};
/** Settings specific to wave file encoding.
* This is not required when encoding wave audio.
* This can optionally be specified when encoding into any PCM format.
*/
struct WaveEncoderSettings
{
/** If this is specified, up to 10 bytes of padding will be added to align
* the data chunk for its data format, so that decoding will be more efficient.
* This is done with a 'JUNK' chunk.
* The data chunk can only be misaligned for @ref SampleFormat::ePcm32 and
* @ref SampleFormat::ePcmFloat.
*/
bool alignDataChunk = true;
};
/** Settings specific to Vorbis file encoding.
* This is not required when encoding Vorbis audio.
*/
struct VorbisEncoderSettings
{
/** Reserved for future expansion.
* Must be set to 0.
*/
uint32_t flags = 0;
/** The encoding quality of the compressed audio.
* This may be within the range of -0.1 to 1.0.
* Vorbis is a lossy codec with variable bitrate, so this doesn't correlate
* to an exact bitrate for the output audio.
* A lower quality increases encode time and decreases decode time.
* 0.8-0.9 is suitable for cases where near-perfect reproduction of the
* original audio is desired, such as music that will be listened to on
* its own.
* Lower quality values for the audio should be acceptable for most use
* cases, but the quality value at which artifacts become obvious will
* depend on the content of the audio, the use case and the quality of the
* speakers used.
* With very low quality settings, such as -0.1, audio artifacts will be
* fairly obvious in music, but for simpler audio, such as voice
* recordings, the quality loss may not be as noticeable (especially in
* scenes with background noise).
* This is 0.9 by default.
*/
float quality = 0.9f;
/** If this is true, the encoder will expect its input to be in Vorbis
* channel order. Otherwise WAVE channel order will be expected.
* All codecs use WAVE channel order by default, so this should be set to
* false in most cases.
* This is false by default.
*/
bool nativeChannelOrder = false;
};
/** The file type used to store FLAC encoded audio. */
enum class FlacFileType
{
/** A .flac container.
* This is the most common container type for FLAC encoded audio.
* This is the default format.
*/
eFlac,
/** A .ogg container.
* This allows FLAC to take advantage of all of the features of the Ogg
* container format.
* FLAC data encoded in Ogg containers will be slightly larger and slower
* to decode than the same data stored in a .flac container.
*/
eOgg,
};
/** Settings specific to FLAC file encoding.
* This is not required when encoding FLAC audio.
*/
struct FlacEncoderSettings
{
/** Reserved for future expansion. */
uint32_t flags = 0;
/** The file container type which will be used.
* The default value is @ref FlacFileType::eFlac.
*/
FlacFileType fileType = FlacFileType::eFlac;
/** The number of bits per sample to store.
* This can be used to truncate the audio to a smaller value, such as 16.
* This must be a value within the range of 4-24. Using values other than
* 8, 12, 16, 20 and 24 requires that @ref streamableSubset is set to
* false.
* Although FLAC supports up to 32 bits per sample, the encoder used
* only supports up to 24 bits per sample.
* The default value for this will be the bit width of the input format,
* except for SampleFormat::ePcm32 and SampleFormat::ePcmFloat, which are
* reduced to 24 bit.
* This can be set to 0 to use the default for the input type.
*/
uint32_t bitsPerSample = 0;
/** Set the compression level preset.
* This must be in the range [0-8], where 8 is the maximum compression level.
* A higher level will have a better compression ratio at the cost of
* compression time.
* The default value is 5.
*/
uint32_t compressionLevel = 5;
/** Set the block size for the encoder to use.
* Set this to 0 to let the encoder choose.
* It is recommended to leave this at 0.
* The default value is 0.
*/
uint32_t blockSize = 0;
/** The FLAC 'streamable subset' is a subset of the FLAC encoding that is
* intended to allow decoders that cannot seek to begin playing from the
* middle of a stream.
* If this is set to true, the codec state creation will fail if the
* following conditions are not met:
* - If the frame rate is above 65536, the frame rate must be divisible
* by 10. (see the FLAC standard for an explanation of this).
* - @ref bitsPerSample must be 8, 12, 16, 20 or 24.
* - Specific restrictions are placed on @ref blockSize.
* Please read the FLAC standard if you need to tune that parameter.
* Setting this to false may improve the compression ratio and decoding
* speed. Testing has shown only slight improvement from setting this
* option to false.
* The default value for this is true.
*/
bool streamableSubset = true;
/** Decode the encoded audio to verify that the encoding was performed
* correctly. The encoding will fail if a chunk does not verify.
* The default value for this is false.
*/
bool verifyOutput = false;
};
/** The intended usage for audio.
* This is used to optimize the Opus encoding for certain applications.
*/
enum class OpusCodecUsage
{
/** General purpose codec usage. Don't optimize for any specific signal type. */
eGeneral,
/** Optimize for the best possible reproduction of music. */
eMusic,
/** Optimize to ensure that speech is as recognizable as possible for a
* given bitrate.
* This should be used for applications such as voice chat, which require
* a low bitrate to be used.
*/
eVoice,
};
/** Encode @ref SampleFormat::eOpus with the maximum possible bitrate. */
const uint32_t kOpusBitrateMax = 512001;
/** Flags to use when encoding audio in @ref SampleFormat::eOpus. */
using OpusEncoderFlags = uint32_t;
/** Optimize the encoder for minimal latency at the cost of quality.
* This will disable the LPC and hybrid modules, which will disable
* voice-optimized modes and forward error correction.
* This also disables some functionality within the MDCT module.
* This reduces the codec lookahead to 2.5ms, rather than the default of 6.5ms.
*/
constexpr OpusEncoderFlags fOpusEncoderFlagLowLatency = 0x00000001;
/** Specify whether the encoder is prevented from producing variable bitrate audio.
* This flag should only be set if there is a specific need for constant bitrate audio.
*/
constexpr OpusEncoderFlags fOpusEncoderFlagConstantBitrate = 0x00000002;
/** This enables a mode in the encoder where silence will only produce
* one frame every 400ms. This is intended for applications such as voice
* chat that will continuously send audio, but long periods of silence
* will be produced.
* This is often referred to as DTX.
*/
constexpr OpusEncoderFlags fOpusEncoderFlagDiscontinuousTransmission = 0x00000004;
/** Disable prediction so that any two blocks of Opus data are (almost
* completely) independent.
* This will reduce audio quality.
* This will disable forward error correction.
* This should only be set if there is a specific need for independent
* frames.
*/
constexpr OpusEncoderFlags fOpusEncoderFlagDisablePrediction = 0x00000008;
/** If this is true, the encoder will expect its input to be in Vorbis
* channel order. Otherwise WAVE channel order will be expected.
* All codecs use WAVE channel order by default, so this should be set to
* false in most cases.
* This is only valid for a stream with 1-8 channels.
*/
constexpr OpusEncoderFlags fOpusEncoderFlagNativeChannelOrder = 0x00000010;
/** Settings specific to @ref SampleFormat::eOpus audio encoding.
* This is not required when encoding Opus audio.
*/
struct OpusEncoderSettings
{
/** The flags to use when encoding.
* These are not necessary to set for general purpose use cases.
*/
OpusEncoderFlags flags = 0;
/** The intended usage of the encoded audio.
* This allows the encoder to optimize for the specific usage.
*/
OpusCodecUsage usage = OpusCodecUsage::eGeneral;
/** The number of frames in the audio stream.
* This can to be set so that the audio stream length isn't increased when
* encoding into Opus.
* Set this to 0 if the encoding stream length is unknown in advance or
* if you don't care about the extra padding.
* Setting this to non-zero when calling @ref IAudioUtils::saveToFile() is
* not allowed.
* Setting this incorrectly will result in padding still appearing at the
* end of the audio stream.
*/
size_t frames = 0;
/** The bitrate to target. Higher bitrates will result in a higher quality.
* This can be from 500 to 512000.
* Use @ref kOpusBitrateMax for the maximum possible quality.
* Setting this to 0 will let the encoder choose.
* If variable bitrate encoding is enabled, this is only a target bitrate.
*/
uint32_t bitrate = 0;
/** The packet size to use for encoding.
* This value is a multiple of 2.5ms that is used for the block size.
* This setting is important to modify when performing latency-sensitive
* tasks, such as voice communication.
* Using a block size less than 10ms disables the LPC and hybrid modules,
* which will disable voice-optimized modes and forward error correction.
* Accepted values are:
* * 1: 2.5ms
* * 2: 5ms
* * 4: 10ms
* * 8: 20ms
* * 16: 40ms
* * 24: 60ms
* * 32: 80ms
* * 48: 120ms
* Setting this to an invalid value will result in 60ms being used.
*/
uint8_t blockSize = 48;
/** Set the estimated packet loss during transmission.
* Setting this to a non-zero value will encode some redundant data to
* enable forward error correction in the decoded stream.
* Forward error correction only takes effect in the LPC and hybrid
* modules, so it's more effective on voice data and will be disabled
* when the LPC and hybrid modes are disabled.
* This is a value from 0-100, where 0 is no packet loss and 100 is heavy
* packet loss.
* Setting this to a higher value will reduce the quality at a given
* bitrate due to the redundant data that has to be included.
* This should be set to 0 when encoding to a file or transmitting over a
* reliable medium.
* @note packet loss compensation is not handled in the decoder yet.
*/
uint8_t packetLoss = 0;
/** Set the computational complexity of the encoder.
* This can be from 0 to 10, with 10 being the maximum complexity.
* More complexity will improve compression, but increase encoding time.
* Set this to -1 for the default.
*/
int8_t complexity = -1;
/** The upper bound on bandwidth to specify for the encoder.
* This only sets the upper bound; the encoder will use lower bandwidths
* as needed.
* Accepted values are:
* * 4: 4KHz - narrow band
* * 6: 6KHz - medium band
* * 8: 8KHz - wide band
* * 12: 12 KHz - superwide band
* * 20: 20 KHz - full band
*/
uint8_t bandwidth = 20;
/** A hint for the encoder on the bit depth of the input audio.
* The maximum bit depth of 24 bits is used if this is set to 0.
* This should only be used in cases where you are sending audio into the
* encoder which was previously encoded from a smaller data type.
* For example, when encoding @ref SampleFormat::ePcmFloat data that was
* previously converted from @ref SampleFormat::ePcm16, this should be
* set to 16.
*/
uint8_t bitDepth = 0;
/** The gain to apply to the output audio.
* Set this to 0 for unity gain.
* This is a fixed point value with 8 fractional bits.
* calculateOpusGain() can be used to calculate this parameter from a
* floating point gain value.
* calculateGainFromLinearScale() can be used if a linear volume scale is
* desired, rather than a gain.
*/
int16_t outputGain = 0;
};
/** capabilities flags for codecs. One or more of these may be set in the codec info block
* to indicate the various features a particular codec may support or require.
*
* @{
*/
/** base type for the codec capabilities flags. */
typedef uint32_t CodecCaps;
/** capabilities flag to indicate that the codec supports encoding to the given format. */
constexpr CodecCaps fCodecCapsSupportsEncode = 0x00000001;
/** capabilities flag to indicate that the codec supports decoding from the given format. */
constexpr CodecCaps fCodecCapsSupportsDecode = 0x00000002;
/** capabilities flag to indicate that the format is compressed data (ie: block oriented or
* otherwise). If this flag is not set, the format is a PCM variant (ie: one of the
* SampleFormat::ePcm* formats).
*/
constexpr CodecCaps fCodecCapsCompressed = 0x00000004;
/** capabilities flag to indicate that the codec supports the use of additional parameters
* through the @a encoderSettings value in the encoder state descriptor object. If this
* flag is not set, there are no additional parameters defined for the format.
*/
constexpr CodecCaps fCodecCapsSupportsAdditionalParameters = 0x00000008;
/** capabilities flag to indicate that the codec requires the use of additional parameters
* through the @a encoderSettings value in the encoder state descriptor object. If this
* flag is not set, the additional parameters are optional and the codec is able to choose
* appropriate default.
*/
constexpr CodecCaps fCodecCapsRequiresAdditionalParameters = 0x00000010;
/** capabilities flag to indicate that the codec supports setting the position within the
* stream. If this flag is not set, calls to setCodecPosition() will fail when using
* the codec.
*/
constexpr CodecCaps fCodecCapsSupportsSetPosition = 0x00000020;
/** capabilities flag to indicate that the codec can calculate and set a frame accurate
* position. If this flag is not set, the codec can only handle setting block aligned
* positions. Note that this flag will never be set if @ref fCodecCapsSupportsSetPosition
* is not also set.
*/
constexpr CodecCaps fCodecCapsHasFrameAccuratePosition = 0x00000040;
/** capabilities flag to indicate that the codec can calculate a frame accurate count of
* remaining data. If this flag is not set, the codec can only handle calculating block
* aligned estimates.
*/
constexpr CodecCaps fCodecCapsHasAccurateAvailableValue = 0x00000080;
/** @} */
/** information about a codec for a single sample format. This includes information that is both
* suitable for display and that can be used to determine if it is safe or possible to perform a
* certain conversion operation.
*/
struct CodecInfo
{
/** the encoded sample format that this codec information describes. */
SampleFormat encodedFormat;
/** the PCM sample format that the decoder prefers to decode to and the encoder prefers to encode from. */
SampleFormat preferredFormat;
/** the friendly name of this codec. */
char name[256];
/** the library, system service, or author that provides the functionality of this codec. */
char provider[256];
/** the owner and developer information for this codec. */
char copyright[256];
/** capabilities flags for this codec. */
CodecCaps capabilities;
/** minimum block size in frames supported by this codec. */
size_t minBlockSize;
/** maximum block size in frames supported by this codec. */
size_t maxBlockSize;
/** the minimum number of channels per frame supported by this codec. */
size_t minChannels;
/** the maximum number of channels per frame supported by this codec. */
size_t maxChannels;
};
/*********************************** Metadata Definitions ***********************************/
/** These are the metadata tags that can be written to RIFF (.wav) files.
* Some of these tags were intended to be used on Video or Image data, rather
* than audio data, but all of these are still technically valid to use in
* .wav files.
* These are not case sensitive.
* @{
*/
constexpr char kMetaDataTagArchivalLocation[] = "Archival Location"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagCommissioned[] = "Commissioned"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagCropped[] = "Cropped"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagDimensions[] = "Dimensions"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagDisc[] = "Disc"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagDpi[] = "Dots Per Inch"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagEditor[] = "Editor"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagEngineer[] = "Engineer"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagKeywords[] = "Keywords"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagLanguage[] = "Language"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagLightness[] = "Lightness"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagMedium[] = "Medium"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagPaletteSetting[] = "Palette Setting"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagSubject[] = "Subject"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagSourceForm[] = "Source Form"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagSharpness[] = "Sharpness"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagTechnician[] = "Technician"; /**< Standard RIFF metadata tag. */
constexpr char kMetaDataTagWriter[] = "Writer"; /**< Standard RIFF metadata tag. */
/** These are the metadata tags that can be written to RIFF (.wav) files and
* also have specified usage under the Vorbis Comment metadata format standard
* (used by .ogg and .flac).
* Vorbis Comment supports any metadata tag name, but these ones should be
* preferred as they have a standardized usage.
* @{
*/
constexpr char kMetaDataTagAlbum[] = "Album"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagArtist[] = "Artist"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagCopyright[] = "Copyright"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagCreationDate[] = "Date"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagDescription[] = "Description"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagGenre[] = "Genre"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagOrganization[] = "Organization"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagTitle[] = "Title"; /**< Standard Vorbis metadata tag. */
constexpr char kMetaDataTagTrackNumber[] = "TrackNumber"; /**< Standard Vorbis metadata tag. */
/** If a SoundData is being encoded with metadata present, this tag will
* automatically be added, with the value being the encoder software used.
* Some file formats, such as Ogg Vorbis, require a metadata section and
* the encoder will automatically add this tag.
* Under the Vorbis Comment metadata format, the 'Encoder' tag represents the
* vendor string.
*/
constexpr char kMetaDataTagEncoder[] = "Encoder";
/** This tag unfortunately has a different meaning in the two formats.
* In RIFF metadata tags, this is the 'Source' of the audio.
* In Vorbis Comment metadata tags, this is the International Standard
* Recording Code track number.
*/
constexpr char kMetaDataTagISRC[] = "ISRC";
/** @} */
/** @} */
/** These are metadata tags specified usage under the Vorbis Comment
* metadata format standard (used by .ogg and .flac), but are not supported
* on RIFF (.wav) files.
* Vorbis Comment supports any metadata tag name, but these ones should be
* preferred as they have a standardized usage.
* These are not case sensitive.
* @{
*/
constexpr char kMetaDataTagLicense[] = "License"; /**< Standard metadata tag. */
constexpr char kMetaDataTagPerformer[] = "Performer"; /**< Standard metadata tag. */
constexpr char kMetaDataTagVersion[] = "Version"; /**< Standard metadata tag. */
constexpr char kMetaDataTagLocation[] = "Location"; /**< Standard metadata tag. */
constexpr char kMetaDataTagContact[] = "Contact"; /**< Standard metadata tag. */
/** @} */
/** These are metadata tags specified as part of the ID3v1 comment format (used
* by some .mp3 files).
* These are not supported on RIFF (.wav) files.
* @{
*/
/** This is a generic comment field in the ID3v1 tag. */
constexpr char kMetaDataTagComment[] = "Comment";
/** Speed or tempo of the music.
* This is specified in the ID3v1 extended data tag.
*/
constexpr char kMetaDataTagSpeed[] = "Speed";
/** Start time of the music.
* The ID3v1 extended data tag specifies this as "mmm:ss"
*/
constexpr char kMetaDataTagStartTime[] = "StartTime";
/** End time of the music.
* The ID3v1 extended data tag specifies this as "mmm:ss"
*/
constexpr char kMetaDataTagEndTime[] = "EndTime";
/** This is part of the ID3v1.2 tag. */
constexpr char kMetaDataTagSubGenre[] = "SubGenre";
/** @} */
/** These are extra metadata tags that are available with the ID3v2 metadata
* tag (used by some .mp3 files).
* These are not supported on RIFF (.wav) files.
* @{
*/
/** Beats per minute. */
constexpr char kMetaDataTagBpm[] = "BPM";
/** Delay between songs in a playlist in milliseconds. */
constexpr char kMetaDataTagPlaylistDelay[] = "PlaylistDelay";
/** The original file name for this file.
* This may be used if the file name had to be truncated or otherwise changed.
*/
constexpr char kMetaDataTagFileName[] = "FileName";
constexpr char kMetaDataTagOriginalAlbum[] = "OriginalTitle"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagOriginalWriter[] = "OriginalWriter"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagOriginalPerformer[] = "OriginalPerformer"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagOriginalYear[] = "OriginalYear"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagPublisher[] = "Publisher"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagRecordingDate[] = "RecordingDate"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagInternetRadioStationName[] = "InternetRadioStationName"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagInternetRadioStationOwner[] = "InternetRadioStationOwner"; /**< Standard ID3v2 metadata tag.
*/
constexpr char kMetaDataTagInternetRadioStationUrl[] = "InternetRadioStationUrl"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagPaymentUrl[] = "PaymentUrl"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagInternetCommercialInformationUrl[] = "CommercialInformationUrl"; /**< Standard ID3v2 metadata
tag. */
constexpr char kMetaDataTagInternetCopyrightUrl[] = "CopyrightUrl"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagWebsite[] = "Website"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagInternetArtistWebsite[] = "ArtistWebsite"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagAudioSourceWebsite[] = "AudioSourceWebsite"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagComposer[] = "Composer"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagOwner[] = "Owner"; /**< Standard ID3v2 metadata tag. */
constexpr char kMetaDataTagTermsOfUse[] = "TermsOfUse"; /**< Standard ID3v2 metadata tag. */
/** The musical key that the audio starts with */
constexpr char kMetaDataTagInitialKey[] = "InitialKey";
/** @} */
/** This is a magic value that can be passed to setMetaData() to remove all
* tags from the metadata table for that sound.
*/
constexpr const char* const kMetaDataTagClearAllTags = nullptr;
/** used to retrieve the peak volume information for a sound data object. This contains one
* volume level per channel in the stream and the frame in the stream at which the peak
* occurs.
*/
struct PeakVolumes
{
/** the number of channels with valid peak data in the arrays below. */
size_t channels;
/** the frame that each peak volume level occurs at for each channel. This will be the
* first frame this peak volume level occurs at if it is reached multiple times in the
* stream.
*/
size_t frame[kMaxChannels];
/** the peak volume level that is reached for each channel in the stream. This will be
* in the range [0.0, 1.0]. This information can be used to normalize the volume level
* for a sound.
*/
float peak[kMaxChannels];
/** the frame that the overall peak volume occurs at in the sound. */
size_t peakFrame;
/** the peak volume among all channels of data. This is simply the maximum value found in
* the @ref peak table.
*/
float peakVolume;
};
/** base type for an event point identifier. */
typedef uint32_t EventPointId;
/** an invalid frame offset for an event point. This value should be set if an event point is
* to be removed from a sound data object.
*/
constexpr size_t kEventPointInvalidFrame = ~0ull;
/** This indicates that an event point should loop infinitely.
*/
constexpr size_t kEventPointLoopInfinite = SIZE_MAX;
/** a event point parsed from a data file. This contains the ID of the event point, its name
* label (optional), and the frame in the stream at which it should occur.
*/
struct EventPoint
{
/** the ID of the event point. This is used to identify it in the file information but is
* not used internally except to match up labels or loop points to the event point.
*/
EventPointId id;
/** the frame that the event point occurs at. This is relative to the start of the stream
* for the sound. When updating event points with setEventPoints(), this can be set
* to @ref kEventPointInvalidFrame to indicate that the event point with the ID @ref id
* should be removed from the sound data object. Otherwise, this frame index must be within
* the bounds of the sound data object's stream.
*/
size_t frame;
/** the user-friendly label given to this event point. This may be parsed from a different
* information chunk in the file and will be matched up later based on the event point ID.
* This value is optional and may be nullptr.
*/
const char* label = nullptr;
/** optional text associated with this event point. This may be additional information
* related to the event point's position in the stream such as closed captioning text
* or a message of some sort. It is the host app's responsibility to interpret and use
* this text appropriately. This text will always be UTF-8 encoded.
*/
const char* text = nullptr;
/** Length of the segment of audio referred to by this event point.
* If @ref length is non-zero, then @ref length is the number of frames
* after @ref frame that this event point refers to.
* If @ref length is zero, then this event point refers to the segment
* from @ref frame to the end of the sound.
* If @ref loopCount is non-zero, then the region specified will refer to
* a looping region.
* If @ref playIndex is non-zero, then the region can additionally specify
* the length of audio to play.
*/
size_t length = 0;
/** Number of times this section of audio in the playlist should be played.
* The region of audio to play in a loop is specified by @ref length.
* if @ref loopCount is 0, then this is a non-looping segment.
* If @ref loopCount is set to @ref kEventPointLoopInfinite, this
* specifies that this region should be looped infinitely.
*/
size_t loopCount = 0;
/** An optional method to specify an ordering for the event points or a
* subset of event points.
* A value of 0 indicates that there is no intended ordering for this
* event point.
* The playlist indexes will always be a contiguous range starting from 1.
* If a user attempts to set a non-contiguous range of event point
* playlist indexes on a SoundData, the event point system will correct
* this and make the range contiguous.
*/
size_t playIndex = 0;
/** user data object attached to this event point. This can have an optional destructor
* to clean up the user data object when the event point is removed, the user data object
* is replaced with a new one, or the sound data object containing the event point is
* destroyed. Note that when the user data pointer is replaced with a new one, it is the
* caller's responsibility to ensure that an appropriate destructor is always paired with
* it.
*/
UserData userData = {};
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** special value for setEventPoints() to indicate that the event point table should be
* cleared instead of adding or removing individual event points.
*/
constexpr EventPoint* const kEventPointTableClear = nullptr;
/******************************** Sound Data Management Interface ********************************/
/** interface to manage audio data in general. This includes loading audio data from multiple
* sources (ie: file, memory, raw data, user-decoded, etc), writing audio data to file, streaming
* audio data to file, decoding audio data to PCM, and changing its sample format. All audio
* data management should go through this interface.
*
* See these pages for more detail:
* @rst
* :ref:`carbonite-audio-label`
* :ref:`carbonite-audio-data-label`
@endrst
*/
struct IAudioData
{
CARB_PLUGIN_INTERFACE("carb::audio::IAudioData", 1, 0)
/*************************** Sound Data Creation and Management ******************************/
/** creates a new sound data object.
*
* @param[in] desc a descriptor of how and from where the audio data should be loaded.
* This may not be nullptr.
* @returns the newly created sound data object if it was successfully loaded or parsed.
* When this object is no longer needed, it must be freed with release().
* @returns nullptr if the sound data could not be successfully loaded.
*
* @remarks This creates a new sound data object from a requested data source. This single
* creation point manages the loading of all types of sound data from all sources.
* Depending on the flags used, the loaded sound data may or may not be decoded
* into PCM data.
*/
SoundData*(CARB_ABI* createData)(const SoundDataLoadDesc* desc);
/** acquires a new reference to a sound data object.
*
* @param[in] sound the sound data object to take a reference to. This may not be
* nullptr.
* @returns the sound data object with an additional reference taken on it. This new
* reference must later be released with release().
*
* @remarks This grabs a new reference to a sound data object. Each reference that is
* taken must be released at some point when it is no longer needed. Note that
* the createData() function returns the new sound data object with a single
* reference on it. This final reference must also be released at some point to
* destroy the object.
*/
SoundData*(CARB_ABI* acquire)(SoundData* sound);
/** releases a reference to a sound data object.
*
* @param[in] sound the sound data object to release a reference on. This may not be
* nullptr.
* @returns the new reference count for the sound data object.
* @returns 0 if the sound data object was destroyed (ie: all references were released).
*
* @remarks This releases a single reference to sound data object. If all references have
* been released, the object will be destroyed. Each call to grab a new reference
* with acquire() must be balanced by a call to release that reference. The
* object's final reference that came from createData() must also be released
* in order to destroy it.
*/
size_t(CARB_ABI* release)(SoundData* sound);
/*************************** Sound Data Information Accessors ********************************/
/** retrieves the creation time flags for a sound data object.
*
* @param[in] sound the sound data object to retrieve the creation time flags for.
* @returns the flags that were used when creating the sound object. Note that if the sound
* data object was duplicated through a conversion operation, the data format flags
* may no longer be accurate.
* @returns 0 if @p sound is nullptr.
*/
DataFlags(CARB_ABI* getFlags)(const SoundData* sound);
/** retrieves the name of the file this object was loaded from (if any).
*
* @param[in] sound the sound data object to retrieve the filename for.
* @returns the original filename if the object was loaded from a file.
* @returns nullptr if the object does not have a name.
* @returns nullptr @p sound is nullptr.
*/
const char*(CARB_ABI* getName)(const SoundData* sound);
/** retrieves the length of a sound data object's buffer.
*
* @param[in] sound the sound to retrieve the buffer length for. This may not be nullptr.
* @param[in] units the units to retrieve the buffer length in. Note that if the buffer
* length in milliseconds is requested, the length may not be precise.
* @returns the length of the sound data object's buffer in the requested units.
*
* @remarks This retrieves the length of a sound data object's buffer in the requested units.
* The length of the buffer represents the total amount of audio data that is
* represented by the object. Note that if this object was created to stream data
* from file or the data is stored still encoded or compressed, this will not
* reflect the amount of memory actually used by the object. Only non-streaming
* PCM formats will be able to convert their length into an amount of memory used.
*/
size_t(CARB_ABI* getLength)(const SoundData* sound, UnitType units);
/** sets the current 'valid' size of an empty buffer.
*
* @param[in] sound the sound data object to set the new valid length for. This may
* not be nullptr.
* @param[in] length the new length of valid data in the units specified by @p units.
* This valid data length may not be specified in time units (ie:
* @ref UnitType::eMilliseconds or @ref UnitType::eMicroseconds)
* since it would not be an exact amount and would be likely to
* corrupt the end of the stream. This length must be less than or
equal to the creation time length of the buffer.
* @param[in] units the units to interpret @p length in. This must be in frames or
* bytes.
* @returns true if the new valid data length is successfully updated.
* @returns false if the new length value was out of range of the buffer size or the
* sound data object was not created as empty.
*
* @remarks This sets the current amount of data in the sound data object buffer that is
* considered 'valid' by the caller. This should only be used on sound data objects
* that were created with the @ref fDataFlagEmpty flag. If the host app decides
* to write data to the empty buffer, it must also set the amount of valid data
* in the buffer before that new data can be decoded successfully. When the
* object's encoded format is not a PCM format, it is the caller's responsibility
* to set both the valid byte and valid frame count since that may not be able
* to be calculated without creating a decoder state for the sound. When the
* object's encoded format is a PCM format, both the frames and byte counts
* will be updated in a single call regardless of which one is specified.
*/
bool(CARB_ABI* setValidLength)(SoundData* sound, size_t length, UnitType units);
/** retrieves the current 'valid' size of an empty buffer.
*
* @param[in] sound the sound data object to retrieve the valid data length for. This
* may not be nullptr.
* @param[in] units the units to retrieve the current valid data length in. Note that
* if a time unit is requested, the returned length may not be accurate.
* @returns the valid data length for the object in the specified units.
* @returns 0 if the buffer does not have any valid data.
*
* @remarks This retrieves the current valid data length for a sound data object. For sound
* data objects that were created without the @ref fDataFlagEmpty flag, this will be
* the same as the value returned from getLength(). For an object that was created
* as empty, this will be the length that was last on the object with a call to
* setValidLength().
*/
size_t(CARB_ABI* getValidLength)(const SoundData* sound, UnitType units);
/** retrieves the data buffer for a sound data object.
*
* @param[in] sound the sound to retrieve the data buffer for. This may not be nullptr.
* @returns the data buffer for the sound data object.
* @returns nullptr if @p sound does not have a writable buffer.
* This can occur for sounds created with @ref fDataFlagUserMemory.
* In that case, the caller either already has the buffer address
* (ie: shared the memory block to save on memory or memory copy
* operations), or the memory exists in a location that should
* not be modified (ie: a sound bank or sound atlas).
* @returns nullptr if the @p sound object is invalid.
* @returns nullptr if @p sound is streaming from disk, since a sound
* streaming from disk will not have a buffer.
*
* @remarks This retrieves the data buffer for a sound data object.
* This is intended for cases such as empty sounds where data
* needs to be written into the buffer of @p sound.
* getReadBuffer() should be used for cases where writing to the
* buffer is not necessary, since not all sound will have a
* writable buffer.
* In-memory streaming sounds without @ref fDataFlagUserMemory
* will return a buffer here; that buffer contains the full
* in-memory file, so writing to it will most likely corrupt the
* sound.
*/
void*(CARB_ABI* getBuffer)(const SoundData* sound);
/** Retrieves the read-only data buffer for a sound data object.
*
* @param[in] sound the sound to retrieve the data buffer for. This may not be nullptr.
* @returns the data buffer for the sound data object.
* @returns nullptr if the @p sound object is invalid.
* @returns nullptr if @p sound is streaming from disk, since a sound
* streaming from disk will not have a buffer.
*
* @remarks This retrieves the data buffer for a sound data object.
* Any decoded @ref SoundData will return a buffer of raw PCM
* data that can be directly played.
* getValidLength() should be used to determine the length of a
* decoded buffer.
* Any in-memory streaming @ref SoundData will also return the
* raw file blob; this needs to be decoded before it can be
* played.
*/
const void*(CARB_ABI* getReadBuffer)(const SoundData* sound);
/** retrieves the amount of memory used by a sound data object.
*
* @param[in] sound the sound data object to retrieve the memory usage for.
* @returns the total number of bytes used to store the sound data object.
* @returns 0 if @p sound is nullptr.
*
* @remarks This retrieves the amount of memory used by a single sound data object. This
* will include all memory required to store the audio data itself, to store the
* object and all its parameters, and the original filename (if any). This
* information is useful for profiling purposes to investigate how much memory
* the audio system is using for a particular scene.
*/
size_t(CARB_ABI* getMemoryUsed)(const SoundData* sound);
/** Retrieves the format information for a sound data object.
*
* @param[in] sound The sound data object to retrieve the format information for. This
* may not be nullptr.
* @param[in] type The type of format information to retrieve.
* For sounds that were decoded on load, this
* parameter doesn't have any effect, so it can be
* set to either value.
* For streaming sounds, @ref CodecPart::eDecoder will
* cause the returned format to be the format that the
* audio will be decoded into (e.g. when decoding Vorbis
* to float PCM, this will return @ref SampleFormat::ePcmFloat).
* For streaming sounds, @ref CodecPart::eEncoder will
* cause the returned format to be the format that the
* audio is being decoded from (e.g. when decoding Vorbis
* to float PCM, this will return @ref SampleFormat::eVorbis).
* In short, when you are working with decoded audio data,
* you should be using @ref CodecPart::eDecoder; when you
* are displaying audio file properties to a user, you
* should be using @ref CodecPart::eEncoder.
* @param[out] format Receives the format information for the sound data object. This
* format information will remain constant for the lifetime of the
* sound data object.
* @returns No return value.
*
* @remarks This retrieves the format information for a sound data object. The format
* information will remain constant for the object's lifetime so it can be
* safely cached once retrieved. Note that the encoded format information may
* not be sufficient to do all calculations on sound data of non-PCM formats.
*/
void(CARB_ABI* getFormat)(const SoundData* sound, CodecPart type, SoundFormat* format);
/** retrieves or calculates the peak volume levels for a sound if possible.
*
* @param[in] sound the sound data object to retrieve the peak information for. This may
* not be nullptr.
* @param[out] peaks receives the peak volume information for the sound data object
* @p sound. Note that only the entries corresponding to the number
* of channels in the sound data object will be written. The contents
* of the remaining channels is undefined.
* @returns true if the peak volume levels are available or could be calculated.
* @returns false if the peak volume levels were not calculated or loaded when the
* sound was created.
*
* @remarks This retrieves the peak volume level information for a sound. This information
* is either loaded from the sound's original source file or is calculated if
* the sound is decoded into memory at load time. This information will not be
* calculated if the sound is streamed from disk or memory.
*/
bool(CARB_ABI* getPeakLevel)(const SoundData* sound, PeakVolumes* peaks);
/** retrieves embedded event point information from a sound data object.
*
* @param[in] sound the sound data object to retrieve the event point information
* from. This may not be nullptr.
* @param[out] events receives the event point information. This may be nullptr if
* only the number of event points is required.
* @param[in] maxEvents the maximum number of event points that will fit in the @p events
* buffer. This must be 0 if @p events is nullptr.
* @returns the number of event points written to the buffer @p events if it was not nullptr.
* @returns if the buffer is not large enough to store all the event points, the maximum
* number that will fit is written to the buffer and the total number of event
* points is returned. This case can be detected by checking if the return value
* is larger than @p maxEvents.
* @returns the number of event points contained in the sound object if the buffer is
* nullptr.
*
* @remarks This retrieves event point information that was embedded in the sound file that
* was used to create a sound data object. The event points are optional in the
* data file and may not be present. If they are parsed from the file, they will
* also be saved out to any destination file that the same sound data object is
* written to, provided the destination format supports embedded event point
* information.
*/
size_t(CARB_ABI* getEventPoints)(const SoundData* sound, EventPoint* events, size_t maxEvents);
/** retrieves a single event point object by its identifier.
*
* @param[in] sound the sound data object to retrieve the named event point from. This
* may not be nullptr.
* @param[in] id the identifier of the event point to be retrieved.
* @returns the information for the event point with the requested identifier if found.
* The returned object is only valid until the event point list for the sound is
* modified. This should not be stored for extended periods since its contents
* may be invalidated at any time.
* @returns nullptr if no event point with the requested identifier is found.
*
* @note Access to this event point information is not thread safe. It is the caller's
* responsibility to ensure access to the event points on a sound data object is
* appropriately locked.
*/
const EventPoint*(CARB_ABI* getEventPointById)(const SoundData* sound, EventPointId id);
/** retrieves a single event point object by its index.
*
* @param[in] sound the sound data object to retrieve the event point from. This may not
* be nullptr.
* @param[in] index the zero based index of the event point to retrieve.
* @returns the information for the event point at the requested index. The returned object
* is only valid until the event point list for the sound is modified. This should
* not be stored for extended periods since its contents may be invalidated at any
* time.
* @returns nullptr if the requested index is out of range of the number of event points in
* the sound.
*
* @note Access to this event point information is not thread safe. It is the caller's
* responsibility to ensure access to the event points on a sound data object is
* appropriately locked.
*/
const EventPoint*(CARB_ABI* getEventPointByIndex)(const SoundData* sound, size_t index);
/** retrieves a single event point object by its playlist index.
*
* @param[in] sound The sound data object to retrieve the event
* point from. This may not be nullptr.
* @param[in] playIndex The playlist index of the event point to retrieve.
* Playlist indexes may range from 1 to SIZE_MAX.
* 0 is not a valid playlist index.
* This function is intended to be called in a loop
* with values of @p playIndex between 1 and the
* return value of getEventPointMaxPlayIndex().
* The range of valid event points will always be
* contiguous, so nullptr should not be returned
* within this range.
*
* @returns the information for the event point at the requested playlist
* index. The returned object is only valid until the event
* point list for the sound is modified. This should not be
* stored for extended periods since its contents may be
* invalidated at any time.
* @returns nullptr if @p playIndex is 0.
* @returns nullptr if no event point has a playlist index of @p playIndex.
*
* @note Access to this event point information is not thread safe. It is
* the caller's responsibility to ensure access to the event points
* on a sound data object is appropriately locked.
*/
const EventPoint*(CARB_ABI* getEventPointByPlayIndex)(const SoundData* sound, size_t playIndex);
/** Retrieve the maximum play index value for the sound.
*
* @param[in] sound The sound data object to retrieve the event
* point index from. This may not be nullptr.
*
* @returns This returns the max play index for this sound.
* This will be 0 if no event points have a play index.
* This is also the number of event points with playlist indexes,
* since the playlist index range is contiguous.
*/
size_t(CARB_ABI* getEventPointMaxPlayIndex)(const SoundData* sound);
/** modifies, adds, or removes event points in a sound data object.
*
* @param[inout] sound the sound data object to update the event point(s) in. This may
* not be nullptr.
* @param[in] eventPoints the event point(s) to be modified or added. The operation that is
* performed for each event point in the table depends on whether
* an event point with the same ID already exists in the sound data
* object. The event points in this table do not need to be sorted
* in any order. This may be @ref kEventPointTableClear to indicate
* that all event points should be removed.
* @param[in] count the total number of event points in the @p eventPoint table. This
* must be 0 if @p eventPoints is nullptr.
* @returns true if all of the event points in the table are updated successfully.
* @returns false if not all event points could be updated. This includes a failure to
* allocate memory or an event point with an invalid frame offset. Note that this
* failing doesn't mean that all the event points failed. This just means that at
* least failed to be set properly. The new set of event points may be retrieved
* and compared to the list set here to determine which one failed to be updated.
*
* @remarks This modifies, adds, or removes one or more event points in a sound data object.
* An event point will be modified if one with the same ID already exists. A new
* event point will be added if it has an ID that is not already present in the
* sound data object and its frame offset is valid. An event point will be removed
* if it has an ID that is present in the sound data object but the frame offset for
* it is set to @ref kEventPointInvalidFrame. Any other event points with invalid
* frame offsets (ie: out of the bounds of the stream) will be skipped and cause the
* function to fail.
*
* @note When adding a new event point or changing a string in an event point, the strings
* will always be copied internally instead of referencing the caller's original
* buffer. The caller can therefore clean up its string buffers immediately upon
* return. The user data object (if any) however must persist since it will be
* referenced instead of copied. If the user data object needs to be cleaned up,
* an appropriate destructor function for it must also be provided.
*
* @note If an event point is modified or removed such that the playlist
* indexes of the event points are no longer contiguous, this function
* will adjust the play indexes of all event points to prevent any
* gaps.
*
* @note The playIndex fields on @p eventPoints must be within the region
* of [0, @p count + getEventPoints(@p sound, nullptr, 0)].
* Trying to set playlist indexes outside this range is an error.
*/
bool(CARB_ABI* setEventPoints)(SoundData* sound, const EventPoint* eventPoints, size_t count);
/** retrieves the maximum simultaneously playing instance count for a sound.
*
* @param[in] sound the sound to retrieve the maximum instance count for. This may not
* be nullptr.
* @returns the maximum instance count for the sound if it is limited.
* @retval kInstancesUnlimited if the instance count is unlimited.
*
* @remarks This retrieves the current maximum instance count for a sound. This limit is
* used to prevent too many instances of a sound from being played simultaneously.
* With the limit set to unlimited, playing too many instances can result in serious
* performance penalties and serious clipping artifacts caused by too much
* constructive interference.
*/
uint32_t(CARB_ABI* getMaxInstances)(const SoundData* sound);
/** sets the maximum simultaneously playing instance count for a sound.
*
* @param[in] sound the sound to change the maximum instance count for. This may not be
* nullptr.
* @param[in] limit the new maximum instance limit for the sound. This may be
* @ref kInstancesUnlimited to remove the limit entirely.
* @returns no return value.
*
* @remarks This sets the new maximum playing instance count for a sound. This limit will
* prevent the sound from being played until another instance of it finishes playing
* or simply cause the play request to be ignored completely. This should be used
* to limit the use of frequently played sounds so that they do not cause too much
* of a processing burden in a scene or cause too much constructive interference
* that could lead to clipping artifacts. This is especially useful for short
* sounds that are played often (ie: gun shots, foot steps, etc). At some [small]
* number of instances, most users will not be able to tell if a new copy of the
* sound played or not.
*/
void(CARB_ABI* setMaxInstances)(SoundData* sound, uint32_t limit);
/** retrieves the user data pointer for a sound data object.
*
* @param[in] sound the sound data object to retrieve the user data pointer for. This may
* not be nullptr.
* @returns the stored user data pointer.
* @returns nullptr if no user data has been set on the requested sound.
*
* @remarks This retrieves the user data pointer for the requested sound data object. This
* is used to associate any arbitrary data with a sound data object. It is the
* caller's responsibility to ensure access to data is done in a thread safe
* manner.
*/
void*(CARB_ABI* getUserData)(const SoundData* sound);
/** sets the user data pointer for a sound data object.
*
* @param[in] sound the sound data object to set the user data pointer for. This may
* not be nullptr.
* @param[in] userData the new user data pointer to set. This may include an optional
* destructor if the user data object needs to be cleaned up. This
* may be nullptr to indicate that the user data pointer should be
* cleared out.
* @returns no return value.
*
* @remarks This sets the user data pointer for this sound data object. This is used to
* associate any arbitrary data with a sound data object. It is the caller's
* responsibility to ensure access to this table is done in a thread safe manner.
*
* @note The user data object must not hold a reference to the sound data object that it is
* attached to. Doing so will cause a cyclical reference and prevent the sound data
* object itself from being destroyed.
*
* @note The sound data object that this user data object is attached to must not be accessed
* from the destructor. If the sound data object is being destroyed when the user data
* object's destructor is being called, its contents will be undefined.
*/
void(CARB_ABI* setUserData)(SoundData* sound, const UserData* userData);
/************************************ Sound Data Codec ***************************************/
/** retrieves information about a supported codec.
*
* @param[in] encodedFormat the encoded format to retrieve the codec information for.
* This may not be @ref SampleFormat::eDefault or
* @ref SampleFormat::eRaw. This is the format that the codec
* either decodes from or encodes to.
* @param[in] pcmFormat the PCM format for the codec that the information would be
* retrieved for. This may be @ref SampleFormat::eDefault to
* retrieve the information for the codec for the requested
* encoded format that decodes to the preferred PCM format.
* This may not be @ref SampleFormat::eRaw.
* @returns the info block for the codec that can handle the requested operation if found.
* @returns nullptr if no matching codec for @p encodedFormat and @p pcmFormat could be
* found.
*
* @remarks This retrieves the information about a single codec. This can be used to check
* if an encoding or decoding operation to or from a requested format pair is
* possible and to retrieve some information suitable for display or UI use for the
* format.
*/
const CodecInfo*(CARB_ABI* getCodecFormatInfo)(SampleFormat encodedFormat, SampleFormat pcmFormat);
/** creates a new decoder or encoder state for a sound data object.
*
* @param[in] desc a descriptor of the decoding or encoding operation that will be
* performed. This may not be nullptr.
* @returns the new state object if the operation is valid and the state was successfully
* initialized. This must be destroyed with destroyCodecState() when it is
* no longer needed.
* @returns nullptr if the operation is not valid or the state could not be created or
* initialized.
*
* @remarks This creates a new decoder or encoder state instance for a sound object. This
* will encapsulate all the information needed to perform the operation on the
* stream as efficiently as possible. Note that the output format of the decoder
* will always be a PCM variant (ie: one of the SampleFormat::ePcm* formats).
* Similarly, the input of the encoder will always be a PCM variant. The input
* of the decoder and output of the encoder may be any format.
*
* @remarks The decoder will treat the sound data object as a stream and will decode it
* in chunks from start to end. The decoder's read cursor will initially be placed
* at the start of the stream. The current read cursor can be changed at any time
* by calling setCodecPosition(). Some compressed or block based formats may
* adjust the new requested position to the start of the nearest block.
*
* @remarks The state is separated from the sound data object so that multiple playing
* instances of each sound data object may be decoded and played simultaneously
* regardless of the sample format or decoder used. Similarly, when encoding
* this prevents any limitation on the number of targets a sound could be streamed
* or written to.
*
* @remarks The encoder state is used to manage the encoding of a single stream of data to
* a single target. An encoder will always be able to be created for an operation
* where the source and destination formats match. For formats that do not support
* encoding, this will fail. More info about each encoder format can be queried
* with getCodecFormatInfo().
*
* @remarks The stream being encoded is expected to have the same number of channels as the
* chosen output target.
*/
CodecState*(CARB_ABI* createCodecState)(const CodecStateDesc* desc);
/** destroys a codec state object.
*
* @param[in] state the codec state to destroy. This call will be ignored if this is
* nullptr.
* @returns no return value.
*
* @remarks This destroys a decoder or encoder state object that was previously returned
* from createCodecState(). For a decoder state, any partially decoded data stored
* in the state object will be lost. For an encoder state, all pending data will
* be written to the output target (padded with silence if needed). If the encoder
* was targeting an output stream, the stream will not be closed. If the encoder
* was targeting a sound data object, the stream size information will be updated.
* The buffer will not be trimmed in size if it is longer than the actual stream.
*/
void(CARB_ABI* destroyCodecState)(CodecState* decodeState);
/** decodes a number of frames of data into a PCM format.
*
* @param[in] decodeState the decoder state to use for the decoding operation. This may
* not be nullptr.
* @param[out] buffer receives the decoded PCM data. This buffer must be at least
* large enough to hold @p framesToDecode frames of data in the
* sound data object's stream. This may not be nullptr.
* @param[in] framesToDecode the requested number of frames to decode. This is taken as a
* suggestion. Up to this many frames will be decoded if it is
* available in the stream. If the stream ends before this
* number of frames is read, the remainder of the buffer will be
* left unmodified.
* @param[out] framesDecoded receives the number of frames that were actually decoded into
* the output buffer. This will never be larger than the
* @p framesToDecode value. This may not be nullptr.
* @returns @p buffer if the decode operation is successful and the decoded data was copied
* into the output buffer.
* @returns a non-nullptr value if the sound data object already contains PCM data in the
* requested decoded format.
* @returns nullptr if the decode operation failed for any reason.
* @returns nullptr if @p framesToDecode is 0.
*
* @remarks This decodes a requested number of frames of data into an output buffer. The
* data will always be decoded into a PCM format specified by the decoder when the
* sound data object is first created. If the sound data object already contains
* PCM data in the requested format, nothing will be written to the destination
* buffer, but a pointer into the data buffer itself will be returned instead.
* The returned pointer must always be used instead of assuming that the decoded
* data was written to the output buffer. Similarly, the @p framesToDecode count
* must be used instead of assuming that exactly the requested number of frames
* were successfully decoded.
*/
const void*(CARB_ABI* decodeData)(CodecState* decodeState, void* buffer, size_t framesToDecode, size_t* framesDecoded);
/** retrieves the amount of data available to decode in a sound data object.
*
* @param[in] decodeState the decode state to retrieve the amount of data that is available
* from the current read cursor position to the end of the stream.
* This may not be nullptr.
* @param[in] units the units to retrieve the available data count in. Note that if
* time units are requested (ie: milliseconds), the returned value
* will only be an estimate of the available data.
* @returns the amount of available data in the requested units.
* @returns 0 if no data is available or it could not be calculated.
*
* @remarks This retrieves the amount of data left to decode from the current read cursor
* to the end of the stream. Some formats may not be able to calculate the amount
* of available data.
*/
size_t(CARB_ABI* getDecodeAvailable)(const CodecState* decodeState, UnitType units);
/** retrieves the current cursor position for a codec state.
*
* @param[in] state the codec state to retrieve the current read cursor position for.
* This may not be nullptr.
* @param[in] units the units to retrieve the current read cursor position in. Note that
* if time units are requested (ie: milliseconds), the returned value
* will only be an estimate of the current position since time units are
* not accurate.
* @ref UnitType::eBytes is invalid if the codec being used specifies
* @ref fCodecCapsCompressed.
* @returns the current cursor position in the requested units. For a decoder state, this is
* the location in the sound's data where the next decoding operation will start
* from. For an encoder state, this is effectively the amount of data that has been
* successfully encoded and written to the target.
* @returns 0 if the cursor is at the start of the buffer or output target.
* @returns 0 if the decode position could not be calculated.
* @returns 0 if no data has been successfully written to an output target.
*
* @remarks This retrieves the current cursor position for a codec state. Some formats may
* not be able to calculate an accurate cursor position and may end up aligning it
* to the nearest block boundary instead.
*
* @note Even though the write cursor for an encoder state can be retrieved, setting it is
* not possible since that would cause a discontinuity in the stream and corrupt it.
* If the stream position needs to be rewound to the beginning, the encoder state
* should be recreated and the stream started again on a new output target.
*/
size_t(CARB_ABI* getCodecPosition)(const CodecState* decodeState, UnitType units);
/** sets the new decoder position.
*
* @param[in] decodeState the decoder state to set the position for. This may not be
* nullptr. This must be a decoder state.
* @param[in] newPosition the new offset into the sound data object's buffer to set the
* read cursor to. The units of this offset depend on the value
* in @p units.
* @param[in] units the units to interpret the @p newPosition offset in. Note that
* if time units are requested (ie: milliseconds), the new position
* may not be accurate in the buffer. The only offset that can be
* guaranteed accurate in time units is 0.
* @returns true if the new decoding read cursor position was successfully set.
* @returns false if the new position could not be set or an encoder state was used.
*
* @remarks This attempts to set the decoder's read cursor position to a new offset in the
* sound buffer. The new position may not be accurately set depending on the
* capabilities of the codec. The position may be aligned to the nearest block
* boundary for sound codecs and may fail for others.
*/
bool(CARB_ABI* setCodecPosition)(CodecState* decodeState, size_t newPosition, UnitType units);
/** calculates the maximum amount of data that a codec produce for a given input size.
*
* @param[in] state the codec state to estimate the buffer size for. This may not
* be nullptr. This may be either an encoder or decoder state.
* @param[in] inputSize for a decoder state, this is the number of bytes of input to
* estimate the output frame count for. For an encoder state, this
* is the number of frames of data that will be submitted to the
* encoder during the encoding operation.
* @returns an upper limit on the number of frames that can be decoded from the given input
* buffer size for decoder states.
* @returns an upper limit on the size of the output buffer in bytes that will be needed to
* hold the output for an encoder state.
* @returns 0 if the frame count could not be calculated or the requested size was 0.
*
* @remarks This calculates the maximum buffer size that would be needed to hold the output
* of the codec operation specified by the state object. This can be used to
* allocate or prepare a destination that is large enough to receive the operation's
* full result. Note that the units of both the inputs and outputs are different
* depending on the type of codec state that is used. This is necessary because the
* size of an encoded buffer in frames cannot always be calculated for a given byte
* size and vice versa. Some sample formats only allow for an upper limit to be
* calculated for such cases.
*
* @remarks For a decoder state, this calculates the maximum number of frames of PCM data
* that could be produced given a number of input bytes in the decoder state's
* output format. This is used to be able to allocate a decoding buffer that is
* large enough to hold the results for a given input request.
*
* @remarks For an encoder state, this calculates an estimate of the buffer size needed in
* order to store the encoder output for a number of input frames. For PCM formats,
* the returned size will be exact. For compressed formats, the returned size will
* be an upper limit on the size of the output stream. Note that this value is not
* always fully predictable ahead of time for all formats since some depend on
* the actual content of the stream to adapt their compression (ie: variable
* bit rate formats, frequency domain compression, etc).
*/
size_t(CARB_ABI* getCodecDataSizeEstimate)(const CodecState* decodeState, size_t inputBytes);
/** encodes a simple buffer of data into the output target for the operation.
*
* @param[in] encodeState the encoder state object that is managing the stream encoding
* operation. This may not be nullptr.
* @param[in] buffer the buffer of data to be encoded. This is expected to be in
* the input data format specified when the encoder state object
* was created. This may not be nullptr.
* @param[in] lengthInFrames the size of the input buffer in frames.
* @returns the number of bytes that were successfully encoded and written to the
* output target.
* @returns 0 if the buffer could not be encoded or the output target has become full or
* or fails to write (ie: the sound data object is full and is not allowed or able
* to expand, or writing to the output stream failed).
*
* @remarks This encodes a single buffer of data into an output target. The buffer is
* expected to be in the input sample format for the encoder. The buffer is also
* expected to be the logical continuation of any previous buffers in the stream.
*/
size_t(CARB_ABI* encodeData)(CodecState* encodeState, const void* buffer, size_t lengthInFrames);
/***************************** Sound Data Metadata Information ********************************/
/** Retrieve the names of the metadata tags in a SoundData.
*
* @param[in] sound The sound to retrieve the metadata tag names from.
* @param[in] index The index of the metadata tag in the sound object.
* To enumerate all tags in @p sound, one should call
* this with @p index == 0, then increment until nullptr
* is returned from this function. Note that adding or
* removing tags may alter the ordering of this table,
* but changing the value of a tag will not.
* @param[out] value If this is non-null and a metadata tag exists at
* index @p index, the contents of the metadata tag
* under the returned name is assigned to @p value.
* If this is non-null and no metadata tag exists at
* index @p index, @p value is assigned to nullptr.
* This string is valid until \p sound is destroyed or
* this entry in the metadata table is changed or
* removed.
*
* @returns This returns a null terminated string for the tag name, if a
* tag at index @p index exists.
* The returned string is valid until \p sound is destroyed or
* this entry in the metadata table is changed or removed.
* @returns This returns nullptr if no tag at @p index exists.
*
* @remarks This function allows the metadata of a @ref SoundData object
* to be enumerated. This function can be called with incrementing
* indices, starting from 0, to retrieve all of the metadata tag
* names. @p value can be used to retrieve the contents of each
* metadata tag, if the contents of each tag is needed.
*
* @note If setMetaData() is called, the order of the tags is not
* guaranteed to remain the same.
*/
const char*(CARB_ABI* getMetaDataTagName)(const SoundData* sound, size_t index, const char** value);
/** Retrieve a metadata tag from a SoundData.
*
* @param[in] sound The sound to retrieve the metadata tag from.
* @param[in] tagName The name of the metadata tag to retrieve.
* For example "artist" may retrieve the name of the
* artist who created the SoundData object's contents.
* This may not be nullptr.
*
* @returns This returns a null terminated string if a metadata tag under
* the name @p tagName exited in @p sound.
* The returned string is valid until \p sound is destroyed or
* this entry in the metadata table is changed or removed.
* @returns This returns nullptr if no tag under the name @p tagName was
* found in @p sound.
*/
const char*(CARB_ABI* getMetaData)(const SoundData* sound, const char* tagName);
/** Set a metadata tag on a SoundData.
*
* @param[in] sound The sound to retrieve the metadata tag from.
* @param[in] tagName The name of the metadata tag to set.
* For example, one may set a tag with @p tagName
* "artist" to specify the creator of the SoundData's
* contents. This can be set to @ref kMetaDataTagClearAllTags
* to remove all metadata tags on the sound object.
* @param[in] tagValue A null terminated string to set as the value for
* @p tagName. This can be set to nullptr to remove
* the tag under @p tagName from the object.
*
* @returns This returns true if the tags was successfully added or changed.
* @returns This returns false if @p tagValue is nullptr and no tag was
* found under the name @p tagName.
* @returns This returns false if an error occurred which prevented the
* tag from being set.
*
* @note @p tagName and @p tagValue are copied internally, so it is safe
* to immediately deallocate them after calling this.
* @note Metadata tag names are not case sensitive.
* @note It is not guaranteed that a given file type will be able to store
* arbitrary key-value pairs. RIFF files (.wav), for example, store
* metadata tags under 4 character codes, so only metadata tags
* that are known to this plugin, such as @ref kMetaDataTagArtist
* or tags that are 4 characters in length can be stored. Note this
* means that storing 4 character tags beginning with 'I' runs the
* risk of colliding with the known tag names (e.g. 'IART' will
* collide with @ref kMetaDataTagArtist when writing a RIFF file).
* @note @p tagName must not contain the character '=' when the output format
* encodes its metadata in the Vorbis Comment format
* (@ref SampleFormat::eVorbis and @ref SampleFormat::eFlac do this).
* '=' will be replaced with '_' when encoding these formats to avoid
* the metadata being encoded incorrectly.
* Additionally, the Vorbis Comment standard states that tag names
* must only contain characters from 0x20 to 0x7D (excluding '=')
* when encoding these formats.
*/
bool(CARB_ABI* setMetaData)(SoundData* sound, const char* tagName, const char* tagValue);
};
} // namespace audio
} // namespace carb
#ifndef DOXYGEN_SHOULD_SKIP_THIS
CARB_ASSET(carb::audio::SoundData, 0, 1);
#endif
| 125,893 | C | 54.192459 | 123 | 0.671626 |
omniverse-code/kit/include/carb/audio/IAudioGroup.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The audio group interface.
*/
#pragma once
#include "../Interface.h"
#include "AudioTypes.h"
#include "IAudioData.h"
#include "IAudioPlayback.h"
namespace carb
{
namespace audio
{
/************************************* Interface Objects *****************************************/
/** an object containing zero or more sound data objects. This group may be used to hold sounds
* that can be selected with differing probabilities when trying to play a high level sound clip
* or to only select a specific sound as needed. A group may contain any number of sounds.
*/
struct Group;
/******************************** typedefs, enums, & macros **************************************/
/** base type for the flags that control the behavior of the creation of a group. */
typedef uint32_t GroupFlags;
/** group creation flag to indicate that the random number generator for the group should
* be seeded with a fixed constant instead of another random value. This will cause the
* group's random number sequence to be repeatable on each run instead of random. Note that
* the constant seed may be platform or implementation dependent. This is useful for tests
* where a stable but non-consecutive sequence is needed. Note that each group has its own
* random number stream and choosing a random sound from one group will not affect the
* random number stream of any other group.
*/
constexpr GroupFlags fGroupFlagFixedSeed = 0x00000001;
/** an entry in a table of sounds being added to a sound group on creation or a single sound
* being added to a sound group with a certain region to be played. This can be used to
* provide sound atlas support in a sound group. Each (or some) of the sounds in the group
* can be the same, but each only plays a small region instead of the full sound.
*/
struct SoundEntry
{
/** the sound data object to add to the sound group. This must not be nullptr. A reference
* will be taken to this sound data object when it is added to the group.
*/
SoundData* sound;
/** the starting point for playback of the new sound. This value is interpreted in the units
* specified in @ref playUnits. This should be 0 to indicate the start of the sound data object
* as the starting point. This may not be larger than the valid data length (in the same
* units) of the sound data object itself.
*/
uint64_t playStart = 0;
/** the length of data to play in the sound data object. This extends from the @ref playStart
* point extending through this much data measured in the units @ref playUnits. This should
* be 0 to indicate that the remainder of the sound data object starting from @ref playStart
* should be played.
*/
uint64_t playLength = 0;
/** the units to interpret the @ref playStart and @ref playLength values in. Note that using
* some time units may not provide precise indexing into the sound data object. Also note
* that specifying this offset in bytes often does not make sense for compressed data.
*/
UnitType playUnits = UnitType::eFrames;
};
/** descriptor of a new group to be created. A group may be optionally named and optionally
* created with a set of sound data objects initially added to it.
*/
struct GroupDesc
{
/** flags to control the behavior of the group's creation or behavior. This is zero or
* more of the kGroupFlag* flags.
*/
GroupFlags flags = 0;
/** optional name to initially give to the group. This can be changed at any later point
* with setGroupName(). The name has no functional purpose except to identify the group
* to a user.
*/
const char* name = nullptr;
/** the total number of sound data objects in the @ref initialSounds table. */
size_t count = 0;
/** a table of sounds and regions that should be added to the new group immediately on
* creation. This may be nullptr to create an empty group, or this may be a table of
* @ref count sound data objects and regions to be added to the group. When each sound
* is added to the group, a reference to the object will be taken. The reference will
* be released when the sound is removed from the group or the group is destroyed. The
* sound data object will only be destroyed when removed from the group or the group is
* destroyed if the group owned the last reference to it.
*/
SoundEntry* initialSounds = nullptr;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** names of possible methods for choosing sounds to play from a sound group. These are used with
* the chooseSound() function. The probabilities of each sound in the group are only used when
* the @ref ChooseType::eRandom selection type is used.
*/
enum class ChooseType
{
/** choose a sound from the group at random using each sound's relative probabilities to
* perform the selection. By default, all sounds in a group will have a uniform probability
* distribution. The tendency to have one sound selected over others can be changed by
* changing that sound's probability with setProbability().
*/
eRandom,
/** chooses the next sound in the group. The next sound is either the first sound in the
* group if none has been selected yet, or the sound following the one that was most recently
* selected from the group. Even if another selection type was used in a previous call,
* this will still return the sound after the one that was most recently selected. This
* will wrap around to the first sound in the group if the last sound in the group was
* previously selected.
*/
eNext,
/** chooses the previous sound in the group. The previous sound is either the last sound in
* the group if none has been selected yet, or the sound preceding the one that was most
* recently selected from the group. Even if another selection type was used in a previous
* call, this will still return the sound before the one that was most recently selected.
* This will wrap around to the last sound in the group if the first sound in the group was
* previously selected.
*/
ePrevious,
/** always chooses the first sound in the group. */
eFirst,
/** always chooses the last sound in the group. */
eLast,
};
/** used in the @ref ProbabilityDesc object to indicate that all sounds within a group should
* be affected, not just a single index.
*/
constexpr size_t kGroupIndexAll = ~0ull;
/** used to identify an invalid index in the group or that a sound could not be added. */
constexpr size_t kGroupIndexInvalid = static_cast<size_t>(-2);
/** descriptor for specifying the relative probabilities for choosing one or more sounds in a
* sound group. This allows the probabilities for a sound within a group being chosen at play
* time. By default, a sound group assigns equal probabilities to all of its members.
*/
struct ProbabilityDesc
{
/** set to the index of the sound within the group to change the probability for. This may
* either be @ref kGroupIndexAll to change all probabilities within the group, or the
* zero based index of the single sound to change. When @ref kGroupIndexAll is used,
* the @ref probability value is ignored since a uniform distribution will always be set
* for each sound in the group. If this index is outside of the range of the number of
* sounds in the group, this call will silently fail.
*/
size_t index;
/** the new relative probability value to set for the specified sound in the group. This
* value will be ignored if the @ref index value is @ref kGroupIndexAll however. This
* value does not need to be within any given range. This simply specifies the relative
* frequency of the specified sound being selected compared to other sounds in the group.
* Setting this to 0 will cause the sound to never be selected from the group.
*/
float probability;
/** value reserved for future expansion. This should be set to nullptr. */
void* ext = nullptr;
};
/******************************** Audio Sound Group Management Interface *******************************/
/** Sound group management interface.
*
* See these pages for more detail:
* @rst
* :ref:`carbonite-audio-label`
* :ref:`carbonite-audio-group-label`
@endrst
*/
struct IAudioGroup
{
CARB_PLUGIN_INTERFACE("carb::audio::IAudioGroup", 1, 0)
/** creates a new sound group.
*
* @param[in] desc a descriptor of the new group to be created. This may be nullptr to
* create a new, empty, unnamed group.
* @returns the new group object if successfully created. This must be destroyed with a call
* to destroyGroup() when it is no longer needed.
* @returns nullptr if the new group could not be created.
*
* @remarks This creates a new sound group object. A sound group may contain zero or more
* sound data objects. The group may be initially populated by one or more sound
* data objects that are specified in the descriptor or it may be created empty.
*
* @note Access to the group object is not thread safe. It is the caller's responsibility
* to ensure that all accesses that may occur simultaneously are properly protected
* with a lock.
*/
Group*(CARB_ABI* createGroup)(const GroupDesc* desc);
/** destroys a sound group.
*
* @param[in] group the group to be destroyed. This must not be nullptr.
* @returns no return value.
*
* @remarks This destroys a sound group object. Each sound data object in the group at
* the time of destruction will have one reference removed from it. The group
* object will no longer be valid upon return.
*/
void(CARB_ABI* destroyGroup)(Group* group);
/** retrieves the number of sound data objects in a group.
*
* @param[in] group the group to retrieve the sound data object count for. This must
* not be nullptr.
* @returns the total number of sound data objects in the group.
* @returns 0 if the group is empty.
*/
size_t(CARB_ABI* getSize)(const Group* group);
/** retrieves the name of a group.
*
* @param[in] group the group to retrieve the name for. This must not be nullptr.
* @returns the name of the group.
* @returns nullptr if the group does not have a name.
*
* @remarks This retrieves the name of a group. The returned string will be valid until
* the group's name is changed with setGroupName() or the group is destroyed. It
* is highly recommended that the returned string be copied if it needs to persist.
*/
const char*(CARB_ABI* getName)(const Group* group);
/** sets the new name of a group.
*
* @param[in] group the group to set the name for. This must not be nullptr.
* @param[in] name the new name to set for the group. This may be nullptr to remove
* the group's name.
* @returns no return value.
*
* @remarks This sets the new name for a group. This will invalidate any names that were
* previously returned from getGroupName() regardless of whether the new name is
* different.
*/
void(CARB_ABI* setName)(Group* group, const char* name);
/** adds a new sound data object to a group.
*
* @param[in] group the group to add the new sound data object to. This must not be
* nullptr.
* @param[in] sound the sound data object to add to the group. This must not be nullptr.
* @returns the index of the new sound in the group if it is successfully added.
* @retval kGroupIndexInvalid if the new sound could not be added to the group.
*
* @remarks This adds a new sound data object to a group. The group will take a reference
* to the sound data object when it is successfully added. There will be no
* checking to verify that the sound data object is not already a member of the
* group. The initial relative probability for any new sound added to a group
* will be 1.0. This may be changed later with setProbability().
*
* @note This returned index is only returned for the convenience of immediately changing the
* sound's other attributes within the group (ie: the relative probability). This
* index should not be stored for extended periods since it may be invalidated by any
* calls to removeSound*(). If changes to a sound in the group need to be made at a
* later time, the index should either be known ahead of time (ie: from a UI that is
* tracking the group's state), or the group's members should be enumerated to first
* find the index of the desired sound.
*/
size_t(CARB_ABI* addSound)(Group* group, SoundData* sound);
/** adds a new sound data object with a play region to a group.
*
* @param[in] group the group to add the new sound data object to. This must not be
* nullptr.
* @param[in] sound the sound data object and play range data to add to the group.
* This must not be nullptr.
* @returns the index of the new sound in the group if it is successfully added.
* @retval kGroupIndexInvalid if the new sound could not be added to the group.
*
* @remarks This adds a new sound data object with a play range to a group. The group
* will take a reference to the sound data object when it is successfully added.
* There will be no checking to verify that the sound data object is not already
* a member of the group. The play region for the sound may indicate the full
* sound or only a small portion of it. The initial relative probability for any
* new sound added to a group will be 1.0. This may be changed later with
* setProbability().
*
* @note This returned index is only returned for the convenience of immediately changing the
* sound's other attributes within the group (ie: the relative probability). This
* index should not be stored for extended periods since it may be invalidated by any
* calls to removeSound*(). If changes to a sound in the group need to be made at a
* later time, the index should either be known ahead of time (ie: from a UI that is
* tracking the group's state), or the group's members should be enumerated to first
* find the index of the desired sound.
*/
size_t(CARB_ABI* addSoundWithRegion)(Group* group, const SoundEntry* sound);
/** removes a sound data object from a group.
*
* @param[in] group the group to remove the sound from. This must not be nullptr.
* @param[in] sound the sound to be removed from the group. This may be nullptr to
* remove all sound data objects from the group.
* @returns true if the sound is a member of the group and it is successfully removed.
* @returns false if the sound is not a member of the group.
*
* @remarks This removes a single sound data object from a group. Only the first instance
* of the requested sound will be removed from the group. If the sound is present
* in the group multiple times, additional explicit calls to remove the sound must
* be made to remove all of them.
*
* @note Once a sound is removed from a group, the ordering of sounds within the group may
* change. The relative probabilities of each remaining sound will still be
* unmodified.
*/
bool(CARB_ABI* removeSound)(Group* group, SoundData* sound);
/** removes a sound data object from a group by its index.
*
* @param[in] group the group to remove the sound from. This must not be nullptr.
* @param[in] index the zero based index of the sound to remove from the group. This
* may be @ref kGroupIndexAll to clear the entire group. This must not
* be @ref kGroupIndexInvalid.
* @returns true if the sound is a member of the group and it is successfully removed.
* @returns false if the given index is out of range of the size of the group.
*
* @note Once a sound is removed from a group, the ordering of sounds within the group may
* change. The relative probabilities of each remaining sound will still be
* unmodified.
*/
bool(CARB_ABI* removeSoundAtIndex)(Group* group, size_t index);
/** sets the current sound play region for an entry in the group.
*
* @param[in] group the group to modify the play region for a sound in. This must not
* be nullptr.
* @param[in] index the zero based index of the sound entry to update the region for.
* This must not be @ref kGroupIndexInvalid or @ref kGroupIndexAll.
* @param[in] region the specification of the new region to set on the sound. The
* @a sound member will be ignored and assumed that it either matches
* the sound data object already at the given index or is nullptr.
* All other members must be valid. This must not be nullptr.
* @returns true if the play region for the selected sound is successfully updated.
* @returns false if the index was out of range of the size of the group.
*
* @remarks This modifies the play region values for a single sound entry in the group.
* This will not replace the sound data object at the requested entry. Only
* the play region (start, length, and units) will be updated for the entry.
* It is the caller's responsibility to ensure the new play region values are
* within the range of the sound data object's current valid region.
*/
bool(CARB_ABI* setSoundRegion)(Group* group, size_t index, const SoundEntry* region);
/** retrieves the sound data object at a given index in a group.
*
* @param[in] group the group to retrieve a sound from. This must not be nullptr.
* @param[in] index the index of the sound data object to retrieve. This must not be
* @ref kGroupIndexInvalid or @ref kGroupIndexAll.
* @returns the sound data object at the requested index in the group. An extra reference
* to this object will not be taken and therefore does not have to be released.
* This object will be valid as long as it is still a member of the group.
* @returns nullptr if the given index was out of range of the size of the group.
*/
SoundData*(CARB_ABI* getSound)(const Group* group, size_t index);
/** retrieves the sound data object and region information at a given index in a group.
*
* @param[in] group the group to retrieve a sound from. This must not be nullptr.
* @param[in] index the index of the sound data object information to retrieve. This
* must not be @ref kGroupIndexInvalid or @ref kGroupIndexAll.
* @param[out] entry receives the information for the sound entry at the given index in
* the group. This not be nullptr.
* @returns true if the sound data object and its region information are successfully
* retrieved. The sound data object returned in @p entry will not have an extra
* reference taken to it and does not need to be released.
* @returns false if the given index was out of range of the group.
*/
bool(CARB_ABI* getSoundEntry)(const Group* group, size_t index, SoundEntry* entry);
/** sets the new relative probability for a sound being selected from a sound group.
*
* @param[in] group the sound group to change the relative probabilities for. This must
* not be nullptr.
* @param[in] desc the descriptor of the sound within the group to be changed and the
* new relative probability for it. This must not be nullptr.
* @returns no return value.
*
* @remarks This sets the new relative probability for choosing a sound within a sound group.
* Each sound in the group gets a relative probability of 1 assigned to it when it
* is first added to the group (ie: giving a uniform distribution initially). These
* relative probabilities can be changed later by setting a new value for individual
* sounds in the group. The actual probability of a particular sound being chosen
* from the group depends on the total sum of all relative probabilities within the
* group as a whole. For example, if a group of five sounds has been assigned the
* relative probabilities 1, 5, 7, 6, and 1, there is a 1/20 chance of the first or
* last sounds being chosen, a 1/4 chance of the second sound being chosen, a 7/20
* chance of the third sound being chosen, and a 6/20 chance of the fourth sound
* being chosen.
*/
void(CARB_ABI* setProbability)(Group* group, const ProbabilityDesc* desc);
/** retrieves a relative probability for a sound being selected from a sound group.
*
* @param[in] group the group to retrieve a relative probability for.
* @param[in] index the index of the sound in the group to retrieve the relative
* probability for. If this is out of range of the size of the
* group, the call will fail. This must not be @ref kGroupIndexAll
* or @ref kGroupIndexInvalid.
* @returns the relative probability of the requested sound within the group.
* @returns 0.0 if the requested index was out of range of the group's size.
*
* @remarks This retrieves the relative probability of the requested sound within a group
* being chosen by the chooseSound() function when using the ChooseType::eRandom
* selection type. Note that this will always the relative probability value that
* was either assigned when the sound was added to the group (ie: 1.0) or the one
* that was most recently set using a call to the setProbability() function.
*
* @note This is intended to be called in an editor situation to retrieve the relative
* probability values that are currently set on a group for display purposes.
*/
float(CARB_ABI* getProbability)(const Group* group, size_t index);
/** gets the relative probability total for all sounds in the group.
*
* @param[in] group the group to retrieve the relative probabilities total for. This
* must not be nullptr.
* @returns the sum total of the relative probabilities of each sound in the group.
* @returns 0.0 if the group is empty or all sounds have a zero relative probability.
* It is the caller's responsibility to check for this before using it as a
* divisor.
*
* @remarks This retrieves the total of all relative probabilities for all sounds in a
* group. This can be used to calculate the absolute probability of each sound
* in the group. This is done by retrieving each sound's relative probability
* with getProbability(), then dividing it by the value returned here.
*/
float(CARB_ABI* getProbabilityTotal)(const Group* group);
/** chooses a sound from a sound group.
*
* @param[in] group the group to select a sound from. This must not be nullptr.
* @param[in] type the specific algorithm to use when choosing the sound.
* @param[out] play receives the play descriptor for the chosen sound. On success, this
* will be filled in with enough information to play the chosen sound and
* region once as a non-spatial sound. It is the caller's responsibility
* to fill in any additional parameters (ie: voice callback function,
* additional voice parameters, spatial sound information, etc). This
* must not be nullptr. This object is assumed to be uninitialized and
* all members will be filled in.
* @returns true if a sound if chosen and the play descriptor @p play is valid.
* @returns false if the group is empty.
* @returns false if the maximum number of sound instances from this group are already
* playing. This may be tried again later and will succeed when the playing
* instance count drops below the limit.
*
* @remarks This chooses a sound from a group according to the given algorithm. When
* choosing a random sound, the sound is chosen using the relative probabilities
* of each of the sounds in the group. When choosing the next or previous sound,
* the sound in the group either after or before the last one that was most recently
* returned from chooseSound() will be returned. This will never fail unless the
* group is empty.
*/
bool(CARB_ABI* chooseSound)(Group* group, ChooseType type, PlaySoundDesc* play);
/** retrieves the maximum simultaneously playing instance count for sounds in a group.
*
* @param[in] group the group to retrieve the maximum instance count for. This must not
* be nullptr.
* @returns the maximum instance count for the group if it is limited.
* @retval kInstancesUnlimited if the instance count is unlimited.
*
* @remarks This retrieves the current maximum instance count for the sounds in a group.
* This limit is used to prevent too many instances of sounds in this group from
* being played simultaneously. With the limit set to unlimited, playing too many
* instances can result in serious performance penalties and serious clipping
* artifacts caused by too much constructive interference.
*/
uint32_t(CARB_ABI* getMaxInstances)(const Group* group);
/** sets the maximum simultaneously playing instance count for sounds in a group.
*
* @param[in] group the group to change the maximum instance count for. This must not be
* nullptr.
* @param[in] limit the new maximum instance limit for this sound group. This may be
* @ref kInstancesUnlimited to remove the limit entirely.
* @returns no return value.
*
* @remarks This sets the new maximum playing instance count for sounds in a group. This
* limit only affects the results of chooseSound(). When the limit is exceeded,
* calls to chooseSound() will start failing until some sound instances in the
* group finish playing. This instance limit is also separate from the maximum
* instance count for each sound in the group. Individual sound data objects
* also have their own maximum instance counts and will limit themselves when
* they are attempted to be played. Note that these two limits may however
* interact with each other if the group's instance limit is not hit but the
* instance limit for the particular chosen sound has been reached. It is the
* caller's responsibility to ensure the various instance limits are set in such
* a way this interaction is minimized.
*/
void(CARB_ABI* setMaxInstances)(Group* group, uint32_t limit);
/** retrieves the user data pointer for a sound group object.
*
* @param[in] group the sound group to retrieve the user data pointer for. This must
* not be nullptr.
* @returns the stored user data pointer.
* @returns nullptr if no user data has been set on the requested sound group.
*
* @remarks This retrieves the user data pointer for the requested sound group. This
* is used to associate any arbitrary data with a sound group object. It is
* the caller's responsibility to ensure access to data is done in a thread
* safe manner.
*/
void*(CARB_ABI* getUserData)(const Group* group);
/** sets the user data pointer for a sound group.
*
* @param[in] group the sound group to set the user data pointer for. This must not
* be nullptr.
* @param[in] userData the new user data pointer to set. This may include an optional
* destructor if the user data object needs to be cleaned up. This
* may be nullptr to indicate that the user data pointer should be
* cleared out entirely and no new object stored.
* @returns no return value.
*
* @remarks This sets the user data pointer for the given sound group. This is used to
* associate any arbitrary data with a sound group. It is the caller's
* responsibility to ensure access to this table is done in a thread safe manner.
*
* @note The sound group that this user data object is attached to must not be accessed
* from the destructor. If the sound group is being destroyed when the user data
* object's destructor is being called, its contents will be undefined.
*/
void(CARB_ABI* setUserData)(Group* group, const UserData* userData);
};
} // namespace audio
} // namespace carb
| 30,988 | C | 54.936823 | 105 | 0.654608 |
omniverse-code/kit/include/carb/audio/IAudioPlayback.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The audio playback interface.
*/
#pragma once
#ifndef DOXYGEN_SHOULD_SKIP_THIS
# define _USE_MATH_DEFINES
#endif
#include "../Interface.h"
#include "AudioTypes.h"
#include "IAudioData.h"
#include <math.h>
namespace carb
{
/** Audio playback and capture. */
namespace audio
{
/******************************** typedefs, enums, & macros **************************************/
/** specifies the relative direction to a single speaker. This is effectively a 3-space vector,
* but is explicitly described here to avoid any confusion between various common coordinate
* systems (ie: graphics systems take Z as pointing in the direction of the camera whereas
* audio systems take Z as pointing up).
*
* This direction vector is always taken to be relative to the [real biological] user's expected
* position within the [physical] speaker setup where the origin is the user's position and the
* coordinates in each direction range from -1.0 to 1.0. The provided vector does not need to
* be normalized.
*/
struct SpeakerDirection
{
/** the left-to-right coordinate. A value of 0.0 is in line with the user's gaze. A value
* of -1.0 puts the speaker fully on the user's left side. A value of 1.0 puts the speaker
* fully on the user's right side.
*/
float leftRight = 0.0f;
/** the front-to-back coordinate. A value of 0.0 is in line with the user's ears. A value
* of -1.0 puts the speaker fully behind the user. A value of 1.0 puts the speaker fully
* in front of the user.
*/
float frontBack = 0.0f;
/** the top-to-bottom coordinate. A value of 0.0 is on the plane formed from the user's ears
* and gaze. A value of -1.0 puts the speaker fully below the user. A value of 1.0 puts the
* speaker fully above the user.
*/
float topBottom = 0.0f;
};
/** flags to affect the behavior of a speaker direction descriptor when it is passed to
* setSpeakerDirections().
*/
typedef uint32_t SpeakerDirectionFlags;
/** a descriptor of the direction from the [real biological] user to all speakers in the user's
* sound setup. This is specified by the direction vector from the user's position (assumed
* to be at the origin) to each speaker. This speaker direction set given here must always
* match the speaker mode for the current device and the user's speaker layout, otherwise the
* output results will be undefined. These speaker directions are used to calculate all
* spatial sounds for a context so that they map as accurately as possible to the user's
* specific speaker setup.
*/
struct SpeakerDirectionDesc
{
/** flags to control the behavior of the speaker positioning operation. No flags are
* currently defined. This must be set to 0.
*/
SpeakerDirectionFlags flags = 0;
/** the audio engine's output speaker mode that was selected at either context creation time
* or device opening time. If the speaker mode was set to @ref kSpeakerModeDefault at
* context creation time, this will be set to the channel mask of the device that was
* selected. Each set bit in this mask must have a corresponding vector set in the
* @ref directions table. All other vectors will be ignored. This channel mask can be
* retrieved from getContextCaps() for the currently selected device. Note that selecting
* a new device with setOutput() will always reset the channel mask back to the defaults
* for the new device.
*/
SpeakerMode speakerMode;
/** the direction vectors from the user to each speaker. This does not need to be normalized.
* Note that when this information is retrieved with getContextCaps(), the speaker direction
* vectors may not match the original values that were set since they may have already been
* normalized internally. Each entry in this table is indexed by a @ref Speaker name. For
* speaker modes that have more than @ref Speaker::eCount speakers, the specific mapping and
* positioning for each speaker is left entirely up to the caller (ie: a set of custom
* speaker directions must be specified for each channel for all contexts). Each valid
* vector in this set, except for @ref Speaker::eLowFrequencyEffect, should have a non-zero
* direction. The LFE speaker is always assumed to be located at the origin.
*/
SpeakerDirection directions[kMaxChannels];
/** provides an extended information block. This is reserved for future expansion and should
* be set to nullptr.
*/
void* ext = nullptr;
};
/** names for the state of a stream used in the Streamer object. These are returned from the
* writeData() function to indicate to the audio processing engine whether the processing rate
* needs to temporarily speed up or slow down (or remain the same). For non-real-time contexts,
* this would effectively always be requesting more data after each call. For real-time
* contexts however, if the streamer is writing the audio data to a custom device, these state
* values are used to prevent the device from being starved or overrun.
*/
enum class StreamState
{
/** indicates that the streamer is content with the current data production rate and that
* this rate should be maintained.
*/
eNormal,
/** indicates that the streamer is dangerously close to starving for data. The audio
* processing engine should immediately run another cycle and produce more data.
*/
eCritical,
/** indicates that the streamer is getting close to starving for data and the audio processing
* engine should temporarily increase its data production rate.
*/
eMore,
/** indicates that the streamer is getting close to overrunning and the audio processing
* engine should temporarily decrease its data production rate.
*/
eLess,
/** indicates that the streamer is dangerously close to overrunning its buffer or device.
* The audio processing engine should decrease its data production rate.
*/
eMuchLess,
};
/** interface for a streamer object. This gives the audio context a way to write audio data
* to a generic interface instead of writing the data to an actual audio device. This
* interface is used by specifying a streamer object in the @ref OutputDesc struct when creating
* the context or when calling setOutput(). Note that this interface is intended to implement
* a stateful object with each instance. Two different instances of this interface should
* be able to operate independently from each other.
*
* There is no requirement for how the incoming audio data is processed. The streamer
* implementation may do whatever it sees fit with the incoming audio data. Between the
* any two paired openStream() and closeStream() calls, each writeStreamData() call will
* be delivering sequential buffers in a single stream of audio data. It is up to the
* streamer implementation to interpret that audio data and do something useful with it.
*
* Since the internal usage of this streamer object is inherently asynchronous, all streamer
* objects must be atomically reference counted. When a streamer is set on an audio context,
* a reference will be taken on it. This reference will be released when the streamer is
* either removed (ie: a new output target is set for the context), or the context is destroyed.
*
* @note This interface must be implemented by the host application. No default implementation
* exists. Some example streamer objects can be found in 'carb/audio/Streamers.h'.
*/
struct Streamer
{
/** acquires a single reference to a Streamer object.
*
* @param[in] self the object to take the reference of.
* @returns no return value.
*
* @remarks This acquires a new reference to a Streamer object. The reference must be
* released later with releaseReference() when it is no longer needed. Each
* call to acquireReference() on an object must be balanced with a call to
* releaseReference(). When a new streamer object is created, it should be
* given a reference count of 1.
*/
void(CARB_ABI* acquireReference)(Streamer* self);
/** releases a single reference to a Streamer object.
*
* @param[in] self the object to release a reference to. The object may be destroyed
* if it was the last reference that was released. The caller should
* consider the object invalid upon return unless it is known that
* additional local references still exist on it.
* @returns no return value.
*
* @remarks This releases a single reference to a Streamer object. If the reference count
* reaches zero, the object will be destroyed.
*/
void(CARB_ABI* releaseReference)(Streamer* self);
/** sets the suggested format for the stream output.
*
* @param[in] self the streamer object to open the stream for. This will not be
* nullptr.
* @param[inout] format on input, this contains the suggested data format for the stream.
* On output, this contains the accepted data format. The streamer
* may make some changes to the data format including the data type,
* sample rate, and channel count. It is strongly suggested that the
* input format be accepted since that will result in the least
* amount of processing overhead. The @a format, @a channels,
* @a frameRate, and @a bitsPerSample members must be valid upon
* return. If the streamer changes the data format, only PCM data
* formats are acceptable.
* @returns true if the data format is accepted by the streamer.
* @returns false if the streamer can neither handle the requested format nor
* can it change the requested format to something it likes.
*
* @remarks This sets the data format that the streamer will receive its data in. The
* streamer may change the data format to another valid PCM data format if needed.
* Note that if the streamer returns a data format that cannot be converted to by
* the processing engine, the initialization of the output will fail. Also note
* that if the streamer changes the data format, this will incur a small performance
* penalty to convert the data to the new format.
*
* @remarks This will be called when the audio context is first created. Once the format
* is accepted by both the audio context and the streamer, it will remain constant
* as long as the processing engine is still running on that context. When the
* engine is stopped (or the context is destroyed), a Streamer::close() call will
* be performed signaling the end of the stream. If the engine is restarted again,
* another open() call will be performed to signal the start of a new stream.
*/
bool(CARB_ABI* openStream)(Streamer* self, SoundFormat* format);
/** writes a buffer of data to the stream.
*
* @param[in] self the streamer object to write a buffer of data into. This will not
* be nullptr.
* @param[in] data the audio data being written to the streamer. This data will be in
* the format that was decided on in the call to open() during the
* context creation or the last call to setOutput(). This buffer will
* not persist upon return. The implementation must copy the contents
* of the buffer if it still needs to access the data later.
* @param[in] bytes the number of bytes of valid data in the buffer @p data.
* @retval StreamState::eNormal if the data was written successfully to the streamer
* and the data production rate should continue at the current rate.
* @retval StreamState::eMore if the data was written successfully to the streamer and
* the data production rate should be temporarily increased.
* @retval StreamState::eLess if the data was written successfully to the streamer and
* the data production rate should be temporarily reduced.
*
* @remarks This writes a buffer of data to the streamer. The streamer is responsible for
* doing something useful with the audio data (ie: write it to a file, write it to
* a memory buffer, stream it to another voice, etc). The caller of this function
* is not interested in whether the streamer successfully does something with the
* data - it is always assumed that the operation is successful.
*
* @note This must execute as quickly as possible. If this call takes too long to return
* and the output is going to a real audio device (through the streamer or some other
* means), an audible audio dropout could occur. If the audio context is executing
* in non-realtime mode (ie: baking audio data), this may take as long as it needs
* only at the expense of making the overall baking process take longer.
*/
StreamState(CARB_ABI* writeStreamData)(Streamer* self, const void* data, size_t bytes);
/** closes the stream.
*
* @param[in] self the streamer object to close the stream for. This will not be
* nullptr.
* @returns no return value.
*
* @remarks This signals that a stream has been finished. This occurs when the engine is
* stopped or the audio context is destroyed. No more calls to writeData() should
* be expected until the streamer is opened again.
*/
void(CARB_ABI* closeStream)(Streamer* self);
};
/** base type for the flags that control the output of an audio context. */
typedef uint32_t OutputFlags;
/** flag to indicate that the output should target a real audio device. When set, this indicates
* that the @ref OutputDesc::deviceIndex value will be valid and that it identifies the index of
* the audio device that should be opened.
*/
constexpr OutputFlags fOutputFlagDevice = 0x00000001;
/** flag to indicate that the output should target one or more generic streamer objects. These
* objects are provided by the host app in the @ref OutputDesc::streamer value. The stream will
* be opened when the audio processing engine is started and closed when the engine is stopped
* or the context is destroyed.
*/
constexpr OutputFlags fOutputFlagStreamer = 0x00000002;
/** flag to indicate that an empty streamer table is allowed. This can be used
* to provide a way to set a null output in cases where audio output is not
* wanted, but audio engine behavior, such as voice callbacks, are still desired.
* This is also useful for testing, since you won't be dependent on the test
* systems having a physical audio device.
*/
constexpr OutputFlags fOutputFlagAllowNoStreamers = 0x00000004;
/** mask of output flag bits that are available for public use. Clear bits in this mask are
* used internally and should not be referenced in other flags here. This is not valid as a
* output flag or flag set.
*/
constexpr OutputFlags fOutputFlagAvailableMask = 0xffffffff;
/** descriptor of the audio output target to use for an audio context. This may be specified
* both when creating an audio context and when calling setOutput(). An output may consist
* of a real audio device or one or more streamers.
*/
struct OutputDesc
{
/** flags to indicate which output target is to be used. Currently only a single output
* target may be specified. This must be one of the fOutputFlag* flags. Future versions
* may allow for multiple simultaneous outputs. If this is 0, the default output device
* will be selected. If more than one flag is specified, the audio device index will
* specify which device to use, and the streamer table will specify the set of streamers
* to attach to the output.
*/
OutputFlags flags = 0;
/** the index of the device to open. This must be greater than or equal to 0 and less than
* the most recent return value of getDeviceCount(). Set this to 0 to choose the system's
* default playback device. This defaults to 0. This value is always ignored if the
* @ref fOutputFlagDevice flag is not used.
*/
size_t deviceIndex = 0;
/** the output speaker mode to set. This is one of the SpeakerMode names or a combination of
* the fSpeakerFlag* speaker flags. This will determine the channel layout for the final
* output of the audio engine. This channel layout will be mapped to the selected device's
* speaker mode before sending the final output to the device. This may be set to
* @ref kSpeakerModeDefault to cause the engine's output to match the output of the device
* that is eventually opened. This defaults to @ref kSpeakerModeDefault.
*/
SpeakerMode speakerMode = kSpeakerModeDefault;
/** the frame rate in Hertz to run the processing engine at. This should be 0 for any output
* that targets a real hardware device (ie: the @ref fOutputFlagDevice is used in @ref flags
* or @ref flags is 0), It is possible to specify a non-zero value here when a hardware
* device is targeted, but that may lead to unexpected results depending on the value given.
* For example, this could be set to 1000Hz, but the device could run at 48000Hz. This
* would process the audio data properly, but it would sound awful since the processing
* data rate is so low. Conversely, if a frame rate of 200000Hz is specified but the device
* is running at 48000Hz, a lot of CPU processing time will be wasted.
*
* When an output is targeting only a streamer table, this should be set to the frame rate
* to process audio at. If this is 0, a frame rate of 48000Hz will be used. This value
* should generally be a common audio processing rate such as 44100Hz, 48000Hz, etc. Other
* frame rates can be used, but the results may be unexpected if a frame cannot be perfectly
* aligned to the cycle period.
*/
size_t frameRate = 0;
/** the number of streams objects in the @ref streamer table. This value is ignored if the
* @ref fOutputFlagStreamer flag is not used.
*/
size_t streamerCount = 0;
/** a table of one or more streamer objects to send the final output to. The number of
* streamers in the table is specified in @ref streamerCount. These streamer objects must
* be both implemented and instantiated by the caller. The streamers will be opened when
* the new output target is first setup. All streamers in the table will receive the same
* input data and format settings when opened. This value is ignored if the
* @ref fOutputFlagStreamer flag is not used. Each object in this table will be opened
* when the audio processing engine is started on the context. Each streamer will receive
* the same data in the same format. Each streamer will be closed when the audio processing
* engine is stopped or the context is destroyed.
*
* A reference to each streamer will be acquired when they are assigned as an output. These
* references will all be released when they are no longer active as outputs on the context
* (ie: replaced as outputs or the context is destroyed). No entries in this table may be
* nullptr.
*
* @note If more than one streamer is specified here, It is the caller's responsibility to
* ensure all of them will behave well together. This means that none of them should
* take a substantial amount of time to execute and that they should all return as
* consistent a stream state as possible from writeStreamData(). Furthermore, if
* multiple streamers are targeting real audio devices, their implementations should
* be able to potentially be able to handle large amounts of latency (ie: up to 100ms)
* since their individual stream state returns may conflict with each other and affect
* each other's timings. Ideally, no more than one streamer should target a real
* audio device to avoid this stream state build-up behavior.
*/
Streamer** streamer = nullptr;
/** extended information for this descriptor. This is reserved for future expansion and
* should be set to nullptr.
*/
void* ext = nullptr;
};
/** names for events that get passed to a context callback function. */
enum class ContextCallbackEvent
{
/** an audio device in the system has changed its state. This could mean that one or more
* devices were either added to or removed from the system. Since device change events
* are inherently asynchronous and multiple events can occur simultaneously, this callback
* does not provide any additional information except that the event itself occurred. It
* is the host app's responsibility to enumerate devices again and decide what to do with
* the event. This event will only occur for output audio devices in the system. With
* this event, the @a data parameter to the callback will be nullptr. This callback will
* always be performed during the context's update() call.
*/
eDeviceChange,
/** the audio engine is about to start a processing cycle. This will occur in the audio
* engine thread. This is given as an opportunity to update any voice parameters in a
* manner that can always be completed immediately and will be synchronized with other
* voice parameter changes made at the same time. Since this occurs in the engine thread,
* it is the caller's responsibility to ensure this callback returns as quickly as possible
* so that it does not interrupt the audio processing timing. If this callback takes too
* long to execute, it will cause audio drop-outs. The callback's @a data parameter will
* be set to nullptr for this event.
*/
eCycleStart,
/** the audio engine has just finished a processing cycle. This will occur in the audio
* engine thread. Voice operations performed in here will take effect immediately. Since
* this occurs in the engine thread, it is the caller's responsibility to ensure this
* callback returns as quickly as possible so that it does not interrupt the audio processing
* timing. If this callback takes too long to execute, it will cause audio drop-outs. The
* callback's @a data parameter will be set to nullptr for this event.
*/
eCycleEnd,
};
/** prototype for a context callback event function.
*
* @param[in] context the context object that triggered the callback.
* @param[in] event the event that occurred on the context.
* @param[in] data provides some additional information for the event that occurred. The
* value and content of this object depends on the event that occurred.
* @param[in] userData the user data value that was registered with the callback when the
* context object was created.
* @returns no return value.
*/
typedef void(CARB_ABI* ContextCallback)(Context* context, ContextCallbackEvent event, void* data, void* userData);
/** flags to control the behavior of context creation. No flags are currently defined. */
typedef uint32_t PlaybackContextFlags;
/** flag to indicate that the audio processing cycle start and end callback events should be
* performed. By default, these callbacks are not enabled unless a baking context is created.
* This flag will be ignored if no callback is provided for the context.
*/
constexpr PlaybackContextFlags fContextFlagCycleCallbacks = 0x00000001;
/** flag to indicate that the audio processing engine should be run in 'baking' mode. This will
* allow it to process audio data as fast as the system permits instead of waiting for a real
* audio device to catch up. When this flag is used, it is expected that the context will also
* use a streamer for its output. If a device index is selected as an output, context creation
* and setting a new output will still succeed, but the results will not sound correct due to
* the audio processing likely going much faster than the device can consume the data. Note
* that using this flag will also imply the use of @ref fContextFlagCycleCallbacks if a
* callback function is provided for the context.
*
* When this flag is used, the new context will be created with the engine in a stopped state.
* The engine must be explicitly started with startProcessing() once the audio graph has been
* setup and all initial voices created. This can be combined with @ref fContextFlagManualStop
* to indicate that the engine will be explicitly stopped instead of stopping automatically once
* the engine goes idle (ie: no more voices are active).
*/
constexpr PlaybackContextFlags fContextFlagBaking = 0x00000002;
/** flag to indicate that the audio processing engine will be manually stopped when a baking
* task is complete instead of stopping it when all of the input voices run out of data to
* process. This flag is ignored if the @ref fContextFlagBaking flag is not used. If this
* flag is not used, the intention for the context is to queue an initial set of sounds to
* play on voices before starting the processing engine with startProcessing(). Once all
* triggered voices are complete, the engine will stop automatically. When this flag is
* used, the intention is that the processing engine will stay running, producing silence,
* even if no voices are currently playing. The caller will be expected to make a call to
* stopProcessing() at some point when the engine no longer needs to be running.
*/
constexpr PlaybackContextFlags fContextFlagManualStop = 0x00000004;
/** flag to enable callbacks of type ContextCallbackEvent::eDeviceChange.
* If this flag is not passed, no callbacks of this type will be performed for
* this context.
*/
constexpr PlaybackContextFlags fContextFlagDeviceChangeCallbacks = 0x00000008;
/** descriptor used to indicate the options passed to the createContext() function. This
* determines the how the context will behave.
*/
struct PlaybackContextDesc
{
/** flags to indicate some additional behavior of the context. No flags are currently
* defined. This should be set to 0. In future versions, these flags may be used to
* determine how the @ref ext member is interpreted.
*/
PlaybackContextFlags flags = 0;
/** a callback function to be registered with the new context object. This callback will be
* performed any time the output device list changes. This notification will only indicate
* that a change has occurred, not which specific change occurred. It is the caller's
* responsibility to re-enumerate devices to determine if any further action is necessary
* for the updated device list. This may be nullptr if no device change notifications are
* needed.
*/
ContextCallback callback = nullptr;
/** an opaque context value to be passed to the callback whenever it is performed. This value
* will never be accessed by the context object and will only be passed unmodified to the
* callback function. This value is only used if a device change callback is provided.
*/
void* callbackContext = nullptr;
/** the maximum number of data buses to process simultaneously. This is equivalent to the
* maximum number of potentially audible sounds that could possibly affect the output on the
* speakers. If more voices than this are active, the quietest or furthest voice will be
* deactivated. The default value for this is 64. Set this to 0 to use the default for
* the platform.
*
* For a baking context, this should be set to a value that is large enough to guarantee
* that no voices will become virtualized. If a voice becomes virtualized in a baking
* context and it is set to simulate that voice's current position, the resulting position
* when it becomes a real voice again is unlikely to match the expected position. This is
* because there is no fixed time base to simulate the voice on. The voice will be simulated
* as if it were playing in real time.
*/
size_t maxBuses = 0;
/** descriptor for the output to choose for the new audio context. This must specify at
* least one output target.
*/
OutputDesc output = {};
/** A name to use for any audio device connection that requires one.
* This can be set to nullptr to use a generic default name, if necessary.
* This is useful in situations where a platform, such as Pulse Audio,
* will display a name to the user for each individual audio connection.
* This string is copied internally, so the memory can be discarded after
* calling createContext().
*/
const char* outputDisplayName = nullptr;
/** extended information for this descriptor. This is reserved for future expansion and
* should be set to nullptr.
*/
void* ext = nullptr;
};
/** the capabilities of the context object. Some of these values are set at the creation time
* of the context object. Others are updated when speaker positions are set or an output
* device is opened. This is only used to retrieve the capabilities of the context.
*/
struct ContextCaps
{
/** the maximum number of data buses to process simultaneously. This is equivalent to the
* maximum number of potentially audible sounds that could possibly affect the output on the
* speakers. If more voices than this are active, the quietest or furthest voice will be
* deactivated. This value is set at creation time of the context object. This can be
* changed after creation with setBusCount().
*/
size_t maxBuses;
/** the directions of each speaker. Only the speaker directions for the current speaker
* mode will be valid. All other speaker directions will be set to (0, 0, 0). This table
* can be indexed using the Speaker::* names. When a new context is first created or when
* a new device is selected with setOutput(), the speaker layout will always be set to
* the default for that device. The host app must set a new speaker direction layout
* if needed after selecting a new device.
*/
SpeakerDirectionDesc speakerDirections;
/** the info for the connection to the currently selected device.
* If no device is selected, the @a flags member will be set to @ref
* fDeviceFlagNotOpen. If a device is selected, its information will be
* set in here, including its preferred output format.
* Note that the format information may differ from the information
* returned by getDeviceDetails() as this is the format that the audio is
* being processed at before being sent to the device.
*/
DeviceCaps selectedDevice;
/** the output target that is currently in use for the context. This will provide access
* to any streamer objects in use or the index of the currently active output device. The
* device index stored in here will match the one in @ref selectedDevice if a real audio
* device is in use.
*/
OutputDesc output;
/** reserved for future expansion. This must be nullptr. */
void* ext;
};
/** flags that indicate how listener and voice entity objects should be treated and which
* values in the @ref EntityAttributes object are valid. This may be 0 or any combination
* of the fEntityFlag* flags.
* @{
*/
typedef uint32_t EntityAttributeFlags;
/** flags for listener and voice entity attributes. These indicate which entity attributes
* are valid or will be updated, and indicate what processing still needs to be done on them.
*/
/** the @ref EntityAttributes::position vector is valid. */
constexpr EntityAttributeFlags fEntityFlagPosition = 0x00000001;
/** the @ref EntityAttributes::velocity vector is valid. */
constexpr EntityAttributeFlags fEntityFlagVelocity = 0x00000002;
/** the @ref EntityAttributes::forward vector is valid. */
constexpr EntityAttributeFlags fEntityFlagForward = 0x00000004;
/** the @ref EntityAttributes::up vector is valid. */
constexpr EntityAttributeFlags fEntityFlagUp = 0x00000008;
/** the @ref EntityAttributes::cone values are valid. */
constexpr EntityAttributeFlags fEntityFlagCone = 0x00000010;
/** the @ref EmitterAttributes::rolloff values are valid. */
constexpr EntityAttributeFlags fEntityFlagRolloff = 0x00000020;
/** all vectors in the entity information block are valid. */
constexpr EntityAttributeFlags fEntityFlagAll = fEntityFlagPosition | fEntityFlagVelocity | fEntityFlagForward |
fEntityFlagUp | fEntityFlagCone | fEntityFlagRolloff;
/** when set, this flag indicates that setListenerAttributes() or setEmitterAttributes()
* should make the @a forward and @a up vectors perpendicular and normalized before setting
* them as active. This flag should only be used when it is known that the vectors are not
* already perpendicular.
*/
constexpr EntityAttributeFlags fEntityFlagMakePerp = 0x80000000;
/** when set, this flag indicates that setListenerAttributes() or setEmitterAttributes()
* should normalize the @a forward and @a up vectors before setting them as active. This
* flag should only be used when it is known that the vectors are not already normalized.
*/
constexpr EntityAttributeFlags fEntityFlagNormalize = 0x40000000;
/** @} */
/** distance based DSP value rolloff curve types. These represent the formula that will be
* used to calculate the spatial DSP values given the distance between an emitter and the
* listener. This represents the default attenuation calculation that will be performed
* for all curves that are not overridden with custom curves. The default rolloff model
* will follow the inverse square law (ie: @ref RolloffType::eInverse).
*/
enum class RolloffType
{
/** defines an inverse attenuation curve where a distance at the 'near' distance is full
* volume and at the 'far' distance gives silence. This is calculated with a formula
* proportional to (1 / distance).
*/
eInverse,
/** defines a linear attenuation curve where a distance at the 'near' distance is full
* volume and at the 'far' distance gives silence. This is calculated with
* (max - distance) / (max - min).
*/
eLinear,
/** defines a linear square attenuation curve where a distance at the 'near' distance is
* full volume and at the 'far' distance gives silence. This is calculated with
* ((max - distance) / (max - min)) ^ 2.
*/
eLinearSquare,
};
/** defines the point-wise curve that is used for specifying custom rolloff curves.
* This curve is defined as a set of points that are treated as a piece-wise curve where each
* point's X value represents the listener's normalized distance from the emitter, and the Y
* value represents the DSP value at that distance. A linear interpolation is done between
* points on the curve. Any distances beyond the X value on the last point on the curve
* simply use the DSP value for the last point. Similarly, and distances closer than the
* first point simply use the first point's DSP value. This curve should always be normalized
* such that the first point is at a distance of 0.0 (maps to the emitter's 'near' distance)
* and the last point is at a distance of 1.0 (maps to the emitter's 'far' distance). The
* interpretation of the specific DSP values at each point depends on the particular usage
* of the curve. If used, this must contain at least one point.
*/
struct RolloffCurve
{
/** the total number of points on the curve. This is the total number of entries in the
* @ref points table. This must be greater than zero.
*/
size_t pointCount;
/** the table of data points in the curve. Each point's X value represents a normalized
* distance from the emitter to the listener. Each point's Y value is the corresponding
* DSP value to be interpolated at that distance. The points in this table must be sorted
* in increasing order of distance. No two points on the curve may have the same distance
* value. Failure to meet these requirements will result in undefined behavior.
*/
Float2* points;
};
/** descriptor of the rolloff mode, range, and curves to use for an emitter. */
struct RolloffDesc
{
/** the default type of rolloff calculation to use for all DSP values that are not overridden
* by a custom curve. This defaults to @ref RolloffType::eLinear.
*/
RolloffType type;
/** the near distance range for the sound. This is specified in arbitrary world units.
* When a custom curve is used, this near distance will map to a distance of 0.0 on the
* curve. This must be less than the @ref farDistance distance. The near distance is the
* closest distance that the emitter's attributes start to rolloff at. At distances
* closer than this value, the calculated DSP values will always be the same as if they
* were at the near distance. This defaults to 0.0.
*/
float nearDistance;
/** the far distance range for the sound. This is specified in arbitrary world units. When
* a custom curve is used, this far distance will map to a distance of 1.0 on the curve.
* This must be greater than the @ref nearDistance distance. The far distance is the
* furthest distance that the emitters attributes will rolloff at. At distances further
* than this value, the calculated DSP values will always be the same as if they were at
* the far distance (usually silence). Emitters further than this distance will often
* become inactive in the scene since they cannot be heard any more. This defaults to
* 10000.0.
*/
float farDistance;
/** the custom curve used to calculate volume attenuation over distance. This must be a
* normalized curve such that a distance of 0.0 maps to the @ref nearDistance distance
* and a distance of 1.0 maps to the @ref farDistance distance. When specified, this
* overrides the rolloff calculation specified by @ref type when calculating volume
* attenuation. This defaults to nullptr.
*/
RolloffCurve* volume;
/** the custom curve used to calculate low frequency effect volume over distance. This
* must be a normalized curve such that a distance of 0.0 maps to the @ref nearDistance
* distance and a distance of 1.0 maps to the @ref farDistance distance. When specified,
* this overrides the rolloff calculation specified by @ref type when calculating the low
* frequency effect volume. This defaults to nullptr.
*/
RolloffCurve* lowFrequency;
/** the custom curve used to calculate low pass filter parameter on the direct path over
* distance. This must be a normalized curve such that a distance of 0.0 maps to the
* @ref nearDistance distance and a distance of 1.0 maps to the @ref farDistance distance.
* When specified, this overrides the rolloff calculation specified by @ref type when
* calculating the low pass filter parameter. This defaults to nullptr.
*/
RolloffCurve* lowPassDirect;
/** the custom curve used to calculate low pass filter parameter on the reverb path over
* distance. This must be a normalized curve such that a distance of 0.0 maps to the
* @ref nearDistance distance and a distance of 1.0 maps to the @ref farDistance distance.
* When specified, this overrides the rolloff calculation specified by @ref type when
* calculating the low pass filter parameter. This defaults to nullptr.
*/
RolloffCurve* lowPassReverb;
/** the custom curve used to calculate reverb mix level over distance. This must be a
* normalized curve such that a distance of 0.0 maps to the @ref nearDistance distance and
* a distance of 1.0 maps to the @ref farDistance distance. When specified, this overrides
* the rolloff calculation specified by @ref type when calculating the low pass filter
* parameter. This defaults to nullptr.
*/
RolloffCurve* reverb;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** specifies a pair of values that define a DSP value range to be interpolated between based
* on an emitter-listener angle that is between a cone's inner and outer angles. For angles
* that are smaller than the cone's inner angle, the 'inner' DSP value will always be used.
* Similarly, for angles that are larger than the cone's outer angle, the 'outer' DSP value
* will always be used. Interpolation will only occur when the emitter-listener angle is
* between the cone's inner and outer angles. No specific meaning or value range is attached
* to the 'inner' and 'outer' DSP values. These come from the specific purpose that this
* object is used for.
*/
struct DspValuePair
{
/** the DSP value to be used for angles less than the cone's inner angle and as one of
* the interpolation endpoints for angles between the cone's inner and outer angles.
*/
float inner;
/** the DSP value to be used for angles greater than the cone's outer angle and as one of
* the interpolation endpoints for angles between the cone's inner and outer angles.
*/
float outer;
};
/** the angle to specify for @ref EntityCone::insideAngle and @ref EntityCone::outsideAngle
* in order to mark the cone as disabled. This will treat the emitter or listener as
* omni-directional.
*/
constexpr float kConeAngleOmnidirectional = (float)(2.0 * M_PI);
/** defines a sound cone relative to an entity's front vector. It is defined by two angles -
* the inner and outer angles. When the angle between an emitter and the listener (relative
* to the entity's front vector) is smaller than the inner angle, the resulting DSP value
* will be the 'inner' value. When the emitter-listener angle is larger than the outer
* angle, the resulting DSP value will be the 'outer' value. For emitter-listener angles
* that are between the inner and outer angles, the DSP value will be interpolated between
* the inner and outer angles. If a cone is valid for an entity, the @ref fEntityFlagCone
* flag should be set in @ref EntityAttributes::flags.
*
* Note that a cone's effect on the spatial volume of a sound is purely related to the angle
* between the emitter and listener. Any distance attenuation is handled separately.
*/
struct EntityCone
{
/** the inside angle of the entity's sound cone in radians. This describes the angle around
* the entity's forward vector within which the entity's DSP values will always use their
* 'inner' values. This angle will extend half way in all directions around the forward
* vector. For example, a 30 degree (as converted to radians to store here) inside angle
* will extend 15 degrees in all directions around the forward vector. Set this to
* @ref kConeAngleOmnidirectional to define an omni-directional entity. This must be
* greater than or equal to 0 and less than or equal to @ref outsideAngle.
*/
float insideAngle;
/** the outside angle of the entity's sound cone in radians. This describes the angle
* around the entity's forward vector up to which the volume will be interpolated. When
* the emitter-listener angle is larger than this angle, the 'outer' DSP values will always
* be used. This angle will extend half way in all directions around the forward vector.
* For example, a 30 degree (as converted to radians to store here) inside angle will extend
* 15 degrees in all directions around the forward vector. Set this to
* @ref kConeAngleOmnidirectional to define an omni-directional entity. This must be greater
* than or equal to @ref insideAngle.
*/
float outsideAngle;
/** the volumes to use for emitter-listener lines that are inside and outside the entity's
* cone angles. These will be used as the endpoint values to interpolate to for angles
* between the inner and outer angles, and for the values for all angles outside the cone's
* inner and outer angles. These should be in the range 0.0 (silence) to 1.0 (full volume).
*/
DspValuePair volume;
/** the low pass filter parameter values to use for emitter-listener lines that are inside
* and outside the entity's cone angles. These will be used as the endpoint values to
* interpolate to for angles between the inner and outer angles, and for the values for all
* angles outside the cone's inner and outer angles. There is no specific range for these
* values other than what is commonly accepted for low pass filter parameters.
* This multiplies by member `direct` of @ref VoiceParams::occlusion, if
* that is set to anything other than 1.0.
* Setting this to a value outside of [0.0, 1.0] will result in an undefined low pass
* filter value being used.
*/
DspValuePair lowPassFilter;
/** the reverb mix level values to use for emitter-listener lines that are inside and outside
* the entity's cone angles. These will be used as the endpoint values to interpolate to for
* angles between the inner and outer angles, and for the values for all angles outside the
* cone's inner and outer angles. This should be in the range 0.0 (no reverb) to 1.0 (full
* reverb).
*/
DspValuePair reverb;
/** reserved for future expansion. This must be nullptr. */
void* ext = nullptr;
};
/** base spatial attributes of the entity. This includes its position, orientation, and velocity
* and an optional cone.
*/
struct EntityAttributes
{
/** a set of flags that indicate which of members of this struct are valid. This may be
* fEntityFlagAll to indicate that all members contain valid data.
*/
EntityAttributeFlags flags;
/** the current position of the listener in world units. This should only be expressed in
* meters if the world units scale is set to 1.0 for this context. This value is ignored
* if the fEntityFlagPosition flag is not set in @ref flags.
*/
Float3 position;
/** the current velocity of the listener in world units per second. This should only be
* expressed in meters per second if the world units scale is set to 1.0 with
* for the context. The magnitude of this vector will be taken as the listener's
* current speed and the vector's direction will indicate the listener's current direction.
* This vector should not be normalized unless the listener's speed is actually 1.0 units
* per second. This may be a zero vector if the listener is not moving. This value is
* ignored if the fEntityFlagVelocity flag is not set in @ref flags. This vector will
* not be modified in any way before use.
*/
Float3 velocity;
/** a vector indicating the direction the listener is currently facing. This does not need
* to be normalized, but should be for simplicity. If the fEntityFlagNormalize flag is
* set in @ref flags, this vector will be normalized internally before being used. This
* vector should be perpendicular to the @ref up vector unless the fEntityFlagMakePerp
* flag is set in @ref flags. This must not be a zero vector unless the fEntityFlagForward
* flag is not set in @ref flags.
*/
Float3 forward;
/** a vector indicating the upward direction for the listener. This does not need to be
* normalized, but should be for simplicity. If the fEntityFlagNormalize flag is set in
* @ref flags, this vector will be normalized internally before being used. This vector
* should be perpendicular to the @ref forward vector unless the fEntityFlagMakePerp flag
* is set in @ref flags. This must not be a zero vector unless the fEntityFlagUp flag is
* not set in @ref flags.
*/
Float3 up;
/** defines an optional sound cone for an entity. The cone is a segment of a sphere around
* the entity's position opening up toward its front vector. The cone is defined by an
* inner and outer angle, and several DSP values to be interpolated between for those two
* endpoint angles. This cone is valid if the @ref fEntityFlagCone flag is set in
* @ref flags.
*/
EntityCone cone;
};
/** spatial attributes for a listener entity. */
struct ListenerAttributes : EntityAttributes
{
/** provides an extended information block. This is reserved for future expansion and should
* be set to nullptr. The values in @ref flags may be used to indicate how this value should
* be interpreted.
*/
void* ext = nullptr;
};
/** spatial attributes of an emitter entity. */
struct EmitterAttributes : EntityAttributes
{
/** a descriptor of the rolloff parameters for this emitter. This is valid and accessed only
* if the @ref fEntityFlagRolloff flag is set in @ref EntityAttributes::flags. The curves
* (if any) in this descriptor must remain valid for the entire time a voice is playing the
* sound represented by this emitter.
*/
RolloffDesc rolloff;
/** provides an extended information block. This is reserved for future expansion and must
* be set to nullptr. The values in @ref flags may be used to indicate how this value should
* be interpreted.
*/
void* ext = nullptr;
};
/** voice callback reason names. These identify what kind of callback is being performed.
* This can either be an event point or the end of the sound.
*/
enum class VoiceCallbackType
{
/** the sound reached its end and has implicitly stopped. This will not be hit for looping
* sounds until the last loop iteration completes and the sound stops playing. In the
* voice callback for this type, the @a data parameter will be set to nullptr.
*/
eSoundEnded,
/** the engine has reached one of the playing sound's event points. These are arbitrary
* points within the sound that need notification so that other objects in the simulation
* can react to the sound. These event points are often chosen by the sound designers.
* In the voice callback for this type, the @a data parameter will be set to the event
* point object that was triggered.
*/
eEventPoint,
/** the engine has reached a loop point. This callback occurs when the new loop iteration
* starts.
* This will only be triggered on voices that have the @ref fPlayFlagRealtimeCallbacks flag
* set.
* On streaming sounds, these callbacks are triggered when the buffer containing a loop end
* has finished playing, rather than when the loop end is decoded. This is not guaranteed to
* be called exactly on the ending frame of the loop.
* If an excessively short loop (e.g. 2ms) is put on a streaming sound,
* some loop callbacks may be skipped.
*/
eLoopPoint,
};
/** prototype for a voice event callback function.
*
* @param[in] voice the voice object that produced the event callback.
* @param[in] callbackType the type of callback being performed. This can either be that the
* sound ended or that one of its event points was hit.
* @param[in] sound the sound data object that the voice is playing or just finished playing.
* @param[in] data some extra data specific to the callback type that occurred. This will
* be nullptr for @ref VoiceCallbackType::eSoundEnded callbacks. This will
* be the EventPoint information for the event point that was hit for
* @ref VoiceCallbackType::eEventPoint callbacks.
* @param[in] context the context value that was specified at the time the callback function was
* registered with the voice.
* @return @ref AudioResult::eOk. Returning any other value may result in the mixer being halted
* or the playback of the current sound stopping.
*
* @remarks This callback allows a system to receive notifications of events occurring on a sound
* object that is playing on a voice. This callback is performed when either the
* sound finishes playing or when one of its event points is hit. Since this callback
* may be performed in the context of the mixer thread, it should take as little time as
* possible to return. Instead of performing heavy calculations, it should simply set a
* flag that those calculations need to be handled on another worker thread at a later
* time.
*/
typedef AudioResult(CARB_ABI* VoiceCallback)(
Voice* voice, VoiceCallbackType callbackType, SoundData* sound, void* data, void* context);
/** base type for the various playback mode flags. The default state for all these flags
* is false (ie: all flags cleared). These flags are set in @ref VoiceParams::playbackMode
* and are only valid when @ref fVoiceParamPlaybackMode, @ref fVoiceParamPause, or
* @ref fVoiceParamMute are used for the parameter block flags.
*
* @{
*/
typedef uint32_t PlaybackModeFlags;
/** flag to indicate whether a sound should be played back as a spatial or non-spatial
* sound. When false, the sound is played in non-spatial mode. This means that only
* the current explicit volume level and pan values will affect how the sound is mapped
* to the output channels. If true, all spatial positioning calculations will be
* performed for the sound and its current emitter attributes (ie: position, orientation,
* velocity) will affect how it is mapped to the output channels.
*/
constexpr PlaybackModeFlags fPlaybackModeSpatial = 0x00000001;
/** flag to indicate how the spatial attributes of an emitter are to be interpreted.
* When true, the emitter's current position, orientation, and velocity will be added
* to those of the listener object to get the world coordinates for each value. The
* spatial calculations will be performed using these calculated world values instead.
* This is useful for orienting and positioning sounds that are 'attached' to the
* listener's world representation (ie: camera, player character, weapon, etc), but
* still move somewhat relative to the listener. When not set, the emitter's spatial
* attributes will be assumed to be in world coordinates already and just used directly.
*/
constexpr PlaybackModeFlags fPlaybackModeListenerRelative = 0x00000002;
/** flag to indicate whether triggering this sound should be delayed to simulate its
* travel time to reach the listener. The sound's trigger time is considered the time
* of the event that produces the sound at the emitter's current location. For distances
* to the listener that are less than an imperceptible threshold (around 20ms difference
* between the travel times of light and sound), this value will be ignored and the sound
* will just be played immediately. The actual distance for this threshold depends on
* the current speed of sound versus the speed of light. For all simulation purposes, the
* speed of light is considered to be infinite (at ~299700km/s in air, there is no
* terrestrial environment that could contain a larger space than light can travel (or
* that scene be rendered) in even a fraction of a second).
*
* Note that if the distance delay is being used to play a sound on a voice, that voice's
* current frequency ratio will not affect how long it takes for the delay period to expire.
* If the frequency ratio is being used to provide a time dilation effect on the sound rather
* than a pitch change or playback speed change, the initial distance delay period will seem
* to be different than expected because of this. If a time dilation effect is needed, that
* should be done by changing the context's spatial sound frequency ratio instead.
*/
constexpr PlaybackModeFlags fPlaybackModeDistanceDelay = 0x00000004;
/** flag to indicate whether interaural time delay calculations should occur on this
* voice. This will cause the left or right channel(s) of the voice to be delayed
* by a few frames to simulate the difference in time that it takes a sound to reach
* one ear versus the other. These calculations will be performed using the current
* speed of sound for the context and a generalized acoustic model of the human head.
* This will be ignored for non-spatial sounds and sounds with fewer than two channels.
* This needs to be set when the voice is created for it to take effect.
* The performance cost of this effect is minimal when the interaural time
* delay is set to 0.
* For now, interaural time delay will only take effect when the @ref SoundData
* being played is 1 channel and the output device was opened with 2 channels.
* This effect adds a small level of distortion when an emitter's angle is changing
* relative to the listener; this is imperceptible in most audio, but it can be
* audible with pure sine waves.
*/
constexpr PlaybackModeFlags fPlaybackModeInterauralDelay = 0x00000008;
/** flag to indicate whether Doppler calculations should be performed on this sound.
* This is ignored for non-spatial sounds. When true, the Doppler calculations will
* be automatically performed for this voice if it is moving relative to the listener.
* If neither the emitter nor the listener are moving, the Doppler shift will not
* have any affect on the sound. When false, the Doppler calculations will be skipped
* regardless of the relative velocities of this emitter and the listener.
*/
constexpr PlaybackModeFlags fPlaybackModeUseDoppler = 0x00000010;
/** flag to indicate whether this sound is eligible to be sent to a reverb effect. This
* is ignored for non-spatial sounds. When true, the sound playing on this voice will
* be sent to a reverb effect if one is present in the current sound environment. When
* false, the sound playing on this voice will bypass any reverb effects in the current
* sound environment.
*/
constexpr PlaybackModeFlags fPlaybackModeUseReverb = 0x00000020;
/** flag to indicate whether filter parameters should be automatically calculated and
* applied for the sound playing on this voice. The filter parameters can be changed
* by the spatial occlusion factor and interaural time delay calculations.
*/
constexpr PlaybackModeFlags fPlaybackModeUseFilters = 0x00000040;
/** flag to indicate the current mute state for a voice. This is valid only when the
* @ref fVoiceParamMute flag is used. When this flag is set, the voice's output will be
* muted. When this flag is not set, the voice's volume will be restored to its previous
* level. This is useful for temporarily silencing a voice without having to clobber its
* current volume level or affect its emitter attributes.
*/
constexpr PlaybackModeFlags fPlaybackModeMuted = 0x00000080;
/** flag to indicate the current pause state of a sound. This is valid only when the
* @ref fVoiceParamPause flag is used. When this flag is set, the voice's playback is
* paused. When this flag is not set, the voice's playback will resume. Note that if all
* buses are occupied, pausing a voice may allow another voice to steal its bus. When a
* voice is resumed, it will continue playback from the same location it was paused at.
*
* When pausing or unpausing a sound, a small volume ramp will be used internally to avoid
* a popping artifact in the stream. This will not affect the voice's current volume level.
*
* Note that if the voice is on the simulation path and it is paused and unpaused rapidly,
* the simulated position may not be updated properly unless the context's update() function
* is also called at least at the same rate that the voice is paused and unpaused at. This
* can lead to a voice's simulated position not being accurately tracked if care is not also
* taken with the frequency of update() calls.
*/
constexpr PlaybackModeFlags fPlaybackModePaused = 0x00000100;
/** Flag to indicate that the sound should fade in when being initially played.
* This should be used when it's not certain that the sound is starting on a
* zero-crossing, so playing it without a fade-in will cause a pop.
* The fade-in takes 10-20ms, so this isn't suitable for situations where a
* gradual fade-in is desired; that should be done manually using callbacks.
* This flag has no effect after the sound has already started playing;
* actions like unpausing and unmuting will always fade in to avoid a pop.
*/
constexpr PlaybackModeFlags fPlaybackModeFadeIn = 0x00000200;
/** Flags to indicate the behavior that is used when a simulated voice gets assigned
* to a bus.
*
* @ref fPlaybackModeSimulatePosition will cause the voice's playback position to
* be simulated during update() calls while the voice is not assigned to a bus.
* When the voice is assigned to a bus, it will begin at that simulated
* position. For example if a sound had its bus stolen then was assigned to a
* bus 2 seconds later, the sound would begin playback at the position 2
* seconds after the position it was when the bus was stolen.
* Voices are faded in from silence when the beginning playback part way
* through to avoid discontinuities.
* Additionally, voices that have finished playback while in the simulated state
* will be cleaned up automatically.
*
* @ref fPlaybackModeNoPositionSimulation will cause a simulated voice to begin
* playing from the start of its sound when it is assigned to a bus.
* Any voice with this setting will not finish when being simulated unless stopVoice()
* is called.
* This is intended for uses cases such as infinitely looping ambient noise
* (e.g. a burning torch); cases where a sound will not play infinitely may
* sound strange when this option is used.
* This option reduces the calculation overhead of update().
* This behavior will be used for sounds that are infinitely looping if neither
* of @ref fPlaybackModeSimulatePosition or @ref fPlaybackModeNoPositionSimulation
* are specified.
*
* If neither of @ref fPlaybackModeSimulatePosition nor
* @ref fPlaybackModeNoPositionSimulation are specified, the default behavior
* will be used. Infinitely looping sounds have the default behavior of
* @ref fPlaybackModeNoPositionSimulation and sounds with no loop or a finite
* loop count will use @ref fPlaybackModeSimulatePosition.
*
* When retrieving the playback mode from a playing voice, exactly one of
* these bits will always be set. Trying to update the playback mode to have
* both of these bits clear or both of these bits set will result in the
* previous value of these two bits being preserved in the playback mode.
*/
constexpr PlaybackModeFlags fPlaybackModeSimulatePosition = 0x00000400;
/** @copydoc fPlaybackModeSimulatePosition */
constexpr PlaybackModeFlags fPlaybackModeNoPositionSimulation = 0x00000800;
/** flag to indicate that a multi-channel spatial voice should treat a specific matrix as its
* non-spatial output, when using the 'spatial mix level' parameter, rather than blending all
* channels evenly into the output. The matrix used will be the one specified by the voice
* parameters. If no matrix was specified in the voice parameters, the default matrix for
* that channel combination will be used. If there is no default matrix for that channel
* combination, the default behavior of blending all channels evenly into the output will be used.
* This flag is ignored on non-spatial voices, since they cannot use the 'spatial mix level'
* parameter.
* This flag is also ignored on mono voices.
* This should be used with caution as the non-spatial mixing matrix may add a direction to each
* channel (the default ones do this), which could make the spatial audio sound very strange.
* Additionally, the default mixing matrices will often be quieter than the fully spatial sound
* so this may sound unexpected
* (this is because the default matrices ensure no destination channel has more than 1.0 volume,
* while the spatial calculations are treated as multiple emitters at the same point in
* space).
* The default behavior of mixing all channels evenly is intended to make the sound become
* omni-present which is the intended use case for this feature.
*/
constexpr PlaybackModeFlags fPlaybackModeSpatialMixLevelMatrix = 0x00001000;
/** flag to disable the low frequency effect channel (@ref Speaker::eLowFrequencyEffect)
* for a spatial voice. By default, some component of the 3D audio will be mixed into
* the low frequency effect channel; setting this flag will result in none of the audio
* being mixed into this channel.
* This flag may be desirable in cases where spatial sounds have a specially mastered
* low frequency effect channel that will be played separately.
* This has no effect on a non-spatial voice; disabling the low frequency
* effect channel on a non-spatial voice can be done through by setting its
* mixing matrix.
*/
constexpr PlaybackModeFlags fPlaybackModeNoSpatialLowFrequencyEffect = 0x00002000;
/** flag to indicate that a voice should be immediately stopped if it ever gets unassigned from
* its bus and put on the simulation path. This will also fail calls to playSound() if the
* voice is immediately put on the simulation path. The default behavior is that voices will
* be able to go into simulation mode.
*/
constexpr PlaybackModeFlags fPlaybackModeStopOnSimulation = 0x00004000;
/** mask of playback mode bits that are available for public use. Clear bits in this mask are
* used internally and should not be referenced in other flags here. This is not valid as a
* playback mode flag or flag set.
*/
constexpr PlaybackModeFlags fPlaybackModeAvailableMask = 0x7fffffff;
/** default playback mode flag states. These flags allow the context's default playback mode
* for selected playback modes to be used instead of always having to explicitly specify various
* playback modes for each new play task. Note that these flags only take effect when a sound
* is first played on a voice, or when update() is called after changing a voice's default
* playback mode state. Changing the context's default playback mode settings will not take
* effect on voices that are already playing.
*
* When these flags are used in the VoiceParams::playbackMode flag set in a PlaySoundDesc
* descriptor or a setVoiceParameters() call, these will take the state for their corresponding
* non-default flags from the context's default playback mode state value and ignore the flags
* specified for the voice's parameter itself.
*
* When these flags are used in the ContextParams::playbackMode flag set, they can be used
* to indicate a 'force off', 'force on', or absolute state for the value. When used, the
* 'force' states will cause the feature to be temporarily disabled or enabled on all playing
* buses on the next update cycle. Using these forced states will not change the playback
* mode settings of each individual playing voice, but simply override them. When the force
* flag is removed from the context, each voice's previous behavior will resume (on the next
* update cycle). When these are used as an absolute state, they determine what the context's
* default playback mode for each flag will be.
*
* Note that for efficiency's sake, if both 'force on' and 'force off' flags are specified
* for any given state, the 'force off' flag will always take precedence. It is up to the
* host app to ensure that conflicting flags are not specified simultaneously.
*
* @{
*/
/** when used in a voice parameters playback mode flag set, this indicates that new voices will
* always use the context's current default Doppler playback mode flag and ignore any specific
* flag set on the voice parameters. When used on the context's default playback mode flag set,
* this indicates that the context's default Doppler mode is enabled.
*/
constexpr PlaybackModeFlags fPlaybackModeDefaultUseDoppler = 0x40000000;
/** when used in a voice parameters playback mode flag set, this indicates that new voices will
* always use the context's current default distance delay playback mode flag and ignore any
* specific flag set on the voice parameters. When used on the context's default playback mode
* flag set, this indicates that the context's default distance delay mode is enabled.
*/
constexpr PlaybackModeFlags fPlaybackModeDefaultDistanceDelay = 0x20000000;
/** when used in a voice parameters playback mode flag set, this indicates that new voices will
* always use the context's current default interaural time delay playback mode flag and ignore
* any specific flag set on the voice parameters. When used on the context's default playback
* mode flag set, this indicates that the context's default interaural time delay mode is
* enabled.
*/
constexpr PlaybackModeFlags fPlaybackModeDefaultInterauralDelay = 0x10000000;
/** when used in a voice parameters playback mode flag set, this indicates that new voices will
* always use the context's current default reverb playback mode flag and ignore any specific
* flag set on the voice parameters. When used on the context's default playback mode flag set,
* this indicates that the context's default reverb mode is enabled.
*/
constexpr PlaybackModeFlags fPlaybackModeDefaultUseReverb = 0x08000000;
/** when used in a voice parameters playback mode flag set, this indicates that new voices will
* always use the context's current default filters playback mode flag and ignore any specific
* flag set on the voice parameters. When used on the context's default playback mode flag set,
* this indicates that the context's default filters mode is enabled.
*/
constexpr PlaybackModeFlags fPlaybackModeDefaultUseFilters = 0x04000000;
/** the mask of all 'default' state playback mode flags. If new flags are added above,
* they must be added here as well.
*/
constexpr PlaybackModeFlags fPlaybackModeDefaultMask =
fPlaybackModeDefaultUseDoppler | fPlaybackModeDefaultDistanceDelay | fPlaybackModeDefaultInterauralDelay |
fPlaybackModeDefaultUseReverb | fPlaybackModeDefaultUseFilters;
/** the maximum number of 'default' state playback mode flags. If new flags are added above,
* their count may not exceed this value otherwise the playback mode flags will run out of
* bits.
*/
constexpr size_t kPlaybackModeDefaultFlagCount = 10;
// FIXME: exhale can't handle this
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** retrieves a set of default playback mode flags that will behave as 'force off' behavior.
*
* @param[in] flags the set of fPlaybackModeDefault* flags to use as 'force off' flags.
* @returns the corresponding 'force off' flags for the input flags. These are suitable
* for setting in the context parameters' default playback mode value. These
* should not be used in the voice parameter block's playback mode value - this
* will lead to unexpected behavior.
*/
constexpr PlaybackModeFlags getForceOffPlaybackModeFlags(PlaybackModeFlags flags)
{
return (flags & fPlaybackModeDefaultMask) >> kPlaybackModeDefaultFlagCount;
}
/** retrieves a set of default playback mode flags that will behave as 'force on' behavior.
*
* @param[in] flags the set of fPlaybackModeDefault* flags to use as 'force on' flags.
* @returns the corresponding 'force on' flags for the input flags. These are suitable
* for setting in the context parameters' default playback mode value. These
* should not be used in the voice parameter block's playback mode value - this
* will lead to unexpected behavior.
*/
constexpr PlaybackModeFlags getForceOnPlaybackModeFlags(PlaybackModeFlags flags)
{
return (flags & fPlaybackModeDefaultMask) >> (kPlaybackModeDefaultFlagCount * 2);
}
#endif
/** @} */
/** @} */
/** base type for the voice parameter flags. These flags describe the set of parameters in the
* @ref VoiceParams structure that are valid for an operation. For setting operations, the
* caller is responsible for ensuring that all flagged values are valid in the @ref VoiceParams
* structure before calling. For getting operations, the flagged values will be valid upon
* return.
* @{
*/
typedef uint32_t VoiceParamFlags;
/** all parameters are valid. */
constexpr VoiceParamFlags fVoiceParamAll = static_cast<VoiceParamFlags>(~0);
/** when set, this flag indicates that the @ref VoiceParams::playbackMode value is valid. This
* does not however include the @ref fPlaybackModeMuted and @ref fPlaybackModePaused states in
* @ref VoiceParams::playbackMode unless the @ref fVoiceParamMute or @ref fVoiceParamPause
* flags are also set.
*/
constexpr VoiceParamFlags fVoiceParamPlaybackMode = 0x00000001;
/** when set, this flag indicates that the @ref VoiceParams::volume value is valid. */
constexpr VoiceParamFlags fVoiceParamVolume = 0x00000002;
/** when set, this flag indicates that the state of the @ref fPlaybackModeMuted flag is valid
* in the @ref VoiceParams::playbackMode flag set.
*/
constexpr VoiceParamFlags fVoiceParamMute = 0x00000004;
/** when set, this flag indicates that the @ref VoiceParams::balance values are valid. */
constexpr VoiceParamFlags fVoiceParamBalance = 0x00000008;
/** when set, this flag indicates that the @ref VoiceParams::frequencyRatio value is valid. */
constexpr VoiceParamFlags fVoiceParamFrequencyRatio = 0x00000010;
/** when set, this flag indicates that the @ref VoiceParams::priority value is valid. */
constexpr VoiceParamFlags fVoiceParamPriority = 0x00000020;
/** when set, this flag indicates that the state of the @ref fPlaybackModePaused flag is valid
* in the @ref VoiceParams::playbackMode flag set.
*/
constexpr VoiceParamFlags fVoiceParamPause = 0x00000040;
/** when set, this flag indicates that the @ref VoiceParams::spatialMixLevel value is valid. */
constexpr VoiceParamFlags fVoiceParamSpatialMixLevel = 0x00000080;
/** when set, this flag indicates that the @ref VoiceParams::dopplerScale value is valid. */
constexpr VoiceParamFlags fVoiceParamDopplerScale = 0x00000100;
/** when set, this flag indicates that the @ref VoiceParams::occlusion values are valid. */
constexpr VoiceParamFlags fVoiceParamOcclusionFactor = 0x00000200;
/** when set, this flag indicates that the @ref VoiceParams::emitter values are valid. */
constexpr VoiceParamFlags fVoiceParamEmitter = 0x00000400;
/** when set, this flag indicates that the @ref VoiceParams::matrix values are valid. */
constexpr VoiceParamFlags fVoiceParamMatrix = 0x00000800;
/** @} */
/** voice parameters block. This can potentially contain all of a voice's parameters and their
* current values. This is used to both set and retrieve one or more of a voice's parameters
* in a single call. The fVoiceParam* flags that are passed to setVoiceParameters() or
* getVoiceParameters() determine which values in this block are guaranteed to be valid.
*/
struct VoiceParams
{
/** flags to indicate how a sound is to be played back. These values is valid only when the
* @ref fVoiceParamPlaybackMode, @ref fVoiceParamMute, or @ref fVoiceParamPause flags are
* used. This controls whether the sound is played as a spatial or non-spatial sound and
* how the emitter's attributes will be interpreted (ie: either world coordinates or
* listener relative).
*/
PlaybackModeFlags playbackMode;
/** the volume level for the voice. This is valid when the @ref fVoiceParamVolume flag is
* used. This should be 0.0 for silence or 1.0 for normal volume. A negative value may be
* used to invert the signal. A value greater than 1.0 will amplify the signal. The volume
* level can be interpreted as a linear scale where a value of 0.5 is half volume and 2.0 is
* double volume. Any volume values in decibels must first be converted to a linear volume
* scale before setting this value. The default value is 1.0.
*/
float volume;
/** non-spatial sound positioning parameters. These provide pan and fade values for the
* voice to give the impression that the sound is located closer to one of the quadrants
* of the acoustic space versus the others. These values are ignored for spatial sounds.
*/
struct VoiceParamBalance
{
/** sets the non-spatial panning value for a voice. This value is valid when the
* @ref fVoiceParamBalance flag is used. This is 0.0 to have the sound "centered" in all
* speakers. This is -1.0 to have the sound balanced to the left side. This is 1.0 to
* have the sound balanced to the right side. The way the sound is balanced depends on
* the number of channels. For example, a mono sound will be balanced between the left
* and right sides according to the panning value, but a stereo sound will just have the
* left or right channels' volumes turned down according to the panning value. This
* value is ignored for spatial sounds. The default value is 0.0.
*
* Note that panning on non-spatial sounds should only be used for mono or stereo sounds.
* When it is applied to sounds with more channels, the results are often undefined or
* may sound odd.
*/
float pan;
/** sets the non-spatial fade value for a voice. This value is valid when the
* @ref fVoiceParamBalance flag is used. This is 0.0 to have the sound "centered" in all
* speakers. This is -1.0 to have the sound balanced to the back side. This is 1.0 to
* have the sound balanced to the front side. The way the sound is balanced depends on
* the number of channels. For example, a mono sound will be balanced between the front
* and back speakers according to the fade value, but a 5.1 sound will just have the
* front or back channels' volumes turned down according to the fade value. This value
* is ignored for spatial sounds. The default value is 0.0.
*
* Note that using fade on non-spatial sounds should only be used for mono or stereo
* sounds. When it is applied to sounds with more channels, the results are often
* undefined or may sound odd.
*/
float fade;
} balance; //!< Non-spatial sound positioning parameters.
/** the frequency ratio for a voice. This is valid when the @ref fVoiceParamFrequencyRatio
* flag is used. This will be 1.0 to play back a sound at its normal rate, a value less than
* 1.0 to lower the pitch and play it back more slowly, and a value higher than 1.0 to
* increase the pitch and play it back faster. For example, a pitch scale of 0.5 will play
* back at half the pitch (ie: lower frequency, takes twice the time to play versus normal),
* and a pitch scale of 2.0 will play back at double the pitch (ie: higher frequency, takes
* half the time to play versus normal). The default value is 1.0.
*
* On some platforms, the frequency ratio may be silently clamped to an acceptable range
* internally. For example, a value of 0.0 is not allowed. This will be clamped to the
* minimum supported value instead.
*
* Note that the even though the frequency ratio *can* be set to any value in the range from
* 1/1024 to 1024, this very large range should only be used in cases where it is well known
* that the particular sound being operated on will still sound valid after the change. In
* the real world, some of these extreme frequency ratios may make sense, but in the digital
* world, extreme frequency ratios can result in audio corruption or even silence. This
* happens because the new frequency falls outside of the range that is faithfully
* representable by either the audio device or sound data itself. For example, a 4KHz tone
* being played at a frequency ratio larger than 6.0 will be above the maximum representable
* frequency for a 48KHz device or sound file. This case will result in a form of corruption
* known as aliasing, where the frequency components above the maximum representable
* frequency will become audio artifacts. Similarly, an 800Hz tone being played at a
* frequency ratio smaller than 1/40 will be inaudible because it falls below the frequency
* range of the human ear.
*
* In general, most use cases will find that the frequency ratio range of [0.1, 10] is more
* than sufficient for their needs. Further, for many cases, the range from [0.2, 4] would
* suffice. Care should be taken to appropriately cap the used range for this value.
*/
float frequencyRatio;
/** the playback priority of this voice. This is valid when the @ref fVoiceParamPriority
* flag is used. This is an arbitrary value whose scale is defined by the host app. A
* value of 0 is the default priority. Negative values indicate lower priorities and
* positive values indicate higher priorities. This priority value helps to determine
* which voices are the most important to be audible at any given time. When all buses
* are busy, this value will be used to compare against other playing voices to see if
* it should steal a bus from another lower priority sound or if it can wait until another
* bus finishes first. Higher priority sounds will be ensured a bus to play on over lower
* priority sounds. If multiple sounds have the same priority levels, the louder sound(s)
* will take priority. When a higher priority sound is queued, it will try to steal a bus
* from the quietest sound with lower or equal priority.
*/
int32_t priority;
/** the spatial mix level. This is valid when @ref fVoiceParamSpatialMixLevel flag is used.
* This controls the mix between the results of a voice's spatial sound calculations and its
* non-spatial calculations. When this is set to 1.0, only the spatial sound calculations
* will affect the voice's playback. This is the default when state. When set to 0.0, only
* the non-spatial sound calculations will affect the voice's playback. When set to a value
* between 0.0 and 1.0, the results of the spatial and non-spatial sound calculations will
* be mixed with the weighting according to this value. This value will be ignored if
* @ref fPlaybackModeSpatial is not set. The default value is 1.0.
* Values above 1.0 will be treated as 1.0. Values below 0.0 will be treated as 0.0.
*
* @ref fPlaybackModeSpatialMixLevelMatrix affects the non-spatial mixing behavior of this
* parameter for multi-channel voices. By default, a multi-channel spatial voice's non-spatial
* component will treat each channel as a separate mono voice. With the
* @ref fPlaybackModeSpatialMixLevelMatrix flag set, the non-spatial component will be set
* with the specified output matrix or the default output matrix.
*/
float spatialMixLevel;
/** the Doppler scale value. This is valid when the @ref fVoiceParamDopplerScale flag is
* used. This allows the result of internal Doppler calculations to be scaled to emulate
* a time warping effect. This should be near 0.0 to greatly reduce the effect of the
* Doppler calculations, and up to 5.0 to exaggerate the Doppler effect. A value of 1.0
* will leave the calculated Doppler factors unmodified. The default value is 1.0.
*/
float dopplerScale;
/** the occlusion factors for a voice. This is valid when the @ref fVoiceParamOcclusionFactor
* flag is used. These values control automatic low pass filters that get applied to the
* spatial sounds to simulate object occlusion between the emitter and listener positions.
*/
struct VoiceParamOcclusion
{
/** the occlusion factor for the direct path of the sound. This is the path directly from
* the emitter to the listener. This factor describes how occluded the sound's path
* actually is. A value of 1.0 means that the sound is fully occluded by an object
* between the voice and the listener. A value of 0.0 means that the sound is not
* occluded by any object at all. This defaults to 0.0.
* This factor multiplies by @ref EntityCone::lowPassFilter, if a cone with a non 1.0
* lowPassFilter value is specified.
* Setting this to a value outside of [0.0, 1.0] will result in an undefined low pass
* filter value being used.
*/
float direct;
/** the occlusion factor for the reverb path of the sound. This is the path taken for
* sounds reflecting back to the listener after hitting a wall or other object. A value
* of 1.0 means that the sound is fully occluded by an object between the listener and
* the object that the sound reflected off of. A value of 0.0 means that the sound is
* not occluded by any object at all. This defaults to 1.0.
*/
float reverb;
} occlusion; //!< Occlusion factors for a voice.
/** the attributes of the emitter related for this voice. This is only valid when the
* @ref fVoiceParamEmitter flag is used. This includes the emitter's position, orientation,
* velocity, cone, and rolloff curves. The default values for these attributes are noted
* in the @ref EmitterAttributes object. This will be ignored for non-spatial sounds.
*/
EmitterAttributes emitter;
/** the channel mixing matrix to use for this @ref Voice. The rows of this matrix represent
* each output channel from this @ref Voice and the columns of this matrix represent the
* input channels of this @ref Voice (e.g. this is a inputChannels x outputChannels matrix).
* The output channel count will always be the number of audio channels set on the
* @ref Context.
* Each cell in the matrix should be a value from 0.0-1.0 to specify the volume that
* this input channel should be mixed into the output channel. Setting negative values
* will invert the signal. Setting values above 1.0 will amplify the signal past unity
* gain when being mixed.
*
* This setting is mutually exclusive with @ref balance; setting one will disable the
* other.
* This setting is only available for spatial sounds if @ref fPlaybackModeSpatialMixLevelMatrix
* if set in the playback mode parameter. Multi-channel spatial audio is interpreted as
* multiple emitters existing at the same point in space, so a purely spatial voice cannot
* have an output matrix specified.
*
* Setting this to nullptr will reset the matrix to the default for the given channel
* count.
* The following table shows the speaker modes that are used for the default output
* matrices. Voices with a speaker mode that is not in the following table will
* use the default output matrix for the speaker mode in the following table that
* has the same number of channels.
* If there is no default matrix for the channel count of the @ref Voice, the output
* matrix will have 1.0 in the any cell (i, j) where i == j and 0.0 in all other cells.
*
* | Channels | Speaker Mode |
* | -------- | ---------------------------------- |
* | 1 | kSpeakerModeMono |
* | 2 | kSpeakerModeStereo |
* | 3 | kSpeakerModeTwoPointOne |
* | 4 | kSpeakerModeQuad |
* | 5 | kSpeakerModeFourPointOne |
* | 6 | kSpeakerModeFivePointOne |
* | 7 | kSpeakerModeSixPointOne |
* | 8 | kSpeakerModeSevenPointOne |
* | 10 | kSpeakerModeNinePointOne |
* | 12 | kSpeakerModeSevenPointOnePointFour |
* | 14 | kSpeakerModeNinePointOnePointFour |
* | 16 | kSpeakerModeNinePointOnePointSix |
*
* It is recommended to explicitly set an output matrix on a non-spatial @ref Voice
* if the @ref Voice or the @ref Context have a speaker layout that is not found in
* the above table.
*/
const float* matrix;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** base type for the context parameter flags. These flags describe the set of parameters in the
* @ref ContextParams structure that are valid for an operation. For setting operations, the
* caller is responsible for ensuring that all flagged values are valid in the @ref ContextParams
* structure before calling. For getting operations, the flagged values will be valid upon
* return.
* @{
*/
using ContextParamFlags = uint32_t;
/** all parameters are valid. */
constexpr ContextParamFlags fContextParamAll = ~0u;
/** when set, this flag indicates that the @ref ContextParams::speedOfSound value is valid. */
constexpr ContextParamFlags fContextParamSpeedOfSound = 0x00000001;
/** when set, this flag indicates that the @ref ContextParams::unitsPerMeter value is valid. */
constexpr ContextParamFlags fContextParamWorldUnitScale = 0x00000002;
/** when set, this flag indicates that the @ref ContextParams::listener values are valid. */
constexpr ContextParamFlags fContextParamListener = 0x00000004;
/** when set, this flag indicates that the @ref ContextParams::dopplerScale value is valid. */
constexpr ContextParamFlags fContextParamDopplerScale = 0x00000008;
/** when set, this flag indicates that the @ref ContextParams::virtualizationThreshold value
* is valid.
*/
constexpr ContextParamFlags fContextParamVirtualizationThreshold = 0x00000010;
/** when set, this flag indicates that the @ref ContextParams::spatialFrequencyRatio value
* is valid.
*/
constexpr ContextParamFlags fContextParamSpatialFrequencyRatio = 0x00000020;
/** when set, this flag indicates that the @ref ContextParams::nonSpatialFrequencyRatio value
* is valid.
*/
constexpr ContextParamFlags fContextParamNonSpatialFrequencyRatio = 0x00000040;
/** when set, this flag indicates that the @ref ContextParams::masterVolume value is valid. */
constexpr ContextParamFlags fContextParamMasterVolume = 0x00000080;
/** when set, this flag indicates that the @ref ContextParams::spatialVolume value is valid. */
constexpr ContextParamFlags fContextParamSpatialVolume = 0x00000100;
/** when set, this flag indicates that the @ref ContextParams::nonSpatialVolume value is valid. */
constexpr ContextParamFlags fContextParamNonSpatialVolume = 0x00000200;
/** when set, this flag indicates that the @ref ContextParams::dopplerLimit value is valid. */
constexpr ContextParamFlags fContextParamDopplerLimit = 0x00000400;
/** when set, this flag indicates that the @ref ContextParams::defaultPlaybackMode value is valid. */
constexpr ContextParamFlags fContextParamDefaultPlaybackMode = 0x00000800;
/** when set, this flag indicates that the @ref ContextParams::flags value is valid. */
constexpr ContextParamFlags fContextParamFlags = 0x00001000;
/** When set, this flag indicates that the @ref ContextParams2::videoLatency and
* @ref ContextParams2::videoLatencyTrim values are valid. In this case, the
* @ref ContextParams::ext value must be set to point to a @ref ContextParams2
* object.
*/
constexpr ContextParamFlags fContextParamVideoLatency = 0x00002000;
/** flag to indicate that voice table validation should be performed any time a voice is allocated
* or recycled. There is a performance cost to enabling this. Any operation involving a new
* voice or recycling a voice will become O(n^2). This flag is ignored in release builds.
* When this flag is not used, no voice validation will be performed.
*/
constexpr ContextParamFlags fContextParamFlagValidateVoiceTable = 0x10000000;
/** @} */
/** The default speed of sound parameter for a Context.
* This is specified in meters per second.
* This is the approximate speed of sound in air at sea level at 15 degrees Celsius.
*/
constexpr float kDefaultSpeedOfSound = 340.f;
/** context parameters block. This can potentially contain all of a context's parameters and
* their current values. This is used to both set and retrieve one or more of a context's
* parameters in a single call. The set of fContextParam* flags that are passed to
* getContextParameter() or setContextParameter() indicates which values in the block are
* guaranteed to be valid.
*/
struct ContextParams
{
/** the speed of sound for the context. This is valid when the @ref fContextParamSpeedOfSound
* flag is used. This is measured in meters per second. This will affect the calculation of
* Doppler shift factors and interaural time difference for spatial voices. The default
* value is @ref kDefaultSpeedOfSound m/s.
* This value can be changed at any time to affect Doppler calculations globally. This should
* only change when the sound environment itself changes (ie: move from air into water).
*/
float speedOfSound;
/** the number of arbitrary world units per meter. This is valid when the
* @ref fContextParamWorldUnitScale flag is used. World units are arbitrary and often
* determined by the level/world designers. For example, if the world units are in feet,
* this value would need to be set to 3.28. All spatial audio calculations are performed in
* SI units (ie: meters for distance, seconds for time). This provides a conversion factor
* from arbitrary world distance units to SI units. This conversion factor will affect all
* audio distance and velocity calculations. This defaults to 1.0, indicating that the world
* units are assumed to be measured in meters. This must not be 0.0 or negative.
*/
float unitsPerMeter;
/** the global Doppler scale value for this context. This is applied to all calculated
* Doppler factors to enhance or diminish the effect of the Doppler factor. A value of
* 1.0 will leave the calculated Doppler levels unmodified. A value lower than 1.0 will
* have the result of diminishing the Doppler effect. A value higher than 1.0 will have
* the effect of enhancing the Doppler effect. This is useful for handling global time
* warping effects. This parameter is a unit less scaling factor. This defaults to 1.0.
*/
float dopplerScale;
/** the global Doppler limit value for this context. This will cap the calculated Doppler
* factor at the high end. This is to avoid excessive aliasing effects for very fast moving
* emitters or listener. When the relative velocity between the listener and an emitter is
* nearing the speed of sound, the calculated Doppler factor can approach ~11 million.
* Accurately simulating this would require a very large scale anti-aliasing or filtering pass
* on all resampling operations on the emitter. That is unfortunately not possible in
* general. Clamping the Doppler factor to something relatively small like 16 will still
* result in the effect being heard but will reduce the resampling artifacts related to high
* frequency ratios. A Doppler factor of 16 represents a relative velocity of ~94% the speed
* of sound so there shouldn't be too much of a loss in the frequency change simulation.
* This defaults to 16. This should not be negative or zero.
*/
float dopplerLimit;
/** the effective volume level at which a voice will become virtual. A virtual voice will
* not decode any data and will perform only minimal update tasks when needed. This
* is expressed as a linear volume value from 0.0 (silence) to 1.0 (full volume). The
* default volume is 0.0.
*/
float virtualizationThreshold;
/** the global frequency ratio to apply to all active spatial voices. This should only be
* used to handle time dilation effects on the voices, not to deal with pitch changes (ie:
* record a sound at a high frequency to save on storage space and load time, but then always
* play it back at a reduced pitch). If this is used for pitch changes, it will interfere
* with distance delay calculations and possibly lead to other undesirable behavior.
* This will not affect any non-spatial voices. This defaults to 1.0.
*/
float spatialFrequencyRatio;
/** the global frequency ratio to apply to all active non-spatial voices. This can be used
* to perform a pitch change (and as a result play time change) on all non-spatial voices,
* or it can be used to simulate a time dilation effect on all non-spatial voices. This
* will not affect any spatial voices. This defaults to 1.0.
*/
float nonSpatialFrequencyRatio;
/** the global master volume for this context. This will only affect the volume level of
* the final mixed output signal. It will not directly affect the relative volumes of
* each voice being played. No individual voice will be able to produce a signal louder
* than this volume level. This is set to 0.0 to silence all output. This defaults to
* 1.0 (ie: full volume). This should not be set beyond 1.0.
*/
float masterVolume;
/** the relative volume of all spatial voices. This will be the initial volume level of
* any new spatial voice. The volume specified in that voice's parameters will be multiplied
* by this volume. This does not affect the volume level of non-spatial voices. This is
* set to 0.0 to silence all spatial voices. This defaults to 1.0 (ie: full volume). This
* should not be set beyond 1.0. This volume is independent of the @ref masterVolume value
* but will effectively be multiplied by it for the final output.
*/
float spatialVolume;
/** the relative volume of all non-spatial voices. This will be the initial volume level of
* any new non-spatial voice. The volume specified in that voice's parameters will be
* multiplied by this volume. This does not affect the volume level of spatial voices. This
* is set to 0.0 to silence all non-spatial voices. This defaults to 1.0 (ie: full volume).
* This should not be set beyond 1.0. This volume is independent of the @ref masterVolume
* value but will effectively be multiplied by it for the final output.
*/
float nonSpatialVolume;
/** attributes of the listener. This is valid when the @ref fContextParamListener flag is
* used. Only the values that have their corresponding fEntityFlag* flags set will be
* updated on a set operation. Any values that do not have their corresponding flag set
* will just be ignored and the previous value will remain current. This can be used to (for
* example) only update the position for the listener but leave its orientation and velocity
* unchanged. The flags would also indicate whether the orientation vectors need to be
* normalized or made perpendicular before continuing. Fixing up these orientation vectors
* should only be left up to this call if it is well known that the vectors are not already
* correct.
*
* It is the caller's responsibility to decide on the listener's appropriate position and
* orientation for any given situation. For example, if the listener is represented by a
* third person character, it would make the most sense to set the position to the
* character's head position, but to keep the orientation relative to the camera's forward
* and up vectors (possibly have the camera's forward vector projected onto the character's
* forward vector). If the character's orientation were used instead, the audio may jump
* from one speaker to another as the character rotates relative to the camera.
*/
ListenerAttributes listener;
/** defines the default playback mode flags for the context. These will provide 'default'
* behavior for new voices. Any new voice that uses the fPlaybackModeDefault* flags in
* its voice parameters block will inherit the default playback mode behavior from this
* value. Note that only specific playback modes are supported in these defaults. This
* also provides a means to either 'force on' or 'force off' certain features for each
* voice. This value is a collection of zero or more of the fPlaybackModeDefault* flags,
* and flags that have been returned from either getForceOffPlaybackModeFlags() or
* getForceOnPlaybackModeFlags(). This may not include any of the other fPlaybackMode*
* flags that are not part of the fPlaybackModeDefault* set. If the other playback mode
* flags are used, the results will be undefined. This defaults to 0.
*/
PlaybackModeFlags defaultPlaybackMode;
/** flags to control the behavior of the context. This is zero or more of the
* @ref ContextParamFlags flags. This defaults to 0.
*/
ContextParamFlags flags;
/** Reserved for future expansion. This must be set to nullptr unless a @ref ContextParams2
* object is also being passed in.
*/
void* ext = nullptr;
};
/** Extended context parameters descriptor object. This provides additional context parameters
* that were not present in the original version of @ref ContextParams. This structure also
* has room for future expansion.
*/
struct ContextParams2
{
/** An estimate of the current level of latency between when a video frame is produced
* and when it will be displayed to the screen. In cases where a related renderer is
* buffering frames (ie: double or triple buffering frames in flight), there can be
* a latency build-up between when a video frame is displayed on screen and when sounds
* related to that particular image should start playing. This latency is related to
* the frame buffering count from the renderer and the current video frame rate. Since
* the video framerate can vary at runtime, this value could be updated frequently with
* new estimates based on the current video frame rate.
*
* This value is measured in microseconds and is intended to be an estimate of the current
* latency level between video frame production and display. This will be used by the
* playback context to delay the start of new voices by approximately this amount of time.
* This should be used to allow the voices to be delayed until a time where it is more
* likely that a related video frame is visible on screen. If this is set to 0 (the
* default), all newly queued voices will be scheduled to start playing as soon as possible.
*
* The carb::audio::estimateVideoLatency() helper function can be used to help calculate
* this latency estimate. Negative values are not allowed.
*/
int64_t videoLatency = 0;
/** An additional user specified video latency value that can be used to adjust the
* value specified in @ref videoLatency by a constant amount. This is expressed in
* microseconds. This could for example be exposed to user settings to allow user-level
* adjustment of audio/video sync or it could be a per-application tuned value to tweak
* audio/video sync. This defaults to 0 microseconds. Negative values are allowed if
* needed as long as @ref videoLatency plus this value is still positive. The total
* latency will always be silently clamped to 0 as needed.
*/
int64_t videoLatencyTrim = 0;
/** Extra padding space reserved for future expansion. Do not use this value directly.
* In future versions, new context parameters will be borrowed from this buffer and given
* proper names and types as needed. When this padding buffer is exhausted, a new
* @a ContextParams3 object will be added that can be chained to this one.
*/
void* padding[32] = {};
/** Reserved for future expansion. This must be set to `nullptr`. */
void* ext = nullptr;
};
/** special value for @ref LoopPointDesc::loopPointIndex that indicates no loop point will be
* used. This will be overridden if the @ref LoopPointDesc::loopPoint value is non-nullptr.
*/
constexpr size_t kLoopDescNoLoop = ~0ull;
/** descriptor of a loop point to set on a voice. This may be specified both when a sound is
* first assigned to a voice in playSound() and to change the current loop point on the voice
* at a later time with setLoopPoint().
*/
struct LoopPointDesc
{
/** the event point to loop at. This may either be an explicitly constructed event point
* information block, or be one of the sound's event points, particularly one that is flagged
* as a loop point. This will define a location to loop back to once the end of the initial
* play region is reached. This event point must be within the range of the sound's data
* buffer. If the event point contains a zero length, the loop region will be taken to be
* the remainder of the sound starting from the loop point. This loop point will also
* contain a loop count. This loop count can be an explicit count or indicate that it
* should loop infinitely. Only a single loop point may be set for any given playing
* instance of a sound. Once the sound starts playing on a voice, the loop point and loop
* count may not be changed. A loop may be broken early by passing nullptr or an empty
* loop point descriptor to setLoopPoint() if needed. This may be nullptr to use one of
* the loop points from the sound itself by its index by specifying it in
* @ref loopPointIndex.
*
* When a loop point is specified explicitly in this manner, it will only be shallow
* copied into the voice object. If its string data is to be maintained to be passed
* through to a callback, it is the caller's responsibility to ensure the original loop
* point object remains valid for the entire period the voice is playing. Otherwise, the
* string members of the loop point should be set to nullptr.
*
* For performance reasons, it is important to ensure that streaming
* sounds do not have short loops (under 1 second is considered very
* short), since streaming loops will usually require seeking and some
* formats will need to partially decode blocks, which can require
* decoding thousands of frames in some formats.
*/
const EventPoint* loopPoint = nullptr;
/** the index of the loop point to use from the sound data object itself. This may be
* @ref kLoopDescNoLoop to indicate that no loop point is necessary. This value is only
* used if @ref loopPoint is nullptr. If the sound data object does not have a valid
* loop point at the specified index, the sound will still play but it will not loop.
* The loop point identified by this index must remain valid on the sound data object
* for the entire period that the voice is playing.
*/
size_t loopPointIndex = kLoopDescNoLoop;
/** reserved for future expansion. This must be set to nullptr. */
void* ext = nullptr;
};
/** base type for the play descriptor flags. Zero or more of these may be specified in
* @ref PlaySoundDesc::flags.
* @{
*/
typedef uint32_t PlayFlags;
/** when set, this indicates that the event points from the sound data object
* @ref PlaySoundDesc::sound should be used to trigger callbacks. If this flag is not set,
* no event point callbacks will be triggered for the playing sound.
*/
constexpr PlayFlags fPlayFlagUseEventPoints = 0x00000001;
/** when set, this indicates that voice event callbacks will be performed on the engine thread
* immediately when the event occurs instead of queuing it to be performed in a later call to
* update() on the host app thread. This flag is useful for streaming sounds or sounds that
* have data dynamically written to them. This allows for a lower latency callback system.
* If the callback is performed on the engine thread, it must complete as quickly as possible
* and not perform any operations that may block (ie: read from a file, wait on a signal, use
* a high contention lock, etc). If the callback takes too long, it will cause the engine cycle
* to go over time and introduce an artifact or audio dropout into the stream. In general, if
* a real-time callback takes more than ~1ms to execute, there is a very high possibility that
* it could cause an audio dropout. If this flag is not set, all callback events will be queued
* when they occur and will not be called until the next call to update() on the context object.
*/
constexpr PlayFlags fPlayFlagRealtimeCallbacks = 0x00000002;
/** when set, this indicates that if a voice is started with a sound that is already over its
* max play instances count, it should still be started but immediately put into simulation
* mode instead of taking a bus. When not set, the call to playSound() will fail if the sound's
* max instance count is above the max instances count. Note that if the new voice is put into
* simulation mode, it will still count as a playing instance of the sound which will cause its
* instance count to go above the maximum. This flag should be used sparingly at best.
*
* Note that when this flag is used, a valid voice will be created for the sound even though
* it is at or above its current instance limit. Despite it being started in simulation mode,
* this will still consume an extra instance count for the sound. The new voice will only be
* allowed to be devirtualized once its sound's instance count has dropped below its limit
* again. However, if the voice has a high priority level and the instance count is still
* above the limit, this will prevent other voices from being devirtualized too. This flag
* is best used on low priority, short, fast repeating sounds.
*/
constexpr PlayFlags fPlayFlagMaxInstancesSimulate = 0x00000004;
/** mask of playback flag bits that are available for public use. Clear bits in this mask are
* used internally and should not be referenced in other flags here. This is not valid as a
* playback flag or flag set.
*/
constexpr PlayFlags fPlayFlagAvailableMask = 0x01ffffff;
/** @} */
/** descriptor of how to play a single sound. At the very least, the @ref sound value must be
* specified.
*/
struct PlaySoundDesc
{
/** flags to describe the way to allocate the voice and play the sound. This may be zero
* or more of the fPlayFlag* flags.
*/
PlayFlags flags = 0;
/** the sound data object to be played. This may not be nullptr. The sound's data buffer
* will provide the data for the voice. By default, the whole sound will be played. If
* a non-zero value for @ref playStart and @ref playLength are also given, only a portion
* of the sound's data will be played.
*/
SoundData* sound;
/** the set of voice parameters that are valid. This can be @ref fVoiceParamAll if all of
* the parameters in the block are valid. It may be a combination of other fVoiceParam*
* flags if only certain parameters are valid. If set to 0, the parameters block in
* @ref params will be ignored and the default parameters used instead.
*/
VoiceParamFlags validParams = 0;
/** the initial parameters to set on the voice. This may be nullptr to use the default
* parameters for the voice. Note that the default parameters for spatial sounds will
* not necessarily be positioned appropriately in the world. If needed, only a portion
* of the parameter block may be specified by listing only the flags for the valid parameters
* in @ref validParams.
*/
VoiceParams* params = nullptr;
/** descriptor of an optional loop point to set for the voice. This may be changed at a
* later point on the voice with setLoopPoint() as well. This will identify the region
* to be played after the initial play region from @ref playStart through @ref playLength
* completes, or after the previous loop completes.
*/
LoopPointDesc loopPoint = {};
/** the callback function to bind to the voice. This provides notifications of the sound
* ending, loops starting on the sound, and event points getting hit in the sound. This
* callback will occur during an update() call if the @ref fPlayFlagRealtimeCallbacks flag
* is not used in @ref flags. This will occur on the engine thread if the flag is set.
* Note that if the callback is executing on the engine thread, it must complete its task
* as quickly as possible so that it doesn't stall the engine's processing operations.
* In most cases, it should just flag that the event occurred and return. The flagged
* event should then be handled on another thread. Blocking the engine thread can result
* in audio dropouts or popping artifacts in the stream. In general, if a real-time
* callback takes more than ~1ms to execute, there is a very high possibility that it could
* cause an audio dropout. This may be nullptr if no callbacks are needed.
*/
VoiceCallback callback = nullptr;
/** the opaque user context value that will be passed to the callback function any time
* it is called. This value is ignored if @ref callback is nullptr.
*/
void* callbackContext = nullptr;
/** the offset in the sound to start the initial playback at. The units of this value are
* specified in @ref playUnits. If this is set to 0, playback will start from the beginning
* of the sound data object. It is the caller's responsibility to ensure that this starting
* point occurs at a zero crossing in the data (otherwise a popping artifact will occur).
* This starting offset must be within the range of the sound data object's buffer. This
* may be outside of any chosen loop region. This region of the sound will be played before
* the loop region plays. This initial play region (starting at this offset and extending
* through @ref playLength) does not count as one of the loop iterations.
*/
size_t playStart = 0;
/** the length of the initial play region. The units of this value are specified in
* @ref playUnits. This may be set to 0 to indicate that the remainder of the sound data
* object's buffer should be played starting from @ref playStart. This length plus the
* starting offset must be within the range of the sound data object's buffer.
*/
size_t playLength = 0;
/** the units that the @ref playStart and @ref playLength values are given in. This may be
* any unit, but the use of time units could result in undesirable artifacts since they are
* not accurate units.
*/
UnitType playUnits = UnitType::eFrames;
/** reserved for future expansion. This must be set to `nullptr` unless it is pointing
* to a @ref PlaySoundDesc2 object.
*/
void* ext = nullptr;
};
/** Extended descriptor to allow for further control over how a new voice plays its sound. This
* must be set in @ref PlaySoundDesc::ext if it is to be included in the original play descriptor
* for the voice.
*/
struct PlaySoundDesc2
{
/** The time in microseconds to delay the start of this voice's sound. This will delay the
* start of the sound by an explicit amount requested by the caller. This specified delay
* time will be in addition to the context's delay time (@ref ContextParams2::videoLatency)
* and the calculated distance delay. This value may be negative to offset the context's
* delay time. However, once all delay times have been combined (context, per-voice,
* distance delay), the total delay will be clamped to 0. This defaults to 0us.
*/
int64_t delayTime = 0;
/** Extra padding space reserved for future expansion. Do not use this value directly.
* In future versions, new context parameters will be borrowed from this buffer and given
* proper names and types as needed. When this padding buffer is exhausted, a new
* @a PlaySoundDesc3 object will be added that can be chained to this one.
*/
void* padding[32] = {};
/** Reserved for future expansion. This must be set to `nullptr`. */
void* ext = nullptr;
};
/********************************** IAudioPlayback Interface **********************************/
/** Low-Level Audio Playback Plugin Interface.
*
* See these pages for more detail:
* @rst
* :ref:`carbonite-audio-label`
* :ref:`carbonite-audio-playback-label`
@endrst
*/
struct IAudioPlayback
{
CARB_PLUGIN_INTERFACE("carb::audio::IAudioPlayback", 1, 1)
/************************ context and device management functions ****************************/
/** retrieves the current audio output device count for the system.
*
* @return the number of audio output devices that are currently connected to the system.
* Device 0 in the list will be the system's default or preferred device.
*
* @note The device count is a potentially volatile value. This can change at any time
* without notice due to user action. For example, the user could remove an audio
* device from the system or add a new one at any time. Thus it is a good idea to
* open the device as quickly as possible after choosing the device index. There
* is no guarantee that the device list will even remain stable during a single
* device enumeration loop. The only device index that is guaranteed to be valid
* is the system default device index of 0.
*/
size_t(CARB_ABI* getDeviceCount)();
/** retrieves the capabilities and information about a single audio output device.
*
* @param[in] deviceIndex the index of the device to retrieve info for. This must be
* between 0 and the most recent return value from getDeviceCount().
* @param[out] caps receives the device information. The @a thisSize value must be set
* to sizeof(DeviceCaps) before calling.
* @returns @ref AudioResult::eOk if the device info was successfully retrieved.
* @returns @ref AudioResult::eInvalidParameter if the @a thisSize value is not properly
* initialized in @p caps or @p caps is nullptr.
* @returns @ref AudioResult::eOutOfRange if the requested device index is out of range of
* the system's current device count.
* @returns @ref AudioResult::eNotSupported if a device is found but it requires an
* unsupported sample format.
* @returns an AudioResult::* error code if the requested device index was out of range
* or the info buffer was invalid.
*
* @remarks This retrieves information about a single audio output device. The
* information will be returned in the @p info buffer. This may fail if the
* device corresponding to the requested index has been removed from the
* system.
*/
AudioResult(CARB_ABI* getDeviceCaps)(size_t deviceIndex, DeviceCaps* caps);
/** creates a new audio output context object.
*
* @param[in] desc a description of the initial settings and capabilities to use for the
* new context object. Set this to nullptr to use all default context
* settings.
* @returns the newly created audio output context object.
*
* @remarks This creates a new audio output context object. This object is responsible for
* managing all access to a single instance of the audio context. Note that there
* will be a separate audio engine thread associated with each instance of this
* context object.
*
* @remarks Upon creation, this object will be in a default state. This means that the
* selected device will be opened and its processing engine created. It will
* output at the chosen device's default frame rate and channel count. If needed,
* a new device may be selected with setOutput(). If a custom speaker mask
* (ie: not one of the standard preset kSpeakerMode* modes) was specified when
* creating the context or a device or speaker mask with more than
* @ref Speaker::eCount channels was used, the caller must make a call to
* setSpeakerDirections() before any spatial sounds can be played. Failing to do
* so will result in undefined behavior in the final audio output.
*
* @note If selecting a device fails during context creation, the context will still be
* created successfully and be valid for future operations. The caller will have
* to select another valid device at a later point before any audio will be output
* however. A caller can check if a device has been opened successfully by calling
* getContextCaps() and checking the @a selectedDevice.flags member to see if it has
* been set to something other than @ref fDeviceFlagNotOpen.
*/
Context*(CARB_ABI* createContext)(const PlaybackContextDesc* desc);
/** destroys an audio output context object.
*
* @param[in] context the context object to be destroyed. Upon return, this object will no
* longer be valid.
* @retval AudioResult::eOk.
*
* @remarks This destroys an audio output context object that was previously created
* with createContext(). If the context is still active and has a running mixer, it
* will be stopped before the object is destroyed. All resources associated with
* the device will be both invalidated and destroyed as well. Only audio data
* buffers that were queued on voices will be left (it is the caller's
* responsibility to destroy those).
*/
AudioResult(CARB_ABI* destroyContext)(Context* context);
/** retrieves the current capabilities and settings for a context object.
*
* @param[in] context the context object to retrieve the capabilities for.
* @returns the context's current capabilities and settings. This includes the speaker mode,
* speaker positions, maximum bus count, and information about the output device
* that is opened (if any).
* @returns nullptr if @p context is nullptr.
*
* @remarks This retrieves the current capabilities and settings for a context object.
* Some of these settings may change depending on whether the context has opened
* an output device or not.
*/
const ContextCaps*(CARB_ABI* getContextCaps)(Context* context);
/** sets one or more parameters on a context.
*
* @param[in] context the context to set the parameter(s) on. This may not be nullptr.
* @param[in] paramsToSet the set of flags to indicate which parameters in the parameter
* block @p params are valid and should be set on the context. This
* may be zero or more of the fContextParam* flags. If this is 0,
* the call will be treated as a no-op.
* @param[in] params the parameter(s) to be set on the context. The flags indicating
* which parameters need to be set are given in @p paramsToSet.
* Undefined behavior may occur if a flag is set but its
* corresponding value(s) have not been properly initialized. This
* may not be nullptr.
* @returns no return value.
*
* @remarks This sets one or more context parameters in a single call. Only parameters that
* have their corresponding flag set in @p paramsToSet will be modified. If a
* change is to be relative to the context's current parameter value, the current
* value should be retrieved first, modified, then set.
*/
void(CARB_ABI* setContextParameters)(Context* context, ContextParamFlags paramsToSet, const ContextParams* params);
/** retrieves one or more parameters for a context.
*
* @param[in] context the context to retrieve parameters for. This may not be nullptr.
* @param[in] paramsToGet flags indicating which parameter values need to be retrieved.
* @param[out] params receives the requested parameter values. This may not be nullptr.
* @returns no return value.
*
* @remarks This retrieves the current values of one or more of a context's parameters. Only
* the parameter values listed in @p paramsToGet flags will be guaranteed to be
* valid upon return.
*/
void(CARB_ABI* getContextParameters)(Context* context, ContextParamFlags paramsToGet, ContextParams* params);
/** Change the maximum number of voices that have their output mixed to the audio device.
* @param[in] ctx The context to modify.
* @param[in] count The new number of buses to select.
* This will be clamped to @ref PlaybackContextDesc::maxBuses,
* if @p count exceeds it.
* This cannot be set to 0.
*
* @returns true if the max bus count was successfully changed.
* @returns false if any voices are still playing on buses.
* @returns false if the operation failed for any other reason (e.g. out of memory).
*
* @note This call needs to stop the audio engine, so this will block for 10-20ms
* if any voices are still playing actively.
*
* @note This should be called infrequently and only in cases where destroying
* the context is not an option.
*
* @note To use this function without introducing audio artifacts, this
* function can only be called after all voices playing on buses
* have become silent or have stopped. The easiest way to ensure this
* is to set the master volume on the context to 0.0.
* At least 10ms must elapse between the volume reduction and this
* call to ensure that the changes have taken effect.
* If voices are being stopped, 20ms must occur between the last
* stopped voice and this call.
*/
bool(CARB_ABI* setBusCount)(Context* ctx, size_t count);
/** sets the [real biological] listener-relative position for all speakers.
*
* @param[in] context the context object to set the speaker positions for. This may not be
* nullptr.
* @param[in] desc a descriptor of the new speaker directions to set for the context.
* This may be nullptr to restore the default speaker directions for the
* currently selected device if it supports a standard speaker mode
* channel count.
* @returns true if the new speaker layout is successfully set.
* @returns false if the call fails or the given speaker mode doesn't match what the device
* was opened at.
*
* @remarks This allows a custom user-relative direction to be set for all speakers. Note
* that these represent the positions of the speakers in the real physical world
* not an entity in the simulated world. A speaker direction is specified as a
* 3-space vector with a left-to-right position, a front-to-back position, and a
* top-to-bottom position. Each coordinate is expected to be within the range
* -1.0 (left, back, or bottom) to 1.0 (right, front, or top). Each speaker
* direction is specified with these three explicit positions instead of an
* X/Y/Z vector to avoid confusion between various common coordinate systems
* (ie: graphics systems often treat negative Z as forward into the screen whereas
* audio systems often treat Z as up).
*
* @remarks When a new device is selected with setOutput(), any previous custom speaker
* directions will be reset to the implicit positions of the new speaker mode. The
* new speaker directions are defined on a cube where the origin (ie: the
* point (0, 0, 0)) represents the position of the user at the center of the
* cube. All values should range from -1.0 to 1.0. The given speaker direction
* vectors do not need to be normalized - this will be done internally. The
* distance from the origin is not important and does not affect spatial sound
* calculations. Only the speaker directions from the user are important.
*
* @remarks These speaker directions are used to affect how spatial audio calculations map
* from the simulated world to the physical world. They will affect the left-to-
* right, front-to-back, and top-to-bottom balancing of the different sound channels
* in each spatial sound calculation.
*
* @note For most applications, setting custom speaker directions is not necessary. This
* would be necessary in situations that use custom speaker modes, situations
* where the expected speaker layout is drastically different from any of the
* standard speaker modes that may be chosen (ie: a car speaker system), or when
* the speaker count does not map to a standard kSpeakerMode* speaker mode.
*
* @note An output must have been successfully selected on the context before this call
* can succeed. This can be checked by verifying that the context caps block's
* @a selectedDevice.flags member is not @ref fDeviceFlagNotOpen.
*/
bool(CARB_ABI* setSpeakerDirections)(Context* context, const SpeakerDirectionDesc* desc);
/** opens a requested audio output device and begins output.
*
* @param[in] context the context object that will have its device index set. This is
* returned from a previous call to createContext(). This must not
* be nullptr.
* @param[in] desc the descriptor of the output to open. This may be nullptr to
* use the default system output device.
* @retval AudioResult::eOk if the requested device is successfully opened.
* @retval AudioResult::eOutOfRange if the device index is invalid.
* @returns an AudioResult::* error code if the operation fails for any other reason. See
* the notes below for more information on failures.
*
* @remarks This sets the index of the audio output device that will be opened and attempts
* to open it. An index of 0 will open the system's default audio output device.
* Note that the device index value is volatile and could change at any time due
* to user activity. It is suggested that the device index be chosen as closely
* as possible to when the device will be opened.
*
* @remarks This allows an existing audio context object to switch to using a different audio
* device for its output after creation without having to destroy and recreate the
* current state of the context. Once a new device is selected, it will be
* available to start processing and outputting audio. Note that switching audio
* devices dynamically may cause an audible pop to occur on both the old device and
* new device depending on the current state of the context. To avoid this, all
* active voices could be muted or paused briefly during the device switch, then
* resumed or un-muted after it completes.
*
* @note If selecting the new device fails, the context will be left without a device to
* play its output on. Upon failure, an attempt to open the system's default device
* may be made by the caller to restore the playback. Note that even choosing the
* system default device may fail for various reasons (ie: the speaker mode of the
* new device cannot be mapped properly, the device is no longer available in the
* system, etc). In this case, all audio processing will still continue but the
* final audio data will just be dropped until a valid output target is connected.
*/
AudioResult(CARB_ABI* setOutput)(Context* context, const OutputDesc* desc);
/** performs required frequent updates for the audio context.
*
* @param[in] context the context object to perform update tasks on.
* @retval AudioResult::eOk if the update is performed successfully.
* @retval AudioResult::eDeviceDisconnected or @ref AudioResult::eDeviceLost if the
* currently selected device has been removed from the system.
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @retval AudioResult::eInvalidParameter if an invalid context is passed in.
* @returns an AudioResult::* error code if the update fails for any other reason.
*
* @remarks This performs common update tasks. Updates need to be performed frequently.
* This will perform any pending callbacks and will ensure that all pending
* parameter changes have been updated in the engine context. This should still
* be called periodically even if no object parameter changes occur.
*
* @remarks All non-realtime voice callbacks will be performed during this call. All
* device change callbacks on the context will also be performed here. Failing
* to call this periodically may cause events to be lost.
*/
AudioResult(CARB_ABI* update)(Context* context);
/** starts the audio processing engine for a context.
*
* @param[in] context the context to start the processing engine for. This must not be
* nullptr.
* @returns no return value.
*
* @remarks This starts the audio processing engine for a context. When creating a playback
* context, the processing engine will always be automatically started. When
* creating a baking context, the processing engine must always be started
* explicitly. This allows the baking operation to be fully setup (ie: queue all
* sounds to be played, set all parameters, etc) before any audio is processed.
* This prevents the baked result from containing an indeterminate amount of silence
* at the start of its stream.
*
* @remarks When using a playback context, this does not need to be called unless the engine
* is being restarted after calling stopProcessing().
*/
void(CARB_ABI* startProcessing)(Context* context);
/** stops the processing engine for a context.
*
* @param[in] context the context to stop the processing engine for. This must not be
* nullptr.
* @returns no return value.
*
* @remarks This stops the audio processing engine for a context. For a playback context,
* this is not necessary unless all processing needs to be halted for some reason.
* For a baking context, this is only necessary if the fContextFlagManualStop flag
* was used when creating the context. If that flags is used, the processing
* engine will be automatically stopped any time it runs out of data to process.
*
* @note Stopping the engine is not the same as pausing the output. Stopping the engine
* will cause any open streamers to be closed and will likely cause an audible pop
* when restarting the engine with startProcessing().
*/
void(CARB_ABI* stopProcessing)(Context* context);
/********************************** sound management functions *******************************/
/** schedules a sound to be played on a voice.
*
* @param[in] context the context to play the new sound on. This must not be nullptr.
* @param[in] desc the descriptor of the play task to be performed. This may not be
* nullptr.
* @returns a new voice handle representing the playing sound. Note that if no buses are
* currently available to play on or the voice's initial parameters indicated that
* it is not currently audible, the voice will be virtual and will not be played.
* The voice handle will still be valid in this case and can be operated on, but
* no sound will be heard from it until it is determined that it should be converted
* to a real voice. This can only occur when the update() function is called.
* This voice handle does not need to be closed or destroyed. If the voice finishes
* its play task, any future calls attempting to modify the voice will simply fail.
* @returns nullptr if the requested sound is already at or above its instance limit and the
* @ref fPlayFlagMaxInstancesSimulate flag is not used.
* @returns nullptr if the play task was invalid or could not be started properly. This can
* most often occur in the case of streaming sounds if the sound's original data
* could not be opened or decoded properly.
*
* @remarks This schedules a sound object to be played on a voice. The sounds current
* settings (ie: volume, pitch, playback frame rate, pan, etc) will be assigned to
* the voice as 'defaults' before playing. Further changes can be made to the
* voice's state at a later time without affecting the sound's default settings.
*
* @remarks Once the sound finishes playing, it will be implicitly unassigned from the
* voice. If the sound or voice have a callback set, a notification will be
* received for the sound having ended.
*
* @remarks If the playback of this sound needs to be stopped, it must be explicitly stopped
* from the returned voice object using stopVoice(). This can be called on a
* single voice or a voice group.
*/
Voice*(CARB_ABI* playSound)(Context* context, const PlaySoundDesc* desc);
/** stops playback on a voice.
*
* @param[in] voice the voice to stop.
* @returns no return value.
*
* @remarks This stops a voice from playing its current sound. This will be silently
* ignored for any voice that is already stopped or for an invalid voice handle.
* Once stopped, the voice will be returned to a 'free' state and its sound data
* object unassigned from it. The voice will be immediately available to be
* assigned a new sound object to play from.
*
* @note This will only schedule the voice to be stopped. Its volume will be implicitly
* set to silence to avoid a popping artifact on stop. The voice will continue to
* play for one more engine cycle until the volume level reaches zero, then the voice
* will be fully stopped and recycled. At most, 1ms of additional audio will be
* played from the voice's sound.
*/
void(CARB_ABI* stopVoice)(Voice* voice);
/********************************** voice management functions *******************************/
/** retrieves the sound (if any) that is currently active on a voice.
*
* @param[in] voice the voice to retrieve the active sound for.
* @returns the sound object that is currently playing on the requested voice.
* @returns nullptr if the voice is not currently playing any sound object.
* @returns nullptr if the given voice handle is no longer valid.
*
* @remarks This retrieves the sound data object that is currently being processed on a
* voice. This can be used to make a connection between a voice and the sound
* data object it is currently processing.
*
* @note If @p voice ends, the returned sound will be freed in the next
* update() call. It is the caller's responsibility to call
* IAudioData::acquire() if the object is going to be held until
* after that update() call. It is also the caller's responsibility
* to ensure acquiring this reference is done in a thread safe
* manner with respect to the update() call.
*/
SoundData*(CARB_ABI* getPlayingSound)(Voice* voice);
/** checks the playing state of a voice.
*
* @param[in] voice the voice to check the playing state for.
* @returns true if the requested voice is playing.
* @returns false if the requested voice is not playing or is paused.
* @returns false if the given voice handle is no longer valid.
*
* @remarks This checks if a voice is currently playing. A voice is considered playing if
* it has a currently active sound data object assigned to it, it is not paused,
* and its play task has not completed yet. This will start failing immediately
* upon the voice completing its play task instead of waiting for the voice to
* be recycled on the next update() call.
*/
bool(CARB_ABI* isPlaying)(Voice* voice);
/** sets a new loop point as current on a voice.
*
* @param[in] voice the voice to set the loop point on. This may not be nullptr.
* @param[in] desc descriptor of the new loop point to set. This may contain a loop
* or event point from the sound itself or an explicitly specified
* loop point. This may be nullptr to indicate that the current loop
* point should be removed and the current loop broken. Similarly,
* an empty loop point descriptor could be passed in to remove the
* current loop point.
* @returns true if the new loop point is successfully set.
* @returns false if the voice handle is invalid or the voice has already stopped on its own.
* @returns false if the new loop point is invalid, not found in the sound data object, or
* specifies a starting point or length that is outside the range of the sound data
* object's buffer.
*
* @remarks This sets a new loop point for a playing voice. This allows for behavior such
* as sound atlases or sound playlists to be played out on a single voice. Ideally
* this should be called from a @ref VoiceCallbackType::eLoopPoint callback to
* ensure the new buffer is queued without allowing the voice to finish on its own
* and to prevent a potential race condition between the engine and the host app
* setting the new loop point. Calling this in a real-time callback would guarantee
* no race would occur, however it could still be done safely in a non-real-time
* callback if the voice's current loop region is long enough and the update()
* function is called frequently enough.
*
* @remarks This could also be called from a @ref VoiceCallbackType::eSoundEnded callback,
* but only if it is done in a real-time callback. In a non-real-time callback
* the voice handle will already have been invalidated by the time the update()
* function performs the callback.
*
* @remarks When @p desc is nullptr or the contents of the descriptor do not specify a new
* loop point, this will immediately break the loop that is currently playing on
* the voice. This will have the effect of setting the voice's current loop count
* to zero. The sound on the voice will continue to play out its current loop
* iteration, but will not loop again when it reaches its end. This is useful for
* stopping a voice that is playing an infinite loop or to prematurely stop a voice
* that was set to loop a specific number of times. This call will effectively be
* ignored if passed in a voice that is not currently looping.
*
* @note For streaming voices, updating a loop point will have a delay due to buffering
* the decoded data. The sound will loop an extra time if the loop point is changed
* after the buffering has started to consume another loop. The default buffer time
* for streaming sounds is currently 200 milliseconds, so this is the minimum slack
* time that needs to be given for a loop change. This means that changing
* a loop point in a @ref VoiceCallbackType::eLoopPoint callback will result in an
* extra loop occurring for a streaming sound.
*/
bool(CARB_ABI* setLoopPoint)(Voice* voice, const LoopPointDesc* desc);
/** retrieves the current play cursor position of a voice.
*
* @param[in] voice the voice to retrieve the play position for.
* @param[in] type the units to retrieve the current position in.
* @returns the current position of the voice in the requested units.
* @returns 0 if the voice does not have a sound assigned to it.
* @returns the last play cursor position if the voice is paused.
*
* @remarks This retrieves the current play position for a voice. This is not necessarily
* the position in the buffer being played, but rather the position in the sound
* data object's stream. For streaming sounds, this will be the offset from the
* start of the stream. For non-streaming sounds, this will be the offset from
* the beginning of the sound data object's buffer.
*
* @note If the loop point for the voice changes during playback, the results of this
* call can be unexpected. Once the loop point changes, there is no longer a
* consistent time base for the voice and the results will reflect the current
* position based off of the original loop's time base. As long as the voice's
* original loop point remains (ie: setLoopPoint() is never called on the voice),
* the calculated position should be correct.
*
* @note It is the caller's responsibility to ensure that this is not called at the same
* time as changing the loop point on the voice or stopping the voice.
*/
size_t(CARB_ABI* getPlayCursor)(Voice* voice, UnitType type);
/** sets one or more parameters on a voice.
*
* @param[in] voice the voice to set the parameter(s) on.
* @param[in] paramsToSet flags to indicate which of the parameters need to be updated.
* This may be one or more of the fVoiceParam* flags. If this is
* 0, this will simply be a no-op.
* @param[in] params the parameter(s) to be set on the voice. The flags indicating
* which parameters need to be set must be set in
* @p paramsToSet by the caller. Undefined behavior
* may occur if a flag is set but its corresponding value(s) have
* not been properly initialized. This may not be nullptr.
* @returns no return value.
*
* @remarks This sets one or more voice parameters in a single call.
* Only parameters that have their corresponding flag set in @p
* paramsToSet will be modified.
* If a change is to be relative to the voice's current parameter value, the current
* value should be retrieved first, modified, then set.
*
* @note only one of @ref fPlaybackModeSimulatePosition or
* @ref fPlaybackModeNoPositionSimulation can be set in the playback
* mode. If none or both of the flags are set, the previous value of
* those two bits will be used.
*/
void(CARB_ABI* setVoiceParameters)(Voice* voice, VoiceParamFlags paramsToSet, const VoiceParams* params);
/** retrieves one or more parameters for a voice.
*
* @param[in] voice the voice to retrieve parameters for.
* @param[in] paramsToGet flags indicating which parameter values need to be retrieved.
* @param[out] params receives the requested parameter values. This may not be nullptr.
* @returns no return value.
*
* @remarks This retrieves the current values of one or more of a voice's parameters. Only
* the parameter values listed in @p paramsToGet flags will be guaranteed to be
* valid upon return.
*/
void(CARB_ABI* getVoiceParameters)(Voice* voice, VoiceParamFlags paramsToGet, VoiceParams* params);
/** stops playback on all voices in a given context.
*
* @param[in] context the context where to stop playback the voices.
*
* @remarks The input context parameter can be nullptr, meaning to stop playback on all
* voices in all contexts in the context table.
*/
void(CARB_ABI* stopAllVoices)(Context* context);
};
} // namespace audio
} // namespace carb
| 152,738 | C | 57.319588 | 119 | 0.702333 |
omniverse-code/kit/include/carb/audio/AudioTypes.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Data types used by the audio interfaces.
*/
#pragma once
#include "../assets/AssetsTypes.h"
#include "carb/Types.h"
#include "carb/extras/Guid.h"
namespace carb
{
namespace audio
{
/** represents a single audio context object. This contains the state for a single instance of
* one of the low-level audio plugins. This is to be treated as an opaque handle to an object
* and should only passed into the function of the plugin that created it.
*/
struct Context DOXYGEN_EMPTY_CLASS;
/** represents a single instance of a playing sound. A single sound object may be playing on
* multiple voices at the same time, however each voice may only be playing a single sound
* at any given time.
*/
struct Voice DOXYGEN_EMPTY_CLASS;
/** various limits values for the audio system.
* @{
*/
constexpr size_t kMaxNameLength = 512; ///< maximum length of a device name in characters.
constexpr size_t kMaxChannels = 64; ///< maximum number of channels supported for output.
constexpr size_t kMinChannels = 1; ///< minimum number of channels supported for capture or output.
constexpr size_t kMaxFrameRate = 200000; ///< maximum frame rate of audio that can be processed.
constexpr size_t kMinFrameRate = 1000; ///< minimum frame rate of audio that can be processed.
/** @} */
/** description of how a size or offset value is defined. This may be given as a */
enum class UnitType : uint32_t
{
eBytes, ///< the size or offset is given as a byte count.
eFrames, ///< the size or offset is given as a frame count.
eMilliseconds, ///< the size or offset is given as a time in milliseconds.
eMicroseconds, ///< the size or offset is given as a time in microseconds.
};
/** possible return values from various audio APIs. These indicate the kind of failure that
* occurred.
*/
enum class AudioResult
{
eOk, ///< the operation was successful.
eDeviceDisconnected, ///< the device was disconnected from the system.
eDeviceLost, ///< access to the device was lost.
eDeviceNotOpen, ///< the device has not been opened yet.
eDeviceOpen, ///< the device has already been opened.
eOutOfRange, ///< a requested parameter was out of range.
eTryAgain, ///< the operation should be retried at a later time.
eOutOfMemory, ///< the operation failed due to a lack of memory.
eInvalidParameter, ///< an invalid parameter was passed in.
eNotAllowed, ///< this operation is not allowed on the object type.
eNotFound, ///< the resource requested, such as a file, was not found.
eIoError, ///< an error occurred in an IO operation.
eInvalidFormat, ///< the format of a resource was invalid.
eOverrun, ///< An overrun occurred
eNotSupported, ///< the resource or operation used is not supported.
};
/** speaker names. Speakers are virtually located on the unit circle with the listener at the
* fSpeakerFlagFrontCenter. Speaker angles are relative to the positive Y axis (ie: forward
* from the listener). Angles increase in the clockwise direction. The top channels are
* located on the unit sphere at an inclination of 45 degrees.
* The channel order of these speakers is represented by the ordering of speakers in this
* enum (e.g. eSideLeft is after eBackLeft).
*/
enum class Speaker
{
eFrontLeft, ///< Front left speaker. Usually located at -45 degrees. Also used for left headphone.
eFrontRight, ///< Front right speaker. Usually located at 45 degrees. Also used for right headphone.
eFrontCenter, ///< Front center speaker. Usually located at 0 degrees.
eLowFrequencyEffect, ///< Low frequency effect speaker (subwoofer). Usually treated as if it is located at the
///< listener.
eBackLeft, ///< Back left speaker. Usually located at -135 degrees.
eBackRight, ///< Back right speaker. Usually located at 135 degrees.
eBackCenter, ///< Back center speaker. Usually located at 180 degrees.
eSideLeft, ///< Side left speaker. Usually located at -90 degrees.
eSideRight, ///< Side right speaker. Usually located at 90 degrees.
eTopFrontLeft, ///< Top front left speaker. Usually located at -45 degrees and raised vertically.
eTopFrontRight, ///< Top front right speaker. Usually located at 45 degrees and raised vertically.
eTopBackLeft, ///< Top back left speaker. Usually located at -135 degrees and raised vertically.
eTopBackRight, ///< Top back right speaker. Usually located at 135 degrees and raised vertically.
eFrontLeftWide, ///< Front left wide speaker. Usually located at -60 degrees.
eFrontRightWide, ///< Front left wide speaker. Usually located at 60 degrees.
eTopLeft, ///< Top left speaker. Usually located at -90 degrees and raised vertically.
eTopRight, ///< Top right speaker. Usually located at 90 degrees and raised vertically.
eCount, ///< Total number of named speakers. This is not a valid speaker name.
};
/** the base type for a set of speaker flag masks. This can be any combination of the
* fSpeakerFlag* speaker names, or one of the kSpeakerMode names.
*/
typedef uint64_t SpeakerMode;
/** @brief a conversion function from a Speaker enum to bitflags.
* @param[in] s The speaker enum to convert to a bitflag.
* @returns The corresponding speaker flag.
*/
constexpr SpeakerMode makeSpeakerFlag(Speaker s)
{
return 1ull << static_cast<SpeakerMode>(s);
}
/** @brief a conversion function from a Speaker enum to bitflags.
* @param[in] s The speaker enum to convert to a bitflag.
* @returns The corresponding speaker flag.
*/
constexpr SpeakerMode makeSpeakerFlag(size_t s)
{
return makeSpeakerFlag(static_cast<Speaker>(s));
}
/** Speaker bitflags that can be used to create speaker modes.
* @{
*/
/** @copydoc Speaker::eFrontLeft */
constexpr SpeakerMode fSpeakerFlagFrontLeft = makeSpeakerFlag(Speaker::eFrontLeft);
/** @copydoc Speaker::eFrontRight */
constexpr SpeakerMode fSpeakerFlagFrontRight = makeSpeakerFlag(Speaker::eFrontRight);
/** @copydoc Speaker::eFrontCenter */
constexpr SpeakerMode fSpeakerFlagFrontCenter = makeSpeakerFlag(Speaker::eFrontCenter);
/** @copydoc Speaker::eLowFrequencyEffect */
constexpr SpeakerMode fSpeakerFlagLowFrequencyEffect = makeSpeakerFlag(Speaker::eLowFrequencyEffect);
/** @copydoc Speaker::eSideLeft */
constexpr SpeakerMode fSpeakerFlagSideLeft = makeSpeakerFlag(Speaker::eSideLeft);
/** @copydoc Speaker::eSideRight */
constexpr SpeakerMode fSpeakerFlagSideRight = makeSpeakerFlag(Speaker::eSideRight);
/** @copydoc Speaker::eBackLeft */
constexpr SpeakerMode fSpeakerFlagBackLeft = makeSpeakerFlag(Speaker::eBackLeft);
/** @copydoc Speaker::eBackRight */
constexpr SpeakerMode fSpeakerFlagBackRight = makeSpeakerFlag(Speaker::eBackRight);
/** @copydoc Speaker::eBackCenter */
constexpr SpeakerMode fSpeakerFlagBackCenter = makeSpeakerFlag(Speaker::eBackCenter);
/** @copydoc Speaker::eTopFrontLeft */
constexpr SpeakerMode fSpeakerFlagTopFrontLeft = makeSpeakerFlag(Speaker::eTopFrontLeft);
/** @copydoc Speaker::eTopFrontRight */
constexpr SpeakerMode fSpeakerFlagTopFrontRight = makeSpeakerFlag(Speaker::eTopFrontRight);
/** @copydoc Speaker::eTopBackLeft */
constexpr SpeakerMode fSpeakerFlagTopBackLeft = makeSpeakerFlag(Speaker::eTopBackLeft);
/** @copydoc Speaker::eTopBackRight */
constexpr SpeakerMode fSpeakerFlagTopBackRight = makeSpeakerFlag(Speaker::eTopBackRight);
/** @copydoc Speaker::eFrontLeftWide */
constexpr SpeakerMode fSpeakerFlagFrontLeftWide = makeSpeakerFlag(Speaker::eFrontLeftWide);
/** @copydoc Speaker::eFrontRightWide */
constexpr SpeakerMode fSpeakerFlagFrontRightWide = makeSpeakerFlag(Speaker::eFrontRightWide);
/** @copydoc Speaker::eTopLeft */
constexpr SpeakerMode fSpeakerFlagTopLeft = makeSpeakerFlag(Speaker::eTopLeft);
/** @copydoc Speaker::eTopRight */
constexpr SpeakerMode fSpeakerFlagTopRight = makeSpeakerFlag(Speaker::eTopRight);
/** @} */
/** the special name for an invalid speaker. Since a speaker mode could also include custom
* bits for unnamed speakers, there needs to be a way to represent failure conditions when
* converting between speaker flags and speaker names.
*/
constexpr size_t kInvalidSpeakerName = ~0ull;
/** common speaker layout modes. These put together a specific set of channels that describe how
* a speaker mode is laid out around the listener.
* @{
*/
/** a special speaker mode that indicates that the audio device's preferred speaker mode
* should be used in the mixer. The individual speaker positions may not be changed
* with setSpeakerDirections() when using this mode.
*/
constexpr SpeakerMode kSpeakerModeDefault = 0;
/** a mono speaker mode. Only a single channel is supported. The one speaker is often
* treated as being positioned at the fSpeakerFlagFrontCenter in front of the listener
* even though it is labeled as 'left'.
*/
constexpr SpeakerMode kSpeakerModeMono = fSpeakerFlagFrontLeft;
/** a stereo speaker mode. This supports two channels. These are usually located at
* -90 degrees and 90 degrees.
*/
constexpr SpeakerMode kSpeakerModeStereo = fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight;
/** A three speaker mode. This has two front speakers and a low frequency effect speaker.
* The speakers are usually located at -45 and 45 degrees.
*/
constexpr SpeakerMode kSpeakerModeTwoPointOne =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagLowFrequencyEffect;
/** a four speaker mode. This has two front speakers and two side or back speakers. The
* speakers are usually located at -45, 45, -135, and 135 degrees around the listener.
*/
constexpr SpeakerMode kSpeakerModeQuad =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight;
/** a five speaker mode. This has two front speakers and two side or back speakers
* and a low frequency effect speaker. The speakers are usually located at -45, 45,
* -135, and 135 degrees around the listener.
*/
constexpr SpeakerMode kSpeakerModeFourPointOne = fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagBackLeft |
fSpeakerFlagBackRight | fSpeakerFlagLowFrequencyEffect;
/** a six speaker mode. This represents a standard 5.1 home theater setup. Speakers are
* usually located at -45, 45, 0, 0, -135, and 135 degrees.
*/
constexpr SpeakerMode kSpeakerModeFivePointOne = fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight |
fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagBackLeft | fSpeakerFlagBackRight;
/** a seven speaker mode. This is an non-standard speaker layout.
* Speakers in this layout are located at -45, 45, 0, 0, -90, 90 and 180 degrees.
*/
constexpr SpeakerMode kSpeakerModeSixPointOne = fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight |
fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagBackCenter | fSpeakerFlagSideLeft | fSpeakerFlagSideRight;
/** an eight speaker mode. This represents a standard 7.1 home theater setup. Speakers are
* usually located at -45, 45, 0, 0, -90, 90, -135, and 135 degrees.
*/
constexpr SpeakerMode kSpeakerModeSevenPointOne =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagSideLeft | fSpeakerFlagSideRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight;
/** a ten speaker mode. This represents a standard 9.1 home theater setup. Speakers are
* usually located at -45, 45, 0, 0, -90, 90, -135, 135, -60 and 60 degrees.
*/
constexpr SpeakerMode kSpeakerModeNinePointOne =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagSideLeft | fSpeakerFlagSideRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight |
fSpeakerFlagFrontLeftWide | fSpeakerFlagFrontRightWide;
/** a twelve speaker mode. This represents a standard 7.1.4 home theater setup. The lower
* speakers are usually located at -45, 45, 0, 0, -90, 90, -135, and 135 degrees. The upper
* speakers are usually located at -45, 45, -135, and 135 at an inclination of 45 degrees.
*/
constexpr SpeakerMode kSpeakerModeSevenPointOnePointFour =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagSideLeft | fSpeakerFlagSideRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight |
fSpeakerFlagTopFrontLeft | fSpeakerFlagTopFrontRight | fSpeakerFlagTopBackLeft | fSpeakerFlagTopBackRight;
/** a fourteen speaker mode. This represents a standard 9.1.4 home theater setup. The lower
* speakers are usually located at -45, 45, 0, 0, -90, 90, -135, 135, -60 and 60 degrees. The upper
* speakers are usually located at -45, 45, -135, and 135 at an inclination of 45 degrees.
*/
constexpr SpeakerMode kSpeakerModeNinePointOnePointFour =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagSideLeft | fSpeakerFlagSideRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight |
fSpeakerFlagFrontLeftWide | fSpeakerFlagFrontRightWide | fSpeakerFlagTopFrontLeft | fSpeakerFlagTopFrontRight |
fSpeakerFlagTopBackLeft | fSpeakerFlagTopBackRight;
/** a sixteen speaker mode. This represents a standard 9.1.6 home theater setup. The lower
* speakers are usually located at -45, 45, 0, 0, -90, 90, -135, 135, -60 and 60 degrees. The upper
* speakers are usually located at -45, 45, -135, 135, -90 and 90 degrees at an inclination of 45 degrees.
*/
constexpr SpeakerMode kSpeakerModeNinePointOnePointSix =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagSideLeft | fSpeakerFlagSideRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight |
fSpeakerFlagFrontLeftWide | fSpeakerFlagFrontRightWide | fSpeakerFlagTopFrontLeft | fSpeakerFlagTopFrontRight |
fSpeakerFlagTopBackLeft | fSpeakerFlagTopBackRight | fSpeakerFlagTopLeft | fSpeakerFlagTopRight;
/** A linear surround setup.
* This is the 3 channel layout in formats using Vorbis channel order.
*/
constexpr SpeakerMode kSpeakerModeThreePointZero =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter;
/** @ref kSpeakerModeFivePointOne without the low frequency effect speaker.
* This is used as the 5 channel layout in formats using Vorbis channel order.
*/
constexpr SpeakerMode kSpeakerModeFivePointZero = fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight |
fSpeakerFlagFrontCenter | fSpeakerFlagBackLeft | fSpeakerFlagBackRight;
/** the total number of 'standard' speaker modes represented here. Other custom speaker modes
* are still possible however by combining the fSpeakerFlag* names in different ways.
*/
constexpr size_t kSpeakerModeCount = 7;
/** All valid speaker mode bits.
*/
constexpr SpeakerMode fSpeakerModeValidBits =
fSpeakerFlagFrontLeft | fSpeakerFlagFrontRight | fSpeakerFlagFrontCenter | fSpeakerFlagLowFrequencyEffect |
fSpeakerFlagSideLeft | fSpeakerFlagSideRight | fSpeakerFlagBackLeft | fSpeakerFlagBackRight |
fSpeakerFlagFrontLeftWide | fSpeakerFlagFrontRightWide | fSpeakerFlagTopFrontLeft | fSpeakerFlagTopFrontRight |
fSpeakerFlagTopBackLeft | fSpeakerFlagTopBackRight | fSpeakerFlagTopLeft | fSpeakerFlagTopRight;
/** @} */
/** flags to indicate the current state of a device in the system. This may be any combination
* of the fDeviceFlag* flags.
*/
typedef uint32_t DeviceFlags;
/** flags to indicate the current state of a device. These are used in the @a flags member of
* the @ref DeviceCaps struct.
* @{
*/
constexpr DeviceFlags fDeviceFlagNotOpen = 0x00000000; ///< no device is currently open.
constexpr DeviceFlags fDeviceFlagConnected = 0x00000001; ///< the device is currently connected to the system.
constexpr DeviceFlags fDeviceFlagDefault = 0x00000002; ///< the device is the system default or preferred device.
constexpr DeviceFlags fDeviceFlagStreamer = 0x00000004; ///< a streamer is being used as an output.
/** @} */
/** prototype for the optional destructor function for a user data object.
*
* @param[in] userData the user data object to be destroyed. This will never be nullptr.
* @returns no return value.
*
* @remarks This destroys the user data object associated with an object. The parent object may
* be a sound data object or sound group, but is irrelevant here since it is not passed
* into this destructor. This destructor is optional. If specified, it will be called
* any time the user data object is replaced with a setUserData() function or when the
* containing object itself is being destroyed.
*/
typedef void(CARB_ABI* UserDataDestructor)(void* userData);
/** an opaque user data object that can be attached to some objects (ie: sound data objects, sound
* groups, etc).
*/
struct UserData
{
/** the opaque user data pointer associated with this entry. The caller is responsible for
* creating this object and ensuring its contents are valid.
*/
void* data = nullptr;
/** the optional destructor that will be used to clean up the user data object whenever it is
* replaced or the object containing this user data object is destroyed. This may be nullptr
* if no clean up is needed for the user data object. It is the host app's responsibility
* to ensure that either this destructor is provided or that the user data object is manually
* cleaned up before anything it is attached to is destroyed.
*/
UserDataDestructor destructor = nullptr;
};
/** the data type for a single sample of raw audio data. This describes how each sample in the
* data buffer should be interpreted. In general, audio data can only be uncompressed Pulse
* Code Modulation (PCM) data, or encoded in some kind of compressed format.
*/
enum class SampleFormat : uint32_t
{
/** 8 bits per sample unsigned integer PCM data. Sample values will range from 0 to 255
* with a value of 128 being 'silence'.
*/
ePcm8,
/** 16 bits per sample signed integer PCM data. Sample values will range from -32768 to
* 32767 with a value of 0 being 'silence'.
*/
ePcm16,
/** 24 bits per sample signed integer PCM data. Sample values will range from -16777216
* to 16777215 with a value of 0 being 'silence'.
*/
ePcm24,
/** 32 bits per sample signed integer PCM data. Sample values will range from -2147483648
* to 2147483647 with a value of 0 being 'silence'.
*/
ePcm32,
/** 32 bits per sample floating point PCM data. Sample values will range from -1.0 to 1.0
* with a value of 0.0 being 'silence'. Note that floating point samples can extend out
* of their range (-1.0 to 1.0) without a problem during mixing. However, once the data
* reaches the device, any samples beyond the range from -1.0 to 1.0 will clip and cause
* distortion artifacts.
*/
ePcmFloat,
/** the total number of PCM formats. This is not a valid format and is only used internally
* to determine how many PCM formats are available.
*/
ePcmCount,
/** The Vorbis codec.
* Vorbis is a lossy compressed codec that is capable of producing high
* quality audio that is difficult to differentiate from lossless codecs.
* Vorbis is suitable for music and other applications that require
* minimal quality loss.
* Vorbis is stored in Ogg file containers (.ogg or .oga).
* Vorbis has a variable block size, with a maximum of 8192 frames per
* block, which makes it non-optimal for low latency audio transfer (e.g.
* voice chat); additionally, the Ogg container combines Vorbis blocks
* into chunks that can be seconds long.
* libvorbis will accept frame rates of 1Hz - 200KHz (Note that IAudioPlayback
* does not supports framerates below @ref kMinFrameRate).
* Vorbis is able to handle up to 255 channels, but sounds with more than 8
* channels have no official ordering. (Note that does not support more than @ref kMaxChannels)
*
* Vorbis has a defined channel mapping for audio with 1-8 channels.
* Channel counts 3 and 5 have an incompatible speaker layout with the
* default layouts in this plugin.
* A 3 channel layout uses @ref kSpeakerModeThreePointZero,
* A 5 channel layout uses @ref kSpeakerModeFivePointZero
* For streams with more than 8 channels, the mapping is undefined and
* must be determined by the application.
*
* These are the results of decoding speed tests run on Vorbis; they are
* shown as the decoding time relative to decoding a 16 bit uncompressed
* WAVE file to @ref SampleFormat::ePcm32. Clip 1 and 2 are stereo music.
* Clip 3 is a mono voice recording. Clip 1 has low inter-channel
* correlation; Clip 2 has high inter-channel correlation.
* Note that the bitrates listed here are approximate, since Vorbis is
* variable bitrate.
* - clip 1, 0.0 quality (64kb/s): 668%
* - clip 1, 0.4 quality (128kb/s): 856%
* - clip 1, 0.9 quality (320kb/s): 1333%
* - clip 2, 0.0 quality (64kb/s): 660%
* - clip 2, 0.4 quality (128kb/s): 806%
* - clip 2, 0.9 quality (320kb/s): 1286%
* - clip 3, 0.0 quality (64kb/s): 682%
* - clip 3, 0.4 quality (128kb/s): 841%
* - clip 3, 0.9 quality (320kb/s): 1074%
*
* These are the file sizes from the previous tests:
* - clip 1, uncompressed: 32.7MiB
* - clip 1, 0.0 quality (64kb/s): 1.5MiB
* - clip 1, 0.4 quality (128kb/s): 3.0MiB
* - clip 1, 0.9 quality (320kb/s): 7.5MiB
* - clip 2, uncompressed: 49.6MiB
* - clip 2, 0.0 quality (64kb/s): 2.0MiB
* - clip 2, 0.4 quality (128kb/s): 4.0MiB
* - clip 2, 0.9 quality (320kb/s): 10.4MiB
* - clip 3, uncompressed: 9.0MiB
* - clip 3, 0.0 quality (64kb/s): 0.9MiB
* - clip 3, 0.4 quality (128kb/s): 1.4MiB
* - clip 3, 0.9 quality (320kb/s): 2.5MiB
*/
eVorbis,
/** The Free Lossless Audio Codec.
* This is a codec capable of moderate compression with a perfect
* reproduction of the original uncompressed signal.
* This encodes and decodes reasonable fast, but the file size is much
* larger than the size of a high quality lossy codec.
* This is suitable in applications where audio data will be repeatedly
* encoded, such as an audio editor. Unlike a lossy codec, repeatedly
* encoding the file with FLAC will not degrade the quality.
* FLAC is very fast to encode and decode compared to other compressed codecs.
* Note that FLAC only stores integer data, so audio of type
* SampleFormat::ePcmFloat will lose precision when stored as FLAC.
* Additionally, the FLAC encoder used only supports up to 24 bit, so
* SampleFormat::ePcm32 will lose some precision when being stored if there
* are more than 24 valid bits per sample.
* FLAC supports frame rates from 1Hz - 655350Hz (Note that IAudioPlayback
* only support framerates of @ref kMinFrameRate to @ref kMaxFrameRate).
* FLAC supports up to 8 channels.
*
* These are the results of decoding speed tests run on FLAC; they are
* shown as the decoding time relative to decoding a 16 bit uncompressed
* WAVE file to @ref SampleFormat::ePcm32. These are the same clips as
* used in the decoding speed test for @ref SampleFormat::eVorbis.
* has high inter-channel correlation.
* - clip 1, compression level 0: 446%
* - clip 1, compression level 5: 512%
* - clip 1, compression level 8: 541%
* - clip 2, compression level 0: 321%
* - clip 2, compression level 5: 354%
* - clip 2, compression level 8: 388%
* - clip 3, compression level 0: 262%
* - clip 3, compression level 5: 303%
* - clip 3, compression level 8: 338%
*
* These are the file sizes from the previous tests:
* - clip 1, uncompressed: 32.7MiB
* - clip 1, compression level 0: 25.7MiB
* - clip 1, compression level 5: 23.7MiB
* - clip 1, compression level 8: 23.4MiB
* - clip 2, uncompressed: 49.6MiB
* - clip 2, compression level 0: 33.1MiB
* - clip 2, compression level 5: 26.8MiB
* - clip 2, compression level 8: 26.3MiB
* - clip 3, uncompressed: 9.0MiB
* - clip 3, compression level 0: 6.2MiB
* - clip 3, compression level 5: 6.1MiB
* - clip 3, compression level 8: 6.0MiB
*
* @note Before encoding FLAC sounds with unusual framerates, please read
* the documentation for @ref FlacEncoderSettings::streamableSubset.
*/
eFlac,
/** The Opus codec.
* This is a lossy codec that is designed to be suitable for almost any
* application.
* Opus can encode very high quality lossy audio, similarly to @ref
* SampleFormat::eVorbis.
* Opus can encode very low bitrate audio at a much higher quality than
* @ref SampleFormat::eVorbis.
* Opus also offers much lower bitrates than @ref SampleFormat::eVorbis.
* Opus is designed for low latency usage, with a minimum latency of 5ms
* and a block size configurable between 2.5ms and 60ms.
* Opus also offers forward error correction to handle packet loss during
* transmission.
*
* Opus is stored in Ogg file containers (.ogg or .oga), but in use cases
* such as network transmission, Ogg containers are not necessary.
* Opus only supports sample rates of 48000Hz, 24000Hz, 16000Hz, 12000Hz and 8000Hz.
* Passing unsupported frame rates below 48KHz to the encoder will result
* in the input audio being resampled to the next highest supported frame
* rate.
* Passing frame rates above 48KHz to the encoder will result in the input
* audio being resampled down to 48KHz.
* The 'Opus Custom' format, which removes this frame rate restriction, is
* not supported.
*
* Opus has a defined channel mapping for audio with 1-8 channels.
* The channel mapping is identical to that of @ref SampleFormat::eVorbis.
* For streams with more than 8 channels, the mapping is undefined and
* must be determined by the application.
* Up to 255 audio channels are supported.
*
* Opus has three modes of operation: a linear predictive coding (LPC)
* mode, a modified discrete cosine transform (MCDT) mode and a hybrid
* mode which combines both the LPC and MCDT mode.
* The LPC mode is optimized to encode voice data at low bitrates and has
* the ability to use forward error correction and packet loss compensation.
* The MCDT mode is suitable for general purpose audio and is optimized
* for minimal latency.
*
* Because Opus uses a fixed number of frames per block, additional
* padding will be added when encoding with a @ref CodecState, unless the
* frame size is specified in advance with @ref OpusEncoderSettings::frames.
*
* These are the results of decoding speed tests run on Opus; they are
* shown as the decoding time relative to decoding a 16 bit uncompressed
* WAVE file to @ref SampleFormat::ePcm32. Clip 1 and 2 are stereo music.
* Clip 3 is a mono voice recording. Clip 1 has low inter-channel
* correlation; Clip 2 has high inter-channel correlation.
* Note that the bitrates listed here are approximate, since Opus is
* variable bitrate.
* - clip 1, 64kb/s: 975%
* - clip 1, 128kb/s: 1181%
* - clip 1, 320kb/s: 2293%
* - clip 2, 64kb/s: 780%
* - clip 2, 128kb/s: 1092%
* - clip 2, 320kb/s: 2376%
* - clip 3, 64kb/s: 850%
* - clip 3, 128kb/s: 997%
* - clip 3, 320kb/s: 1820%
*
* These are the file sizes from the previous tests:
* - clip 1, uncompressed: 32.7MiB
* - clip 1, 64kb/s: 1.5MiB
* - clip 1, 128kb/s: 3.0MiB
* - clip 1, 320kb/s: 7.5MiB
* - clip 2, uncompressed: 49.6MiB
* - clip 2, 64kb/s: 2.3MiB
* - clip 2, 128kb/s: 4.6MiB
* - clip 2, 320kb/s: 11.3MiB
* - clip 3, uncompressed: 9.0MiB
* - clip 3, 64kb/s: 1.7MiB
* - clip 3, 128kb/s: 3.3MiB
* - clip 3, 320kb/s: 6.7MiB
*/
eOpus,
/** MPEG audio layer 3 audio encoding.
* This is currently supported for decoding only; to compress audio with a
* lossy algorithm, @ref SampleFormat::eVorbis or @ref SampleFormat::eOpus
* should be used.
*
* The MP3 decoder currently only has experimental support for seeking;
* files encoded by LAME seem to seek with frame-accurate precision, but
* results may vary on other encoders.
* It is recommended to load the file with @ref fDataFlagDecode,
* if you intend to use frame-accurate loops.
*
* MP3 is faster to decode than @ref SampleFormat::eVorbis and @ref
* SampleFormat::eOpus.
* This is particularly noticeable because MP3's decoding speed is not
* affected as significantly by increasing bitrates as @ref
* SampleFormat::eVorbis and @ref SampleFormat::eOpus.
* The quality degradation of MP3 with low bitrates is much more severe
* than with @ref SampleFormat::eVorbis and @ref SampleFormat::eOpus, so
* this difference in performance is not as severe as it may appear.
* The following are the times needed to decode a sample file that is
* about 10 minutes long:
* | encoding: | time (seconds): |
* |-----------------|-----------------|
* | 45kb/s MP3 | 0.780 |
* | 64kb/s MP3 | 0.777 |
* | 128kb/s MP3 | 0.904 |
* | 320kb/s MP3 | 1.033 |
* | 45kb/s Vorbis | 1.096 |
* | 64kb/s Vorbis | 1.162 |
* | 128kb/s Vorbis | 1.355 |
* | 320kb/s Vorbis | 2.059 |
* | 45kb/s Opus | 1.478 |
* | 64kb/s Opus | 1.647 |
* | 128kb/s Opus | 2.124 |
* | 320kb/s Opus | 2.766 |
*/
eMp3,
/** the data is in an unspecified compressed format. Being able to interpret the data in
* the sound requires extra information on the caller's part.
*/
eRaw,
/** the default or preferred sample format for a device. This format name is only valid when
* selecting a device or decoding data.
*/
eDefault,
/** the number of supported sample formats. This is not a valid format and is only used
* internally to determine how many formats are available.
*/
eCount,
};
/** provides information about the format of a sound. This is used both when creating the sound
* and when retrieving information about its format. When a sound is loaded from a file, its
* format will be implicitly set on load. The actual format can then be retrieved later with
* getSoundFormat().
*/
struct SoundFormat
{
/** the number of channels of data in each frame of the audio data. */
size_t channels;
/** the number of bits per sample of the audio data. This is also encoded in the @ref format
* value, but it is given here as well for ease of use in calculations. This represents the
* number of bits in the decoded samples of the sound stream.
* This will be 0 for variable bitrate compressed formats.
*/
size_t bitsPerSample;
/** the size in bytes of each frame of data in the format. A frame consists of one sample
* per channel. This represents the size of a single frame of decoded data from the sound
* stream.
* This will be 0 for variable bitrate compressed formats.
*/
size_t frameSize;
/** The size in bytes of a single 'block' of encoded data.
* For PCM data, this is the same as a frame.
* For formats with a fixed bitrate, this is the size of a single unit of
* data that can be decoded.
* For formats with a variable bitrate, this will be 0.
* Note that certain codecs can be fixed or variable bitrate depending on
* the encoder settings.
*/
size_t blockSize;
/** The number of frames that will be decoded from a single block of data.
* For PCM formats, this will be 1.
* For formats with a fixed number of frames per block, this will be
* number of frames of data that will be produced when decoding a single
* block of data. Note that variable bitrate formats can have a fixed
* number of frames per block.
* For formats with a variable number of frames per block, this will be 0.
* Note that certain codecs can have a fixed or variable number of frames
* per block depending on the encoder settings.
*/
size_t framesPerBlock;
/** the number of frames per second that must be played back for the audio data to sound
* 'normal' (ie: the way it was recorded or produced).
*/
size_t frameRate;
/** the channel mask for the audio data. This specifies which speakers the stream is intended
* for and will be a combination of one or more of the @ref Speaker names or a
* @ref SpeakerMode name. This may be calculated from the number of channels present in the
* original audio data or it may be explicitly specified in the original audio data on load.
*/
SpeakerMode channelMask;
/** the number of bits of valid data that are present in the audio data. This may be used to
* specify that (for example) a stream of 24-bit sample data is being processed in 32-bit
* containers. Each sample will actually consist of 32-bit data in the buffer, using the
* full 32-bit range, but only the top 24 bits of each sample will be valid useful data.
* This represents the valid number of bits per sample in the decoded data for the sound
* stream.
*/
size_t validBitsPerSample;
/** the format of each sample of audio data. This is given as a symbolic name so
* that the data can be interpreted properly. The size of each sample in bits is also
* given in the @ref bitsPerSample value.
*/
SampleFormat format = SampleFormat::eDefault;
};
/** special value for @ref DeviceCaps::index to indicate that a real audio device is not currently
* selected for output. When this value is present, a streamer output is in use instead. This
* value will only ever be set on the DeviceCaps object returned in the result of the
* IAudioPlayback::getContextCaps() function.
*/
constexpr size_t kInvalidDeviceIndex = ~0ull;
/** contains information about a single audio input or output device. This information can be
* retrieved with IAudioPlayback::getDeviceCaps() or IAudioCapture::getDeviceCaps().
* Note that this information should not be stored since it can change at any time due to user
* activity (ie: unplugging a device, plugging in a new device, changing system default devices,
* etc). Device information should only be queried just before deciding which device to select.
*/
struct DeviceCaps
{
/** indicates the size of this object to allow for versioning and future expansion. This
* must be set to sizeof(DeviceCaps) before calling getDeviceCaps().
*/
size_t thisSize = sizeof(DeviceCaps);
/** the current index of this device in the enumeration order. Note that this value is highly
* volatile and can change at any time due to user action (ie: plugging in or removing a
* device from the system). When a device is added to or removed from the system, the
* information for the device at this index may change. It is the caller's responsibility
* to refresh its collected device information if the device list changes. The device at
* index 0 will always be considered the system's 'default' device.
*/
size_t index;
/** flags to indicate some attributes about this device. These may change at any time due
* to user action (ie: unplugging a device or switching system defaults). This may be 0
* or any combination of the fDeviceFlag* flags.
*/
DeviceFlags flags;
/** a UTF-8 string that describes the name of the audio device. This will most often be a
* 'friendly' name for the device that is suitable for display to the user. This cannot
* be guaranteed for all devices or platforms since its contents are defined by the device
* driver. The string will always be null terminated and may have been truncated if it
* was too long.
*/
char name[kMaxNameLength];
/** a GUID that can be used to uniquely identify the device. The GUID for a given device
* may not be the same from one process to the next, or if the device is removed from the
* system and reattached. The GUID will remain constant for the entire time the device
* is connected to the system however.
*/
carb::extras::Guid guid;
/** the preferred number of channels of data in each frame of the audio data. Selecting
* a device using a different format than this will result in extra processing overhead
* due to the format conversion.
*/
size_t channels;
/** the preferred number of frames per second that must be played back for the audio
* data to sound 'normal' (ie: the way it was recorded or produced). Selecting a
* device using a different frame rate than this will result in extra processing
* overhead due to the frame rate conversion.
*/
size_t frameRate;
/** the preferred format of each sample of audio data. This is given as a symbolic name so
* that the data can be interpreted properly. Selecting a device using a different format
* than this will result in extra processing overhead due to the format conversion.
*/
SampleFormat format = SampleFormat::eDefault;
};
/** various default values for the audio system.
* @{
*/
constexpr size_t kDefaultFrameRate = 48000; ///< default frame rate.
constexpr size_t kDefaultChannelCount = 1; ///< default channel count.
constexpr SampleFormat kDefaultFormat = SampleFormat::ePcmFloat; ///< default sample format.
/** @} */
/** An estimate of the time in microseconds below which many users cannot perceive a
* synchronization issue between a sound and the visual it should be emitted from.
* There are definitely some users that can tell there is a problem with audio/visual
* sync timing close to this value, but they may not be able to say which direction
* the sync issue goes (ie: audio first vs visual event first).
*/
constexpr int64_t kImperceptibleDelay = 200000;
} // namespace audio
} // namespace carb
| 39,920 | C | 48.591304 | 121 | 0.698272 |
omniverse-code/kit/include/carb/audio/IAudioCapture.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The audio capture interface.
*/
#pragma once
#include "../Interface.h"
#include "../assets/IAssets.h"
#include "AudioTypes.h"
namespace carb
{
namespace audio
{
/******************************** typedefs, enums, & macros **************************************/
/** prototype for a device change callback function.
*
* @param[in] context the context object that triggered the callback.
* @param[in] userData the user data value that was registered with the callback when the
* context object was created.
* @returns no return value.
*
* @remarks This callback will be performed any time an audio capture device changes its
* connection state. This includes when a device is connected to or disconnected
* from the system, or when the system's default capture device changes.
*
* @remarks Only the fact that a change occurred will be implied with this callback. It will
* not deliver specific information about the device or devices that changed (it could
* be many or just one). It is the callback's responsibility to re-discover the
* device list information and decide what if anything should be done about the
* change. The changed device is not reported due to the inherently asynchronous
* nature of device change notifications - once the callback decides to collect
* information about a device it may have already changed again.
*
* @note The callback will always be performed in the context of the thread that calls into
* the update() function. It is the callback's responsibility to ensure that any shared
* resources are accessed in a thread safe manner.
*/
typedef void(CARB_ABI* DeviceChangeCallback)(Context* context, void* userData);
/** flags to control the capture device selection. No flags are currently defined. */
typedef uint32_t CaptureDeviceFlags;
/** Ignore overruns during capture.
* IAudioCapture::lock(), IAudioCapture::read(), IAudioCapture::lock(),
* IAudioCapture::unlock() and IAudioCapture::getAvailableFrames()
* will no longer return @ref AudioResult::eOverrun when the audio device overruns.
* This may be useful in some unexpected circumstance.
*/
constexpr CaptureDeviceFlags fCaptureDeviceFlagIgnoreOverruns = 0x1;
/** describes the parameters to use when selecting a capture device. This includes the sound
* format, buffer length, and device index. This is used when selecting an audio capture device
* with IAudioCapture::setSource().
*/
struct CaptureDeviceDesc
{
/** flags to control the behavior of selecting a capture device. No flags are currently
* defined. These may be used to control how the values in @ref ext are interpreted.
*/
CaptureDeviceFlags flags = 0;
/** the index of the device to be opened. This must be less than the return value of the most
* recent call to getDeviceCount(). Note that since the capture device list can change at
* any time asynchronously due to external user action, setting any particular value here
* is never guaranteed to be valid. There is always the possibility the user could remove
* the device after its information is collected but before it is opened. Using this
* index may either fail to open or open a different device if the system's set of connected
* capture devices changes. The only value that guarantees a device will be opened (at
* least with default settings) is device 0 - the system's default capture device, as long
* as at least one is connected.
*/
size_t deviceIndex = 0;
/** the frame rate to capture audio at. Note that if this is different from the device's
* preferred frame rate (retrieved from a call to getDeviceCaps()), a resampler will have
* to be added to convert the recorded sound to the requested frame rate. This will incur
* an extra processing cost. This may be 0 to use the device's preferred frame rate. The
* actual frame rate may be retrieved with getSoundFormat().
*/
size_t frameRate = 0;
/** the number of channels to capture audio into. This should match the device's preferred
* channel count (retrieved from a recent call to getDeviceCaps()). If the channel count is
* different, the captured audio may not appear in the expected channels of the buffer. For
* example, if a mono source is used, the captured audio may only be present in the front
* left channel of the buffer. This may be 0 to use the device's preferred channel count.
* The actual channel count may be retrieved with getSoundFormat().
*/
size_t channels = 0;
/** the format of each audio sample that is captured. If this does not match the device's
* preferred sample format, a conversion will be performed internally as needed. This will
* incur an extra processing cost however. This may be @ref SampleFormat::eDefault to
* indicate that the device's preferred format should be used instead. In this case, the
* actual sample format may be retrieved with getSoundFormat(). Only PCM sample formats
* and @ref SampleFormat::eDefault are allowed.
*/
SampleFormat sampleFormat = SampleFormat::eDefault;
/** the requested length of the capture buffer. The interpretation of this size value depends
* on the @a lengthType value. This may be given as a byte count, a frame count, or a time
* in milliseconds or microseconds. This may be set to 0 to allow a default buffer length
* to be chosen. If a zero buffer size is used, the buffer's real size can be discovered
* later with a call to getBufferSize(). Note that if a buffer size is given in bytes, it
* may be adjusted slightly to ensure it is frame aligned.
*/
size_t bufferLength = 0;
/** describes how the buffer length value should be interpreted. This value is ignored if
* @ref bufferLength is 0. Note that the buffer size will always be rounded up to the next
* frame boundary even if the size is specified in bytes.
*/
UnitType lengthType = UnitType::eFrames;
/** The number of fragments that the recording buffer is divided into.
* The buffer is divided into this number of fragments; each fragment must
* be filled before the data will be returned by IAudioCapture::lock() or
* IAudioCapture::read().
* If all of the fragments are filled during a looping capture, then this
* is considered an overrun.
* This is important to configure for low latency capture; dividing the
* buffer into smaller fragments will reduce additional capture latency.
* The minimum possible capture latency is decided by the underlying audio
* device (typically 10-20ms).
* This will be clamped to the range [2, 64]
*/
size_t bufferFragments = 8;
/** extended information for this object. This is reserved for future expansion and must be
* set to nullptr. The values in @ref flags will affect how this is interpreted.
*/
void* ext = nullptr;
};
/** flags to control the behavior of context creation. No flags are currently defined. */
typedef uint32_t CaptureContextFlags;
/** descriptor used to indicate the options passed to the createContext() function. This
* determines the how the context will behave and which capture device will be selected.
*/
struct CaptureContextDesc
{
/** flags to indicate some additional behavior of the context. No flags are currently
* defined. This should be set to 0. In future versions, these flags may be used to
* determine how the @ref ext member is interpreted.
*/
CaptureContextFlags flags = 0;
/** a callback function to be registered with the new context object. This callback will be
* performed any time the capture device list changes. This notification will only indicate
* that a change has occurred, not which specific change occurred. It is the caller's
* responsibility to re-enumerate devices to determine if any further action is necessary
* for the updated device list. This may be nullptr if no device change notifications are
* needed.
*/
DeviceChangeCallback changeCallback = nullptr;
/** an opaque context value to be passed to the callback whenever it is performed. This value
* will never be accessed by the context object and will only be passed unmodified to the
* callback function. This value is only used if a device change callback is provided.
*/
void* callbackContext = nullptr;
/** a descriptor of the capture device to initially use for this context. If this device
* fails to be selected, the context will still be created and valid, but any attempt to
* capture audio on the context will fail until a source is successfully selected with
* IAudioCapture::setSource(). The source used on this context may be changed any time
* a capture is not in progress using IAudioCapture::setSource().
*/
CaptureDeviceDesc device;
/** extended information for this descriptor. This is reserved for future expansion and
* must be set to nullptr.
*/
void* ext = nullptr;
};
/** stores the buffer information for gaining access to a buffer of raw audio data. A buffer of
* audio data is a linear buffer that may wrap around if it is set to loop. If the requested
* lock region extends past the end of the buffer, it will wrap around to the beginning by
* returning a second pointer and length as well. If the lock region does not wrap around,
* only the first pointer and length will be returned. The second pointer will be nullptr and
* the second length will be 0.
*
* The interpretation of this buffer is left up to the caller that locks it. Since the lock
* regions point to the raw audio data, it is the caller's responsibility to know the data's
* format (ie: bits per sample) and channel count and interpret them properly. The data format
* information can be collected with the IAudioCapture::getSoundFormat() call.
*
* Note that these returned pointers are writable. It is possible to write new data to the
* locked regions of the buffer (for example, clearing the buffer for security purposes after
* reading), but it is generally not advised or necessary. If the capture buffer is looping,
* the contents will quickly be overwritten soon anyway.
*/
struct LockRegion
{
/** pointer to the first chunk of locked audio data. This will always be non-nullptr on a
* successful lock operation. This will point to the first byte of the requested frame
* offset in the audio buffer.
*/
void* ptr1;
/** The length of ptr1 in frames. */
size_t len1;
/** pointer to the second chunk of locked audio data. This will be nullptr on a successful
* lock operation if the requested lock region did not wrap around the end of the capture
* buffer. This will always point to the first byte in the audio buffer if it is
* non-nullptr.
*/
void* ptr2;
/** The length of ptr2 in frames. */
size_t len2;
};
/********************************** IAudioCapture Interface **************************************/
/** Low-Level Audio Capture Plugin Interface.
*
* See these pages for more detail:
* @rst
* :ref:`carbonite-audio-label`
* :ref:`carbonite-audio-capture-label`
@endrst
*/
struct IAudioCapture
{
CARB_PLUGIN_INTERFACE("carb::audio::IAudioCapture", 1, 0)
/************************ device and context management functions ****************************/
/** retrieves the current audio capture device count for the system.
*
* @returns the number of audio capture devices that are currently connected to the system
* or known to the system. The system's default or preferred device can be found
* by looking at the @a flags member of the info structure retrieved from
* getDeviceCaps(). The default capture device will always be device 0.
*
* @note The device count is a potentially volatile value. This can change at any time,
* without notice, due to user action. For example, the user could remove an audio
* device from the system or add a new one at any time. Thus it is a good idea to
* select the device with setSource() as quickly as possible after choosing the device
* index. There is no guarantee that the device list will even remain stable during
* a single device enumeration loop. The only device index that is guaranteed to be
* valid is the system default device index of 0 (as long as at least one capture
* device is connected).
*/
size_t(CARB_ABI* getDeviceCount)();
/** retrieves the capabilities and information about a single audio capture device.
*
* @param[in] deviceIndex the index of the device to retrieve info for. This must be
* between 0 and the most recent return value from getDeviceCount().
* @param[out] caps receives the device information. The @a thisSize value must be set
* to sizeof(DeviceCaps) before calling.
* @retval AudioResult::eOk if the device info was successfully retrieved.
* @retval AudioResult::eOutOfRange if the requested device index was out of range
* of devices connected to the system.
* @retval AudioResult::eInvalidParameter if the @a thisSize value was not initialized
* in @p caps or @p caps was nullptr.
* @retval AudioResult::eNotAllowed if the device list could not be accessed.
* @returns an @ref AudioResult error code if the call fails for any other reason.
*
* @remarks This retrieves information about a single audio capture device. The
* information will be returned in the @p caps buffer. This may fail if the
* device corresponding to the requested index has been removed from the
* system.
*/
AudioResult(CARB_ABI* getDeviceCaps)(size_t deviceIndex, DeviceCaps* caps);
/** creates a new audio capture context object.
*
* @param[in] desc a descriptor of the initial settings for the capture context. This
* may be nullptr to create a context that uses the default capture
* device in its preferred format. The device's format information
* may later be retrieved with getSoundFormat().
* @returns the newly created audio capture context object if it was successfully created.
* @returns nullptr if a new context object could not be created.
*
* @remarks This creates a new audio capture context object. This object is responsible
* for managing all access to a single instance of the audio capture device. Note
* that there will be a separate recording thread associated with each instance of
* the capture context.
*
* @note If the requested device fails to be set during context creation, the returned
* context object will still be valid, but it will not be able to capture until a
* successful call to setSource() returns. This case may be checked upon return
* using isSourceValid().
*/
Context*(CARB_ABI* createContext)(const CaptureContextDesc* desc);
/** destroys an audio capture context object.
*
* @param[in] context the context object to be destroyed. Upon return, this object will no
* longer be valid.
* @retval AudioResult::eOk if the object was successfully destroyed.
* @retval AudioResult::eInvalidParameter if nullptr is passed in.
*
* @remarks This destroys an audio capture context object that was previously created
* with createContext(). If the context is still active and has a running capture
* thread, it will be stopped before the object is destroyed. All resources
* associated with the context will be both invalidated and destroyed as well.
*/
AudioResult(CARB_ABI* destroyContext)(Context* context);
/** selects a capture device and prepares it to begin recording.
*
* @param[in] context the context object to set the capture source. This context may not
* be actively capturing data when calling this function. A call to
* captureStop() must be made first in this case.
* @param[in] desc a descriptor of the device that should be opened and what format the
* captured data should be in. This may be nullptr to select the
* system's default capture device in its preferred format and a default
* capture buffer size.
* @retval AudioResult::eOk if the requested device was successfully opened.
* @retval AudioResult::eNotAllowed if a capture is currently running.
* @retval AudioResult::eOutOfRange if the requested device index is not valid.
* @retval AudioResult::eInvalidFormat if the requested frame rate or channel count
* is not allowed.
* @returns an @ref AudioResult error code if the device could not be opened.
*
* @remarks This selects a capture device and sets up the recording buffer for it. The audio
* will always be captured as uncompressed PCM data in the requested format. The
* captured audio can be accessed using the lock() and unlock() functions, or with
* read().
*
* @remarks The length of the buffer would depend on the needs of the caller. For example,
* if a looping capture is used, the buffer should be long enough that the caller
* can keep pace with reading the data as it is generated, but not too long that
* it will introduce an unnecessary amount of latency between when the audio is
* captured and the caller does something with it. In many situations, a 10-20
* millisecond buffer should suffice for streaming applications. A delay greater
* than 100ms between when audio is produced and heard will be noticeable to the
* human ear.
*
* @note If this fails, the state of the context may be reset. This must succeed before
* any capture operation can be started with captureStart(). All efforts will be
* made to keep the previous source valid in as many failure cases as possible, but
* this cannot always be guaranteed. If the call fails, the isSourceValid() call can
* be used to check whether a capture is still possible without having to call
* setSource() again.
*
* @note If this succeeds (or fails in non-recoverable ways mentioned above), the context's
* state will have been reset. This means that any previously captured data will be
* lost and that any previous data format information may be changed. This includes
* the case of selecting the same device that was previously selected.
*/
AudioResult(CARB_ABI* setSource)(Context* context, const CaptureDeviceDesc* desc);
/** checks whether a valid capture source is currently selected.
*
* @param[in] context the context to check the capture source on. This may not be nullptr.
* @returns true if the context's currently selected capture source is valid and can start
* a capture.
* @returns false if the context's source is not valid or could not be selected.
*
* @remarks This checks whether a context's current source is valid for capture immediately.
* This can be used after capture creation to test whether the source was
* successfully selected instead of having to attempt to start a capture then
* clear the buffer.
*/
bool(CARB_ABI* isSourceValid)(Context* context);
/**************************** capture state management functions *****************************/
/** starts capturing audio data from the currently opened device.
*
* @param[in] context the context object to start capturing audio from. This context must
* have successfully selected a capture device either on creation or by
* using setSource(). This can be verified with isSourceValid().
* @param[in] looping set to true if the audio data should loop over the buffer and
* overwrite previous data once it reaches the end. Set to false to
* perform a one-shot capture into the buffer. In this mode, the capture
* will automatically stop once the buffer becomes full.
* Note that the cursor position is not reset when capture is stopped,
* so starting a non-looping capture session will result in the remainder
* of the buffer being captured.
*
* @retval AudioResult::eOk if the capture is successfully started.
* @retval AudioResult::eDeviceNotOpen if a device is not selected in the context.
* @returns an AudioResult::* error code if the capture could not be started for any other
* reason.
*
* @remarks This starts an audio capture on the currently opened device for a context. The
* audio data will be captured into an internal data buffer that was created with
* the information passed to the last call to setSource() or when the context was
* created. The recorded audio data can be accessed by locking regions of the
* buffer and copying the data out, or by calling read() to retrieve the data as
* it is produced.
*
* @remarks If the capture buffer is looping, old data will be overwritten after
* the buffer fills up. It is the caller's responsibility in this case to
* periodically check the capture's position with getCaptureCuror(), and
* read the data out once enough has been captured.
*
* @remarks If the capture is not looping, the buffer's data will remain intact even
* after the capture is complete or is stopped. The caller can read the data
* back at any time.
*
* @remarks When the capture is started, any previous contents of the buffer will remain
* and will be added to by the new captured data. If the buffer should be
* cleared before continuing from a previous capture, the clear() function must
* be explicitly called first. Each time a new capture device is selected with
* setSource(), the buffer will be cleared implicitly. Each time the capture
* is stopped with captureStop() however, the buffer will not be cleared and can
* be added to by starting it again.
*/
AudioResult(CARB_ABI* captureStart)(Context* context, bool looping);
/** stops capturing audio data from the selected device.
*
* @param[in] context the context object to stop capturing audio on. This context object
* must have successfully opened a device either on creation or by using
* setSource().
* @returns @ref AudioResult::eOk if the capture is stopped.
* @returns @ref AudioResult::eDeviceNotOpen if a device is not open.
* @returns an AudioResult::* error code if the capture could not be stopped or was never
* started in the first place.
*
* @remarks This stops an active audio capture on the currently opened device for a
* context. The contents of the capture buffer will be left unmodified and can
* still be accessed with lock() and unlock() or read(). If the capture is
* started again, it will be resumed from the same location in the buffer as
* when it was stopped unless clear() is called.
*
* @note If the capture is stopped somewhere in the middle of the buffer (whether
* looping or not), the contents of the remainder of the buffer will be
* undefined. Calling getCaptureCursor() even after the capture is stopped
* will still return the correct position of the last valid frame of data.
*/
AudioResult(CARB_ABI* captureStop)(Context* context);
/** retrieves the current capture position in the device's buffer.
*
* @param[in] context the context object that the capture is occurring on. This context
* object must have successfully opened a device either on creation or
* by using setSource().
* @param[in] type the units to retrieve the current position in. Note that this may
* not return an accurate position if units in milliseconds or
* microseconds are requested. If a position in bytes is requested, the
* returned value will always be aligned to a frame boundary.
* @param[out] position receives the current position of the capture cursor in the units
* specified by @p type. All frames in the buffer up to this point
* will contain valid audio data.
* @retval AudioResult::eOk if the current capture position is successfully retrieved.
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @returns an AudioResult::* error code if the capture position could not be retrieved.
*
* @remarks This retrieves the current capture position in the buffer. This position will be
* valid even after the capture has been stopped with captureStop(). All data in
* the buffer up to the returned position will be valid. If the buffer was looping,
* some of the data at the end of the buffer may be valid as well.
*/
AudioResult(CARB_ABI* getCaptureCursor)(Context* context, UnitType type, size_t* position);
/** checks whether the context is currently capturing audio data.
*
* @param[in] context the context object to check the recording state of.
* @returns true if the context is currently recording.
* @returns false if the context is not recording or no device has been opened.
*/
bool(CARB_ABI* isCapturing)(Context* context);
/********************************* data management functions *********************************/
/** locks a portion of the buffer to be read.
*
* @param[in] context the context object to read data from. This context object must have
* successfully opened a device either on creation or by using
* setSource().
* @param[in] length The length of the buffer to lock, in frames.
* This may be 0 to lock as much data as possible.
* @param[out] region receives the lock region information if the lock operation is
* successful. This region may be split into two chunks if the region
* wraps around the end of the buffer. The values in this struct are
* undefined if the function fails.
* @retval AudioResult::eOk if the requested region is successfully locked.
* @retval AudioResult::eDeviceNotOpen if no device is open.
* @retval AudioResult::eNotAllowed if a region is already locked and needs to be
* unlocked.
* @retval AudioResult::eOverrun if data has not been read fast
* enough and some captured data has overwritten unread data.
* @returns an @ref AudioResult error code if the region could not be locked.
*
* @remarks This locks a portion of the buffer so that data can be read back. The region may
* be split into two chunks if the region wraps around the end of the buffer. A
* non-looping buffer will always be truncated to the end of the buffer and only one
* chunk will be returned.
*
* @remarks Once the locked region is no longer needed, it must be unlocked with a call to
* unlock(). Only one region may be locked on the buffer at any given time.
* Attempting to call lock() twice in a row without unlocking first will result
* in the second call failing.
*/
AudioResult(CARB_ABI* lock)(Context* context, size_t length, LockRegion* region);
/** unlocks a previously locked region of the buffer.
*
* @param[in] context the context object to unlock the buffer on. This context object must
* have successfully opened a device either on creation or by using
* setSource().
* @retval AudioResult::eOk if the region is successfully unlocked.
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @retval AudioResult::eNotAllowed if no region is currently locked.
* @retval AudioResult::eOverrun if the audio device wrote to part
* of the locked buffer before unlock() was called.
* @returns an @ref AudioResult error code if the region could not be unlocked.
*
* @remarks This unlocks a region of the buffer that was locked with a previous call to
* lock(). Once the buffer is unlocked, a new region may be locked with lock().
*
* @note Once the buffer is unlocked, it is not guaranteed that the memory in the region
* will still be accessible. The caller should never cache the locked region
* information between unlocks and future locks. The next successful lock call
* may return a completely different region of memory even for the same offset
* in the buffer.
*/
AudioResult(CARB_ABI* unlock)(Context* context);
/** calculates the required buffer size to store the requested number of frames.
*
* @param[in] context the context object to calculate the buffer size for. This context
* object must have successfully opened a device either on creation
* or by using setSource().
* @param[in] framesCount the number of frames to calculate the storage space for.
* @returns the number of bytes required to store the requested frame count for this
* context's current data format.
* @returns 0 if no device has been selected.
*
* @remarks This is a helper function to calculate the required size in bytes for a buffer
* to store a requested number of frames. This can be used with read() to ensure
* a buffer is large enough to store the available number of frames of data.
*/
size_t(CARB_ABI* calculateReadBufferSize)(Context* context, size_t frameCount);
/** attempts to read captured data from the buffer.
*
* @param[in] context the context object to read data from. This context must have
* successfully opened a device either upon creation or by using
* setSource().
* @param[out] buffer receives the data that was read from the capture stream. This may
* be nullptr if only the available number of frames of data is required.
* In this case, the available frame count will be returned in the
* @p framesRead parameter. The contents of @p buffer are undefined if
* this function fails.
* @param[in] lengthInFrames the maximum number of frames of data that can fit in the
* buffer @p buffer. It is the caller's responsibility to
* know what the device's channel count is and account for
* that when allocating memory for the buffer. The size of
* the required buffer in bytes may be calculated with a call
* to calculateReadBufferSize(). This will always account for
* data format and channel count. If @p buffer is nullptr, this
* must be set to 0.
* @param[out] framesRead receives the total number of frames of audio data that were read
* into the buffer. This may be 0 if no new data is available to be
* read. It is the caller's responsibility to check this value after
* return to ensure garbage data is not being processed. It cannot
* be assumed that the buffer will always be completely filled. The
* calculateReadBufferSize() helper function can be used to calculate
* the size of the read data in bytes from this value. This value
* will not exceed @p lengthInFrames if @p buffer is not nullptr. If
* the buffer is nullptr, this will receive the minimum number of
* frames currently available to be read.
* @retval AudioResult::eOk if at least one frame of data is successfully read from the
* buffer.
* @retval AudioResult::eTryAgain if no data was available to read and @p buffer was
* not nullptr and no other errors occurred (the value in @p framesRead will be 0), or
* if @p buffer is `nullptr` and there is data to be read (the number of available
* frames will be stored in @p framesRead).
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @retval AudioResult::eOutOfMemory if @p lengthInFrames is 0 and @p buffer is not
* nullptr.
* @retval AudioResult::eOverrun if data has not been read fast
* enough and some captured data has overwritten unread data.
* @returns an @ref AudioResult error code if the operation failed for some other reason.
*
* @remarks This provides a means to read the captured audio data as a 'stream'. This
* behaves similarly to the libc read() function - it will read data from the
* current cursor position up to either as much data will fit in the buffer or
* is currently available to immediately read.
*
* @remarks This may be called with a nullptr buffer and 0 buffer length if only the number
* of available frames of data is needed. This call method may be used to determine
* the size of the buffer to pass in or to ensure the buffer is large enough. No
* actual data will be read and the next call with a non-nullptr buffer will be the
* one to consume the data. Note that if audio data is still being captured, the
* number of available frames of data may increase between two consecutive calls.
* This is fine as only the number of frames that will fit in the output buffer
* will be consumed and any extra frames that were captured in the meantime can be
* consumed on the next call. The calcReadBufferSize() function may be used to
* help calculate the required buffer size in bytes from the available frame count.
*
* @note It is the caller's responsibility to call this frequently enough that the capture
* cursor on a looping buffer will not write over the data that has been read so far.
* If the capture cursor passes over the read cursor (ie: the last point that the data
* had been read up to), some corruption in the data may occur when it is finally read
* again. Data should be read from the buffer with a period of at most half the length
* of time required to fill the capture buffer.
*
* @note When this method of reading the captured data is used, it's not necessary to lock
* and unlock regions of the buffer. While using this read method may be easier, it
* may end up being less efficient in certain applications because it may incur some
* extra processing overhead per call that can be avoided with the use of lock(),
* unlock(), and getCaptureCursor(). Also, using this method cannot guarantee that
* the data will be delivered in uniformly sized chunks.
*
* @note The buffer length and read count must be specified in frames here, otherwise there
* is no accurate means of identifying how much data will fit in the buffer and how
* much data was actually read.
*/
AudioResult(CARB_ABI* read)(Context* context, void* buffer, size_t lengthInFrames, size_t* framesRead);
/** retrieves the size of the capture buffer in frames.
*
* @param[in] context the context object to retrieve the buffer size for. This context
* object must have successfully opened a device either upon creation or
* by using setSource().
* @param[in] type the units to retrieve the buffer size in.
* @returns the size of the capture buffer in the specified units.
* @returns 0 if a device hasn't been opened yet.
*
* @remarks This retrieves the actual size of the capture buffer that was created when the
* context opened its device. This is useful as a way to retrieve the buffer size
* in different units than it was created in (ie: create in frames but retrieved as
* time in milliseconds), or to retrieve the size of a buffer on a device that was
* opened with a zero buffer size.
*
* @remarks If the buffer length is requested in milliseconds or microseconds, it may not be
* precise due to rounding issues. The returned buffer size in this case will be
* the minimum time in milliseconds or microseconds that the buffer will cover.
*
* @remarks If the buffer length is requested in bytes, the returned size will always be
* aligned to a frame boundary.
*/
size_t(CARB_ABI* getBufferSize)(Context* context, UnitType type);
/** retrieves the captured data's format information.
*
* @param[in] context the context object to retrieve the data format information for. This
* context object must have successfully opened a device either upon
* creation or by using setSource().
* @param[out] format receives the data format information. This may not be nullptr.
* @retval AudioResult::eOk if the data format information is successfully returned.
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @returns an @ref AudioResult error code if any other error occurs.
*
* @remarks This retrieves the data format information for the internal capture buffer. This
* will identify how the captured audio is intended to be processed. This can be
* collected to identify the actual capture data format if the device is opened
* using its preferred channel count and frame rate.
*/
AudioResult(CARB_ABI* getSoundFormat)(Context* context, SoundFormat* format);
/** clears the capture buffer and resets it to the start.
*
* @param[in] context the context object to clear the buffer on. This context object must
* have successfully opened a device using setSource().
* @retval AudioResult::eOk if the capture buffer was successfully cleared.
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @retval AudioResult::eNotAllowed if the buffer is currently locked or currently capturing.
* @returns an @ref AudioResult error code if the operation fails for any other reason.
*
* @remarks This clears the contents of the capture buffer and resets its cursor back to the
* start of the buffer. This should only be done when the device is not capturing
* data. Attempting to clear the buffer while the capture is running will cause this
* call to fail.
*/
AudioResult(CARB_ABI* clear)(Context* context);
/** Get the available number of frames to be read.
* @param[in] context The context object to clear the buffer on. This context object must
* have successfully opened a device using setSource().
* @param[out] available The number of frames that can be read from the buffer.
* @retval AudioResult::eOk if the frame count was retrieved successfully.
* @retval AudioResult::eDeviceNotOpen if no device has been opened.
* @retval AudioResult::eOverrun if data has not been read fast enough and
* the buffer filled up.
*
*/
AudioResult(CARB_ABI* getAvailableFrames)(Context* context, size_t* available);
};
} // namespace audio
} // namespace carb
| 42,355 | C | 59.76901 | 107 | 0.655696 |
omniverse-code/kit/include/carb/audio/AudioStreamerUtils.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Helper classes for streaming data from @ref carb::audio::IAudioPlayback.
*/
#pragma once
#include "AudioUtils.h"
#include "IAudioData.h"
#include "IAudioPlayback.h"
#include "IAudioUtils.h"
#include "../Framework.h"
#include "../cpp/Atomic.h"
#include "../events/IEvents.h"
#include "../../omni/extras/DataStreamer.h"
#include <atomic>
#include <string.h>
#if CARB_PLATFORM_WINDOWS
# define strdup _strdup
#endif
namespace carb
{
namespace audio
{
/** wrapper base class to handle defining new streamer objects in C++ classes. This base class
* handles all reference counting for the Streamer interface. Objects that inherit from this
* class should never be explicitly deleted. They should always be destroyed through the
* reference counting system. Each object that inherits from this will be created with a
* reference count of 1 meaning that the creator owns a single reference. When that reference
* is no longer needed, it should be released with release(). When all references are
* released, the object will be destroyed.
*
* Direct instantiations of this wrapper class are not allowed because it contains pure
* virtual methods. Classes that inherit from this must override these methods in order to
* be used.
*
* See these pages for more information:
* @rst
* :ref:`carbonite-audio-label`
* :ref:`carbonite-streamer-label`
@endrst
*/
class StreamerWrapper : public Streamer
{
public:
StreamerWrapper()
{
m_refCount = 1;
acquireReference = streamerAcquire;
releaseReference = streamerRelease;
openStream = streamerOpen;
writeStreamData = streamerWriteData;
closeStream = streamerClose;
}
/** acquires a single reference to this streamer object.
*
* @returns no return value.
*
* @remarks This acquires a new reference to this streamer object. The reference must be
* released later with release() when it is no longer needed. Each call to
* acquire() on an object must be balanced with a call to release(). When a new
* streamer object is created, it should be given a reference count of 1.
*/
void acquire()
{
m_refCount.fetch_add(1, std::memory_order_relaxed);
}
/** releases a single reference to this streamer object.
*
* @returns no return value.
*
* @remarks This releases a single reference to this streamer object. If the reference count
* reaches zero, the object will be destroyed. The caller should assume the object
* to have been destroyed unless it is well known that other local references still
* exist.
*/
void release()
{
if (m_refCount.fetch_sub(1, std::memory_order_release) == 1)
{
std::atomic_thread_fence(std::memory_order_acquire);
delete this;
}
}
/** Wait until the close() call has been given.
* @param[in] duration The duration to wait before timing out.
* @returns `true` if the close call has been given
* @returns `false` if the timeout was reached.
*
* @remarks If you disconnect a streamer via IAudioPlayback::setOutput(),
* the engine may not be stopped, so the streamer won't be
* immediately disconnected. In cases like this, you should call
* waitForClose() if you need to access the streamer's written data
* but don't have access to the close() call (e.g. if you're using
* an @ref OutputStreamer).
*/
template <class Rep, class Period>
bool waitForClose(const std::chrono::duration<Rep, Period>& duration) noexcept
{
return m_open.wait_for(true, duration);
}
/** sets the suggested format for this stream output.
*
* @param[inout] format on input, this contains the suggested data format for the stream.
* On output, this contains the accepted data format. The streamer
* may make some changes to the data format including the data type,
* sample rate, and channel count. It is strongly suggested that the
* input format be accepted since that will result in the least
* amount of processing overhead. The @a format, @a channels,
* @a frameRate, and @a bitsPerSample members must be valid upon
* return. If the streamer changes the data format, only PCM data
* formats are acceptable.
* @returns true if the data format is accepted by the streamer.
* @returns false if the streamer can neither handle the requested format nor
* can it change the requested format to something it likes.
*
* @remarks This sets the data format that the streamer will receive its data in. The
* streamer may change the data format to another valid PCM data format if needed.
* Note that if the streamer returns a data format that cannot be converted to by
* the processing engine, the initialization of the output will fail. Also note
* that if the streamer changes the data format, this will incur a small performance
* penalty to convert the data to the new format.
*
* @remarks This will be called when the audio context is first created. Once the format
* is accepted by both the audio context and the streamer, it will remain constant
* as long as the processing engine is still running on that context. When the
* engine is stopped (or the context is destroyed), a Streamer::close() call will
* be performed signaling the end of the stream. If the engine is restarted again,
* another open() call will be performed to signal the start of a new stream.
*
* @note This should not be called directly. This will be called by the audio processing
* engine when this streamer object is first assigned as an output on an audio context.
*/
virtual bool open(SoundFormat* format) = 0;
/** writes a buffer of data to the stream.
*
* @param[in] data the audio data being written to the streamer. This data will be in
* the format that was decided on in the call to open() during the
* context creation or the last call to setOutput(). This buffer will
* not persist upon return. The implementation must copy the contents
* of the buffer if it still needs to access the data later.
* @param[in] bytes the number of bytes of valid data in the buffer @p data.
* @retval StreamState::eNormal if the data was written successfully to the streamer
* and the data production rate should continue at the current rate.
* @retval StreamState::eMore if the data was written successfully to the streamer and
* the data production rate should be temporarily increased.
* @retval StreamState::eLess if the data was written successfully to the streamer and
* the data production rate should be temporarily reduced.
* @retval StreamState::eCritical if the data was written successfully to the streamer
* and more data needs to be provided as soon as possible.
* @retval StreamState::eMuchLess if the data was written successfully to the streamer
* and the data rate needs to be halved.
*
* @remarks This writes a buffer of data to the streamer. The streamer is responsible for
* doing something useful with the audio data (ie: write it to a file, write it to
* a memory buffer, stream it to another voice, etc). The caller of this function
* is not interested in whether the streamer successfully does something with the
* data - it is always assumed that the operation is successful.
*
* @note This must execute as quickly as possible. If this call takes too long to return
* and the output is going to a real audio device (through the streamer or some other
* means), an audible audio dropout could occur. If the audio context is executing
* in non-realtime mode (ie: baking audio data), this may take as long as it needs
* only at the expense of making the overall baking process take longer.
*
* @note This should not be called directly. This will be called by the audio processing
* engine when a buffer of new data is produced.
*/
virtual StreamState writeData(const void* data, size_t bytes) = 0;
/** closes the stream.
*
* @returns no return value.
*
* @remarks This signals that a stream has been finished. This occurs when the engine is
* stopped or the audio context is destroyed. No more calls to writeData() should
* be expected until the streamer is opened again.
*
* @note This should not be called directly. This will be called by the audio processing
* engine when audio processing engine is stopped or the context is destroyed.
*/
virtual void close() = 0;
protected:
virtual ~StreamerWrapper()
{
auto refCount = m_refCount.load(std::memory_order_relaxed);
CARB_UNUSED(refCount);
CARB_ASSERT(refCount == 0,
"deleting the streamer with refcount %zd - was it destroyed by a method other than calling release()?",
refCount);
}
private:
static void CARB_ABI streamerAcquire(Streamer* self)
{
StreamerWrapper* ctxt = static_cast<StreamerWrapper*>(self);
ctxt->acquire();
}
static void CARB_ABI streamerRelease(Streamer* self)
{
StreamerWrapper* ctxt = static_cast<StreamerWrapper*>(self);
ctxt->release();
}
static bool CARB_ABI streamerOpen(Streamer* self, SoundFormat* format)
{
StreamerWrapper* ctxt = static_cast<StreamerWrapper*>(self);
ctxt->m_open = true;
return ctxt->open(format);
}
static StreamState CARB_ABI streamerWriteData(Streamer* self, const void* data, size_t bytes)
{
StreamerWrapper* ctxt = static_cast<StreamerWrapper*>(self);
return ctxt->writeData(data, bytes);
}
static void CARB_ABI streamerClose(Streamer* self)
{
StreamerWrapper* ctxt = static_cast<StreamerWrapper*>(self);
ctxt->close();
ctxt->m_open = false;
ctxt->m_open.notify_all();
}
/** the current reference count to this object. This will be 1 on object creation. This
* object will be destroyed when the reference count reaches zero.
*/
std::atomic<size_t> m_refCount;
/** Flag that marks if the streamer is still open. */
carb::cpp::atomic<bool> m_open{ false };
};
/** a streamer object to write to a stream to a file. The stream will be output in realtime by
* default (ie: writing to file at the same rate as the sound would play back on an audio
* device). This can be sped up by not specifying the @ref fFlagRealtime flag. When this flag
* is not set, the stream data will be produced as fast as possible.
*
* An output filename must be set with setFilename() before the streamer can be opened. All
* other parameters will work properly as their defaults.
*/
class OutputStreamer : public StreamerWrapper
{
public:
/** Type definition for the behavioral flags for this streamer. */
typedef uint32_t Flags;
/** flag to indicate that the audio data should be produced for the streamer at the same
* rate as it would be produced for a real audio device. If this flag is not set, the
* data will be produced as quickly as possible.
*/
static constexpr Flags fFlagRealtime = 0x00000001;
/** flag to indicate that the output stream should be flushed to disk after each buffer is
* written to it. If this flag is not present, flushing to disk will not be guaranteed
* until the stream is closed.
*/
static constexpr Flags fFlagFlush = 0x00000002;
/** Constructor.
* @param[in] outputFormat The encoded format for the output file.
* @param[in] flags Behavioral flags for this instance.
*/
OutputStreamer(SampleFormat outputFormat = SampleFormat::eDefault, Flags flags = fFlagRealtime)
{
m_desc.flags = 0;
m_desc.filename = nullptr;
m_desc.inputFormat = SampleFormat::eDefault;
m_desc.outputFormat = outputFormat;
m_desc.frameRate = 0;
m_desc.channels = 0;
m_desc.encoderSettings = nullptr;
m_desc.ext = nullptr;
m_filename = nullptr;
m_encoderSettings = nullptr;
m_stream = nullptr;
m_utils = nullptr;
m_flags = flags;
}
/** retrieves the descriptor that will be used to open the output stream.
*
* @returns the descriptor object. This will never be nullptr. This can be used to
* manually fill in the descriptor if need be, or to just verify the settings
* that will be used to open the output stream.
*/
OutputStreamDesc* getDescriptor()
{
return &m_desc;
}
/** sets the flags that will control how data is written to the stream.
*
* @param[in] flags the flags that will control how data is written to the stream. This
* is zero or more of the kFlag* flags.
* @returns no return value.
*/
void setFlags(Flags flags)
{
m_flags = flags;
}
/** retrieves the flags that are control how data is written to the stream.
*
* @returns the flags that will control how data is written to the stream. This is zero
* or more of the kFlag* flags.
*/
Flags getFlags() const
{
return m_flags;
}
/** sets the output format for the stream.
*
* @param[in] format the output format for the stream. This can be SampleFormat::eDefault
* to use the same format as the input. If this is to be changed, this
* must be done before open() is called.
* @returns no return value.
*/
void setOutputFormat(SampleFormat format)
{
m_desc.outputFormat = format;
}
/** sets the filename for the output stream.
*
* @param[in] filename the filename to use for the output stream. This must be set
* before open() is called. This may not be nullptr.
* @returns no return value.
*/
void setFilename(const char* filename)
{
char* temp;
temp = strdup(filename);
if (temp == nullptr)
return;
if (m_filename != nullptr)
free(m_filename);
m_filename = temp;
m_desc.filename = m_filename;
}
/** retrieves the filename assigned to this streamer.
*
* @returns the filename assigned to this streamer. This will be nullptr if no filename
* has been set yet.
*/
const char* getFilename() const
{
return m_filename;
}
/** sets the additional encoder settings to use for the output stream.
*
* @param[in] settings the encoder settings block to use to open the output stream.
* This may be nullptr to clear any previously set encoder settings
* block.
* @param[in] sizeInBytes the size of the encoder settings block in bytes.
* @returns no return value.
*
* @remarks This sets the additional encoder settings block to use for the output stream.
* This block will be copied to be stored internally. This will replace any
* previous encoder settings block.
*/
void setEncoderSettings(const void* settings, size_t sizeInBytes)
{
void* temp;
if (settings == nullptr)
{
if (m_encoderSettings != nullptr)
free(m_encoderSettings);
m_encoderSettings = nullptr;
m_desc.encoderSettings = nullptr;
return;
}
temp = malloc(sizeInBytes);
if (temp == nullptr)
return;
if (m_encoderSettings != nullptr)
free(m_encoderSettings);
memcpy(temp, settings, sizeInBytes);
m_encoderSettings = temp;
m_desc.encoderSettings = m_encoderSettings;
}
bool open(SoundFormat* format) override
{
m_utils = getFramework()->acquireInterface<carb::audio::IAudioUtils>();
CARB_ASSERT(m_utils != nullptr, "the IAudioData interface was not successfully acquired!");
CARB_ASSERT(m_desc.filename != nullptr, "call setFilename() first!");
// update the output stream descriptor with the given format information and flags.
if ((m_flags & fFlagFlush) != 0)
m_desc.flags |= fStreamFlagFlushAfterWrite;
m_desc.channels = format->channels;
m_desc.frameRate = format->frameRate;
m_desc.inputFormat = format->format;
m_stream = m_utils->openOutputStream(getDescriptor());
return m_stream != nullptr;
}
StreamState writeData(const void* data, size_t bytes) override
{
CARB_ASSERT(m_utils != nullptr);
CARB_ASSERT(m_stream != nullptr);
m_utils->writeDataToStream(m_stream, data, bytesToFrames(bytes, m_desc.channels, m_desc.inputFormat));
return (m_flags & fFlagRealtime) != 0 ? StreamState::eNormal : StreamState::eCritical;
}
void close() override
{
CARB_ASSERT(m_utils != nullptr);
if (m_stream == nullptr)
return;
m_utils->closeOutputStream(m_stream);
m_stream = nullptr;
}
protected:
~OutputStreamer() override
{
if (m_stream != nullptr)
m_utils->closeOutputStream(m_stream);
if (m_filename != nullptr)
free(m_filename);
if (m_encoderSettings != nullptr)
free(m_encoderSettings);
}
private:
/** the current filename for the output stream. This must be a valid path before open()
* is called.
*/
char* m_filename;
/** the current encoder settings for the output stream. This may be nullptr if no extra
* encoder settings are needed.
*/
void* m_encoderSettings;
/** the flags describing how the stream should be written. This is a combination of zero
* or more of the kFlag* flags.
*/
Flags m_flags;
/** the descriptor to open the output stream with. The information in this descriptor is
* collected by making various set*() calls on this object, or by retrieving and editing
* the descriptor directly with getDescriptor().
*/
OutputStreamDesc m_desc;
/** the output stream to be operated on. This is created in the open() call when this
* streamer is first set as an output on an audio context.
*/
OutputStream* m_stream;
/** the data interface object. */
IAudioUtils* m_utils;
};
/** a null streamer implementation. This will accept all incoming audio data but will simply
* ignore it. The audio processing engine will be told to continue producing data at the
* current rate after each buffer is written. All data formats will be accepted.
*
* This is useful for silencing an output while still allowing audio processing based events to
* occur as scheduled.
*/
class NullStreamer : public StreamerWrapper
{
public:
NullStreamer()
{
}
bool open(SoundFormat* format) override
{
CARB_UNUSED(format);
return true;
}
StreamState writeData(const void* data, size_t bytes) override
{
CARB_UNUSED(data, bytes);
return m_state;
}
void close() override
{
}
/** sets the stream state that will be returned from writeData().
*
* @param[in] state the stream state to return from each writeData() call. This will
* affect the behavior of the audio processing engine and its rate
* of running new cycles. The default is @ref StreamState::eNormal.
* @returns no return value.
*/
void setStreamState(StreamState state)
{
m_state = state;
}
protected:
~NullStreamer() override
{
}
/** the stream state to be returned from each writeData() call. */
StreamState m_state = StreamState::eNormal;
};
/** An event that is sent when the audio stream opens.
* This will inform the listener of the stream's format and version.
*/
constexpr carb::events::EventType kAudioStreamEventOpen = 1;
/** An event that is sent when the audio stream closes. */
constexpr carb::events::EventType kAudioStreamEventClose = 2;
/** Version tag to mark @rstref{ABI breaks <abi-compatibility>}. */
constexpr int32_t kEventStreamVersion = 1;
/** A listener for data from an @ref EventStreamer.
* This allows an easy way to bind the necessary callbacks to receive audio
* data from the stream.
*/
class EventListener : omni::extras::DataListener
{
public:
/** Constructor.
* @param[inout] p The event stream that was returned from the
* getEventStream() call from an @ref EventStreamer.
* @param[in] open The callback which is sent when the audio stream
* is first opened.
* This is used to provide information about the
* data in the audio stream.
* @param[in] writeData The callback which is sent when a buffer of data
* is sent from the stream.
* These callbacks are only sent after an @p open()
* callback has been sent.
* Note that the data sent here may not be properly
* aligned for its data type due to the nature of
* @ref events::IEvents, so you should memcpy the
* data somewhere that's aligned for safety.
* @param[in] close This is called when the audio stream is closed.
*
* @remarks All that needs to be done to start receiving data is to create
* this class. Once the class is created, the callbacks will start
* being sent.
* Note that you must create the listener before the audio stream
* opens, otherwise the open event will never be received, so you
* will not receive data until the stream closes and re-opens.
*/
EventListener(carb::events::IEventStreamPtr p,
std::function<void(const carb::audio::SoundFormat* fmt)> open,
std::function<void(const void* data, size_t bytes)> writeData,
std::function<void()> close)
: omni::extras::DataListener(p)
{
OMNI_ASSERT(open, "this callback is not optional");
OMNI_ASSERT(writeData, "this callback is not optional");
OMNI_ASSERT(close, "this callback is not optional");
m_openCallback = open;
m_writeDataCallback = writeData;
m_closeCallback = close;
}
protected:
/** Function to pass received data to this audio streamer's destination.
*
* @param[in] payload The packet of data that was received. This is expected to contain
* the next group of audio frames in the stream on each call.
* @param[in] bytes The length of @p payload in bytes.
* @param[in] type The data type ID of the data contained in @p payload. This is
* ignored since calls to this handler are always expected to be plain
* data for the stream.
* @returns No return value.
*/
void onDataReceived(const void* payload, size_t bytes, omni::extras::DataStreamType type) noexcept override
{
CARB_UNUSED(type);
if (m_open)
{
m_writeDataCallback(payload, bytes);
}
}
/** Handler function for non-data events on the stream.
*
* @param[in] e The event that was received. This will either be an 'open' or 'close'
* event depending on the value of this event's 'type' member.
* @returns No return value.
*/
void onEventReceived(const carb::events::IEvent* e) noexcept override
{
carb::audio::SoundFormat fmt = {};
auto getIntVal = [this](const carb::dictionary::Item* root, const char* name) -> size_t {
const carb::dictionary::Item* child = m_dict->getItem(root, name);
return (child == nullptr) ? 0 : m_dict->getAsInt64(child);
};
switch (e->type)
{
case kAudioStreamEventOpen:
{
int32_t ver = int32_t(getIntVal(e->payload, "version"));
if (ver != kEventStreamVersion)
{
CARB_LOG_ERROR("EventListener version %" PRId32 " tried to attach to data stream version %" PRId32,
kEventStreamVersion, ver);
disconnect();
return;
}
fmt.channels = getIntVal(e->payload, "channels");
fmt.bitsPerSample = getIntVal(e->payload, "bitsPerSample");
fmt.frameSize = getIntVal(e->payload, "frameSize");
fmt.blockSize = getIntVal(e->payload, "blockSize");
fmt.framesPerBlock = getIntVal(e->payload, "framesPerBlock");
fmt.frameRate = getIntVal(e->payload, "frameRate");
fmt.channelMask = getIntVal(e->payload, "channelMask");
fmt.validBitsPerSample = getIntVal(e->payload, "validBitsPerSample");
fmt.format = SampleFormat(getIntVal(e->payload, "format"));
m_openCallback(&fmt);
m_open = true;
break;
}
case kAudioStreamEventClose:
if (m_open)
{
m_closeCallback();
m_open = false;
}
break;
default:
OMNI_LOG_ERROR("unknown event received %zd", size_t(e->type));
}
}
private:
std::function<void(const carb::audio::SoundFormat* fmt)> m_openCallback;
std::function<void(const void* data, size_t bytes)> m_writeDataCallback;
std::function<void()> m_closeCallback;
bool m_open = false;
};
/** A @ref events::IEvents based audio streamer.
* This will send a stream of audio data through @ref events::IEvents then
* pumps the event stream asynchronously.
* This is ideal for use cases where audio streaming is needed, but the
* component receiving audio is unable to meet the latency requirements of
* other audio streamers.
*
* To receive data from this, you will need to create an @ref EventListener
* with the event stream returned from the getEventStream() call on this class.
*/
class EventStreamer : public StreamerWrapper
{
public:
EventStreamer()
{
}
/** Check if the class actually initialized successfully.
* @returns whether the class actually initialized successfully.
*/
bool isWorking() noexcept
{
return m_streamer.isWorking();
}
/** Specify a desired format for the audio stream.
* @param[in] format The format that you want to be used.
* This can be `nullptr` to just use the default format.
*/
void setFormat(const SoundFormat* format) noexcept
{
if (format != nullptr)
{
m_desiredFormat = *format;
}
else
{
m_desiredFormat = {};
}
}
/** Create an @ref EventListener for this streamer.
*
* @param[in] open The callback which is sent when the audio stream
* is first opened.
* This is used to provide information about the
* data in the audio stream.
* @param[in] writeData The callback which is sent when a buffer of data
* is sent from the stream.
* These callbacks are only sent after an @p open()
* callback has been sent.
* Note that the data sent here may not be properly
* aligned for its data type due to the nature of
* @ref events::IEvents, so you should memcpy the
* data somewhere that's aligned for safety.
* @param[in] close This is called when the audio stream is closed.
*
* @returns An event listener.
* @returns `nullptr` if an out of memory error occurs.
*
* @remarks These callbacks will be fired until the @ref EventListener
* is deleted.
* Note that you must create the listener before the audio stream
* opens, otherwise the open event will never be received, so you
* will not receive data until the stream closes and re-opens.
*/
EventListener* createListener(std::function<void(const carb::audio::SoundFormat* fmt)> open,
std::function<void(const void* data, size_t bytes)> writeData,
std::function<void()> close)
{
return new (std::nothrow) EventListener(m_streamer.getEventStream(), open, writeData, close);
}
/** Retrieve the event stream used by the data streamer.
* @returns The event stream used by the data streamer.
*
* @remarks This event stream is exposed to be subscribed to.
* Sending other events into this stream will cause errors.
*/
carb::events::IEventStreamPtr getEventStream() noexcept
{
return m_streamer.getEventStream();
}
/** Wait for all asynchronous tasks created by this stream to finish. */
void flush() noexcept
{
m_streamer.flush();
}
private:
bool open(carb::audio::SoundFormat* format) noexcept override
{
if (!m_streamer.isWorking())
{
return false;
}
if (m_desiredFormat.channels != 0)
{
format->channels = m_desiredFormat.channels;
format->channelMask = kSpeakerModeDefault;
}
if (m_desiredFormat.frameRate != 0)
{
format->frameRate = m_desiredFormat.frameRate;
}
if (m_desiredFormat.channelMask != kSpeakerModeDefault)
{
format->channelMask = m_desiredFormat.channelMask;
}
if (m_desiredFormat.format != SampleFormat::eDefault)
{
format->format = m_desiredFormat.format;
}
m_streamer.getEventStream()->push(kAudioStreamEventOpen, std::make_pair("version", kEventStreamVersion),
std::make_pair("channels", int64_t(format->channels)),
std::make_pair("bitsPerSample", int64_t(format->bitsPerSample)),
std::make_pair("frameSize", int64_t(format->frameSize)),
std::make_pair("blockSize", int64_t(format->blockSize)),
std::make_pair("framesPerBlock", int64_t(format->framesPerBlock)),
std::make_pair("frameRate", int64_t(format->frameRate)),
std::make_pair("channelMask", int64_t(format->channelMask)),
std::make_pair("validBitsPerSample", int64_t(format->validBitsPerSample)),
std::make_pair("format", int32_t(format->format)));
m_streamer.pumpAsync();
return true;
}
void close() noexcept override
{
if (!m_streamer.isWorking())
{
return;
}
m_streamer.getEventStream()->push(kAudioStreamEventClose);
m_streamer.pumpAsync();
}
StreamState writeData(const void* data, size_t bytes) noexcept override
{
if (!m_streamer.isWorking())
{
return StreamState::eNormal;
}
// just push as bytes here, we'll clean up the type later
m_streamer.pushData(static_cast<const uint8_t*>(data), bytes);
m_streamer.pumpAsync();
return StreamState::eNormal;
}
SoundFormat m_desiredFormat = {};
omni::extras::DataStreamer m_streamer;
};
} // namespace audio
} // namespace carb
| 33,667 | C | 38.843787 | 123 | 0.60739 |
omniverse-code/kit/include/carb/fastcache/FastCacheTypes.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <carb/Defines.h>
#include <carb/Types.h>
namespace carb
{
namespace fastcache
{
struct Float4x4
{
float m[16];
};
struct Double4x4
{
double m[16];
};
// NOTE: omni physics relies on this struct being all floats.
// Actual fastcache users should use Transformd defined below.
struct Transform
{
carb::Float3 position;
carb::Float4 orientation;
carb::Float3 scale;
};
struct TransformD
{
TransformD() {}
explicit TransformD(const Transform& t) : orientation(t.orientation), scale(t.scale) {
position.x = t.position.x;
position.y = t.position.y;
position.z = t.position.z;
}
void CopyTo(Transform& t)
{
t.position.x = float(position.x);
t.position.y = float(position.y);
t.position.z = float(position.z);
t.orientation = orientation;
t.scale = scale;
}
carb::Double3 position;
carb::Float4 orientation;
carb::Float3 scale;
};
// This type can be casted to carb::scenerenderer::VertexElemDesc
struct BufferDesc
{
BufferDesc() = default;
BufferDesc(const void* _data, uint32_t _elementStride, uint32_t _elementSize)
: data(_data), elementStride(_elementStride), elementSize(_elementSize)
{
}
const void* data = nullptr; // float elements, vec2, vec3 or vec4
uint32_t elementStride = 0; // in bytes
uint32_t elementSize = 0; // in bytes
};
typedef uint32_t FastCacheDirtyFlags;
const FastCacheDirtyFlags kFastCacheClean = 0; // only copy data to fast cache
const FastCacheDirtyFlags kFastCacheDirtyTransformRender = 1 << 1; // do we write transform to hydra render sync?
const FastCacheDirtyFlags kFastCacheDirtyTransformScale = 1 << 2; // change scale? false if rigid transform only
const FastCacheDirtyFlags kFastCacheDirtyTransformChildren = 1 << 3; // update all the children?
const FastCacheDirtyFlags kFastCacheDirtyPoints = 1 << 4; // mesh point data dirtied?
const FastCacheDirtyFlags kFastCacheDirtyNormals = 1 << 5; // mesh normal data dirtied?
const FastCacheDirtyFlags kFastCacheDirtyAll = ~0;
// cannot use USD data types in header, so we cast them to void pointer
typedef void* UsdPrimPtr;
} // namespace fastcache
} // namespace carb
| 2,673 | C | 29.386363 | 113 | 0.716423 |
omniverse-code/kit/include/carb/fastcache/FastCache.h | // Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <carb/Defines.h>
#include <carb/Types.h>
#include <carb/fastcache/FastCacheTypes.h>
namespace carb
{
namespace fastcache
{
struct FastCache
{
CARB_PLUGIN_INTERFACE("carb::fastcache::FastCache", 0, 4)
/// API for simple transform update
// set transform for a usd prim to the fast cache
// see FastCacheDirtyBits for options for dirty bits
bool(CARB_ABI* setTransformF)(const pxr::SdfPath& primPath, const Transform& transform, FastCacheDirtyFlags dirtyFlags);
// set 4x4 matrix directly for this prim
bool(CARB_ABI* setWorldMatrixF)(const pxr::SdfPath& primPath, const Float4x4& mat, FastCacheDirtyFlags dirtyFlags);
/// Optimized API for faster transform update
/// each plugin should first call getCacheItemId to get integer id, then use set*ById functions below
// path->index map may have changed, other plugins should update cache index (use getCacheItemId below)
bool(CARB_ABI* indexMaybeDirty)(void);
// index into transform cache buffer for the given prim path
uint32_t(CARB_ABI* getCacheItemId)(const pxr::SdfPath& primPath);
// optimized transform update using precomputed index
bool(CARB_ABI* setTransformByIdF)(uint32_t, const Transform& transform, FastCacheDirtyFlags dirtyFlags);
// Dead function - does nothing.
bool(CARB_ABI* setWorldMatrixById)(uint32_t, const Float4x4& mat, FastCacheDirtyFlags dirtyFlags);
// set transform for a usd instance to the fast cache
// see FastCacheDirtyBits for options for dirty bits
bool(CARB_ABI* setInstanceTransformF)(const pxr::SdfPath& instancerPath,
const Transform& transform,
uint32_t instanceIndex,
FastCacheDirtyFlags dirtyFlags);
// Dead function - does nothing.
bool(CARB_ABI* setInstanceTransformBatch)(const pxr::SdfPath& instancerPath,
const Transform* transform,
uint32_t instanceCount,
uint32_t instanceStartIndex);
// Dead function - does nothing.
bool(CARB_ABI* setInstancePositionBatch)(const pxr::SdfPath& instancerPath,
const carb::Float3* position,
uint32_t instanceCount,
uint32_t instanceStartIndex);
// get transform from fast cache for a usd prim
bool(CARB_ABI* getTransformF)(const pxr::SdfPath& primPath, Transform& transform);
bool(CARB_ABI* setPositionBuffer)(const pxr::SdfPath& primPath, const BufferDesc& buffer);
bool(CARB_ABI* setNormalBuffer)(const pxr::SdfPath& primPath, const BufferDesc& binding);
/*
Sync with USD
*/
void(CARB_ABI* blockUSDUpdate)(bool val);
// Dead function - does nothing.
void(CARB_ABI* enableSyncFastUpdate)(bool val);
// Dead function - does nothing.
bool(CARB_ABI* syncFastUpdate)();
// Dead function - not implemented.
void(CARB_ABI* handleAddedPrim)(const pxr::SdfPath& primPath);
// Dead function - not implemented.
void(CARB_ABI* handleChangedPrim)(const pxr::SdfPath& primPath);
// Dead function - not implemented.
void(CARB_ABI* handleRemovedPrim)(const pxr::SdfPath& primPath);
// Dead function - not implemented.
void(CARB_ABI* resyncPrimCacheMap)(void);
// Dead function - not implemented.
void(CARB_ABI* clearAll)(void);
/// prim range cache
// get size of a prim range (usd prim + all of its decendents)
size_t(CARB_ABI* getPrimRangePathCount)(const pxr::SdfPath& primPath);
// get subtree info (prim range)
void(CARB_ABI* getPrimRangePaths)(const pxr::SdfPath& primPath, pxr::SdfPath* primRangePaths, size_t pathRangeSize);
// Scatter the position data to corresponding instance possition slots routed by the indexMap
bool(CARB_ABI* setInstancePositionF)(const pxr::SdfPath& instancerPath,
const carb::Float3* position,
const uint32_t* indexMap,
const uint32_t& instanceCount);
// Double versions of float functions
bool(CARB_ABI* setTransformD)(const pxr::SdfPath& primPath, const TransformD& transform);
bool(CARB_ABI* setWorldMatrixD)(const pxr::SdfPath& primPath, const Double4x4& mat);
bool(CARB_ABI* setTransformByIdD)(uint32_t, const TransformD& transform);
bool(CARB_ABI* setInstanceTransformD)(const pxr::SdfPath& instancerPath,
const TransformD& transform,
uint32_t instanceIndex);
bool(CARB_ABI* getTransformD)(const pxr::SdfPath& primPath, TransformD& transform);
bool(CARB_ABI* setInstancePositionD)(const pxr::SdfPath& instancerPath,
const carb::Double3* position,
const uint32_t* indexMap,
const uint32_t& instanceCount);
// Overloaded compatibility wrappers (float)
bool setTransform(const pxr::SdfPath& primPath, const Transform& transform, FastCacheDirtyFlags dirtyFlags)
{
return setTransformF(primPath, transform, dirtyFlags);
}
bool setWorldMatrix(const pxr::SdfPath& primPath, const Float4x4& mat, FastCacheDirtyFlags dirtyFlags)
{
return setWorldMatrixF(primPath, mat, dirtyFlags);
}
bool setTransformById(uint32_t id, const Transform& transform, FastCacheDirtyFlags dirtyFlags)
{
return setTransformByIdF(id, transform, dirtyFlags);
}
bool setInstanceTransform(const pxr::SdfPath& instancerPath, const Transform& transform, uint32_t instanceIndex, FastCacheDirtyFlags dirtyFlags)
{
return setInstanceTransformF(instancerPath, transform, instanceIndex, dirtyFlags);
}
bool getTransform(const pxr::SdfPath& primPath, Transform& transform)
{
return getTransformF(primPath, transform);
}
bool setInstancePosition(const pxr::SdfPath& instancerPath, const carb::Float3* position, const uint32_t* indexMap, const uint32_t& instanceCount)
{
return setInstancePositionF(instancerPath, position, indexMap, instanceCount);
}
// Overloaded compatibility wrappers (double)
bool setTransform(const pxr::SdfPath& primPath, const TransformD& transform, FastCacheDirtyFlags)
{
return setTransformD(primPath, transform);
}
bool setWorldMatrix(const pxr::SdfPath& primPath, const Double4x4& mat, FastCacheDirtyFlags)
{
return setWorldMatrixD(primPath, mat);
}
bool setTransformById(uint32_t id, const TransformD& transform, FastCacheDirtyFlags)
{
return setTransformByIdD(id, transform);
}
bool setInstanceTransform(const pxr::SdfPath& instancerPath, const TransformD& transform, uint32_t instanceIndex, FastCacheDirtyFlags)
{
return setInstanceTransformD(instancerPath, transform, instanceIndex);
}
bool getTransform(const pxr::SdfPath& primPath, TransformD& transform)
{
return getTransformD(primPath, transform);
}
bool setInstancePosition(const pxr::SdfPath& instancerPath, const carb::Double3* position, const uint32_t* indexMap, const uint32_t& instanceCount)
{
return setInstancePositionD(instancerPath, position, indexMap, instanceCount);
}
};
} // namespace fastcache
} // namespace carb
| 8,039 | C | 42.934426 | 151 | 0.670481 |
omniverse-code/kit/include/carb/fastcache/FastCacheHydra.h | // Copyright (c) 2018-2020, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <carb/Defines.h>
#include <carb/Types.h>
#include <carb/fastcache/FastCacheTypes.h>
#include <map>
#include <string>
#include <vector>
namespace carb
{
namespace fastcache
{
/**
Hydra API (used by hydra scene/render delegate, DO NOT use in other plugins)
*/
struct FastCacheHydra
{
CARB_PLUGIN_INTERFACE("carb::fastcache::FastCacheHydra", 0, 2)
// Create an entry for a single prim
// TODO: This is to enable XR controllers to be updated
// this needs a better solution
void(CARB_ABI* populatePrim)(UsdPrimPtr prim);
};
} // namespace fastcache
} // namespace carb
| 1,058 | C | 26.153845 | 80 | 0.743856 |
omniverse-code/kit/include/carb/typeinfo/ITypeInfo.h | // Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Interface.h"
namespace carb
{
namespace typeinfo
{
/**
* All supported Types.
*/
enum class TypeKind
{
eNone,
eBuiltin, ///! int, float etc.
ePointer, ///! int*, const float* etc.
eConstantArray, ///! int[32]
eFunctionPointer, ///! float (*) (char, int)
eRecord, ///! class, struct
eEnum, ///! enum
eUnknown, ///! Unresolved type. Type could be unsupported or not registered in the plugin.
eCount
};
/**
* Type hash is unique type identifier. (FNV-1a 64 bit hash is used).
*/
typedef uint64_t TypeHash;
/**
* Type info common to all types.
*/
struct Type
{
TypeHash hash; ///! Hashed type name string.
const char* name; ///! Type name (C++ canonical name).
size_t size; ///! Size of a type. Generally it is equal to sizeof(Type::name). Could be 0 for some types (void,
/// function).
};
/**
* Get a type info for defined type.
*
* Defining a type is not mandatory, but can be convenient to extract type name, hash and size from a type.
* All builtins are already predefined. Use CARB_TYPE_INFO to define own types.
*
* Usage example:
* printf(getType<unsigned int>().name); // prints "unsigned int";
*/
template <class T>
constexpr Type getType();
/**
* Type link used as a reference to any other type.
*
* If kind is TypeKind::eUnknown -> type is nullptr, hash is valid
* If kind is TypeKind::eNone -> type is nullptr, hash is 0. That means link points to nothing.
* For any other kind -> type points to actual class. E.g. for TypeKind::eRecord type points to RecordType.
*
* Usage example:
* TypeLink type = ...;
* if (type.is<PointerType>())
* TypeLink pointedType = type.getAs<PointerType>()->pointee;
*/
struct TypeLink
{
TypeHash hash = 0;
TypeKind kind = TypeKind::eNone;
void* type = nullptr;
template <typename T>
bool is() const
{
return T::kKind == kind;
}
template <typename T>
const T* getAs() const
{
if (is<T>())
return static_cast<const T*>(type);
return nullptr;
}
};
/**
* Helper class to store const ranges in array. Supports C++11 range-based for loop.
*/
template <class T>
class Range
{
public:
Range() = default;
Range(const T* begin, size_t size) : m_begin(begin), m_size(size)
{
}
const T* begin() const
{
return m_begin;
}
const T* end() const
{
return m_begin + m_size;
}
size_t size() const
{
return m_size;
}
const T& operator[](size_t idx) const
{
CARB_ASSERT(idx < m_size);
return m_begin[idx];
}
private:
const T* m_begin;
size_t m_size;
};
/**
* Attribute is a tag that is used to convey additional (meta) information about fields or records.
*
* The idea is that you can associate some data of particular type with a field or record.
* Use AttributeDesc to specify data pointer, data type and size. Data will be copied internally, so it should be fully
* copyable.
*
* struct MyAttribute { int min, max };
* MyAttribute attr1 = { 0, 100 };
* AttributeDesc desc = { "", &attr1, sizeof(MyAttribute), CARB_HASH_STRING("carb::my::MyAttribute") };
*
* ... pass desc into some of ITypeInfo registration functions, for example in FieldDesc.
* then you can use it as:
*
* const RecordType* r = ...;
* const Attribute& a = r->fields[0]->attributes[0];
* if (a.isType<MyAttribute>())
* return a.getValue<MyAttrubte>();
*
* You can also pass nullptr as data and only use annotation string. Thus have custom string attribute.
*/
class Attribute
{
public:
const char* annotation = nullptr; //!< Stores whole annotation string as is.
const void* data = nullptr; //!< Pointer to the data constructed from attribute expression.
TypeLink type; //!< Type of the attribute data.
template <class T>
bool isType() const
{
return getType<T>().hash == type.hash;
}
template <class T>
const T& getValue() const
{
CARB_ASSERT(isType<T>() && "type mismatch");
return *static_cast<const T*>(data);
}
};
/**
* Attribute descriptor used to specify field and record attributes.
*/
struct AttributeDesc
{
const char* annotation; ///! Annotation string as is (recommended). It is not used anywhere internally, so any
/// information could be stored.
void* data; ///! Pointer to a data to copy. Can be nullptr.
size_t dataSize; ///! Size of data to copy.
TypeHash type; ///! Type of data. Is ignored if data is nullptr or 0 size.
};
/**
* Builtin type. E.g. float, int, double, char etc.
*
* All builtin types are automatically registered and defined (see CARB_TYPE_INFO below).
*/
struct BuiltinType
{
Type base;
static constexpr TypeKind kKind = TypeKind::eBuiltin;
};
/**
* Pointer type. E.g. int*, const float* const*.
*/
struct PointerType
{
Type base;
TypeLink pointee; ///! The type it points to.
static constexpr TypeKind kKind = TypeKind::ePointer;
};
/**
* Represents the canonical version of C arrays with a specified constant size.
* Example: int x[204];
*/
struct ConstantArrayType
{
Type base;
TypeLink elementType; ///! The type of array element.
size_t arraySize; ///! The size of array.
static constexpr TypeKind kKind = TypeKind::eConstantArray;
};
/**
* Function pointer type.
*
* Special type which describes pointer to a function.
*/
struct FunctionPointerType
{
Type base;
TypeLink returnType; ///! Qualified return type of a function.
Range<TypeLink> parameters; ///! Function parameters represented as qualified types.
static constexpr TypeKind kKind = TypeKind::eFunctionPointer;
};
struct FunctionPointerTypeDesc
{
TypeHash returnType;
Range<TypeHash> parameters;
};
struct FieldExtra;
/**
* Represents a field in a record (class or struct).
*/
struct Field
{
TypeLink type; ///! Qualified type of a field.
uint32_t offset; ///! Field offset in a record. Only fields with valid offset are supported.
const char* name; ///! Field name.
FieldExtra* extra; ///! Extra information available for some fields. Can be nullptr.
Range<Attribute> attributes; ///! Field attributes.
//////////// Access ////////////
template <class T>
bool isType() const
{
return getType<T>().hash == type.hash;
}
template <class T>
bool isTypeOrElementType() const
{
if (isType<T>())
return true;
const ConstantArrayType* arrayType = type.getAs<ConstantArrayType>();
return arrayType && (arrayType->elementType.hash == getType<T>().hash);
}
template <class T, typename S>
void setValue(volatile S& instance, T const& value) const
{
memcpy((char*)&instance + offset, &value, sizeof(T));
}
template <class T, typename S>
void setValueChecked(volatile S& instance, T const& value) const
{
if (isType<T>())
setValue(instance, value);
else
CARB_ASSERT(false && "type mismatch");
}
template <class T, typename S>
T& getRef(S& instance) const
{
return *(T*)((char*)&instance + offset);
}
template <class T, typename S>
const T& getRef(const S& instance) const
{
return getRef(const_cast<S&>(instance));
}
template <class T, typename S>
T getValue(const S& instance) const
{
return *(T*)((const char*)&instance + offset);
}
template <class T, typename S>
T getValueChecked(const S& instance) const
{
if (isType<T>())
return getValue<T>(instance);
CARB_ASSERT(false && "type mismatch");
return T{};
}
template <class T, typename S>
T* getPtr(S& instance) const
{
return reinterpret_cast<T*>((char*)&instance + offset);
}
template <class T, typename S>
const T* getPtr(const S& instance) const
{
return getPtr(const_cast<S&>(instance));
}
template <class T, typename S>
T* getPtrChecked(S& instance) const
{
if (isTypeOrElementType<T>())
return getPtr(instance);
CARB_ASSERT(false && "type mismatch");
return nullptr;
}
template <class T, typename S>
const T* getPtrChecked(const S& instance) const
{
return getPtrChecked(const_cast<S&>(instance));
}
};
/**
* Field extra information.
*
* If Field is a function pointer it stores function parameter names.
*/
struct FieldExtra
{
Range<const char*> functionParameters; ///! Function parameter names
};
/**
* Field descriptor used to specify fields.
*
* The main difference from the Field is that type is specified using a hash, which plugin automatically resolves into
* TypeLink during this record registration or later when type with this hash is registered.
*/
struct FieldDesc
{
TypeHash type;
uint32_t offset;
const char* name;
Range<AttributeDesc> attributes;
Range<const char*> extraFunctionParameters;
};
/**
* Represents a record (struct or class) as a collection of fields
*/
struct RecordType
{
Type base;
Range<Field> fields;
Range<Attribute> attributes; ///! Record attributes.
static constexpr TypeKind kKind = TypeKind::eRecord;
};
/**
* Represents single enum constant.
*/
struct EnumConstant
{
const char* name;
uint64_t value;
};
/**
* Represents a enum type (enum or enum class).
*/
struct EnumType
{
Type base;
Range<EnumConstant> constants;
static constexpr TypeKind kKind = TypeKind::eEnum;
};
/**
* ITypeInfo plugin interface.
*
* Split into 2 parts: one for type registration, other for querying type information.
*
* Registration follows the same principle for every function starting with word "register":
* If a type (of the same type kind) with this name is already registered:
* 1. It returns it instead
* 2. Warning is logged.
* 3. The content is checked and error is logged for any mismatch.
*
* The order of type registering is not important. If registered type contains TypeLink inside (fields of a struct,
* returned type of function etc.) it will be lazily resolved when appropriate type is registered.
*
* Every registration function comes in 2 flavors: templated version and explicit (with "Ex" postfix). The first one
* works only if there is appropriate getType<> specialization, thus CARB_TYPE_INFO() with registered type
* should be defined before.
*
*/
struct ITypeInfo
{
CARB_PLUGIN_INTERFACE("carb::typeinfo::ITypeInfo", 1, 0)
/**
* Get a type registered in the plugin by name/type hash. Empty link can be returned.
*/
TypeLink(CARB_ABI* getTypeByName)(const char* name);
TypeLink(CARB_ABI* getTypeByHash)(TypeHash hash);
/**
* Get a record type registered in the plugin by name/type hash. Can return nullptr.
*/
const RecordType*(CARB_ABI* getRecordTypeByName)(const char* name);
const RecordType*(CARB_ABI* getRecordTypeByHash)(TypeHash hash);
/**
* Get a number of all record types registered in the plugin.
*/
size_t(CARB_ABI* getRecordTypeCount)();
/**
* Get all record types registered in the plugin. The count of elements in the array is
* ITypeInfo::getRecordTypeCount().
*/
const RecordType* const*(CARB_ABI* getRecordTypes)();
/**
* Get a enum type registered in the plugin by name/type hash. Can return nullptr.
*/
const EnumType*(CARB_ABI* getEnumTypeByName)(const char* name);
const EnumType*(CARB_ABI* getEnumTypeByHash)(TypeHash hash);
/**
* Get a pointer type registered in the plugin by name/type hash. Can return nullptr.
*/
const PointerType*(CARB_ABI* getPointerTypeByName)(const char* name);
const PointerType*(CARB_ABI* getPointerTypeByHash)(TypeHash hash);
/**
* Get a constant array type registered in the plugin by name/type hash. Can return nullptr.
*/
const ConstantArrayType*(CARB_ABI* getConstantArrayTypeByName)(const char* name);
const ConstantArrayType*(CARB_ABI* getConstantArrayTypeByHash)(TypeHash hash);
/**
* Get a function pointer type registered in the plugin by name/type hash. Can return nullptr.
*/
const FunctionPointerType*(CARB_ABI* getFunctionPointerTypeByName)(const char* name);
const FunctionPointerType*(CARB_ABI* getFunctionPointerTypeByHash)(TypeHash hash);
/**
* Register a new record type.
*/
template <class T>
const RecordType* registerRecordType(const Range<FieldDesc>& fields = {},
const Range<AttributeDesc>& attributes = {});
const RecordType*(CARB_ABI* registerRecordTypeEx)(const char* name,
size_t size,
const Range<FieldDesc>& fields,
const Range<AttributeDesc>& attributes);
/**
* Register a new enum type.
*/
template <class T>
const EnumType* registerEnumType(const Range<EnumConstant>& constants);
const EnumType*(CARB_ABI* registerEnumTypeEx)(const char* name, size_t size, const Range<EnumConstant>& constants);
/**
* Register a new pointer type.
*/
template <class T>
const PointerType* registerPointerType(TypeHash pointee);
const PointerType*(CARB_ABI* registerPointerTypeEx)(const char* name, size_t size, TypeHash pointee);
/**
* Register a new constant array type.
*/
template <class T>
const ConstantArrayType* registerConstantArrayType(TypeHash elementType, size_t arraySize);
const ConstantArrayType*(CARB_ABI* registerConstantArrayTypeEx)(const char* name,
size_t size,
TypeHash elementType,
size_t arraySize);
/**
* Register a new function pointer type.
*/
template <class T>
const FunctionPointerType* registerFunctionPointerType(TypeHash returnType, Range<TypeHash> parameters = {});
const FunctionPointerType*(CARB_ABI* registerFunctionPointerTypeEx)(const char* name,
size_t size,
TypeHash returnType,
Range<TypeHash> parameters);
};
template <class T>
inline const RecordType* ITypeInfo::registerRecordType(const Range<FieldDesc>& fields,
const Range<AttributeDesc>& attributes)
{
const Type type = getType<T>();
return this->registerRecordTypeEx(type.name, type.size, fields, attributes);
}
template <class T>
inline const EnumType* ITypeInfo::registerEnumType(const Range<EnumConstant>& constants)
{
const Type type = getType<T>();
return this->registerEnumTypeEx(type.name, type.size, constants);
}
template <class T>
inline const PointerType* ITypeInfo::registerPointerType(TypeHash pointee)
{
const Type type = getType<T>();
return this->registerPointerTypeEx(type.name, type.size, pointee);
}
template <class T>
inline const ConstantArrayType* ITypeInfo::registerConstantArrayType(TypeHash elementType, size_t arraySize)
{
const Type type = getType<T>();
return this->registerConstantArrayTypeEx(type.name, type.size, elementType, arraySize);
}
template <class T>
inline const FunctionPointerType* ITypeInfo::registerFunctionPointerType(TypeHash returnType, Range<TypeHash> parameters)
{
const Type type = getType<T>();
return this->registerFunctionPointerTypeEx(type.name, type.size, returnType, parameters);
}
} // namespace typeinfo
} // namespace carb
/**
* Convenience macro to define type.
*
* Use it like that:
* CARB_TYPE_INFO(int*)
* CARB_TYPE_INFO(np::MyClass)
*
* NOTE: it is important to also pass full namespace path to your type (to capture it in the type name).
*/
#define CARB_TYPE_INFO(T) \
namespace carb \
{ \
namespace typeinfo \
{ \
template <> \
constexpr carb::typeinfo::Type getType<T>() \
{ \
return { CARB_HASH_STRING(#T), #T, sizeof(T) }; \
} \
} \
}
/**
* Predefined builtin types
*/
CARB_TYPE_INFO(bool)
CARB_TYPE_INFO(char)
CARB_TYPE_INFO(unsigned char)
CARB_TYPE_INFO(short)
CARB_TYPE_INFO(unsigned short)
CARB_TYPE_INFO(int)
CARB_TYPE_INFO(unsigned int)
CARB_TYPE_INFO(long)
CARB_TYPE_INFO(unsigned long)
CARB_TYPE_INFO(long long)
CARB_TYPE_INFO(unsigned long long)
CARB_TYPE_INFO(float)
CARB_TYPE_INFO(double)
CARB_TYPE_INFO(long double)
| 18,410 | C | 29.28125 | 121 | 0.605323 |
omniverse-code/kit/include/carb/typeinfo/TypeInfoRegistrationUtils.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "ITypeInfo.h"
#include <vector>
namespace carb
{
namespace typeinfo
{
template <class T>
class RecordRegistrator
{
public:
RecordRegistrator() : m_name(getType<T>().name), m_size(sizeof(T))
{
}
template <typename R>
RecordRegistrator<T>& addField(const char* name, R T::*mem)
{
TypeHash type = getType<R>().hash;
uint32_t offset = carb::offsetOf(mem);
m_fields.push_back({ type, offset, name, {}, {} });
return *this;
}
void commit(ITypeInfo* info)
{
info->registerRecordTypeEx(m_name, m_size, { m_fields.data(), m_fields.size() }, {});
}
private:
const char* m_name;
uint64_t m_size;
std::vector<FieldDesc> m_fields;
};
} // namespace typeinfo
} // namespace carb
| 1,225 | C | 24.020408 | 93 | 0.675102 |
omniverse-code/kit/include/carb/time/TscClock.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//! @brief Implementation of a clock based on the CPU time-stamp counter
#pragma once
#include "../Defines.h"
#include "../cpp/Numeric.h"
#include "../Strong.h"
#include <thread>
#if CARB_PLATFORM_WINDOWS
// From immintrin.h
extern "C" unsigned __int64 rdtscp(unsigned int*);
# pragma intrinsic(__rdtscp)
# include "../CarbWindows.h"
#elif CARB_POSIX
# include <time.h>
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
namespace carb
{
//! Namespace for time utilities
namespace time
{
//! \cond DEV
namespace detail
{
#if CARB_PLATFORM_WINDOWS
inline uint64_t readTsc(void) noexcept
{
unsigned int cpu;
return __rdtscp(&cpu);
}
inline uint64_t readMonotonic(void) noexcept
{
CARBWIN_LARGE_INTEGER li;
BOOL b = QueryPerformanceCounter((LARGE_INTEGER*)&li);
CARB_ASSERT(b);
CARB_UNUSED(b);
return li.QuadPart;
}
inline uint64_t readMonotonicFreq(void) noexcept
{
CARBWIN_LARGE_INTEGER li;
BOOL b = QueryPerformanceFrequency((LARGE_INTEGER*)&li);
CARB_ASSERT(b);
CARB_UNUSED(b);
return li.QuadPart;
}
#elif CARB_POSIX
# if CARB_X86_64
__inline__ uint64_t readTsc(void) noexcept
{
// Use RDTSCP since it is serializing and flushes the pipeline intrinsically.
uint64_t msr;
// clang-format off
__asm__ __volatile__(
"rdtscp;\n" // read the rdtsc counter
"shl $32, %%rdx;\n" // rdx <<= 32
"or %%rdx, %0" // rax |= rdx, output is in rax
: "=a"(msr) // output to msr variable
: // no inputs
: "%rcx", "%rdx"); // clobbers
// clang-format on
return msr;
}
# elif CARB_AARCH64
__inline__ uint64_t readTsc(void) noexcept
{
// From: https://github.com/google/benchmark/blob/master/src/cycleclock.h
// System timer of ARMv8 runs at a different frequency than the CPU's.
// The frequency is fixed, typically in the range 1-50MHz. It can be
// read at CNTFRQ special register. We assume the OS has set up
// the virtual timer properly.
uint64_t virtualTimer;
asm volatile("mrs %0, cntvct_el0" : "=r"(virtualTimer));
return virtualTimer;
}
# else
CARB_UNSUPPORTED_ARCHITECTURE();
# endif
inline uint64_t readMonotonic(void) noexcept
{
struct timespec tp;
clock_gettime(CLOCK_MONOTONIC, &tp);
return ((tp.tv_sec * 1'000'000'000) + tp.tv_nsec) / 10;
}
inline uint64_t readMonotonicFreq(void) noexcept
{
// 10ns resolution is sufficient for system clock and gives us less chance to overflow in computeTscFrequency()
return 100'000'000;
}
#endif
inline void sampleClocks(uint64_t& tsc, uint64_t& monotonic) noexcept
{
// Attempt to take a TSC stamp and monotonic stamp as closely together as possible. In order to do this, we will
// interleave several timestamps in the pattern: TSC, mono, TSC, mono, ..., TSC
// Essentially this measures how long each monotonic timestamp takes in terms of the much faster TSC. We can then
// take the fastest monotonic timestamp and calculate an equivalent TSC timestamp from the midpoint.
static constexpr int kIterations = 100;
uint64_t stamps[kIterations * 2 + 1];
uint64_t* stamp = stamps;
uint64_t* const end = stamp + (kIterations * 2);
// Sleep so that we hopefully start with a full quanta and are less likely to context switch during this function.
std::this_thread::sleep_for(std::chrono::milliseconds(1));
// Interleave sampling the TSC and monotonic clocks ending on a TSC
while (stamp != end)
{
// Unroll the loop slightly
*(stamp++) = readTsc();
*(stamp++) = readMonotonic();
*(stamp++) = readTsc();
*(stamp++) = readMonotonic();
*(stamp++) = readTsc();
*(stamp++) = readMonotonic();
*(stamp++) = readTsc();
*(stamp++) = readMonotonic();
CARB_ASSERT(stamp <= end);
}
*(stamp++) = readTsc();
// Start with the first as a baseline
uint64_t best = stamps[2] - stamps[0];
tsc = stamps[0] + ((stamps[2] - stamps[0]) / 2);
monotonic = stamps[1];
// Find the best sample
for (int i = 0; i != kIterations; ++i)
{
uint64_t tscDiff = stamps[2 * (i + 1)] - stamps[2 * i];
if (tscDiff < best)
{
best = tscDiff;
// Use a tsc sample midway between two samples
tsc = stamps[2 * i] + (tscDiff / 2);
monotonic = stamps[2 * i + 1];
}
}
}
inline uint64_t computeTscFrequency() noexcept
{
// We have two clocks in two different domains. The CPU-specific TSC and the monotonic clock. We need to compute the
// frequency of the TSC since it is not presented in any way.
uint64_t tsc[2];
uint64_t monotonic[2];
// Sample our clocks and wait briefly then sample again
sampleClocks(tsc[0], monotonic[0]);
std::this_thread::sleep_for(std::chrono::milliseconds(50));
sampleClocks(tsc[1], monotonic[1]);
// This shouldn't happen, given the delay
CARB_ASSERT(monotonic[1] != monotonic[0]);
return ((tsc[1] - tsc[0]) * readMonotonicFreq()) / (monotonic[1] - monotonic[0]);
}
} // namespace detail
//! \endcond
//! Static class for a CPU time-stamp clock
//!
//! The functions and types within this class are used for sampling the CPU's time-stamp counter--typically a clock-
//! cycle resolution clock directly within the CPU hardware.
class tsc_clock
{
public:
//! Type definition of a sample from the CPU time-stamp counter.
//!
//! The time units of this are unspecified. Use \ref Freq to determine the frequency of the time-stamp counter.
CARB_STRONGTYPE(Sample, uint64_t);
//! The frequency of the timestamp counter, that is, the number of Samples per second.
CARB_STRONGTYPE(Freq, uint64_t);
//! Read a sample from the CPU time-stamp clock.
//!
//! Note that this operation is intended to be as fast as possible to maintain accuracy.
//! @returns a time-stamp \ref Sample at the time the function is called.
static Sample sample() noexcept
{
return Sample(detail::readTsc());
}
//! Computes the frequency of the CPU time-stamp clock.
//!
//! The first call to this function can take longer as the CPU time-stamp clock is calibrated.
//! @note This implementation assumes that the frequency never changes. Please verify with your CPU architecture
//! that this assumption is correct.
//! @returns the computed \ref Freq of the CPU time-stamp clock.
static Freq frequency() noexcept
{
static Freq freq{ detail::computeTscFrequency() };
return freq;
}
//! Computes the difference of two samples as a std::chrono::duration
//!
//! @tparam Duration a `std::chrono::duration` template to convert to.
//! @param older The older (starting) sample
//! @param newer The newer (ending) sample
//! @returns The difference in timestamps as the requested `Duration` representation
template <class Duration>
static Duration duration(Sample older, Sample newer) noexcept
{
using To = Duration;
using Rep = typename Duration::rep;
using Period = typename Duration::period;
int64_t diff = newer.get() - older.get();
// std::ratio is compile-time, so we have to do our own computations
using CT = std::common_type_t<Rep, int64_t, intmax_t>;
intmax_t _N1 = 1;
intmax_t _D1 = intmax_t(frequency().get());
intmax_t _N2 = Period::den; // Inverted for divide
intmax_t _D2 = Period::num; // Inverted for divide
intmax_t _Gx = carb::cpp::gcd(_N1, _D2);
intmax_t _Gy = carb::cpp::gcd(_N2, _D1);
intmax_t ratio_num = (_N1 / _Gx) * (_N2 / _Gy); // TODO: Check for overflow
intmax_t ratio_den = (_D1 / _Gy) * (_D2 / _Gx); // TODO: Check for overflow
if (ratio_num == 1 && ratio_den == 1)
return To(Rep(diff));
if (ratio_num != 1 && ratio_den == 1)
return To(Rep(CT(diff) * CT(ratio_num)));
if (ratio_num == 1 && ratio_den != 1)
return To(Rep(CT(diff) / CT(ratio_den)));
// Unfortunately, our frequency() is often not even numbers so the gcd() will be low. Which means that we often
// need to multiply and divide large numbers that end up overflowing. So use double here to keep better
// precision. As an alternative we could try to round the frequency up or down slightly, though this will impact
// precision.
return To(Rep(double(diff) * double(ratio_num) / double(ratio_den)));
}
};
} // namespace time
} // namespace carb
| 9,066 | C | 33.60687 | 120 | 0.643393 |
omniverse-code/kit/include/carb/time/Util.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Defines.h"
#include <time.h>
namespace carb
{
namespace time
{
/**
* Platform independent version of asctime_r: convert a `struct tm` into a null-terminated string.
* @tparam N The size of \p buf; must be at least 26 characters.
* @param tm The time component representation.
* @param buf The character buffer to render the string into. Must be at least 26 characters.
* @returns \p buf, or `nullptr` if an error occurs.
*/
template <size_t N>
inline char* asctime_r(const struct tm* tm, char (&buf)[N]) noexcept
{
// Buffer requirements as specified:
// https://linux.die.net/man/3/gmtime_r
// https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/asctime-s-wasctime-s?view=msvc-170
static_assert(N >= 26, "Insufficient buffer size");
#if CARB_PLATFORM_WINDOWS
return asctime_s(buf, N, tm) == 0 ? buf : nullptr;
#elif CARB_POSIX
return ::asctime_r(tm, buf);
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Platform independent version of ctime_r; convert a `time_t` into a null-terminated string in the user's local time
* zone.
*
* Equivalent to:
* ```
* struct tm tmBuf;
* return asctime_r(localtime_r(timep, &tmBuf), buf);
* ```
* @tparam N The size of \p buf; must be at least 26 characters.
* @param timep A pointer to a `time_t`.
* @param buf The character buffer to render the string into. Must be at least 26 characters.
* @returns \p buf, or `nullptr` if an error occurs.
*/
template <size_t N>
inline char* ctime_r(const time_t* timep, char (&buf)[N]) noexcept
{
// Buffer requirements as specified:
// https://linux.die.net/man/3/gmtime_r
// https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s?view=msvc-170
static_assert(N >= 26, "Insufficient buffer size");
#if CARB_PLATFORM_WINDOWS
auto err = ctime_s(buf, N, timep);
return err == 0 ? buf : nullptr;
#elif CARB_POSIX
return ::ctime_r(timep, buf);
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Platform independent version of gmtime_r: convert a `time_t` to UTC component representation.
* @param timep A pointer to a `time_t`.
* @param result A pointer to a `struct tm` that will receive the result.
* @returns \p result if conversion succeeded; `nullptr` if the year does not fit into an integer or an error occurs.
*/
inline struct tm* gmtime_r(const time_t* timep, struct tm* result) noexcept
{
#if CARB_PLATFORM_WINDOWS
auto err = ::gmtime_s(result, timep);
return err == 0 ? result : nullptr;
#elif CARB_POSIX
return ::gmtime_r(timep, result);
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Platform independent version of localtime_r: convert a `time_t` to local timezone component representation.
* @param timep A pointer to a `time_t`.
* @param result A pointer to a `struct tm` that will receive the result.
* @returns \p result if conversion succeeded; `nullptr` if the year does not fit into an integer or an error occurs.
*/
inline struct tm* localtime_r(const time_t* timep, struct tm* result) noexcept
{
#if CARB_PLATFORM_WINDOWS
auto err = ::localtime_s(result, timep);
return err == 0 ? result : nullptr;
#elif CARB_POSIX
return ::localtime_r(timep, result);
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
} // namespace time
} // namespace carb
| 3,808 | C | 33.008928 | 145 | 0.705357 |
omniverse-code/kit/include/carb/settings/ISettings.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief carb.settings interface definition
#pragma once
#include "../Defines.h"
#include "../Types.h"
#include "../InterfaceUtils.h"
#include "../dictionary/IDictionary.h"
#include <cstddef>
namespace carb
{
//! Namespace for \ref carb::settings::ISettings interface and utilities.
namespace settings
{
//! An opaque type representing a settings transaction.
//! @see ISettings::createTransaction
struct Transaction DOXYGEN_EMPTY_CLASS;
/**
* The Carbonite Settings interface.
*
* Carbonite settings are built on top of the \ref carb::dictionary::IDictionary interface. Many dictionary functions
* are replicated in settings, but explicitly use the settings database instead of a generic
* \ref carb::dictionary::Item.
*
* ISettings uses keys (or paths) that start with an optional forward-slash and are forward-slash separated (example:
* "/log/level"). The settings database exists as a root-level \ref carb::dictionary::Item (of type 'dictionary') that
* is created and maintained by the \c ISettings interface (typically through the *carb.settings.plugin* plugin). The
* root level settings \ref carb::dictionary::Item is accessible through `getSettingsDictionary("/")`.
*
* @thread_safety
* All functions in \c ISettings are thread-safe unless otherwise specified. By "thread-safe," this means
* that individual call to a *carb.settings* API function will fully complete in a thread-safe manner; \b however this
* does not mean that multiple calls together will be threadsafe as another thread may act on the settings database
* between the API calls. In order to ensure thread-safety across multiple calls, use the \ref ScopedRead and
* \ref ScopedWrite RAII objects to ensure locking. The settings database uses a global recursive read/write lock to
* ensure thread safety across the entire settings database.
*
* @par Subscriptions
* Portions of the settings database hierarchy can be subscribed to with \ref ISettings::subscribeToTreeChangeEvents, or
* individual keys may be subscribed to with \ref ISettings::subscribeToNodeChangeEvents. Subscriptions are called in
* the context of the thread that triggered the change, and only once that thread has released all settings database
* locks. Subscription callbacks also follow the principles of Basic Callback Hygiene:
* 1. \ref ISettings::unsubscribeToChangeEvents may be called from within the callback to unregister the called
* subscription or any other subscription.
* 2. Unregistering the subscription ensures that it will never be called again, and any calls in process on another
* thread will complete before \ref ISettings::unsubscribeToChangeEvents returns.
* 3. The settings database lock is not held while the callback is called, but may be temporarily taken for API calls
* within the callback.
*
* @see carb::dictionary::IDictionary
*/
struct ISettings
{
CARB_PLUGIN_INTERFACE("carb::settings::ISettings", 1, 0)
/**
* Returns dictionary item type of the key at the given path.
*
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return \ref carb::dictionary::ItemType of value at \p path; if \p path is `nullptr` or does not exist,
* \ref carb::dictionary::ItemType::eCount is returned.
*/
dictionary::ItemType(CARB_ABI* getItemType)(const char* path);
/**
* Checks if the item could be accessible as the provided type, either directly, or via conversion.
*
* @param itemType Item type to check for.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return True if accessible, or false otherwise.
*/
bool(CARB_ABI* isAccessibleAs)(dictionary::ItemType itemType, const char* path);
/**
* Creates a dictionary (or changes an existing value to a dictionary) at the specified path.
*
* If the setting value previously existed as a dictionary, it is not modified. If the setting value exists as
* another type, it is destroyed and a new setting value is created as an empty dictionary. If the setting value did
* not exist, it is created as an empty dictionary. If any levels of the path hierarchy did not exist, they are
* created as dictionary items.
*
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`. Providing the root level ("/"
* or "") is undefined behavior.
*/
void(CARB_ABI* setDictionary)(const char* path);
/**
* Attempts to get the supplied item as integer, either directly or via conversion.
*
* @see carb::dictionary::IDictionary::getAsInt64
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return The 64-bit integer value of the value at \p path. If \p path is invalid, non-existent, or cannot be
* converted to an integer, `0` is returned.
*/
int64_t(CARB_ABI* getAsInt64)(const char* path);
/**
* Sets the integer value at the supplied path.
*
* If an item was already present, changes its original type to 'integer'. If the present item is a dictionary with
* children, all children are destroyed. If \p path doesn't exist, creates integer item, and all the required items
* along the path if necessary.
*
* @see carb::dictionary::IDictionary::setInt64
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value Integer value that will be stored to the supplied path.
*/
void(CARB_ABI* setInt64)(const char* path, int64_t value);
/**
* Attempts to get the supplied item as `int32_t`, either directly or via conversion.
*
* @warning The value is truncated by casting to 32-bits. In debug builds, an assert occurs if the value read from
* the item would be truncated.
* @see carb::dictionary::IDictionary::getAsInt
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return The `int32_t` value of the setting value at \p path. If \p path is invalid, non-existent, or cannot be
* converted to an `int32_t`, `0` is returned.
*/
int32_t getAsInt(const char* path);
/**
* Sets the integer value at the supplied path.
*
* If an item was already present, changes its original type to 'integer'. If the present item is a dictionary with
* children, all children are destroyed. If \p path doesn't exist, creates integer item, and all the required items
* along the path if necessary.
*
* @see carb::dictionary::IDictionary::setInt
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value Integer value that will be stored to the supplied path.
*/
void setInt(const char* path, int32_t value);
/**
* Attempts to get the supplied item as `double`, either directly or via conversion.
*
* @see carb::dictionary::IDictionary::getAsFloat64
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return The `double` value of the setting value at \p path. If \p path is invalid, non-existent, or cannot be
* converted to a `double`, `0.0` is returned.
*/
double(CARB_ABI* getAsFloat64)(const char* path);
/**
* Sets the floating point value at the supplied path.
*
* If an item was already present, changes its original type to 'double'. If the present item is a dictionary with
* children, all children are destroyed. If \p path doesn't exist, creates 'double' item, and all the required items
* along the path if necessary.
*
* @see carb::dictionary::IDictionary::setFloat64
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value Floating point value that will be stored to the supplied path.
*/
void(CARB_ABI* setFloat64)(const char* path, double value);
/**
* Attempts to get the supplied item as `float`, either directly or via conversion.
*
* @see carb::dictionary::IDictionary::getAsFloat
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return The `float` value of the setting value at \p path. If \p path is invalid, non-existent, or cannot be
* converted to a `float`, `0.0f` is returned.
*/
float getAsFloat(const char* path);
/**
* Sets the floating point value at the supplied path.
*
* If an item was already present, changes its original type to 'float'. If the present item is a dictionary with
* children, all children are destroyed. If \p path doesn't exist, creates 'float' item, and all the required items
* along the path if necessary.
*
* @see carb::dictionary::IDictionary::setFloat
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value Floating point value that will be stored to the supplied path.
*/
void setFloat(const char* path, float value);
/**
* Attempts to get the supplied item as `bool`, either directly or via conversion.
*
* @see carb::dictionary::IDictionary::getAsBool
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return The `bool` value of the setting value at \p path. If \p path is invalid, non-existent, or cannot be
* converted to a `bool`, `false` is returned. See \ref carb::dictionary::IDictionary::getAsBool for an
* explanation of how different item types are converted.
*/
bool(CARB_ABI* getAsBool)(const char* path);
/**
* Sets the boolean value at the supplied path.
*
* If an item was already present, changes its original type to 'bool'. If the present item is a dictionary with
* children, all children are destroyed. If \p path doesn't exist, creates 'bool' item, and all the required items
* along the path if necessary.
*
* @see carb::dictionary::IDictionary::setBool
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value Boolean value that will be stored to the supplied path.
*/
void(CARB_ABI* setBool)(const char* path, bool value);
//! @private
const char*(CARB_ABI* internalCreateStringBufferFromItemValue)(const char* path, size_t* pStringLen);
/**
* Attempts to create a new string buffer with a value, either the real string value or a string resulting
* from converting the item value to a string.
*
* @note Please use \ref destroyStringBuffer() to free the created buffer.
*
* @see carb::dictionary::IDictionary::createStringBufferFromItemValue() carb::settings::getStringFromItemValue()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param pStringLen (optional) Receives the length of the string. This can be useful if the string contains NUL
* characters (i.e. byte data).
* @return Pointer to the created string buffer if applicable, nullptr otherwise.
*/
const char* createStringBufferFromItemValue(const char* path, size_t* pStringLen = nullptr) const
{
return internalCreateStringBufferFromItemValue(path, pStringLen);
}
//! @private
const char*(CARB_ABI* internalGetStringBuffer)(const char* path, size_t* pStringLen);
/**
* Returns internal raw data pointer to the string value of an item. Thus, doesn't perform any
* conversions.
*
* @warning This function returns the internal string buffer. Another thread may change the setting value which can
* cause the string buffer to be destroyed. It is recommended to take a \ref ScopedRead lock around calling this
* function and using the return value.
*
* @see carb::dictionary::IDictionary::getStringBuffer() carb::settings::getString()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param pStringLen (optional) Receives the length of the string. This can be useful if the string contains NUL
* characters (i.e. byte data).
* @return Raw pointer to the internal string value if applicable, nullptr otherwise.
*/
const char* getStringBuffer(const char* path, size_t* pStringLen = nullptr) const
{
return internalGetStringBuffer(path, pStringLen);
}
//! @private
void(CARB_ABI* internalSetString)(const char* path, const char* value, size_t stringLen);
/**
* Sets a string value at the given path.
*
* The given @p path is walked and any dictionary items are changed or created to create the path. If the @p path
* item itself exists but is not of type `eString` it is changed to be `eString`. Change notifications for
* subscriptions are queued. The given string is then set in the item at @p path. If @p value is \c nullptr, the
* string item will store an empty string.
*
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value String value that will be stored to the supplied path. `nullptr` is interpreted as an empty string.
* @param stringLen (optional) The length of the string at \p value to copy. This can be useful if only a portion
* of the string should be copied, or if \p value contains NUL characters (i.e. byte data). The default value of
* `size_t(-1)` treats \p value as a NUL-terminated string.
*/
void setString(const char* path, const char* value, size_t stringLen = size_t(-1)) const
{
internalSetString(path, value, stringLen);
}
/**
* Reads the value from a path, converting if necessary.
* @tparam T The type of item to read. Must be a supported type.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @returns The value read from the \p path.
*/
template <typename T>
T get(const char* path);
/**
* Sets the value at a path.
* @tparam T The type of item to read. Must be a supported type.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value The value to store in the item at \p path.
*/
template <typename T>
void set(const char* path, T value);
/**
* Checks if the item could be accessible as array, i.e. all child items names are valid
* contiguous non-negative integers starting with zero.
*
* @see carb::dictionary::IDictionary::isAccessibleAsArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return True if accessible, or false otherwise.
*/
bool(CARB_ABI* isAccessibleAsArray)(const char* path);
/**
* Checks if the item could be accessible as the array of items of provided type,
* either directly, or via conversion of all elements.
*
* @see carb::dictionary::IDictionary::isAccessibleAsArrayOf
* @param itemType Item type to check for.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return True if a valid array and with all items accessible, or false otherwise.
*/
bool(CARB_ABI* isAccessibleAsArrayOf)(dictionary::ItemType itemType, const char* path);
/**
* Checks if the all the children of the item have array-style indices. If yes, returns the number
* of children (array elements).
*
* @see carb::dictionary::IDictionary::getArrayLength
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return Number of array elements if applicable, or 0 otherwise.
*/
size_t(CARB_ABI* getArrayLength)(const char* path);
/**
* Runs through all the array elements and infers a type that is most suitable for the
* array.
*
* The rules are thus:
* - Strings attempt to convert to float or bool if possible.
* - The converted type of the first element is the initial type.
* - If the initial type is a \ref dictionary::ItemType::eBool and later elements can be converted to
* \ref dictionary::ItemType::eBool without losing precision, \ref dictionary::ItemType::eBool is kept. (String
* variants of "true"/"false", or values exactly equal to 0/1)
* - Elements of type \ref dictionary::ItemType::eFloat can convert to \ref dictionary::ItemType::eInt if they don't
* lose precision.
*
* @see dictionary::IDictionary::getPreferredArrayType
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return \ref dictionary::ItemType that is most suitable for the array, or \ref dictionary::ItemType::eCount on
* failure.
*/
dictionary::ItemType(CARB_ABI* getPreferredArrayType)(const char* path);
/**
* Attempts to read an array item as a 64-bit integer.
*
* Attempts to read the path and array index as an integer, either directly or via conversion, considering the
* item at path to be an array, and using the supplied index to access its child.
* Default value (`0`) is returned if \p path doesn't exist, index doesn't exist, or there is a conversion
* failure.
*
* @see dictionary::IDictionary::getAsInt64At
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @return Integer value, either raw value or cast from the real item type. Zero is returned if \p path doesn't
* exist, is not an array, \p index doesn't exist in the array, or a conversion error occurs.
*/
int64_t(CARB_ABI* getAsInt64At)(const char* path, size_t index);
/**
* Attempts to set a 64-bit integer value in an array item.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). \p index is converted to a string and appended to \p path as a child path name. The
* child path is created as `eInt` or changed to be `eInt`, and the value is set from \p value. Subscription
* notifications are triggered when the current thread no longer has any settings locks.
*
* @see dictionary::IDictionary::setInt64At
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param value Integer value that will be stored to the supplied path.
*/
void(CARB_ABI* setInt64At)(const char* path, size_t index, int64_t value);
/**
* Attempts to read an array item as a 32-bit integer.
*
* Attempts to read the path and array index as an integer, either directly or via conversion, considering the
* item at path to be an array, and using the supplied index to access its child.
* Default value (`0`) is returned if \p path doesn't exist, index doesn't exist, or there is a conversion
* failure.
*
* @warning The value is truncated by casting to 32-bits. In debug builds, an assert occurs if the value read from
* the item would be truncated.
* @see dictionary::IDictionary::getAsIntAt()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @return Integer value, either raw value or cast from the real item type. Zero is returned if \p path doesn't
* exist, is not an array, \p index doesn't exist in the array, or a conversion error occurs.
*/
int32_t getAsIntAt(const char* path, size_t index);
/**
* Attempts to set a 32-bit integer value in an array item.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). \p index is converted to a string and appended to \p path as a child path name. The
* child path is created as `eInt` or changed to be `eInt`, and the value is set from \p value. Subscription
* notifications are triggered when the current thread no longer has any settings locks.
*
* @see dictionary::IDictionary::setIntAt()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param value Integer value that will be stored to the supplied path.
*/
void setIntAt(const char* path, size_t index, int32_t value);
/**
* Fills the given buffer with the array values from the given path.
*
* If the provided @p path is not a dictionary item, @p arrayOut is not modified. If the array item contains more
* items than @p arrayBufferLength, a warning message is logged and items past the end are ignored.
* @warning Dictionary items that are not arrays will only have child keys which are convertible to array indices
* written to @p arrayOut. For example, if @p path is the location of a dictionary item with keys '5' and '10',
* only those items will be written into @p arrayOut; the other indices will not be written. It is highly
* recommended to take a \ref ScopedRead lock around calling this function, and call only if
* \ref isAccessibleAsArray or \ref isAccessibleAsArrayOf return \c true.
*
* @see carb::dictionary::IDictionary::getAsInt64Array
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param arrayOut Array buffer to fill with integer values.
* @param arrayBufferLength Size of the supplied array buffer.
*/
void(CARB_ABI* getAsInt64Array)(const char* path, int64_t* arrayOut, size_t arrayBufferLength);
/**
* Creates or updates an item to be an integer array.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). If \p path already exists as a `eDictionary` it is cleared (change notifications
* will be queued for any child items that are destroyed). New child items are created for all elements of the given
* @p array.
*
* @see carb::dictionary::IDictionary::setInt64Array
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Integer array to copy values from.
* @param arrayLength Array length.
*/
void(CARB_ABI* setInt64Array)(const char* path, const int64_t* array, size_t arrayLength);
/**
* Fills the given buffer with the array values from the given path.
*
* If the provided @p path is not a dictionary item, @p arrayOut is not modified. If the array item contains more
* items than @p arrayBufferLength, a warning message is logged and items past the end are ignored.
* @warning Dictionary items that are not arrays will only have child keys which are convertible to array indices
* written to @p arrayOut. For example, if @p path is the location of a dictionary item with keys '5' and '10',
* only those items will be written into @p arrayOut; the other indices will not be written. It is highly
* recommended to take a \ref ScopedRead lock around calling this function, and call only if
* \ref isAccessibleAsArray or \ref isAccessibleAsArrayOf return \c true.
* @warning Any integer element that does not fit within \c int32_t is truncated by casting.
*
* @see carb::dictionary::IDictionary::getAsIntArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param arrayOut Array buffer to fill with integer values.
* @param arrayBufferLength Size of the supplied array buffer.
*/
void(CARB_ABI* getAsIntArray)(const char* path, int32_t* arrayOut, size_t arrayBufferLength);
/**
* Creates or updates an item to be an integer array.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). If \p path already exists as a `eDictionary` it is cleared (change notifications
* will be queued for any child items that are destroyed). New child items are created for all elements of the given
* @p array.
*
* @see carb::dictionary::IDictionary::setIntArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Integer array to copy values from.
* @param arrayLength Array length.
*/
void(CARB_ABI* setIntArray)(const char* path, const int32_t* array, size_t arrayLength);
/**
* Attempts to read an array item as a `double`.
*
* Attempts to read the path and array index as a `double`, either directly or via conversion, considering the
* item at path to be an array, and using the supplied index to access its child.
* Default value (`0.0`) is returned if \p path doesn't exist, index doesn't exist, or there is a conversion
* failure.
*
* @see carb::dictionary::IDictionary::getAsFloat64At
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return `double` value, either raw value or cast from the real item type.
*/
double(CARB_ABI* getAsFloat64At)(const char* path, size_t index);
/**
* Attempts to set a `double` value in an array item.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). \p index is converted to a string and appended to \p path as a child path name. The
* child path is created as `eFloat` or changed to be `eFloat`, and the value is set from \p value. Subscription
* notifications are triggered when the current thread no longer has any settings locks.
*
* @see carb::dictionary::IDictionary::setFloat64At
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param value `double` value that will be stored to the supplied path.
*/
void(CARB_ABI* setFloat64At)(const char* path, size_t index, double value);
/**
* Attempts to read an array item as a `float`.
*
* Attempts to read the path and array index as a `float`, either directly or via conversion, considering the
* item at path to be an array, and using the supplied index to access its child.
* Default value (`0.0f`) is returned if \p path doesn't exist, index doesn't exist, or there is a conversion
* failure.
*
* @see carb::dictionary::IDictionary::getAsFloatAt()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @return `float` value, either raw value or cast from the real item type.
*/
float getAsFloatAt(const char* path, size_t index);
/**
* Attempts to set a `float` value in an array item.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). \p index is converted to a string and appended to \p path as a child path name. The
* child path is created as `eFloat` or changed to be `eFloat`, and the value is set from \p value. Subscription
* notifications are triggered when the current thread no longer has any settings locks.
*
* @see carb::dictionary::IDictionary::setFloatAt()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param value Floating point value that will be stored to the supplied path.
*/
void setFloatAt(const char* path, size_t index, float value);
/**
* Fills the given buffer with the array values from the given path.
*
* If the provided @p path is not a dictionary item, @p arrayOut is not modified. If the array item contains more
* items than @p arrayBufferLength, a warning message is logged and items past the end are ignored.
* @warning Dictionary items that are not arrays will only have child keys which are convertible to array indices
* written to @p arrayOut. For example, if @p path is the location of a dictionary item with keys '5' and '10',
* only those items will be written into @p arrayOut; the other indices will not be written. It is highly
* recommended to take a \ref ScopedRead lock around calling this function, and call only if
* \ref isAccessibleAsArray or \ref isAccessibleAsArrayOf return \c true.
*
* @see carb::dictionary::IDictionary::getAsFloat64Array
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param arrayOut Array buffer to fill with floating point values.
* @param arrayBufferLength Size of the supplied array buffer.
*/
void(CARB_ABI* getAsFloat64Array)(const char* path, double* arrayOut, size_t arrayBufferLength);
/**
* Creates or updates an item to be a `double` array.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). If \p path already exists as a `eDictionary` it is cleared (change notifications
* will be queued for any child items that are destroyed). New child items are created for all elements of the given
* @p array.
*
* @see carb::dictionary::IDictionary::setFloat64Array
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Floating point array to copy values from.
* @param arrayLength Array length.
*/
void(CARB_ABI* setFloat64Array)(const char* path, const double* array, size_t arrayLength);
/**
* Fills the given buffer with the array values from the given path.
*
* If the provided @p path is not a dictionary item, @p arrayOut is not modified. If the array item contains more
* items than @p arrayBufferLength, a warning message is logged and items past the end are ignored.
* @warning Dictionary items that are not arrays will only have child keys which are convertible to array indices
* written to @p arrayOut. For example, if @p path is the location of a dictionary item with keys '5' and '10',
* only those items will be written into @p arrayOut; the other indices will not be written. It is highly
* recommended to take a \ref ScopedRead lock around calling this function, and call only if
* \ref isAccessibleAsArray or \ref isAccessibleAsArrayOf return \c true.
* @warning Any element that does not fit within \c float is truncated by casting.
*
* @see carb::dictionary::IDictionary::getAsFloatArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param arrayOut Array buffer to fill with floating point values.
* @param arrayBufferLength Size of the supplied array buffer.
*/
void(CARB_ABI* getAsFloatArray)(const char* path, float* arrayOut, size_t arrayBufferLength);
/**
* Creates or updates an item to be a `float` array.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). If \p path already exists as a `eDictionary` it is cleared (change notifications
* will be queued for any child items that are destroyed). New child items are created for all elements of the given
* @p array.
*
* @see carb::dictionary::IDictionary::setFloatArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Floating point array to copy values from.
* @param arrayLength Array length.
*/
void(CARB_ABI* setFloatArray)(const char* path, const float* array, size_t arrayLength);
/**
* Attempts to read an array item as a `bool`.
*
* Attempts to read the path and array index as a `bool`, either directly or via conversion, considering the
* item at path to be an array, and using the supplied index to access its child.
* Default value (`false`) is returned if \p path doesn't exist, index doesn't exist, or there is a conversion
* failure.
*
* @see carb::dictionary::IDictionary::getAsBoolAt
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @return Boolean value, either raw value or cast from the real item type.
*/
bool(CARB_ABI* getAsBoolAt)(const char* path, size_t index);
/**
* Attempts to set a `bool` value in an array item.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). \p index is converted to a string and appended to \p path as a child path name. The
* child path is created as `eBool` or changed to be `eBool`, and the value is set from \p value. Subscription
* notifications are triggered when the current thread no longer has any settings locks.
*
* @see carb::dictionary::IDictionary::setBoolAt
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param value Boolean value that will be stored to the supplied path.
*/
void(CARB_ABI* setBoolAt)(const char* path, size_t index, bool value);
/**
* Fills the given buffer with the array values from the given path.
*
* If the provided @p path is not a dictionary item, @p arrayOut is not modified. If the array item contains more
* items than @p arrayBufferLength, a warning message is logged and items past the end are ignored.
* @warning Dictionary items that are not arrays will only have child keys which are convertible to array indices
* written to @p arrayOut. For example, if @p path is the location of a dictionary item with keys '5' and '10',
* only those items will be written into @p arrayOut; the other indices will not be written. It is highly
* recommended to take a \ref ScopedRead lock around calling this function, and call only if
* \ref isAccessibleAsArray or \ref isAccessibleAsArrayOf return \c true.
*
* @see carb::dictionary::IDictionary::getAsBoolArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param arrayOut Array buffer to fill with boolean values.
* @param arrayBufferLength Size of the supplied array buffer.
*/
void(CARB_ABI* getAsBoolArray)(const char* path, bool* arrayOut, size_t arrayBufferLength);
/**
* Creates or updates an item to be a `bool` array.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). If \p path already exists as a `eDictionary` it is cleared (change notifications
* will be queued for any child items that are destroyed). New child items are created for all elements of the given
* @p array.
*
* @see carb::dictionary::IDictionary::setBoolArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Boolean array to copy values from.
* @param arrayLength Array length.
*/
void(CARB_ABI* setBoolArray)(const char* path, const bool* array, size_t arrayLength);
//! @private
const char*(CARB_ABI* internalCreateStringBufferFromItemValueAt)(const char* path, size_t index, size_t* pStringLen);
/**
* Attempts to create a new string buffer with a value, either the real string value or a string resulting
* from converting the item value to a string.
*
* This function effectively converts \p index to a string, appends it to \p path after a path separator ('/'), and
* calls \ref createStringBufferFromItemValue().
*
* @see carb::dictionary::IDictionary::createStringBufferFromItemValueAt()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param pStringLen (optional) Receives the length of the string. This can be useful if the string contains NUL
* characters (i.e. byte data). Undefined if the function returns nullptr.
* @return Pointer to the created string buffer if applicable, nullptr otherwise. Non-nullptr return values must be
* passed to \ref destroyStringBuffer to dispose of when finished.
*
* @note It is undefined to create `std::string` out of nullptr. For using the value as `std::string`, see
* \ref carb::settings::getStringFromItemValueAt()
*/
const char* createStringBufferFromItemValueAt(const char* path, size_t index, size_t* pStringLen = nullptr) const
{
return internalCreateStringBufferFromItemValueAt(path, index, pStringLen);
}
//! @private
const char*(CARB_ABI* internalGetStringBufferAt)(const char* path, size_t index, size_t* pStringLen);
/**
* Returns internal raw data pointer to the string value of an item in an array. Thus, doesn't perform any
* conversions.
*
* @warning This function returns the internal string buffer. Another thread may change the setting value which can
* cause the string buffer to be destroyed. It is recommended to take a \ref ScopedRead lock around calling this
* function and using the return value.
*
* @see carb::dictionary::IDictionary::getStringBufferAt()
* @param path Settings database key path of an array item (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param pStringLen (optional) Receives the length of the string. This can be useful if the string contains NUL
* characters (i.e. byte data). Undefined if the function returns nullptr.
* @return Raw pointer to the internal string value if applicable, nullptr otherwise.
*
* @note It is undefined to create std::string out of nullptr. For using the value as std::string, @see
* carb::settings::getStringAt()
*/
const char* getStringBufferAt(const char* path, size_t index, size_t* pStringLen = nullptr) const
{
return internalGetStringBufferAt(path, index, pStringLen);
}
//! @private
void(CARB_ABI* internalSetStringAt)(const char* path, size_t index, const char* value, size_t stringLen);
/**
* Sets a string value at the given path.
*
* The given @p path is walked and any dictionary items are changed or created to create the path. @p index is
* converted to a string and appended to @p path. If the item at this composite path
* exists but is not of type `eString` it is changed to be `eString`. Change notifications for
* subscriptions are queued. The given string is then set in the item at the composite path path. If @p value is
* \c nullptr, the string item will store an empty string.
*
* @see carb::dictionary::IDictionary::setStringAt()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param index Index of the element in array.
* @param value String value that will be stored to the supplied path.
* @param stringLen (optional) The length of the string at \p value to copy. This can be useful if only a portion
* of the string should be copied, or if \p value contains NUL characters (i.e. byte data). The default value of
* size_t(-1) treats \p value as a NUL-terminated string.
*/
void setStringAt(const char* path, size_t index, const char* value, size_t stringLen = size_t(-1)) const
{
internalSetStringAt(path, index, value, stringLen);
}
/**
* Returns internal raw data pointers to the string value of all child items of an array. Thus, doesn't perform any
* conversions.
*
* @warning This function returns the internal string buffer(s) for several items. Another thread may change the
* setting value which can cause the string buffer to be destroyed. It is recommended to take a \ref ScopedRead lock
* around calling this function and use of the filled items in @p arrayOut.
*
* If the provided @p path is not a dictionary item, @p arrayOut is not modified. If the array item contains more
* items than @p arrayBufferLength, a warning message is logged and items past the end are ignored.
* @warning Dictionary items that are not arrays will only have child keys which are convertible to array indices
* written to @p arrayOut. For example, if @p path is the location of a dictionary item with keys '5' and '10',
* only those items will be written into @p arrayOut; the other indices will not be written. It is highly
* recommended to take a \ref ScopedRead lock around calling this function, and call only if
* \ref isAccessibleAsArray or \ref isAccessibleAsArrayOf return \c true.
*
* @see carb::dictionary::IDictionary::getStringBufferArray carb::settings::getStringArray()
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param arrayOut Array buffer to fill with char buffer pointer values.
* @param arrayBufferLength Size of the supplied array buffer.
*/
void(CARB_ABI* getStringBufferArray)(const char* path, const char** arrayOut, size_t arrayBufferLength);
/**
* Creates or updates an item to be a string array.
*
* Ensures that the given \p path exists as an `eDictionary`, changing types as the path is walked (and triggering
* subscription notifications). If \p path already exists as a `eDictionary` it is cleared (change notifications
* will be queued for any child items that are destroyed). New child items are created for all elements of the given
* @p array.
*
* @see carb::dictionary::IDictionary::setStringArray
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array String array to copy values from.
* @param arrayLength Array length.
*/
void(CARB_ABI* setStringArray)(const char* path, const char* const* array, size_t arrayLength);
/**
* Creates or updates an item to be an array of the given type with provided values.
*
* This is a helper function that will call the appropriate API function based on \c SettingArrayType:
* * `bool`: \ref setBoolArray
* * `int32_t`: \ref setIntArray
* * `int64_t`: \ref setInt64Array
* * `float`: \ref setFloatArray
* * `double`: \ref setFloat64Array
* * `const char*`: \ref setStringArray
*
* @see carb::dictionary::IDictionary::setArray()
* @tparam SettingArrayType The type of elements.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Array to copy values from.
* @param arrayLength Number of items in @p array.
*/
template <typename SettingArrayType>
void setArray(const char* path, const SettingArrayType* array, size_t arrayLength);
/**
* Creates a transaction.
*
* A transaction is an asynchronous settings database that can be applied at a later time as one atomic unit with
* \ref commitTransaction. A transaction may be retained and committed several times. A transaction must be disposed
* of with \ref destroyTransaction when it is no longer needed.
*
* Values can be set within the transaction with \ref setInt64Async, \ref setFloat64Async, \ref setBoolAsync and
* \ref setStringAsync.
*
* @returns An opaque \ref Transaction pointer.
*/
Transaction*(CARB_ABI* createTransaction)();
/**
* Destroys a transaction.
*
* Destroys a transaction previously created with \ref createTransaction.
* @warning After calling this function, the given @p transaction should no longer be used or undefined behavior
* will occur.
* @param transaction The \ref Transaction to destroy.
*/
void(CARB_ABI* destroyTransaction)(Transaction* transaction);
/**
* Commits a transaction.
*
* This atomically copies all of the values set in the transaction to the settings database. This is done as via:
* ```
* // note: transaction->database is expository only
* update("/", transaction->database, nullptr, carb::dictionary::overwriteOriginalWithArrayHandling,
* carb::getCachedInterface<carb::dictionary::IDictionary>());
* ```
* Values can be set within the transaction with \ref setInt64Async, \ref setFloat64Async, \ref setBoolAsync and
* \ref setStringAsync.
*
* This function can be called multiple times for a given @p transaction that has not been destroyed.
*
* Change notifications are queued.
*
* @param transaction The \ref Transaction to commit.
*/
void(CARB_ABI* commitTransaction)(Transaction* transaction);
/**
* Sets a value in a Transaction to be applied at a later time.
*
* The value is not committed to the settings database until \ref commitTransaction is called.
* @note Values cannot be read or deleted from a \ref Transaction.
*
* @param transaction The \ref Transaction previously created with \ref createTransaction.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`. The settings database is not
* modified until \ref commitTransaction is called.
* @param value The value to store in the \p transaction.
*/
void(CARB_ABI* setInt64Async)(Transaction* transaction, const char* path, int64_t value);
//! @copydoc setInt64Async
void(CARB_ABI* setFloat64Async)(Transaction* transaction, const char* path, double value);
//! @copydoc setInt64Async
void(CARB_ABI* setBoolAsync)(Transaction* transaction, const char* path, bool value);
//! @copydoc setInt64Async
void(CARB_ABI* setStringAsync)(Transaction* transaction, const char* path, const char* value);
/**
* Subscribes to change events about a specific item.
*
* When finished with the subscription, call \ref unsubscribeToChangeEvents.
*
* @see carb::dictionary::IDictionary::subscribeToNodeChangeEvents
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param onChangeEventFn The function to call when a change event occurs.
* @param userData User-specific data that will be provided to \p onChangeEventFn.
* @return A subscription handle that can be used with \ref unsubscribeToChangeEvents.
*/
dictionary::SubscriptionId*(CARB_ABI* subscribeToNodeChangeEvents)(const char* path,
dictionary::OnNodeChangeEventFn onChangeEventFn,
void* userData);
/**
* Subscribes to change events for all items in a subtree.
*
* All items including and under @p path will trigger change notifications.
*
* When finished with the subscription, call \ref unsubscribeToChangeEvents.
*
* @see carb::dictionary::IDictionary::subscribeToTreeChangeEvents
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param onChangeEventFn The function to call when a change event occurs.
* @param userData User-specific data that will be provided to \p onChangeEventFn.
* @return A subscription handle that can be used with \ref unsubscribeToChangeEvents.
*/
dictionary::SubscriptionId*(CARB_ABI* subscribeToTreeChangeEvents)(const char* path,
dictionary::OnTreeChangeEventFn onChangeEventFn,
void* userData);
/**
* Unsubscribes from change events.
*
* It is safe to call this function from within a subscription callback. Once it returns, this function guarantees
* that the subscription callback has exited (only if being called from another thread) and will never be called
* again.
*
* @param subscriptionId The subscription handle from \ref subscribeToNodeChangeEvents or
* \ref subscribeToTreeChangeEvents
*/
void(CARB_ABI* unsubscribeToChangeEvents)(dictionary::SubscriptionId* subscriptionId);
/**
* Merges the source item into the settings database. Destination path may be non-existing, then
* missing items in the path will be created as dictionaries.
*
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`. Used as the destination
* location within the settings database. "/" is considered to be the root.
* @param dictionary The \ref carb::dictionary::Item that is the base of the items to merge into the setting
* database.
* @param dictionaryPath A child path of @p dictionary to use as the root for merging. May be `nullptr` in order to
* use @p dictionary directly as the root.
* @param onUpdateItemFn Function that will tell whether the update should overwrite the destination item with the
* source item. See \ref carb::dictionary::keepOriginal(), \ref carb::dictionary::overwriteOriginal(), or
* \ref carb::dictionary::overwriteOriginalWithArrayHandling().
* @param userData User data pointer that will be passed into the onUpdateItemFn.
*/
void(CARB_ABI* update)(const char* path,
const dictionary::Item* dictionary,
const char* dictionaryPath,
dictionary::OnUpdateItemFn onUpdateItemFn,
void* userData);
/**
* Accesses the settings database as a dictionary Item.
*
* This allows use of \ref carb::dictionary::IDictionary functions directly.
*
* @warning The root \ref dictionary::Item is owned by \c ISettings and must not be altered or destroyed.
* @note It is highly recommended to take a \ref ScopedRead or \ref ScopedWrite lock while working with the setting
* database directly.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`. Used as the destination
* location within the settings database. "/" is considered to be the root.
* @returns A \ref carb::dictionary::Item that can be used directly with the \ref carb::dictionary::IDictionary
* interface.
*/
const dictionary::Item*(CARB_ABI* getSettingsDictionary)(const char* path);
/**
* Takes a snapshot of a portion of the settings database as a dictionary Item.
*
* @param path Settings database key path (i.e. "/log/level") to consider the root for the copy. "/" is considered
* to be the root (will copy the entire settings database).
* @returns A \ref carb::dictionary::Item that is a separate copy of the requested portion of the settings database.
* When no longer needed, this can be passed to \ref carb::dictionary::IDictionary::destroyItem.
*/
dictionary::Item*(CARB_ABI* createDictionaryFromSettings)(const char* path);
/**
* Destroys a setting item and queues change notifications.
*
* @warning Any string buffers or \ref carb::dictionary::Item pointers to the referenced path become invalid and
* their use is undefined behavior.
* @see carb::dictionary::IDictionary::destroyItem
* @param path Settings database key path (i.e. "/log/level") to destroy. "/" is considered
* to be the root (will clear the entire settings database without actually destroying the root).
*/
void(CARB_ABI* destroyItem)(const char* path);
/**
* Frees a string buffer.
*
* The string buffers are created by \ref createStringBufferFromItemValue() or
* \ref createStringBufferFromItemValueAt().
* @see carb::dictionary::IDictionary::destroyStringBuffer
* @param stringBuffer String buffer to destroy. Undefined behavior results if this is not a value returned from one
* of the functions listed above.
*/
void(CARB_ABI* destroyStringBuffer)(const char* stringBuffer);
/**
* Performs a one-time initialization from a given dictionary item.
*
* @note This function may only be called once. Subsequent calls will result in an error message logged.
* @param dictionary The \ref carb::dictionary::Item to initialize the settings database from. The items are copied
* into the root of the settings database. This item is not retained and may be destroyed immediately after this
* function returns.
*/
void(CARB_ABI* initializeFromDictionary)(const dictionary::Item* dictionary);
/**
* Sets a value at the given path, if and only if one does not already exist.
*
* Atomically checks if a value exists at the given @p path, and if so, exits without doing anything. Otherwise, any
* required dictionary items are created while walking @p path and @p value is stored. Change notifications are
* queued.
*
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param value Value that will be stored at the given @p path in the settings database.
*/
void setDefaultInt64(const char* path, int64_t value);
//! @copydoc setDefaultInt64
void setDefaultInt(const char* path, int32_t value);
//! @copydoc setDefaultInt64
void setDefaultFloat64(const char* path, double value);
//! @copydoc setDefaultInt64
void setDefaultFloat(const char* path, float value);
//! @copydoc setDefaultInt64
void setDefaultBool(const char* path, bool value);
//! @copydoc setDefaultInt64
void setDefaultString(const char* path, const char* value);
//! @copydoc setDefaultInt64
//! @tparam SettingType The type of @p value.
template <typename SettingType>
void setDefault(const char* path, SettingType value);
/**
* Copies values into the setting dictionary, if and only if they don't already exist.
*
* Values are checked and copied atomically, and change notifications are queued.
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`. This is the root location at
* which \p dictionary is copied in.
* @param dictionary The \ref dictionary::Item to copy defaults from.
*/
void setDefaultsFromDictionary(const char* path, const dictionary::Item* dictionary);
/**
* Sets an array of values at the given path, if and only if one does not already exist.
*
* Atomically checks if a value exists at the given @p path, and if so, exits without doing anything. Otherwise, any
* required dictionary items are created while walking @p path and @p array is stored. Change notifications are
* queued.
*
* @param path Settings database key path (i.e. "/log/level"). Must not be `nullptr`.
* @param array Array of values that will be stored at the given @p path in the settings database.
* @param arrayLength Number of values in @p array.
*/
void setDefaultInt64Array(const char* path, const int64_t* array, size_t arrayLength);
//! @copydoc setDefaultInt64Array
void setDefaultIntArray(const char* path, const int32_t* array, size_t arrayLength);
//! @copydoc setDefaultInt64Array
void setDefaultFloat64Array(const char* path, const double* array, size_t arrayLength);
//! @copydoc setDefaultInt64Array
void setDefaultFloatArray(const char* path, const float* array, size_t arrayLength);
//! @copydoc setDefaultInt64Array
void setDefaultBoolArray(const char* path, const bool* array, size_t arrayLength);
//! @copydoc setDefaultInt64Array
void setDefaultStringArray(const char* path, const char* const* array, size_t arrayLength);
//! @copydoc setDefaultInt64Array
//! @tparam SettingArrayType The type of the values in @p array.
template <typename SettingArrayType>
void setDefaultArray(const char* path, const SettingArrayType* array, size_t arrayLength);
};
/**
* A helper class for performing a scoped write lock on the settings database.
*/
class ScopedWrite : public carb::dictionary::ScopedWrite
{
public:
/**
* RAII constructor. Immediately takes a write lock and holds it until *this is destroyed.
* @note Settings locks are recursive.
* @warning If the current thread already owns a read lock (i.e. via \ref ScopedRead), promotion to a write lock
* necessitates *releasing* all locks and then waiting for a write lock. This can cause state to change. Always
* re-evaluate state if this is the case.
*/
ScopedWrite()
: carb::dictionary::ScopedWrite(
*carb::getCachedInterface<dictionary::IDictionary>(),
const_cast<dictionary::Item*>(carb::getCachedInterface<settings::ISettings>()->getSettingsDictionary("/")))
{
}
//! Destructor. Releases the write lock.
~ScopedWrite() = default;
CARB_PREVENT_COPY_AND_MOVE(ScopedWrite);
};
/**
* A helper class for performing a scoped read lock on the settings database.
*/
class ScopedRead : public carb::dictionary::ScopedRead
{
public:
/**
* RAII constructor. Immediately takes a read lock and holds it until *this is destroyed.
* @note Settings locks are recursive.
*/
ScopedRead()
: carb::dictionary::ScopedRead(*carb::getCachedInterface<dictionary::IDictionary>(),
carb::getCachedInterface<settings::ISettings>()->getSettingsDictionary("/"))
{
}
//! Destructor. Releases the read lock.
~ScopedRead() = default;
CARB_PREVENT_COPY_AND_MOVE(ScopedRead);
};
inline int32_t ISettings::getAsInt(const char* path)
{
auto val = getAsInt64(path);
CARB_ASSERT(val >= INT_MIN && val <= INT_MAX);
return int32_t(val);
}
inline void ISettings::setInt(const char* path, int32_t value)
{
setInt64(path, (int64_t)value);
}
inline float ISettings::getAsFloat(const char* path)
{
return (float)getAsFloat64(path);
}
inline void ISettings::setFloat(const char* path, float value)
{
setFloat64(path, (double)value);
}
inline int32_t ISettings::getAsIntAt(const char* path, size_t index)
{
auto val = getAsInt64At(path, index);
CARB_ASSERT(val >= INT_MIN && val <= INT_MAX);
return int32_t(val);
}
inline void ISettings::setIntAt(const char* path, size_t index, int32_t value)
{
setInt64At(path, index, (int64_t)value);
}
inline float ISettings::getAsFloatAt(const char* path, size_t index)
{
return (float)getAsFloat64At(path, index);
}
inline void ISettings::setFloatAt(const char* path, size_t index, float value)
{
setFloat64At(path, index, (double)value);
}
inline void ISettings::setDefaultInt64(const char* path, int64_t value)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setInt64(path, value);
}
}
inline void ISettings::setDefaultInt(const char* path, int32_t value)
{
setDefaultInt64(path, (int64_t)value);
}
inline void ISettings::setDefaultFloat64(const char* path, double value)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setFloat64(path, value);
}
}
inline void ISettings::setDefaultFloat(const char* path, float value)
{
setDefaultFloat64(path, (double)value);
}
inline void ISettings::setDefaultBool(const char* path, bool value)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setBool(path, value);
}
}
inline void ISettings::setDefaultString(const char* path, const char* value)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setString(path, value);
}
}
inline void ISettings::setDefaultsFromDictionary(const char* path, const dictionary::Item* dictionary)
{
if (dictionary)
{
update(path, dictionary, nullptr, dictionary::kUpdateItemKeepOriginal, nullptr);
}
}
inline void ISettings::setDefaultInt64Array(const char* path, const int64_t* array, size_t arrayLength)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setInt64Array(path, array, arrayLength);
}
}
inline void ISettings::setDefaultIntArray(const char* path, const int32_t* array, size_t arrayLength)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setIntArray(path, array, arrayLength);
}
}
inline void ISettings::setDefaultFloat64Array(const char* path, const double* array, size_t arrayLength)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setFloat64Array(path, array, arrayLength);
}
}
inline void ISettings::setDefaultFloatArray(const char* path, const float* array, size_t arrayLength)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setFloatArray(path, array, arrayLength);
}
}
inline void ISettings::setDefaultBoolArray(const char* path, const bool* array, size_t arrayLength)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setBoolArray(path, array, arrayLength);
}
}
inline void ISettings::setDefaultStringArray(const char* path, const char* const* array, size_t arrayLength)
{
ScopedWrite writeLock;
dictionary::ItemType itemType = getItemType(path);
if (itemType == dictionary::ItemType::eCount)
{
setStringArray(path, array, arrayLength);
}
}
#ifndef DOXYGEN_BUILD
template <>
inline int32_t ISettings::get<int>(const char* path)
{
return getAsInt(path);
}
template <>
inline int64_t ISettings::get<int64_t>(const char* path)
{
return getAsInt64(path);
}
template <>
inline float ISettings::get<float>(const char* path)
{
return getAsFloat(path);
}
template <>
inline double ISettings::get<double>(const char* path)
{
return getAsFloat64(path);
}
template <>
inline bool ISettings::get<bool>(const char* path)
{
return getAsBool(path);
}
template <>
inline const char* ISettings::get<const char*>(const char* path)
{
return getStringBuffer(path);
}
template <>
inline void ISettings::set<int32_t>(const char* path, int32_t value)
{
setInt(path, value);
}
template <>
inline void ISettings::set<int64_t>(const char* path, int64_t value)
{
setInt64(path, value);
}
template <>
inline void ISettings::set<float>(const char* path, float value)
{
setFloat(path, value);
}
template <>
inline void ISettings::set<double>(const char* path, double value)
{
setFloat64(path, value);
}
template <>
inline void ISettings::set<bool>(const char* path, bool value)
{
setBool(path, value);
}
template <>
inline void ISettings::set<const char*>(const char* path, const char* value)
{
setString(path, value);
}
template <>
inline void ISettings::setArray(const char* path, const bool* array, size_t arrayLength)
{
setBoolArray(path, array, arrayLength);
}
template <>
inline void ISettings::setArray(const char* path, const int32_t* array, size_t arrayLength)
{
setIntArray(path, array, arrayLength);
}
template <>
inline void ISettings::setArray(const char* path, const int64_t* array, size_t arrayLength)
{
setInt64Array(path, array, arrayLength);
}
template <>
inline void ISettings::setArray(const char* path, const float* array, size_t arrayLength)
{
setFloatArray(path, array, arrayLength);
}
template <>
inline void ISettings::setArray(const char* path, const double* array, size_t arrayLength)
{
setFloat64Array(path, array, arrayLength);
}
template <>
inline void ISettings::setArray(const char* path, const char* const* array, size_t arrayLength)
{
setStringArray(path, array, arrayLength);
}
template <>
inline void ISettings::setDefault(const char* path, bool value)
{
setDefaultBool(path, value);
}
template <>
inline void ISettings::setDefault(const char* path, int32_t value)
{
setDefaultInt(path, value);
}
template <>
inline void ISettings::setDefault(const char* path, int64_t value)
{
setDefaultInt64(path, value);
}
template <>
inline void ISettings::setDefault(const char* path, float value)
{
setDefaultFloat(path, value);
}
template <>
inline void ISettings::setDefault(const char* path, double value)
{
setDefaultFloat64(path, value);
}
template <>
inline void ISettings::setDefault(const char* path, const char* value)
{
setDefaultString(path, value);
}
template <>
inline void ISettings::setDefaultArray(const char* settingsPath, const bool* array, size_t arrayLength)
{
setDefaultBoolArray(settingsPath, array, arrayLength);
}
template <>
inline void ISettings::setDefaultArray(const char* settingsPath, const int32_t* array, size_t arrayLength)
{
setDefaultIntArray(settingsPath, array, arrayLength);
}
template <>
inline void ISettings::setDefaultArray(const char* settingsPath, const int64_t* array, size_t arrayLength)
{
setDefaultInt64Array(settingsPath, array, arrayLength);
}
template <>
inline void ISettings::setDefaultArray(const char* settingsPath, const float* array, size_t arrayLength)
{
setDefaultFloatArray(settingsPath, array, arrayLength);
}
template <>
inline void ISettings::setDefaultArray(const char* settingsPath, const double* array, size_t arrayLength)
{
setDefaultFloat64Array(settingsPath, array, arrayLength);
}
template <>
inline void ISettings::setDefaultArray(const char* settingsPath, const char* const* array, size_t arrayLength)
{
setDefaultStringArray(settingsPath, array, arrayLength);
}
#endif
} // namespace settings
} // namespace carb
| 67,156 | C | 45.636806 | 121 | 0.690586 |
omniverse-code/kit/include/carb/settings/SettingsUtils.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief carb.settings utilities
#pragma once
#include "../dictionary/DictionaryUtils.h"
#include "../dictionary/ISerializer.h"
#include "ISettings.h"
#include <atomic>
#include <string>
namespace carb
{
namespace settings
{
/**
* Retrieves a std::string from a setting key for simplicity.
*
* Typically to retrieve a string value from \ref carb::dictionary::Item,
* \ref ISettings::createStringBufferFromItemValue() must be called, but this means that
* \ref ISettings::destroyStringBuffer() must be called when finished. This function instead returns a `std::string`.
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path to retrieve.
* @param defaultValue The value that is returned if \p path is not a valid path.
* @returns A `std::string` representation of the item value.
* @see ISettings::createStringBufferFromItemValue(), getStringFromItemValueAt().
*/
inline std::string getStringFromItemValue(const ISettings* settings, const char* path, const std::string& defaultValue = "")
{
const char* stringBuf = settings->createStringBufferFromItemValue(path);
if (!stringBuf)
return defaultValue;
std::string returnString = stringBuf;
settings->destroyStringBuffer(stringBuf);
return returnString;
}
/**
* Retrieves a std::string from an array setting key for simplicity.
*
* Typically to retrieve a string value from an array of \ref carb::dictionary::Item objects,
* \ref ISettings::createStringBufferFromItemValueAt() must be called, but this means that
* \ref ISettings::destroyStringBuffer() must be called when finished. This function instead returns a `std::string`.
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path to retrieve (must be an array or \p defaultValue will be returned).
* @param index The array index to retrieve.
* @param defaultValue The value that is returned if \p path is not a valid path, not an array, or the index does not
* exist.
* @returns A `std::string` representation of the item value.
* @see ISettings::createStringBufferFromItemValueAt(), getStringFromItemValue().
*/
inline std::string getStringFromItemValueAt(const ISettings* settings,
const char* path,
size_t index,
const std::string& defaultValue = "")
{
const char* stringBuf = settings->createStringBufferFromItemValueAt(path, index);
if (!stringBuf)
return defaultValue;
std::string returnString = stringBuf;
settings->destroyStringBuffer(stringBuf);
return returnString;
}
/**
* Retrieves a std::string from a string-type setting for simplicity.
*
* Equivalent to:
* ```cpp
* auto p = settings->getStringBuffer(path); return p ? std::string(p) : defaultValue;
* ```
* @see ISettings::getStringBuffer, getStringAt()
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path to retrieve (must be a string or \p defaultValue will be returned).
* @param defaultValue The value that is returned if \p path is not a valid path or not a string setting.
* @returns A `std::string` representation of the item value.
*/
inline std::string getString(const ISettings* settings, const char* path, const std::string& defaultValue = "")
{
const char* value = settings->getStringBuffer(path);
if (!value)
return defaultValue;
return value;
}
/**
* Retrieves a std::string from an array of string-type setting for simplicity.
*
* Equivalent to:
* ```cpp
* auto p = settings->getStringBufferAt(path, index); return p ? std::string(p) : defaultValue;
* ```
* @see ISettings::getStringBuffer, getString()
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path to retrieve (must be an array of strings or \p defaultValue will be returned).
* @param index The array index to retrieve.
* @param defaultValue The value that is returned if \p path is not a valid path, not an array of strings, or the
* index does not exist.
* @returns A `std::string` representation of the item value.
*/
inline std::string getStringAt(const ISettings* settings,
const char* path,
size_t index,
const std::string& defaultValue = "")
{
const char* value = settings->getStringBufferAt(path, index);
if (!value)
return defaultValue;
return value;
}
/**
* A helper function for setting a `std::vector<int>` as an array of integers.
*
* Equivalent to:
* ```cpp
* settings->setIntArray(path, array.data(), array.size());
* ```
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. See \ref ISettings::setIntArray for details.
* @param array A vector containing the integer values for the setting value.
*/
inline void setIntArray(ISettings* settings, const char* path, const std::vector<int>& array)
{
settings->setIntArray(path, array.data(), array.size());
}
/**
* A helper function for setting a `std::vector<int64_t>` as an array of 64-bit integers.
*
* Equivalent to:
* ```cpp
* settings->setInt64Array(path, array.data(), array.size());
* ```
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. See \ref ISettings::setInt64Array for details.
* @param array A vector containing the 64-bit integer values for the setting value.
*/
inline void setIntArray(ISettings* settings, const char* path, const std::vector<int64_t>& array)
{
settings->setInt64Array(path, array.data(), array.size());
}
/**
* A helper function for setting a `std::vector<float>` as an array of floats.
*
* Equivalent to:
* ```cpp
* settings->setFloatArray(path, array.data(), array.size());
* ```
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. See \ref ISettings::setFloatArray for details.
* @param array A vector containing the float values for the setting value.
*/
inline void setFloatArray(ISettings* settings, const char* path, const std::vector<float>& array)
{
settings->setFloatArray(path, array.data(), array.size());
}
/**
* A helper function for setting a `std::vector<double>` as an array of doubles.
*
* Equivalent to:
* ```cpp
* settings->setFloatArray(path, array.data(), array.size());
* ```
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. See \ref ISettings::setFloat64Array for details.
* @param array A vector containing the double values for the setting value.
*/
inline void setFloatArray(ISettings* settings, const char* path, const std::vector<double>& array)
{
settings->setFloat64Array(path, array.data(), array.size());
}
/**
* A helper function for setting a `std::vector<bool>` as an array of bools.
*
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. See \ref ISettings::setBoolArray for details.
* @param array A vector containing the bool values for the setting value.
* @note \p array is first converted to an array of `bool` on the stack and then passed in to
* \ref ISettings::setBoolArray. If the stack is particularly small and \p array is particularly large, stack space
* may be exceeded. In this case, it is advised to call \ref ISettings::setBoolArray directly.
*/
inline void setBoolArray(ISettings* settings, const char* path, const std::vector<bool>& array)
{
const size_t arraySize = array.size();
// Since std::vector<bool> is typically specialized and doesn't function like normal vector (i.e. no data()), first
// convert to an array of bools on the stack.
bool* pbools = CARB_STACK_ALLOC(bool, arraySize);
for (size_t i = 0; i != arraySize; ++i)
pbools[i] = array[i];
settings->setBoolArray(path, pbools, arraySize);
}
/**
* A helper function for reading a setting value that is an array of string values as `std::vector<std::string>`.
*
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. If this path does not exist or is not an array, an empty vector will be returned.
* @param defaultValue The value that is returned for each array item if the array item is not a string value.
* @returns a `std::vector<std::string>` of all string array elements. If the value at \p path does not
* exist or is not an array type, an empty vector is returned. Otherwise, a vector is returned with the number of
* elements matching the number of elements in the value at \p path (as determined via
* \ref ISettings::getArrayLength). Any array elements that are not string types will instead be \p defaultValue.
* @see getStringArrayFromItemValues() for a function that handles values of mixed or non-string types.
*/
inline std::vector<std::string> getStringArray(ISettings* settings, const char* path, const std::string& defaultValue = "")
{
dictionary::ScopedRead readLock(
*carb::getCachedInterface<dictionary::IDictionary>(), settings->getSettingsDictionary(""));
std::vector<std::string> array(settings->getArrayLength(path));
for (size_t i = 0, arraySize = array.size(); i < arraySize; ++i)
{
array[i] = getStringAt(settings, path, i, defaultValue);
}
return array;
}
/**
* A helper function for reading a setting value that is an array of mixed values as `std::vector<std::string>`.
*
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. If this path does not exist or is not an array, an empty vector will be returned.
* @param defaultValue The value that is returned for each array item if the array item cannot be converted to a string
* value.
* @returns a `std::vector<std::string>` of all array elements converted to a string. If the value at \p path does not
* exist or is not an array type, an empty vector is returned. Otherwise, a vector is returned with the number of
* elements matching the number of elements in the value at \p path (as determined via
* \ref ISettings::getArrayLength). Any array elements that cannot be converted to a string will instead be
* \p defaultValue.
*/
inline std::vector<std::string> getStringArrayFromItemValues(ISettings* settings,
const char* path,
const std::string& defaultValue = "")
{
dictionary::ScopedRead readLock(
*carb::getCachedInterface<dictionary::IDictionary>(), settings->getSettingsDictionary(""));
std::vector<std::string> array(settings->getArrayLength(path));
for (size_t i = 0, arraySize = array.size(); i < arraySize; ++i)
{
array[i] = getStringFromItemValueAt(settings, path, i, defaultValue);
}
return array;
}
/**
* A helper function for setting a `std::vector<bool>` as an array of strings.
*
* @param settings The acquired \ref ISettings interface.
* @param path The setting key path. See \ref ISettings::setStringArray for details.
* @param array A vector containing the bool values for the setting value.
* @note \p array is first converted to an array of `const char*` on the stack and then passed in to
* \ref ISettings::setStringArray. If the stack is particularly small and \p array is particularly large, stack space
* may be exceeded. In this case, it is advised to call \ref ISettings::setStringArray directly.
*/
inline void setStringArray(ISettings* settings, const char* path, const std::vector<std::string>& array)
{
const size_t arraySize = array.size();
const char** pp = CARB_STACK_ALLOC(const char*, arraySize);
for (size_t i = 0; i != arraySize; ++i)
pp[i] = array[i].c_str();
settings->setStringArray(path, pp, arraySize);
}
/**
* A helper function to load settings from a file.
*
* This function first creates a dictionary from a file using the provided \p serializer passed to
* \ref carb::dictionary::createDictionaryFromFile(). The dictionary is then applied to the settings system with
* \ref ISettings::update at settings path \p path using the \ref carb::dictionary::overwriteOriginalWithArrayHandling()
* method. The created dictionary is then destroyed. When the function returns, the settings from the given \p filename
* are available to be queried through the settings system.
* @param settings The acquired \ref ISettings interface.
* @param path The path at which the loaded settings are placed. An empty string or "/" is considered the root of the
* settings tree.
* @param dictionary The acquired \ref dictionary::IDictionary interface.
* @param serializer The \ref dictionary::ISerializer interface to use. The file format should match the format of
* \p filename. I.e. if \p filename is a json file, the \ref dictionary::ISerializer from
* *carb.dictionary.serializer-json.plugin* should be used.
* @param filename The filename to read settings from.
*/
inline void loadSettingsFromFile(ISettings* settings,
const char* path,
dictionary::IDictionary* dictionary,
dictionary::ISerializer* serializer,
const char* filename)
{
carb::dictionary::Item* settingsFromFile = carb::dictionary::createDictionaryFromFile(serializer, filename);
if (settingsFromFile)
{
settings->update(path, settingsFromFile, nullptr, dictionary::overwriteOriginalWithArrayHandling, dictionary);
dictionary->destroyItem(settingsFromFile);
}
}
/**
* A helper function to save settings to a file.
*
* @see dictionary::saveFileFromDictionary()
* @param settings The acquired \ref ISettings interface.
* @param serializer The \ref dictionary::ISerializer interface to use. The serializer should match the desired output
* file format. I.e. if a json file is desired, the \ref dictionary::ISerializer from
* *carb.dictionary.serializer-json.plugin* should be used.
* @param path The settings path to save. An empty string or "/" is considered the root of the settings tree.
* @param filename The filename to write settings into. This file will be overwritten.
* @param serializerOptions Options that will be passed to \p serializer.
*/
inline void saveFileFromSettings(const ISettings* settings,
dictionary::ISerializer* serializer,
const char* path,
const char* filename,
dictionary::SerializerOptions serializerOptions)
{
const dictionary::Item* settingsDictionaryAtPath = settings->getSettingsDictionary(path);
dictionary::saveFileFromDictionary(serializer, settingsDictionaryAtPath, filename, serializerOptions);
}
/**
* A function for walking all of the settings from a given root.
*
* Similar to \ref dictionary::walkDictionary().
* @tparam ElementData Type of the second parameter passed to \p onItemFn.
* @tparam OnItemFnType Type of the invocable \p onItemFn.
* @param idict The acquired \ref dictionary::IDictionary interface.
* @param settings The acquired \ref ISettings interface.
* @param walkerMode See \ref dictionary::WalkerMode.
* @param rootPath The settings root to begin the walk at. An empty string or "/" is considered the root of the settings
* tree.
* @param rootElementData A value of type `ElementData` that is passed as the second parameter to \p onItemFn. This
* value is not used by `walkSettings()` and is intended to be used only by the caller and the \p onItemFn invocable.
* @param onItemFn An invocable that is invoked for each setting value encountered. The type of this invocable should be
* `ElementData(const char*, ElementData, void*)`: the encountered item path is the first parameter, followed by the
* parent's `ElementData`, followed by \p userData. The return value is only used for dictionary and array settings:
* the returned `ElementData` will be passed to \p onItemFn invocations for child settings; the return value is
* otherwise ignored.
* @param userData A caller-specific value that is not used but is passed to every \p onItemFn invocation.
*/
template <typename ElementData, typename OnItemFnType>
inline void walkSettings(carb::dictionary::IDictionary* idict,
carb::settings::ISettings* settings,
dictionary::WalkerMode walkerMode,
const char* rootPath,
ElementData rootElementData,
OnItemFnType onItemFn,
void* userData)
{
using namespace carb;
if (!rootPath)
{
return;
}
if (rootPath[0] == 0)
rootPath = "/";
struct ValueToParse
{
std::string srcPath;
ElementData elementData;
};
std::vector<ValueToParse> valuesToParse;
valuesToParse.reserve(100);
auto enqueueChildren = [&idict, &settings, &valuesToParse](const char* parentPath, ElementData parentElementData) {
if (!parentPath)
{
return;
}
const dictionary::Item* parentItem = settings->getSettingsDictionary(parentPath);
size_t numChildren = idict->getItemChildCount(parentItem);
for (size_t chIdx = 0; chIdx < numChildren; ++chIdx)
{
const dictionary::Item* childItem = idict->getItemChildByIndex(parentItem, numChildren - chIdx - 1);
const char* childItemName = idict->getItemName(childItem);
std::string childPath;
bool isRootParent = (idict->getItemParent(parentItem) == nullptr);
if (isRootParent)
{
childPath = std::string(parentPath) + childItemName;
}
else
{
childPath = std::string(parentPath) + "/" + childItemName;
}
valuesToParse.push_back({ childPath, parentElementData });
}
};
if (walkerMode == dictionary::WalkerMode::eSkipRoot)
{
const char* parentPath = rootPath;
ElementData parentElementData = rootElementData;
enqueueChildren(parentPath, parentElementData);
}
else
{
valuesToParse.push_back({ rootPath, rootElementData });
}
while (valuesToParse.size())
{
const ValueToParse& valueToParse = valuesToParse.back();
std::string curItemPathStorage = std::move(valueToParse.srcPath);
const char* curItemPath = curItemPathStorage.c_str();
ElementData elementData = std::move(valueToParse.elementData);
valuesToParse.pop_back();
dictionary::ItemType curItemType = settings->getItemType(curItemPath);
if (curItemType == dictionary::ItemType::eDictionary)
{
ElementData parentElementData = onItemFn(curItemPath, elementData, userData);
enqueueChildren(curItemPath, parentElementData);
}
else
{
onItemFn(curItemPath, elementData, userData);
}
}
}
/**
* A utility for caching a setting and automatically subscribing to changes of the value, as opposed to constantly
* polling.
*
* @thread_safety Despite the name, this class is not thread-safe except that another thread may change the setting
* value and `*this` will have the cached value updated in a thread-safe manner. Unless otherwise specified, assume that
* calls to all functions must be serialized externally.
*
* @tparam SettingType The type of the setting. Must be a supported setting value type or compilation errors will
* result: `bool`, `int32_t`, `int64_t`, `float`, `double`, `const char*`.
*/
template <typename SettingType>
class ThreadSafeLocalCache
{
public:
/**
* Constructor.
* @param initState The initial value to cache.
* @note The value is not read from \ref ISettings and tracking does not start until \ref startTracking() is called.
* Attempting to read the value before calling \ref startTracking() will result in an assert.
*/
ThreadSafeLocalCache(SettingType initState = SettingType{}) : m_value(initState), m_valueDirty(false)
{
}
/**
* Destructor.
*
* Calls \ref stopTracking().
*/
~ThreadSafeLocalCache()
{
stopTracking();
}
/**
* Reads the value from the settings database and subscribes to changes for the value.
*
* This function reads the setting value at the given \p settingPath and caches it. Then
* \ref ISettings::subscribeToNodeChangeEvents is called so that *this can be notified of changes to the value.
* @note Assertions will occur if \p settingPath is `nullptr` or tracking is already started without calling
* \ref stopTracking() first.
* @param settingPath The path of the setting to read. Must not be `nullptr`.
*/
void startTracking(const char* settingPath)
{
CARB_ASSERT(settingPath, "Must specify a valid setting name.");
CARB_ASSERT(m_subscription == nullptr,
"Already tracking this value, do not track again without calling stopTracking first.");
Framework* f = getFramework();
m_settings = f->tryAcquireInterface<settings::ISettings>();
m_dictionary = f->tryAcquireInterface<dictionary::IDictionary>();
if (!m_settings || !m_dictionary)
return;
m_valueSettingsPath = settingPath;
m_value.store(m_settings->get<SettingType>(settingPath), std::memory_order_relaxed);
m_valueDirty.store(false, std::memory_order_release);
m_subscription = m_settings->subscribeToNodeChangeEvents(
settingPath,
[](const dictionary::Item* changedItem, dictionary::ChangeEventType changeEventType, void* userData) {
if (changeEventType == dictionary::ChangeEventType::eChanged)
{
ThreadSafeLocalCache* thisClassInstance = reinterpret_cast<ThreadSafeLocalCache*>(userData);
thisClassInstance->m_value.store(
thisClassInstance->getDictionaryInterface()->template get<SettingType>(changedItem),
std::memory_order_relaxed);
thisClassInstance->m_valueDirty.store(true, std::memory_order_release);
}
},
this);
if (m_subscription != nullptr)
{
f->addReleaseHook(m_settings, sOnRelease, this);
}
}
/**
* Halts tracking changes on the setting key provided with \ref startTracking().
*
* It is safe to call this function even if tracking has already been stopped, or never started. Do not call
* \ref get() after calling this function without calling \ref startTracking() prior, otherwise an assertion will
* occur.
*/
void stopTracking()
{
if (m_subscription)
{
carb::getFramework()->removeReleaseHook(m_settings, sOnRelease, this);
m_settings->unsubscribeToChangeEvents(m_subscription);
m_subscription = nullptr;
}
}
/**
* Retrieves the cached value.
*
* @warning `get()` may only be called while a subscription is active. A subscription is only active once
* \ref startTracking() has been called (including on a newly constructed object), and only until
* \ref stopTracking() is called (at which point \ref startTracking() may be called to resume). Calling this
* function when a subscription is not active will result in an assertion and potentially reading a stale value.
* @thread_safety This function is safe to call from multiple threads, though if the setting value is changed by
* other threads, multiple threads calling this function may receive different results.
* @returns The cached value of the setting key provided in \ref startTracking().
*/
SettingType get() const
{
CARB_ASSERT(m_subscription, "Call startTracking before reading this variable.");
return m_value.load(std::memory_order_relaxed);
}
/**
* Syntactic sugar for \ref get().
*/
operator SettingType() const
{
return get();
}
/**
* Sets the value in the setting database.
*
* @note Do not call this function after \ref stopTracking() has been called and/or before \ref startTracking() has
* been called, otherwise an assertion will occur and the setting database may be corrupted.
* @param value The new value to set for the setting key given to \ref startTracking().
*/
void set(SettingType value)
{
CARB_ASSERT(m_subscription);
if (!m_valueSettingsPath.empty())
m_settings->set<SettingType>(m_valueSettingsPath.c_str(), value);
}
/**
* Checks to see if the cached value has been updated.
*
* The dirty flag must be manually reset by calling \ref clearValueDirty(). The dirty flag is set any time the
* cached value is updated through the subscription. This also includes calls to \ref set(SettingType).
* @returns \c true if the dirty flag is set; \c false otherwise.
*/
bool isValueDirty() const
{
return m_valueDirty.load(std::memory_order_relaxed);
}
/**
* Resets the dirty flag.
*
* After this function returns (and assuming that the subscription has not updated the cached value on a different
* thread), \ref isValueDirty() will return `false`.
*/
void clearValueDirty()
{
m_valueDirty.store(false, std::memory_order_release);
}
/**
* Retrieves the setting key previously given to \ref startTracking().
* @returns The setting key previously given to \ref startTracking().
*/
const char* getSettingsPath() const
{
return m_valueSettingsPath.c_str();
}
/**
* Retrieves the cached \ref dictionary::IDictionary pointer.
* @returns The cached \ref dictionary::IDictionary pointer.
*/
inline dictionary::IDictionary* getDictionaryInterface() const
{
return m_dictionary;
}
private:
static void sOnRelease(void* iface, void* user)
{
// Settings has gone away, so our subscription is defunct
static_cast<ThreadSafeLocalCache*>(user)->m_subscription = nullptr;
carb::getFramework()->removeReleaseHook(iface, sOnRelease, user);
}
// NOTE: The callback may come in on another thread so wrap it in an atomic to prevent a race.
std::atomic<SettingType> m_value;
std::atomic<bool> m_valueDirty;
std::string m_valueSettingsPath;
dictionary::SubscriptionId* m_subscription = nullptr;
dictionary::IDictionary* m_dictionary = nullptr;
settings::ISettings* m_settings = nullptr;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template <>
class ThreadSafeLocalCache<const char*>
{
public:
ThreadSafeLocalCache(const char* initState = "") : m_valueDirty(false)
{
std::lock_guard<std::mutex> guard(m_valueMutex);
m_value = initState;
}
~ThreadSafeLocalCache()
{
stopTracking();
}
void startTracking(const char* settingPath)
{
CARB_ASSERT(settingPath, "Must specify a valid setting name.");
CARB_ASSERT(m_subscription == nullptr,
"Already tracking this value, do not track again without calling stopTracking first.");
Framework* f = getFramework();
m_settings = f->tryAcquireInterface<settings::ISettings>();
m_dictionary = f->tryAcquireInterface<dictionary::IDictionary>();
m_valueSettingsPath = settingPath;
const char* valueRaw = m_settings->get<const char*>(settingPath);
m_value = valueRaw ? valueRaw : "";
m_valueDirty.store(false, std::memory_order_release);
m_subscription = m_settings->subscribeToNodeChangeEvents(
settingPath,
[](const dictionary::Item* changedItem, dictionary::ChangeEventType changeEventType, void* userData) {
if (changeEventType == dictionary::ChangeEventType::eChanged)
{
ThreadSafeLocalCache* thisClassInstance = reinterpret_cast<ThreadSafeLocalCache*>(userData);
{
const char* valueStringBuffer =
thisClassInstance->getDictionaryInterface()->template get<const char*>(changedItem);
std::lock_guard<std::mutex> guard(thisClassInstance->m_valueMutex);
thisClassInstance->m_value = valueStringBuffer ? valueStringBuffer : "";
}
thisClassInstance->m_valueDirty.store(true, std::memory_order_release);
}
},
this);
if (m_subscription)
{
f->addReleaseHook(m_settings, sOnRelease, this);
}
}
void stopTracking()
{
if (m_subscription)
{
m_settings->unsubscribeToChangeEvents(m_subscription);
m_subscription = nullptr;
carb::getFramework()->removeReleaseHook(m_settings, sOnRelease, this);
}
}
const char* get() const
{
// Not a safe operation
CARB_ASSERT(false);
CARB_LOG_ERROR("Shouldn't use unsafe get on a ThreadSafeLocalCache<const char*>");
return "";
}
operator const char*() const
{
// Not a safe operation
return get();
}
std::string getStringSafe() const
{
// Not a safe operation
CARB_ASSERT(m_subscription, "Call startTracking before reading this variable.");
std::lock_guard<std::mutex> guard(m_valueMutex);
return m_value;
}
void set(const char* value)
{
m_settings->set<const char*>(m_valueSettingsPath.c_str(), value);
}
bool isValueDirty() const
{
return m_valueDirty.load(std::memory_order_relaxed);
}
void clearValueDirty()
{
m_valueDirty.store(false, std::memory_order_release);
}
const char* getSettingsPath() const
{
return m_valueSettingsPath.c_str();
}
inline dictionary::IDictionary* getDictionaryInterface() const
{
return m_dictionary;
}
private:
static void sOnRelease(void* iface, void* user)
{
// Settings has gone away, so our subscription is defunct
static_cast<ThreadSafeLocalCache*>(user)->m_subscription = nullptr;
carb::getFramework()->removeReleaseHook(iface, sOnRelease, user);
}
// NOTE: The callback may come in on another thread so wrap it in a mutex to prevent a race.
std::string m_value;
mutable std::mutex m_valueMutex;
std::atomic<bool> m_valueDirty;
std::string m_valueSettingsPath;
dictionary::SubscriptionId* m_subscription = nullptr;
dictionary::IDictionary* m_dictionary = nullptr;
settings::ISettings* m_settings = nullptr;
};
#endif
} // namespace settings
} // namespace carb
| 31,598 | C | 40.687335 | 124 | 0.67077 |
omniverse-code/kit/include/carb/settings/SettingsBindingsPython.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "../dictionary/DictionaryBindingsPython.h"
#include "ISettings.h"
#include "SettingsUtils.h"
#include <memory>
#include <string>
#include <vector>
namespace carb
{
namespace dictionary
{
// Must provide an empty definition for this class to satisfy pybind
struct SubscriptionId
{
};
} // namespace dictionary
namespace settings
{
namespace
{
template <typename T>
py::list toList(const std::vector<T>& v)
{
py::list list;
for (const T& e : v)
list.append(e);
return list;
}
template <typename T>
std::vector<T> toAllocatedArray(const py::sequence& s)
{
std::vector<T> v(s.size());
for (size_t i = 0, size = s.size(); i < size; ++i)
v[i] = s[i].cast<T>();
return v;
}
// std::vector<bool> is typically specialized, so avoid it
std::unique_ptr<bool[]> toBoolArray(const py::sequence& s, size_t& size)
{
size = s.size();
std::unique_ptr<bool[]> p(new bool[size]);
for (size_t i = 0; i < size; ++i)
p[i] = s[i].cast<bool>();
return p;
}
void setValueFromPyObject(ISettings* isregistry, const char* path, const py::object& value)
{
if (py::isinstance<py::bool_>(value))
{
auto val = value.cast<bool>();
py::gil_scoped_release nogil;
isregistry->setBool(path, val);
}
else if (py::isinstance<py::int_>(value))
{
auto val = value.cast<int64_t>();
py::gil_scoped_release nogil;
isregistry->setInt64(path, val);
}
else if (py::isinstance<py::float_>(value))
{
auto val = value.cast<double>();
py::gil_scoped_release nogil;
isregistry->setFloat64(path, val);
}
else if (py::isinstance<py::str>(value))
{
auto val = value.cast<std::string>();
py::gil_scoped_release nogil;
isregistry->setString(path, val.c_str());
}
else if (py::isinstance<py::tuple>(value) || py::isinstance<py::list>(value))
{
py::sequence valueSeq = value.cast<py::sequence>();
{
py::gil_scoped_release nogil;
isregistry->destroyItem(path);
}
for (size_t idx = 0, valueSeqSize = valueSeq.size(); idx < valueSeqSize; ++idx)
{
py::object valueSeqElement = valueSeq[idx];
if (py::isinstance<py::bool_>(valueSeqElement))
{
auto val = valueSeqElement.cast<bool>();
py::gil_scoped_release nogil;
isregistry->setBoolAt(path, idx, val);
}
else if (py::isinstance<py::int_>(valueSeqElement))
{
auto val = valueSeqElement.cast<int64_t>();
py::gil_scoped_release nogil;
isregistry->setInt64At(path, idx, val);
}
else if (py::isinstance<py::float_>(valueSeqElement))
{
auto val = valueSeqElement.cast<double>();
py::gil_scoped_release nogil;
isregistry->setFloat64At(path, idx, val);
}
else if (py::isinstance<py::str>(valueSeqElement))
{
auto val = valueSeqElement.cast<std::string>();
py::gil_scoped_release nogil;
isregistry->setStringAt(path, idx, val.c_str());
}
else if (py::isinstance<py::dict>(valueSeqElement))
{
std::string basePath = path ? path : "";
std::string elemPath = basePath + "/" + std::to_string(idx);
setValueFromPyObject(isregistry, elemPath.c_str(), valueSeqElement);
}
else
{
CARB_LOG_WARN("Unknown type in sequence being written to %s", path);
}
}
}
else if (py::isinstance<py::dict>(value))
{
{
py::gil_scoped_release nogil;
isregistry->destroyItem(path);
}
py::dict valueDict = value.cast<py::dict>();
for (auto kv : valueDict)
{
std::string basePath = path ? path : "";
if (!basePath.empty())
basePath = basePath + "/";
std::string subPath = basePath + kv.first.cast<std::string>().c_str();
setValueFromPyObject(isregistry, subPath.c_str(), kv.second.cast<py::object>());
}
}
}
void setDefaultValueFromPyObject(ISettings* isregistry, const char* path, const py::object& value)
{
if (py::isinstance<py::bool_>(value))
{
auto val = value.cast<bool>();
py::gil_scoped_release nogil;
isregistry->setDefaultBool(path, val);
}
else if (py::isinstance<py::int_>(value))
{
auto val = value.cast<int64_t>();
py::gil_scoped_release nogil;
isregistry->setDefaultInt64(path, val);
}
else if (py::isinstance<py::float_>(value))
{
auto val = value.cast<double>();
py::gil_scoped_release nogil;
isregistry->setDefaultFloat64(path, val);
}
else if (py::isinstance<py::str>(value))
{
auto val = value.cast<std::string>();
py::gil_scoped_release nogil;
isregistry->setDefaultString(path, val.c_str());
}
else if (py::isinstance<py::tuple>(value) || py::isinstance<py::list>(value))
{
py::sequence valueSeq = value.cast<py::sequence>();
if (valueSeq.size() == 0)
{
py::gil_scoped_release nogil;
isregistry->setDefaultArray<int>(path, nullptr, 0);
}
else
{
const py::object& firstElement = valueSeq[0];
if (py::isinstance<py::bool_>(firstElement))
{
size_t size;
auto array = toBoolArray(valueSeq, size);
py::gil_scoped_release nogil;
isregistry->setDefaultArray<bool>(path, array.get(), size);
}
else if (py::isinstance<py::int_>(firstElement))
{
auto array = toAllocatedArray<int64_t>(valueSeq);
py::gil_scoped_release nogil;
isregistry->setDefaultArray<int64_t>(path, &array.front(), array.size());
}
else if (py::isinstance<py::float_>(firstElement))
{
auto array = toAllocatedArray<double>(valueSeq);
py::gil_scoped_release nogil;
isregistry->setDefaultArray<double>(path, &array.front(), array.size());
}
else if (py::isinstance<py::str>(firstElement))
{
std::vector<std::string> strs(valueSeq.size());
std::vector<const char*> strPtrs(valueSeq.size());
for (size_t i = 0, size = valueSeq.size(); i < size; ++i)
{
strs[i] = valueSeq[i].cast<std::string>();
strPtrs[i] = strs[i].c_str();
}
py::gil_scoped_release nogil;
isregistry->setDefaultArray<const char*>(path, strPtrs.data(), strPtrs.size());
}
else if (py::isinstance<py::dict>(firstElement))
{
std::string basePath = path ? path : "";
for (size_t i = 0, size = valueSeq.size(); i < size; ++i)
{
std::string elemPath = basePath + "/" + std::to_string(i);
setDefaultValueFromPyObject(isregistry, elemPath.c_str(), valueSeq[i]);
}
}
else
{
CARB_LOG_WARN("Unknown type in sequence being set as default in '%s'", path);
}
}
}
else if (py::isinstance<py::dict>(value))
{
py::dict valueDict = value.cast<py::dict>();
for (auto kv : valueDict)
{
std::string basePath = path ? path : "";
if (!basePath.empty())
basePath = basePath + "/";
std::string subPath = basePath + kv.first.cast<std::string>().c_str();
setDefaultValueFromPyObject(isregistry, subPath.c_str(), kv.second.cast<py::object>());
}
}
}
} // namespace
inline void definePythonModule(py::module& m)
{
using namespace carb;
using namespace carb::settings;
m.doc() = "pybind11 carb.settings bindings";
py::class_<dictionary::SubscriptionId>(m, "SubscriptionId", R"(Representation of a subscription)");
py::enum_<dictionary::ChangeEventType>(m, "ChangeEventType")
.value("CREATED", dictionary::ChangeEventType::eCreated, R"(An Item was created)")
.value("CHANGED", dictionary::ChangeEventType::eChanged, R"(An Item was changed)")
.value("DESTROYED", dictionary::ChangeEventType::eDestroyed, R"(An Item was destroyed)");
static ScriptCallbackRegistryPython<dictionary::SubscriptionId*, void, const dictionary::Item*, dictionary::ChangeEventType>
s_nodeChangeEventCBs;
static ScriptCallbackRegistryPython<dictionary::SubscriptionId*, void, const dictionary::Item*,
const dictionary::Item*, dictionary::ChangeEventType>
s_treeChangeEventCBs;
using UpdateFunctionWrapper =
ScriptCallbackRegistryPython<void*, dictionary::UpdateAction, const dictionary::Item*, dictionary::ItemType,
const dictionary::Item*, dictionary::ItemType>;
defineInterfaceClass<ISettings>(m, "ISettings", "acquire_settings_interface", nullptr, R"(
The Carbonite Settings interface
Carbonite settings are built on top of the carb.dictionary interface (which is also required in order to use this
interface). Many dictionary functions are replicated in settings, but explicitly use the settings database instead of a
generic carb.dictionary.Item object.
carb.settings uses keys (or paths) that start with an optional forward-slash and are forward-slash separated (example:
"/log/level"). The settings database exists as a root-level carb.dictionary.Item (of type ItemType.DICTIONARY) that is
created and maintained by the carb.settings system (typically through the carb.settings.plugin plugin). The root level
settings carb.dictionary.Item is accessible through get_settings_dictionary().
Portions of the settings database hierarchy can be subscribed to with subscribe_to_tree_change_events() or individual
keys may be subscribed to with subscribe_to_tree_change_events().
)")
.def("is_accessible_as", wrapInterfaceFunction(&ISettings::isAccessibleAs),
py::call_guard<py::gil_scoped_release>(), R"(
Checks if the item could be accessible as the provided type, either directly or via a cast.
Parameters:
itemType: carb.dictionary.ItemType to check for.
path: Settings database key path (i.e. "/log/level").
Returns:
boolean: True if the item is accessible as the provided type; False otherwise.
)")
.def("get_as_int", wrapInterfaceFunction(&ISettings::getAsInt64), py::call_guard<py::gil_scoped_release>(), R"(
Attempts to get the supplied item as an integer, either directly or via conversion.
Parameters:
path: Settings database key path (i.e. "/log/level").
Returns:
Integer: an integer value representing the stored value. If conversion fails, 0 is returned.
)")
.def("set_int", wrapInterfaceFunction(&ISettings::setInt64), py::call_guard<py::gil_scoped_release>(), R"(
Sets the integer value at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: An integer value to store.
)")
.def("get_as_float", wrapInterfaceFunction(&ISettings::getAsFloat64), py::call_guard<py::gil_scoped_release>(), R"(
Attempts to get the supplied item as a floating-point value, either directly or via conversion.
Parameters:
path: Settings database key path (i.e. "/log/level").
Returns:
Float: a floating-point value representing the stored value. If conversion fails, 0.0 is returned.
)")
.def("set_float", wrapInterfaceFunction(&ISettings::setFloat64), py::call_guard<py::gil_scoped_release>(), R"(
Sets the floating-point value at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: A floating-point value to store.
)")
.def("get_as_bool", wrapInterfaceFunction(&ISettings::getAsBool), py::call_guard<py::gil_scoped_release>(), R"(
Attempts to get the supplied item as a boolean value, either directly or via conversion.
Parameters:
path: Settings database key path (i.e. "/log/level").
Returns:
Boolean: a boolean value representing the stored value. If conversion fails, False is returned.
)")
.def("set_bool", wrapInterfaceFunction(&ISettings::setBool), py::call_guard<py::gil_scoped_release>(), R"(
Sets the boolean value at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: A boolean value to store.
)")
.def("get_as_string",
[](const ISettings* isregistry, const char* path) { return getStringFromItemValue(isregistry, path); },
py::call_guard<py::gil_scoped_release>(), R"(
Attempts to get the supplied item as a string value, either directly or via conversion.
Parameters:
path: Settings database key path (i.e. "/log/level").
Returns:
String: a string value representing the stored value. If conversion fails, "" is returned.
)")
.def("set_string",
[](ISettings* isregistry, const char* path, const std::string& str) {
isregistry->setString(path, str.c_str());
},
py::call_guard<py::gil_scoped_release>(), R"(
Sets the string value at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: A string value.
)")
.def("get",
// The defaultValue here is DEPRECATED, some of the scripts out there still use it like that. TODO: remove
// it after some time.
[](const ISettings* isregistry, const char* path) -> py::object {
const dictionary::Item* item = isregistry->getSettingsDictionary(path);
auto obj = dictionary::getPyObject(getCachedInterfaceForBindings<dictionary::IDictionary>(), item);
if (py::isinstance<py::tuple>(obj))
{
// Settings wants a list instead of a tuple
return py::list(std::move(obj));
}
return obj;
},
py::arg("path"), R"(
Retrieve the stored value at the supplied path as a Python object.
An array value will be returned as a list. If the value does not exist, None will be returned.
Parameters:
path: Settings database key path (i.e. "/log/level").
Returns:
A Python object representing the stored value.
)")
.def("set", &setValueFromPyObject, py::arg("path"), py::arg("value"), R"(
Sets the given value at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: A Python object. The carb.dictionary.ItemType is inferred from the type of the object; if the type is not supported, the value is ignored. Both tuples and lists are treated as arrays (a special kind of ItemType.DICTIONARY).
)")
.def("set_default", &setDefaultValueFromPyObject, py::arg("path"), py::arg("value"))
.def("set_int_array",
[](ISettings* isregistry, const char* path, const std::vector<int32_t>& array) {
settings::setIntArray(isregistry, path, array);
},
py::call_guard<py::gil_scoped_release>(), R"(
Sets the given array at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
array: A tuple or list of integer values.
)")
.def("set_float_array",
[](ISettings* isregistry, const char* path, const std::vector<double>& array) {
settings::setFloatArray(isregistry, path, array);
},
py::call_guard<py::gil_scoped_release>(), R"(
Sets the given array at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
array: A tuple or list of floating-point values.
)")
.def("set_bool_array",
[](ISettings* isregistry, const char* path, const std::vector<bool>& array) {
settings::setBoolArray(isregistry, path, array);
},
py::call_guard<py::gil_scoped_release>(), R"(
Sets the given array at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
array: A tuple or list of boolean values.
)")
.def("set_string_array",
[](ISettings* isregistry, const char* path, const std::vector<std::string>& array) {
settings::setStringArray(isregistry, path, array);
},
py::call_guard<py::gil_scoped_release>(), R"(
Sets the given array at the supplied path.
Parameters:
path: Settings database key path (i.e. "/log/level").
array: A tuple or list of strings.
)")
.def("destroy_item", wrapInterfaceFunction(&ISettings::destroyItem), py::call_guard<py::gil_scoped_release>(), R"(
Destroys the item at the given path.
Any objects that reference the given path become invalid and their use is undefined behavior.
Parameters:
path: Settings database key path (i.e. "/log/level").
)")
.def("get_settings_dictionary", wrapInterfaceFunction(&ISettings::getSettingsDictionary),
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>(), R"(
Access the setting database as a dictionary.Item
Accesses the setting database as a dictionary.Item, which allows use of carb.dictionary functions directly.
WARNING: The root dictionary.Item is owned by carb.settings and must not be altered or destroyed.
Parameters:
path: An optional path from root to access. "/" or "" is interpreted to be the settings database root.
)",
py::arg("path") = "")
.def("create_dictionary_from_settings", wrapInterfaceFunction(&ISettings::createDictionaryFromSettings),
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>(), R"(
Takes a snapshot of a portion of the setting database as a dictionary.Item.
Parameters:
path: An optional path from root to access. "/" or "" is interpreted to be the settings database root.
)",
py::arg("path") = "")
.def("initialize_from_dictionary", wrapInterfaceFunction(&ISettings::initializeFromDictionary),
py::call_guard<py::gil_scoped_release>(), R"(
Performs a one-time initialization from a given dictionary.Item.
NOTE: This function may only be called once. Subsequent calls will result in an error message logged.
Parameters:
dictionary: A dictionary.Item to initialize the settings database from. The items are copied into the root of the settings database.
)")
.def("subscribe_to_node_change_events",
[](ISettings* isregistry, const char* path, const decltype(s_nodeChangeEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_nodeChangeEventCBs.create(eventFn);
dictionary::SubscriptionId* id =
isregistry->subscribeToNodeChangeEvents(path, s_nodeChangeEventCBs.call, eventFnCopy);
s_nodeChangeEventCBs.add(id, eventFnCopy);
return id;
},
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>(), R"(
Subscribes to node change events about a specific item.
When finished with the subscription, call unsubscribe_to_change_events().
Parameters:
path: Settings database key path (i.e. "/log/level") to subscribe to.
eventFn: A function that is called for each change event.
)")
.def("subscribe_to_tree_change_events",
[](ISettings* isregistry, const char* path, const decltype(s_treeChangeEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_treeChangeEventCBs.create(eventFn);
dictionary::SubscriptionId* id =
isregistry->subscribeToTreeChangeEvents(path, s_treeChangeEventCBs.call, eventFnCopy);
s_treeChangeEventCBs.add(id, eventFnCopy);
return id;
},
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>(), R"(
Subscribes to change events for all items in a subtree.
When finished with the subscription, call unsubscribe_to_change_events().
Parameters:
path: Settings database key path (i.e. "/log/level") to subscribe to.
eventFn: A function that is called for each change event.
)")
.def("unsubscribe_to_change_events",
[](ISettings* isregistry, dictionary::SubscriptionId* id) {
isregistry->unsubscribeToChangeEvents(id);
s_nodeChangeEventCBs.tryRemoveAndDestroy(id);
s_treeChangeEventCBs.tryRemoveAndDestroy(id);
},
py::call_guard<py::gil_scoped_release>(), R"(
Unsubscribes from change events.
Parameters:
id: The handle returned from subscribe_to_tree_change_events() or subscribe_to_node_change_events().
)",
py::arg("id"))
.def("set_default_int",
[](ISettings* isregistry, const char* path, int value) { isregistry->setDefaultInt(path, value); },
py::call_guard<py::gil_scoped_release>(), R"(
Sets a value at the given path, if and only if one does not already exist.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: Value that will be stored at the given path if a value does not already exist there.
)")
.def("set_default_float",
[](ISettings* isregistry, const char* path, float value) { isregistry->setDefaultFloat(path, value); },
py::call_guard<py::gil_scoped_release>(), R"(
Sets a value at the given path, if and only if one does not already exist.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: Value that will be stored at the given path if a value does not already exist there.
)")
.def("set_default_bool",
[](ISettings* isregistry, const char* path, bool value) { isregistry->setDefaultBool(path, value); },
py::call_guard<py::gil_scoped_release>(), R"(
Sets a value at the given path, if and only if one does not already exist.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: Value that will be stored at the given path if a value does not already exist there.
)")
.def("set_default_string",
[](ISettings* isregistry, const char* path, const std::string& str) {
isregistry->setDefaultString(path, str.c_str());
},
py::call_guard<py::gil_scoped_release>(), R"(
Sets a value at the given path, if and only if one does not already exist.
Parameters:
path: Settings database key path (i.e. "/log/level").
value: Value that will be stored at the given path if a value does not already exist there.
)")
.def("update",
[](ISettings* isregistry, const char* path, const dictionary::Item* dictionary, const char* dictionaryPath,
const py::object& updatePolicy) {
if (py::isinstance<dictionary::UpdateAction>(updatePolicy))
{
dictionary::UpdateAction updatePolicyEnum = updatePolicy.cast<dictionary::UpdateAction>();
py::gil_scoped_release nogil;
if (updatePolicyEnum == dictionary::UpdateAction::eOverwrite)
{
isregistry->update(path, dictionary, dictionaryPath, dictionary::overwriteOriginal, nullptr);
}
else if (updatePolicyEnum == dictionary::UpdateAction::eKeep)
{
isregistry->update(path, dictionary, dictionaryPath, dictionary::keepOriginal, nullptr);
}
else
{
CARB_LOG_ERROR("Unknown update policy type");
}
}
else
{
const UpdateFunctionWrapper::FuncT updateFn =
updatePolicy.cast<const UpdateFunctionWrapper::FuncT>();
py::gil_scoped_release nogil;
isregistry->update(path, dictionary, dictionaryPath, UpdateFunctionWrapper::call, (void*)&updateFn);
}
},
R"(
Merges the source dictionary.Item into the settings database.
Destination path need not exist and missing items in the path will be created as ItemType.DICTIONARY.
Parameters:
path: Settings database key path (i.e. "/log/level"). Used as the destination location within the setting database. "/" is considered to be the root.
dictionary: A dictionary.Item used as the base of the items to merge into the setting database.
dictionaryPath: A child path of `dictionary` to use as the root for merging. May be None or an empty string in order to use `dictionary` directly as the root.
updatePolicy: One of dictionary.UpdateAction to use as the policy for updating.
)");
}
} // namespace settings
} // namespace carb
| 25,769 | C | 40.902439 | 234 | 0.619077 |
omniverse-code/kit/include/carb/datasource/IDataSource.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Interface.h"
#include "../Types.h"
#include "DataSourceTypes.h"
namespace carb
{
namespace datasource
{
/**
* Defines a data source interface.
*/
struct IDataSource
{
/**
* 1.1 added "hash" field to carb::datasource::ItemInfo
*/
CARB_PLUGIN_INTERFACE("carb::datasource::IDataSource", 1, 1)
/**
* Gets a list of supported protocols for this interface.
*
* @return The comma-separated list of supported protocols.
*/
const char*(CARB_ABI* getSupportedProtocols)();
/**
* Connects to a datasource.
*
* @param desc The connection descriptor.
* @param onConnectionEvent The callback for handling connection events.
* @param userData The userData to be passed back to callback.
*/
void(CARB_ABI* connect)(const ConnectionDesc& desc, OnConnectionEventFn onConnectionEvent, void* userData);
/**
* Disconnects from a datasource.
*
* @param connection The connection to use.
*/
void(CARB_ABI* disconnect)(Connection* connection);
/**
* Attempts to stop processing a specified request on a connection.
*
* @param connection The connection to use.
* @param id The request id to stop processing.
*/
void(CARB_ABI* stopRequest)(Connection* connection, RequestId id);
/**
* Lists all the child relative data path entries from the specified path in the data source.
*
* You must delete the path returned.
*
* @param connection The connect to use.
* @param path The path to start the listing from.
* @param recursive true to recursively list items in directory and subdirectories.
* @param onListDataItem The callback for each item listed.
* @param onListDataDone The callback for when there are no more items listed.
* @param userData The userData to be pass to callback.
* @return The data request id or 0 if failed.
*/
RequestId(CARB_ABI* listData)(Connection* connection,
const char* path,
bool recursize,
OnListDataItemFn onListDataItem,
OnListDataDoneFn onListDataDone,
void* userData);
/**
* Creates a data block associated to the specified path to the data source.
*
* @param connection The connect to use.
* @param path The path to create the data. Must not exist.
* @param payload The payload data to be initialize to.
* @param payloadSize The size of the payload data to initialize.
* @param onCreateData Callback function use.
* @param userData The userData to be pass to callback.
* @return The data request id or 0 if failed.
*/
RequestId(CARB_ABI* createData)(Connection* connection,
const char* path,
uint8_t* payload,
size_t payloadSize,
OnCreateDataFn onCreateData,
void* userData);
/**
* Deletes a data block based on the specified path from the data source.
*
* @param connection The connect to use.
* @param path The path of the data to be destroyed(deleted).
* @param onFree The callback function to be used to free the data.
* @param onDeleteData The callback function to be called when the data is deleted.
* @param userData The userData to be pass to callback.
* @return The data request id or 0 if failed.
*/
RequestId(CARB_ABI* deleteData)(Connection* connection, const char* path, OnDeleteDataFn onDeleteData, void* userData);
/**
* Initiates an asynchronous read of data from the datasource. A callback is called when the read completes.
*
* @param connection The connection to use.
* @param path The path for the data.
* @param onMalloc The callback function to allocate the memory that will be returned in data
* @param onReadData The callback function called once the data is read.
* @param userData The userData to be pass to callback.
* @return The data request id or 0 if failed.
*/
RequestId(CARB_ABI* readData)(
Connection* connection, const char* path, OnMallocFn onMalloc, OnReadDataFn onReadData, void* userData);
/**
* Synchronously reads data from the data source.
*
* @param connection The connection to use.
* @param path The path for the data.
* @param onMalloc the callback function to allocate memory that will be returned
* @param block The allocated memory holding the data will be returned here
* @param size The size of the allocated block will be returned here
* @return One of the response codes to indicate the success of the call
*/
Response(CARB_ABI* readDataSync)(
Connection* connection, const char* path, OnMallocFn onMalloc, void** block, size_t* size);
/**
* Writes data to the data source.
*
* @param connection The connection to use.
* @param path The path for the data.
* @param payload The data that was written. *** This memory must be freed by the caller.
* @param payloadSize The size of the data written.
* @param version The version of the data written.
* @param onWriteData The callback function to call when payload data is written.
* @param userData The userData to be pass to callback.
* @return The data request id or 0 if failed.
*/
RequestId(CARB_ABI* writeData)(Connection* connection,
const char* path,
const uint8_t* payload,
size_t payloadSize,
const char* version,
OnWriteDataFn onWriteData,
void* userData);
/**
* Creates a subscription for modifications to data.
*
* @param connection The connection to use.
* @param path The path for the data.
* @param onModifyData The function to call when the data is modified.
* @param userData The user data ptr to be associated with the callback.
* @return The subscription id or 0 if failed.
*/
SubscriptionId(CARB_ABI* subscribeToChangeEvents)(Connection* connection,
const char* path,
OnChangeEventFn onChangeEvent,
void* userData);
/**
* Removes a subscription for modifications to data.
*
* @param connection The connection from which to remove the subscription.
* @param id The subscription id to unsubscribe from.
*/
void(CARB_ABI* unsubscribeToChangeEvents)(Connection* connection, SubscriptionId subscriptionId);
/**
* Gets the native handle from a datasource connection.
*
* @param The connection from which to native connection handle from.
* @return The native connection handle.
*/
void*(CARB_ABI* getConnectionNativeHandle)(Connection* connection);
/**
* Gets the url from a datasource connection.
*
* @param The connection from which to get url from.
* @return The connection url.
*/
const char*(CARB_ABI* getConnectionUrl)(Connection* connection);
/**
* Gets the username from a datasource connection.
*
* @param The connection from which to get username from.
* @return The connection username. nullptr if username is not applicable for the connection.
*/
const char*(CARB_ABI* getConnectionUsername)(Connection* connection);
/**
* Gets the unique connection id from a datasource connection.
* @param The connection from which to get id from.
* @return The connection id. kInvalidConnectionId if the datasource has no id implementation
* or the connection is invalid.
*/
ConnectionId(CARB_ABI* getConnectionId)(Connection* connection);
/**
* Tests whether it's possible to write data with the provided path.
*
* @param path The path to write the data.
* @return true if it's possible to write to this data.
*/
RequestId(CARB_ABI* isWritable)(Connection* connection, const char* path, OnIsWritableFn onIsWritable, void* userData);
/**
* Returns authentication token, which encapsulates the security identity of the connection.
* The token can be used to connect to other omniverse services.
*
* @param connection from which to get authentication token from.
* @return authentication token as a string.
*/
const char*(CARB_ABI* getConnectionAuthToken)(Connection* connection);
};
} // namespace datasource
} // namespace carb
| 9,359 | C | 39.695652 | 123 | 0.639278 |
omniverse-code/kit/include/carb/datasource/DataSourceBindingsPython.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "IDataSource.h"
#include <chrono>
#include <memory>
#include <string>
#include <vector>
namespace carb
{
namespace datasource
{
struct Connection
{
};
struct ConnectionDescPy
{
std::string url;
std::string username;
std::string password;
bool disableCache;
};
struct ItemInfoPy
{
std::string path;
std::string version;
std::chrono::system_clock::time_point modifiedTimestamp;
std::chrono::system_clock::time_point createdTimestamp;
size_t size;
bool isDirectory;
bool isWritable;
std::string hash;
};
inline void definePythonModule(py::module& m)
{
using namespace carb;
using namespace carb::datasource;
m.doc() = "pybind11 carb.datasource bindings";
py::class_<Connection>(m, "Connection");
m.attr("INVALID_CONNECTION_ID") = py::int_(kInvalidConnectionId);
m.attr("SUBSCRIPTION_FAILED") = py::int_(kSubscriptionFailed);
py::enum_<ChangeAction>(m, "ChangeAction", R"(
ChangeAction.
)")
.value("CREATED", ChangeAction::eCreated)
.value("DELETED", ChangeAction::eDeleted)
.value("MODIFIED", ChangeAction::eModified)
.value("CONNECTION_LOST", ChangeAction::eConnectionLost);
py::enum_<ConnectionEventType>(m, "ConnectionEventType", R"(
Connection event results.
)")
.value("CONNECTED", ConnectionEventType::eConnected)
.value("DISCONNECTED", ConnectionEventType::eDisconnected)
.value("FAILED", ConnectionEventType::eFailed)
.value("INTERUPTED", ConnectionEventType::eInterrupted);
py::enum_<Response>(m, "Response", R"(
Response results for data requests.
)")
.value("OK", Response::eOk)
.value("ERROR_INVALID_PATH", Response::eErrorInvalidPath)
.value("ERROR_ALREADY_EXISTS", Response::eErrorAlreadyExists)
.value("ERROR_INCOMPATIBLE_VERSION", Response::eErrorIncompatibleVersion)
.value("ERROR_TIMEOUT", Response::eErrorTimeout)
.value("ERROR_ACCESS", Response::eErrorAccess)
.value("ERROR_UNKNOWN", Response::eErrorUnknown);
py::class_<ConnectionDescPy>(m, "ConnectionDesc", R"(
Descriptor for a connection.
)")
.def(py::init<>())
.def_readwrite("url", &ConnectionDescPy::url)
.def_readwrite("username", &ConnectionDescPy::username)
.def_readwrite("password", &ConnectionDescPy::password)
.def_readwrite("disable_cache", &ConnectionDescPy::disableCache);
py::class_<ItemInfoPy>(m, "ItemInfo", R"(
Class holding the list data item information
)")
.def(py::init<>())
.def_readonly("path", &ItemInfoPy::path)
.def_readonly("version", &ItemInfoPy::version)
.def_readonly("hash", &ItemInfoPy::hash)
.def_readonly("modified_timestamp", &ItemInfoPy::modifiedTimestamp)
.def_readonly("created_timestamp", &ItemInfoPy::createdTimestamp)
.def_readonly("size", &ItemInfoPy::size)
.def_readonly("is_directory", &ItemInfoPy::isDirectory)
.def_readonly("is_writable", &ItemInfoPy::isWritable);
defineInterfaceClass<IDataSource>(m, "IDataSource", "acquire_datasource_interface")
.def("get_supported_protocols", wrapInterfaceFunction(&IDataSource::getSupportedProtocols))
.def("connect",
[](IDataSource* iface, const ConnectionDescPy& descPy,
std::function<void(Connection * connection, ConnectionEventType eventType)> fn) {
auto callable = createPyAdapter(std::move(fn));
using Callable = decltype(callable)::element_type;
ConnectionDesc desc = { descPy.url.c_str(), descPy.username.c_str(), descPy.password.c_str(),
descPy.disableCache };
iface->connect(desc,
[](Connection* connection, ConnectionEventType eventType, void* userData) {
Callable::callAndKeep(userData, connection, eventType);
if (eventType != ConnectionEventType::eConnected)
{
Callable::destroy(userData);
}
},
callable.release());
})
.def("disconnect", wrapInterfaceFunctionReleaseGIL(&IDataSource::disconnect))
.def("stop_request", wrapInterfaceFunction(&IDataSource::stopRequest))
.def("list_data",
[](IDataSource* iface, Connection* connection, const char* path, bool recursize,
std::function<bool(Response, const ItemInfoPy&)> onListDataItemFn,
std::function<void(Response, const std::string&)> onListDataDoneFn) {
auto pair = std::make_pair(
createPyAdapter(std::move(onListDataItemFn)), createPyAdapter(std::move(onListDataDoneFn)));
using Pair = decltype(pair);
auto pairHeap = new Pair(std::move(pair));
auto onListDataItemCppFn = [](Response response, const ItemInfo* const info, void* userData) -> bool {
auto pyCallbacks = static_cast<Pair*>(userData);
ItemInfoPy infoPy;
infoPy.path = info->path;
infoPy.version = info->version ? info->version : "";
infoPy.modifiedTimestamp = std::chrono::system_clock::from_time_t(info->modifiedTimestamp);
infoPy.createdTimestamp = std::chrono::system_clock::from_time_t(info->createdTimestamp);
infoPy.size = info->size;
infoPy.isDirectory = info->isDirectory;
infoPy.isWritable = info->isWritable;
infoPy.hash = info->hash ? info->hash : "";
return pyCallbacks->first->call(response, infoPy);
};
auto onListDataDoneCppFn = [](Response response, const char* path, void* userData) {
auto pyCallbacks = reinterpret_cast<Pair*>(userData);
pyCallbacks->second->call(response, path);
delete pyCallbacks;
};
return iface->listData(connection, path, recursize, onListDataItemCppFn, onListDataDoneCppFn, pairHeap);
})
.def("create_data",
[](IDataSource* iface, Connection* connection, const char* path, const py::bytes& payload,
std::function<void(Response response, const char* path, const char* version)> onCreateDataFn) {
auto callable = createPyAdapter(std::move(onCreateDataFn));
using Callable = decltype(callable)::element_type;
std::string payloadContent(payload);
static_assert(sizeof(std::string::value_type) == sizeof(uint8_t), "payload data size mismatch");
return iface->createData(connection, path, reinterpret_cast<uint8_t*>(&payloadContent[0]),
payloadContent.size(), Callable::adaptCallAndDestroy, callable.release());
})
.def("delete_data",
[](IDataSource* iface, Connection* connection, const char* path,
std::function<void(Response response, const char* path)> onDeleteDataFn) {
auto callable = createPyAdapter(std::move(onDeleteDataFn));
using Callable = decltype(callable)::element_type;
return iface->deleteData(connection, path, Callable::adaptCallAndDestroy, callable.release());
})
.def("read_data",
[](IDataSource* iface, Connection* connection, const char* path,
std::function<void(Response response, const char* path, const py::bytes& payload)> onReadDataFn) {
auto callable = createPyAdapter(std::move(onReadDataFn));
using Callable = decltype(callable)::element_type;
return iface->readData(
connection, path, std::malloc,
[](Response response, const char* path, uint8_t* data, size_t dataSize, void* userData) {
static_assert(sizeof(char) == sizeof(uint8_t), "payload data size mismatch");
py::gil_scoped_acquire gil; // make sure we own the GIL for creating py::bytes
const py::bytes payload(reinterpret_cast<const char*>(data), dataSize);
Callable::callAndDestroy(userData, response, path, payload);
// Data needs to be freed manually.
if (data)
{
std::free(data);
}
},
callable.release());
})
.def("read_data_sync",
[](IDataSource* iface, Connection* connection, const char* path) -> py::bytes {
void* data{ nullptr };
size_t size{ 0 };
Response response = iface->readDataSync(connection, path, std::malloc, &data, &size);
py::gil_scoped_acquire gil; // make sure we own the GIL for creating py::bytes
py::bytes bytes =
response == Response::eOk ? py::bytes(reinterpret_cast<const char*>(data), size) : py::bytes();
if (data)
{
std::free(data);
}
return bytes;
})
.def("write_data",
[](IDataSource* iface, Connection* connection, const char* path, const py::bytes& payload,
const char* version, std::function<void(Response response, const char* path)> onWriteDataFn) {
auto callable = createPyAdapter(std::move(onWriteDataFn));
using Callable = decltype(callable)::element_type;
std::string payloadContent(payload);
static_assert(sizeof(std::string::value_type) == sizeof(uint8_t), "payload data size mismatch");
return iface->writeData(connection, path, reinterpret_cast<const uint8_t*>(payloadContent.data()),
payloadContent.size(), version, Callable::adaptCallAndDestroy,
callable.release());
})
.def("subscribe_to_change_events",
[](IDataSource* iface, Connection* connection, const char* path,
std::function<void(const char* path, ChangeAction action)> fn) {
using namespace std::placeholders;
return createPySubscription(std::move(fn),
std::bind(iface->subscribeToChangeEvents, connection, path, _1, _2),
[iface, connection](SubscriptionId id) {
// Release the GIL since unsubscribe can block on a mutex and deadlock
py::gil_scoped_release gsr;
iface->unsubscribeToChangeEvents(connection, id);
});
})
.def("get_connection_native_handle", wrapInterfaceFunction(&IDataSource::getConnectionNativeHandle))
.def("get_connection_url", wrapInterfaceFunction(&IDataSource::getConnectionUrl))
.def("get_connection_username", wrapInterfaceFunction(&IDataSource::getConnectionUsername))
.def("get_connection_id", wrapInterfaceFunction(&IDataSource::getConnectionId))
.def("is_writable", [](IDataSource* iface, Connection* connection, const char* path,
std::function<void(Response response, const char* path, bool writable)> fn) {
auto callable = createPyAdapter(std::move(fn));
using Callable = decltype(callable)::element_type;
return iface->isWritable(connection, path, Callable::adaptCallAndDestroy, callable.release());
});
}
} // namespace datasource
} // namespace carb
| 12,737 | C | 48.372093 | 121 | 0.579022 |
omniverse-code/kit/include/carb/datasource/DataSourceTypes.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Defines.h"
namespace carb
{
namespace datasource
{
typedef uint64_t RequestId;
typedef uint64_t SubscriptionId;
typedef uint64_t ConnectionId;
constexpr uint64_t kInvalidConnectionId = ~0ull;
constexpr uint64_t kSubscriptionFailed = 0;
struct Connection;
/**
* Defines a descriptor for a connection.
*/
struct ConnectionDesc
{
const char* url;
const char* username;
const char* password;
bool disableCache;
};
/**
* Defines a struct holding the list data item information
*/
struct ItemInfo
{
const char* path;
const char* version;
time_t modifiedTimestamp;
time_t createdTimestamp;
size_t size;
bool isDirectory;
bool isWritable;
const char* hash;
};
enum class ChangeAction
{
eCreated,
eDeleted,
eModified,
eConnectionLost
};
/**
* Defines the connection event type.
*/
enum class ConnectionEventType
{
eConnected,
eFailed,
eDisconnected,
eInterrupted
};
/**
* Response results for data requests.
*/
enum class Response
{
eOk,
eErrorInvalidPath,
eErrorAlreadyExists,
eErrorIncompatibleVersion,
eErrorTimeout,
eErrorAccess,
eErrorUnknown
};
/**
* Function callback on connection events.
*
* @param connection The connection used.
* @param eventType The connection event type.
* @param userData The user data passed back.
*/
typedef void (*OnConnectionEventFn)(Connection* connection, ConnectionEventType eventType, void* userData);
/**
* Function callback on change events.
*
* @param path The path that has changed.
* @param action The change action that has occurred.
* @parm userData The user data passed back.
*/
typedef void (*OnChangeEventFn)(const char* path, ChangeAction action, void* userData);
/**
* Function callback on listed data items.
*
* This is called for each item returned from IDataSource::listData
*
* @param response The response result.
* @param path The path of the list item.
* @param version The version of the list item.
* @param userData The user data passed back.
* @return true to continue iteration, false to stop it. This can be useful when searching for a specific file
* or when iteration needs to be user interruptable.
*/
typedef bool (*OnListDataItemFn)(Response response, const ItemInfo* const info, void* userData);
/**
* Function callback on listed data items are done.
*
* @param response The response result.
* @param path The path the listing is complete listing items for.
* @param userData The user data passed back.
*/
typedef void (*OnListDataDoneFn)(Response response, const char* path, void* userData);
/**
* Function callback on data created.
*
* @param response The response result.
* @param path The path the data was created on.
* @param version The version of the data created.
* @param userData The user data passed back.
*/
typedef void (*OnCreateDataFn)(Response response, const char* path, const char* version, void* userData);
/**
* Function callback on data deleted.
*
* @param response The response result.
* @param path The path the data was created on.
* @param userData The user data passed back.
*/
typedef void (*OnDeleteDataFn)(Response response, const char* path, void* userData);
/**
* Function callback on data read.
*
* @param response The response result.
* @param path The path the data was created on.
* @param payload The payload data that was read. *** This must be freed when completed.
* @param payloadSize The size of the payload data read.
* @param userData The user data passed back.
*/
typedef void (*OnReadDataFn)(Response response, const char* path, uint8_t* payload, size_t payloadSize, void* userData);
/**
* Function callback on data written.
*
* @param response The response result.
* @param path The path the data was written at.
* @param userData The user data passed back.
*/
typedef void (*OnWriteDataFn)(Response response, const char* path, void* userData);
/**
* Function callback for allocation of data.
*
* @param size The size of data to allocate.
* @return The pointer to the data allocated.
*/
typedef void* (*OnMallocFn)(size_t size);
/**
* Function callback on data read.
*
* @param response The response result.
* @param path The path the data was created on.
* @param userData The user data passed back.
*/
typedef void (*OnIsWritableFn)(Response response, const char* path, bool writable, void* userData);
} // namespace datasource
} // namespace carb
| 4,928 | C | 25.643243 | 120 | 0.726664 |
omniverse-code/kit/include/carb/datasource/DataSourceUtils.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Framework.h"
#include "../Types.h"
#include "../logging/ILogging.h"
#include "IDataSource.h"
#include <future>
namespace carb
{
namespace datasource
{
inline Connection* connectAndWait(const ConnectionDesc& desc, const IDataSource* dataSource)
{
std::promise<Connection*> promise;
auto future = promise.get_future();
dataSource->connect(desc,
[](Connection* connection, ConnectionEventType eventType, void* userData) {
std::promise<Connection*>* promise = reinterpret_cast<std::promise<Connection*>*>(userData);
switch (eventType)
{
case ConnectionEventType::eConnected:
promise->set_value(connection);
break;
case ConnectionEventType::eFailed:
case ConnectionEventType::eInterrupted:
promise->set_value(nullptr);
break;
case ConnectionEventType::eDisconnected:
break;
}
},
&promise);
return future.get();
}
inline Connection* connectAndWait(const ConnectionDesc& desc, const char* pluginName = nullptr)
{
carb::Framework* framework = carb::getFramework();
IDataSource* dataSource = framework->acquireInterface<IDataSource>(pluginName);
return connectAndWait(desc, dataSource);
}
} // namespace datasource
} // namespace carb
| 2,118 | C | 36.175438 | 120 | 0.586874 |
omniverse-code/kit/include/carb/thread/FutexImpl.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Defines.h"
#include "../cpp/Bit.h"
#include "../math/Util.h"
#include "../thread/Util.h"
#include <atomic>
#if CARB_PLATFORM_WINDOWS
# pragma comment(lib, "synchronization.lib") // must link with synchronization.lib
# include "../CarbWindows.h"
#elif CARB_PLATFORM_LINUX
# include <linux/futex.h>
# include <sys/syscall.h>
# include <sys/time.h>
# include <unistd.h>
#elif CARB_PLATFORM_MACOS
/* nothing for now */
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
namespace carb
{
namespace thread
{
namespace detail
{
template <class T, size_t S = sizeof(T)>
struct to_integral
{
};
template <class T>
struct to_integral<T, 1>
{
using type = int8_t;
};
template <class T>
struct to_integral<T, 2>
{
using type = int16_t;
};
template <class T>
struct to_integral<T, 4>
{
using type = int32_t;
};
template <class T>
struct to_integral<T, 8>
{
using type = int64_t;
};
template <class T>
using to_integral_t = typename to_integral<T>::type;
template <class As, class T>
CARB_NODISCARD std::enable_if_t<std::is_integral<T>::value && sizeof(As) == sizeof(T), As> reinterpret_as(const T& in) noexcept
{
static_assert(std::is_integral<As>::value, "Must be integral type");
return static_cast<As>(in);
}
template <class As, class T>
CARB_NODISCARD std::enable_if_t<std::is_pointer<T>::value && sizeof(As) == sizeof(T), As> reinterpret_as(const T& in) noexcept
{
static_assert(std::is_integral<As>::value, "Must be integral type");
return reinterpret_cast<As>(in);
}
template <class As, class T>
CARB_NODISCARD std::enable_if_t<(!std::is_pointer<T>::value && !std::is_integral<T>::value) || sizeof(As) != sizeof(T), As> reinterpret_as(
const T& in) noexcept
{
static_assert(std::is_integral<As>::value, "Must be integral type");
As out{}; // Init to zero
memcpy(&out, std::addressof(in), sizeof(in));
return out;
}
template <class Duration>
Duration clampDuration(Duration offset)
{
using namespace std::chrono;
constexpr static Duration Max = duration_cast<Duration>(milliseconds(0x7fffffff));
return ::carb_max(Duration(0), ::carb_min(Max, offset));
}
#if CARB_PLATFORM_WINDOWS
// Windows WaitOnAddress() supports 1, 2, 4 or 8 bytes, so it doesn't need to use ParkingLot. For testing ParkingLot
// or for specific modules this can be enabled though.
# ifndef CARB_USE_PARKINGLOT
# define CARB_USE_PARKINGLOT 0
# endif
using hundrednanos = std::chrono::duration<int64_t, std::ratio<1, 10'000'000>>;
template <class T>
inline bool WaitOnAddress(const std::atomic<T>& val, T compare, int64_t* timeout) noexcept
{
static_assert(sizeof(val) == sizeof(compare), "Invalid assumption about atomic");
// Use the NTDLL version of this function since we can give it relative or absolute times in 100ns units
using RtlWaitOnAddressFn = DWORD(__stdcall*)(volatile const void*, void*, size_t, int64_t*);
static RtlWaitOnAddressFn RtlWaitOnAddress =
(RtlWaitOnAddressFn)GetProcAddress(GetModuleHandleW(L"ntdll.dll"), "RtlWaitOnAddress");
volatile const T* addr = reinterpret_cast<volatile const T*>(std::addressof(val));
switch (DWORD ret = RtlWaitOnAddress(addr, &compare, sizeof(compare), timeout))
{
case CARBWIN_STATUS_SUCCESS:
return true;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from RtlWaitOnAddress: %u, GetLastError=%u", ret, ::GetLastError());
CARB_FALLTHROUGH; // (not really, but the compiler doesn't know that CARB_FATAL_UNLESS doesn't return)
case CARBWIN_STATUS_TIMEOUT:
return false;
}
}
template <class T>
inline void futex_wait(const std::atomic<T>& val, T compare) noexcept
{
WaitOnAddress(val, compare, nullptr);
}
template <class T, class Rep, class Period>
inline bool futex_wait_for(const std::atomic<T>& val, T compare, std::chrono::duration<Rep, Period> duration)
{
// RtlWaitOnAddress treats negative timeouts as positive relative time
int64_t timeout = -std::chrono::duration_cast<hundrednanos>(clampDuration(duration)).count();
if (timeout >= 0)
{
// duration to wait is negative
return false;
}
CARB_ASSERT(timeout < 0);
return WaitOnAddress(val, compare, &timeout);
}
template <class T, class Clock, class Duration>
inline bool futex_wait_until(const std::atomic<T>& val, T compare, std::chrono::time_point<Clock, Duration> time_point)
{
int64_t absTime;
auto now = Clock::now();
// RtlWaitOnAddress is quite slow to return if the time has already elapsed. It's much faster for us to check first.
if (time_point <= now)
{
return false;
}
// Constrain the time to something that is well before the heat death of the universe
auto tp = now + clampDuration(time_point - now);
// if ((void*)std::addressof(Clock::now) != (void*)std::addressof(std::chrono::system_clock::now))
if (!std::is_same<Clock, std::chrono::system_clock>::value)
{
// If we're not using the system clock, then we need to convert to the system clock
absTime = std::chrono::duration_cast<detail::hundrednanos>(
(tp - now + std::chrono::system_clock::now()).time_since_epoch())
.count();
}
else
{
// Already in terms of system clock
// According to https://github.com/microsoft/STL/blob/master/stl/inc/chrono, the system_clock appears to
// use GetSystemTimePreciseAsFileTime minus an epoch value so that it lines up with 1/1/1970 midnight GMT.
// Unfortunately there's not an easy way to check for it here, but we have a unittest in TestSemaphore.cpp.
absTime = std::chrono::duration_cast<detail::hundrednanos>(tp.time_since_epoch()).count();
}
// Epoch value from https://github.com/microsoft/STL/blob/master/stl/src/xtime.cpp
// This is the number of 100ns units between 1 January 1601 00:00 GMT and 1 January 1970 00:00 GMT
constexpr int64_t kFiletimeEpochToUnixEpochIn100nsUnits = 0x19DB1DED53E8000LL;
absTime += kFiletimeEpochToUnixEpochIn100nsUnits;
CARB_ASSERT(absTime >= 0);
return detail::WaitOnAddress(val, compare, &absTime);
}
template <class T>
inline void futex_wake_one(std::atomic<T>& val) noexcept
{
WakeByAddressSingle(std::addressof(val));
}
template <class T>
inline void futex_wake_n(std::atomic<T>& val, size_t n) noexcept
{
while (n--)
futex_wake_one(val);
}
template <class T>
inline void futex_wake_all(std::atomic<T>& val) noexcept
{
WakeByAddressAll(std::addressof(val));
}
# if !CARB_USE_PARKINGLOT
template <class T, size_t S = sizeof(T)>
class Futex
{
static_assert(S == 1 || S == 2 || S == 4 || S == 8, "Unsupported size");
public:
using AtomicType = typename std::atomic<T>;
using Type = T;
static inline void wait(const AtomicType& val, Type compare) noexcept
{
futex_wait(val, compare);
}
template <class Rep, class Period>
static inline bool wait_for(const AtomicType& val, Type compare, std::chrono::duration<Rep, Period> duration)
{
return futex_wait_for(val, compare, duration);
}
template <class Clock, class Duration>
static inline bool wait_until(const AtomicType& val, Type compare, std::chrono::time_point<Clock, Duration> time_point)
{
return futex_wait_until(val, compare, time_point);
}
static inline void notify_one(AtomicType& a) noexcept
{
futex_wake_one(a);
}
static inline void notify_n(AtomicType& a, size_t n) noexcept
{
futex_wake_n(a, n);
}
static inline void notify_all(AtomicType& a) noexcept
{
futex_wake_all(a);
}
};
# endif
#elif CARB_PLATFORM_LINUX
# define CARB_USE_PARKINGLOT 1 // Linux only supports 4 byte futex so it must use the ParkingLot
constexpr int64_t kNsPerSec = 1'000'000'000;
inline int futex(const std::atomic_uint32_t& aval,
int futex_op,
uint32_t val,
const struct timespec* timeout,
uint32_t* uaddr2,
int val3) noexcept
{
static_assert(sizeof(aval) == sizeof(uint32_t), "Invalid assumption about atomic");
int ret = syscall(SYS_futex, std::addressof(aval), futex_op, val, timeout, uaddr2, val3);
return ret >= 0 ? ret : -errno;
}
inline void futex_wait(const std::atomic_uint32_t& val, uint32_t compare) noexcept
{
for (;;)
{
int ret = futex(val, FUTEX_WAIT_BITSET_PRIVATE, compare, nullptr, nullptr, FUTEX_BITSET_MATCH_ANY);
switch (ret)
{
case 0:
case -EAGAIN: // Valid or spurious wakeup
return;
case -ETIMEDOUT:
// Apparently on Windows Subsystem for Linux, calls to the kernel can timeout even when a timeout value
// was not specified. Fall through.
case -EINTR: // Interrupted by signal; loop again
break;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from futex(): %d/%s", -ret, strerror(-ret));
}
}
}
template <class Rep, class Period>
inline bool futex_wait_for(const std::atomic_uint32_t& val, uint32_t compare, std::chrono::duration<Rep, Period> duration)
{
// Relative time
int64_t ns = std::chrono::duration_cast<std::chrono::nanoseconds>(clampDuration(duration)).count();
if (ns <= 0)
{
return false;
}
struct timespec ts;
ts.tv_sec = time_t(ns / detail::kNsPerSec);
ts.tv_nsec = long(ns % detail::kNsPerSec);
// Since we're using relative time here, we can use FUTEX_WAIT_PRIVATE (see futex() man page)
int ret = futex(val, FUTEX_WAIT_PRIVATE, compare, &ts, nullptr, 0);
switch (ret)
{
case 0: // Valid wakeup
case -EAGAIN: // Valid or spurious wakeup
case -EINTR: // Interrupted by signal; treat as a spurious wakeup
return true;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from futex(): %d/%s", -ret, strerror(-ret));
CARB_FALLTHROUGH; // (not really but the compiler doesn't know that the above won't return)
case -ETIMEDOUT:
return false;
}
}
template <class Clock, class Duration>
inline bool futex_wait_until(const std::atomic_uint32_t& val,
uint32_t compare,
std::chrono::time_point<Clock, Duration> time_point)
{
struct timespec ts;
clock_gettime(CLOCK_MONOTONIC, &ts);
// Constrain the time to something that is well before the heat death of the universe
auto now = Clock::now();
auto tp = now + clampDuration(time_point - now);
// Get the number of nanoseconds to go
int64_t ns = std::chrono::duration_cast<std::chrono::nanoseconds>(tp - now).count();
if (ns <= 0)
{
return false;
}
ts.tv_sec += time_t(ns / kNsPerSec);
ts.tv_nsec += long(ns % kNsPerSec);
// Handle rollover
if (ts.tv_nsec >= kNsPerSec)
{
++ts.tv_sec;
ts.tv_nsec -= kNsPerSec;
}
for (;;)
{
// Since we're using absolute monotonic time, we use FUTEX_WAIT_BITSET_PRIVATE. See the man page for futex for
// more info.
int ret = futex(val, FUTEX_WAIT_BITSET_PRIVATE, compare, &ts, nullptr, FUTEX_BITSET_MATCH_ANY);
switch (ret)
{
case 0: // Valid wakeup
case -EAGAIN: // Valid or spurious wakeup
return true;
case -EINTR: // Interrupted by signal; loop again
break;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from futex(): %d/%s", -ret, strerror(-ret));
CARB_FALLTHROUGH; // (not really but the compiler doesn't know that the above won't return)
case -ETIMEDOUT:
return false;
}
}
}
inline void futex_wake_n(std::atomic_uint32_t& val, unsigned count) noexcept
{
int ret = futex(val, FUTEX_WAKE_BITSET_PRIVATE, count, nullptr, nullptr, FUTEX_BITSET_MATCH_ANY);
CARB_ASSERT(ret >= 0, "futex(FUTEX_WAKE) failed with errno=%d/%s", -ret, strerror(-ret));
CARB_UNUSED(ret);
}
inline void futex_wake_one(std::atomic_uint32_t& val) noexcept
{
futex_wake_n(val, 1);
}
inline void futex_wake_all(std::atomic_uint32_t& val) noexcept
{
futex_wake_n(val, INT_MAX);
}
#elif CARB_PLATFORM_MACOS
# define CARB_USE_PARKINGLOT 1
# define UL_COMPARE_AND_WAIT 1
# define UL_UNFAIR_LOCK 2
# define UL_COMPARE_AND_WAIT_SHARED 3
# define UL_UNFAIR_LOCK64_SHARED 4
# define UL_COMPARE_AND_WAIT64 5
# define UL_COMPARE_AND_WAIT64_SHARED 6
# define ULF_WAKE_ALL 0x00000100
# define ULF_WAKE_THREAD 0x00000200
# define ULF_NO_ERRNO 0x01000000
/** Undocumented OSX futex-like call.
* @param operation A combination of the UL_* and ULF_* flags.
* @param[in] addr The address to wait on.
* This is a 32 bit value unless UL_COMPARE_AND_WAIT64 is passed.
* @param value The address's previous value.
* @param timeout Timeout in microseconds.
* @returns 0 or a positive value (representing additional waiters) on success, or a negative value on error. If a
* negative value is returned, `errno` will be set, unless ULF_NO_ERRNO is provided, in which case the
* return value is the negated error value.
*/
extern "C" int __ulock_wait(uint32_t operation, void* addr, uint64_t value, uint32_t timeout);
/** Undocumented OSX futex-like call.
* @param operation A combination of the UL_* and ULF_* flags.
* @param[in] addr The address to wake, passed to __ulock_wait by other threads.
* @param wake_value An extra value to be interpreted based on \p operation. If `ULF_WAKE_THREAD` is provided,
* then this is the mach_port of the specific thread to wake.
* @returns 0 or a positive value (representing additional waiters) on success, or a negative value on error. If a
* negative value is returned, `errno` will be set, unless ULF_NO_ERRNO is provided, in which case the
* return value is the negated error value.
*/
extern "C" int __ulock_wake(uint32_t operation, void* addr, uint64_t wake_value);
inline void futex_wait(const std::atomic_uint32_t& val, uint32_t compare) noexcept
{
for (;;)
{
int rc = __ulock_wait(UL_COMPARE_AND_WAIT | ULF_NO_ERRNO,
const_cast<uint32_t*>(reinterpret_cast<const uint32_t*>(std::addressof(val))), compare, 0);
if (rc >= 0)
{
// According to XNU source, the non-negative return value is the number of remaining waiters.
// See ulock_wait_cleanup in sys_ulock.c
return;
}
switch (-rc)
{
case EINTR: // According to XNU source, EINTR can be returned.
continue;
case ETIMEDOUT:
CARB_FALLTHROUGH;
case EFAULT:
CARB_FALLTHROUGH;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from __ulock_wait: %d/%s", -rc, strerror(-rc));
}
}
}
template <class Rep, class Period>
inline bool futex_wait_for(const std::atomic_uint32_t& val, uint32_t compare, std::chrono::duration<Rep, Period> duration)
{
// Relative time
int64_t usec = std::chrono::duration_cast<std::chrono::microseconds>(clampDuration(duration)).count();
if (usec <= 0)
{
return false;
}
if (usec > UINT32_MAX)
{
usec = UINT32_MAX;
}
int rc = __ulock_wait(UL_COMPARE_AND_WAIT | ULF_NO_ERRNO,
const_cast<uint32_t*>(reinterpret_cast<const uint32_t*>(std::addressof(val))), compare, usec);
if (rc >= 0)
{
// According to XNU source, the non-negative return value is the number of remaining waiters.
// See ulock_wait_cleanup in sys_ulock.c
return true;
}
switch (-rc)
{
case EINTR: // Treat signal interrupt as a spurious wakeup
return true;
case ETIMEDOUT:
return false;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from __ulock_wait: %d/%s", -rc, strerror(-rc));
}
}
template <class Clock, class Duration>
inline bool futex_wait_until(const std::atomic_uint32_t& val,
uint32_t compare,
std::chrono::time_point<Clock, Duration> time_point)
{
// Constrain the time to something that is well before the heat death of the universe
auto now = Clock::now();
auto tp = now + clampDuration(time_point - now);
// Convert to number of microseconds from now
int64_t usec = std::chrono::duration_cast<std::chrono::microseconds>(tp - now).count();
if (usec <= 0)
{
return false;
}
if (usec > UINT32_MAX)
{
usec = UINT32_MAX;
}
int rc = __ulock_wait(UL_COMPARE_AND_WAIT | ULF_NO_ERRNO,
const_cast<uint32_t*>(reinterpret_cast<const uint32_t*>(std::addressof(val))), compare, usec);
if (rc >= 0)
{
// According to XNU source, the non-negative return value is the number of remaining waiters.
// See ulock_wait_cleanup in sys_ulock.c
return true;
}
switch (-rc)
{
case EINTR: // Treat signal interrupt as a spurious wakeup
return true;
case ETIMEDOUT:
return false;
default:
CARB_FATAL_UNLESS(0, "Unexpected result from __ulock_wait: %d/%s", -rc, strerror(-rc));
}
}
inline void futex_wake_n(std::atomic_uint32_t& val, unsigned count) noexcept
{
for (unsigned i = 0; i < count; i++)
{
__ulock_wake(UL_COMPARE_AND_WAIT, std::addressof(val), 0);
}
}
inline void futex_wake_one(std::atomic_uint32_t& val) noexcept
{
__ulock_wake(UL_COMPARE_AND_WAIT, std::addressof(val), 0);
}
inline void futex_wake_all(std::atomic_uint32_t& val) noexcept
{
__ulock_wake(UL_COMPARE_AND_WAIT | ULF_WAKE_ALL, std::addressof(val), 0);
}
#endif
class NativeFutex
{
public:
using AtomicType = std::atomic_uint32_t;
using Type = uint32_t;
static inline void wait(const AtomicType& val, Type compare) noexcept
{
futex_wait(val, compare);
}
template <class Rep, class Period>
static inline bool wait_for(const AtomicType& val, Type compare, std::chrono::duration<Rep, Period> duration)
{
return futex_wait_for(val, compare, duration);
}
template <class Clock, class Duration>
static inline bool wait_until(const AtomicType& val, Type compare, std::chrono::time_point<Clock, Duration> time_point)
{
return futex_wait_until(val, compare, time_point);
}
static inline void notify_one(AtomicType& a) noexcept
{
futex_wake_one(a);
}
static inline void notify_n(AtomicType& a, size_t n) noexcept
{
futex_wake_n(a, n);
}
static inline void notify_all(AtomicType& a) noexcept
{
futex_wake_all(a);
}
};
#if CARB_USE_PARKINGLOT
struct ParkingLot
{
struct WaitEntry
{
const void* addr;
WaitEntry* next{ nullptr };
WaitEntry* prev{ nullptr };
uint32_t changeId{ 0 };
NativeFutex::AtomicType wakeup{ 0 };
enum Bits : uint32_t
{
kNoBits = 0,
kNotifyBit = 1,
kWaitBit = 2,
};
};
class WaitBucket
{
// In an effort to conserve size and implement appearsEmpty(), we use the least significant bit as a lock bit.
constexpr static size_t kUnlocked = 0;
constexpr static size_t kLock = 1;
union
{
std::atomic<WaitEntry*> m_head{ nullptr };
std::atomic_size_t m_lock;
// The native futex is only 32 bits, so m_lock must coincide with the LSBs of m_lock, hence we assert
// little-endian
NativeFutex::AtomicType m_futex;
static_assert(carb::cpp::endian::native == carb::cpp::endian::little, "Requires little endian");
};
WaitEntry* m_tail;
std::atomic_uint32_t m_waiters{ 0 };
std::atomic_uint32_t m_changeTracker{ 0 };
void setHead(WaitEntry* newHead) noexcept
{
assertLockState();
assertNoLockBits(newHead);
size_t val = size_t(newHead);
// Maintain bits but set to new value
// Relaxed semantics because we own the lock so shouldn't need to synchronize-with any other threads
m_lock.store(val | kLock, std::memory_order_relaxed);
}
void setHeadAndUnlock(WaitEntry* newHead) noexcept
{
assertLockState();
assertNoLockBits(newHead);
size_t val = size_t(newHead);
m_lock.store(val, std::memory_order_seq_cst);
if (m_waiters.load(std::memory_order_relaxed))
NativeFutex::notify_one(m_futex);
}
void assertLockState() const noexcept
{
// Relaxed because this should only be done within the lock
CARB_ASSERT(m_lock.load(std::memory_order_relaxed) & kLock);
}
static void assertNoLockBits(WaitEntry* e) noexcept
{
CARB_UNUSED(e);
CARB_ASSERT(!(size_t(e) & kLock));
}
void assertHead(WaitEntry* e) const noexcept
{
// Relaxed because this should only be done within the lock
CARB_UNUSED(e);
CARB_ASSERT((m_lock.load(std::memory_order_relaxed) & ~kLock) == size_t(e));
}
public:
constexpr WaitBucket() noexcept : m_head{ nullptr }, m_tail{ nullptr }
{
}
void incChangeTracker() noexcept
{
assertLockState(); // under lock
m_changeTracker.store(m_changeTracker.load(std::memory_order_relaxed) + 1, std::memory_order_relaxed);
}
bool appearsEmpty() const noexcept
{
// fence-fence synchronization with wait functions
this_thread::atomic_fence_seq_cst();
return m_lock.load(std::memory_order_relaxed) == 0;
}
std::atomic_uint32_t& changeTracker() noexcept
{
return m_changeTracker;
}
WaitEntry* lock() noexcept
{
size_t val = m_lock.load(std::memory_order_relaxed);
for (;;)
{
if (!(val & kLock))
{
if (m_lock.compare_exchange_strong(val, val | kLock))
return reinterpret_cast<WaitEntry*>(val);
continue;
}
if (!this_thread::spinTryWait([&] { return !((val = m_lock.load(std::memory_order_relaxed)) & kLock); }))
{
++m_waiters;
while ((val = m_lock.load(std::memory_order_relaxed)) & kLock)
carb::thread::detail::NativeFutex::wait(m_futex, uint32_t(val));
--m_waiters;
}
}
}
void unlockHint(WaitEntry* head) noexcept
{
assertLockState();
assertNoLockBits(head);
assertHead(head);
m_lock.store(size_t(head), std::memory_order_seq_cst);
if (m_waiters.load(std::memory_order_relaxed))
NativeFutex::notify_one(m_futex);
}
void unlock() noexcept
{
unlockHint(reinterpret_cast<WaitEntry*>(m_lock.load(std::memory_order_relaxed) & ~kLock));
}
void appendAndUnlock(WaitEntry* e) noexcept
{
assertLockState();
assertNoLockBits(e);
e->prev = m_tail;
e->next = nullptr;
if (e->prev)
{
m_tail = e->prev->next = e;
unlock();
}
else
{
m_tail = e;
setHeadAndUnlock(e);
}
}
void remove(WaitEntry* e) noexcept
{
assertLockState();
if (e->next)
e->next->prev = e->prev;
else
{
CARB_ASSERT(m_tail == e);
m_tail = e->prev;
}
if (e->prev)
e->prev->next = e->next;
else
{
assertHead(e);
setHead(e->next);
}
}
void removeAndUnlock(WaitEntry* e) noexcept
{
assertLockState();
assertNoLockBits(e);
if (e->next)
e->next->prev = e->prev;
else
{
CARB_ASSERT(m_tail == e);
m_tail = e->prev;
}
if (e->prev)
{
e->prev->next = e->next;
unlock();
}
else
{
assertHead(e);
setHeadAndUnlock(e->next);
}
}
constexpr static size_t kNumWaitBuckets = 2048; // Must be a power of two
static_assert(carb::cpp::has_single_bit(kNumWaitBuckets), "Invalid assumption");
static inline WaitBucket& bucket(const void* addr) noexcept
{
static WaitBucket waitBuckets[kNumWaitBuckets];
# if 1
// FNV-1a hash is fast with really good distribution
// In "futex buckets" test, about ~70% on Windows and ~80% on Linux
auto hash = carb::hashBuffer(&addr, sizeof(addr));
return waitBuckets[hash & (kNumWaitBuckets - 1)];
# else
// Simple bitshift method
// In "futex buckets" test:
// >> 4 bits: ~71% on Windows, ~72% on Linux
// >> 5 bits: ~42% on Windows, ~71% on Linux
return waitBuckets[(size_t(addr) >> 4) & (kNumWaitBuckets - 1)];
# endif
}
};
template <typename T>
static void wait(const std::atomic<T>& val, T compare) noexcept
{
WaitEntry entry{ std::addressof(val) };
using I = to_integral_t<T>;
// Check before waiting
if (reinterpret_as<I>(val.load(std::memory_order_acquire)) != reinterpret_as<I>(compare))
{
return;
}
WaitBucket& b = WaitBucket::bucket(std::addressof(val));
auto hint = b.lock();
// Check inside the lock to reduce spurious wakeups
if (CARB_UNLIKELY(reinterpret_as<I>(val.load(std::memory_order_acquire)) != reinterpret_as<I>(compare)))
{
b.unlockHint(hint);
return;
}
entry.changeId = b.changeTracker().load(std::memory_order_relaxed);
b.appendAndUnlock(&entry);
// fence-fence synchronization with appearsEmpty()
this_thread::atomic_fence_seq_cst();
// Do the wait if everything is consistent
if (CARB_LIKELY(reinterpret_as<I>(val.load(std::memory_order_relaxed)) == reinterpret_as<I>(compare) &&
b.changeTracker().load(std::memory_order_relaxed) == entry.changeId))
{
NativeFutex::wait(entry.wakeup, uint32_t(WaitEntry::kNoBits));
}
// Speculatively see if we've been removed
uint32_t v = entry.wakeup.load(std::memory_order_acquire);
if (CARB_UNLIKELY(!v))
{
// Need to remove
hint = b.lock();
// Check again under the lock (relaxed because we're under the lock)
v = entry.wakeup.load(std::memory_order_relaxed);
if (!v)
{
b.removeAndUnlock(&entry);
return;
}
else
{
// Already removed
b.unlockHint(hint);
}
}
// Spin briefly while the wait bit is set, though this should be rare
this_thread::spinWait([&] { return !(entry.wakeup.load(std::memory_order_acquire) & WaitEntry::kWaitBit); });
}
template <typename T, typename Rep, typename Period>
static bool wait_for(const std::atomic<T>& val, T compare, std::chrono::duration<Rep, Period> duration)
{
WaitEntry entry{ std::addressof(val) };
using I = to_integral_t<T>;
// Check before waiting
if (reinterpret_as<I>(val.load(std::memory_order_acquire)) != reinterpret_as<I>(compare))
{
return true;
}
WaitBucket& b = WaitBucket::bucket(std::addressof(val));
auto hint = b.lock();
// Check inside the lock to reduce spurious wakeups
if (CARB_UNLIKELY(reinterpret_as<I>(val.load(std::memory_order_acquire)) != reinterpret_as<I>(compare)))
{
b.unlockHint(hint);
return true;
}
entry.changeId = b.changeTracker().load(std::memory_order_relaxed);
b.appendAndUnlock(&entry);
// fence-fence synchronization with appearsEmpty()
this_thread::atomic_fence_seq_cst();
// Do the wait if everything is consistent
bool finished = true;
if (CARB_LIKELY(reinterpret_as<I>(val.load(std::memory_order_relaxed)) == reinterpret_as<I>(compare) &&
b.changeTracker().load(std::memory_order_relaxed) == entry.changeId))
{
finished = NativeFutex::wait_for(entry.wakeup, uint32_t(WaitEntry::kNoBits), duration);
}
// Speculatively see if we've been removed
uint32_t v = entry.wakeup.load(std::memory_order_acquire);
if (CARB_UNLIKELY(!v))
{
// Need to remove
hint = b.lock();
// Check again under the lock (relaxed because we're under the lock)
v = entry.wakeup.load(std::memory_order_relaxed);
if (!v)
{
b.removeAndUnlock(&entry);
return finished;
}
else
{
// Already removed
b.unlockHint(hint);
finished = true;
}
}
// Spin briefly while the wait bit is set, though this should be rare
this_thread::spinWait([&] { return !(entry.wakeup.load(std::memory_order_acquire) & WaitEntry::kWaitBit); });
return finished;
}
template <typename T, typename Clock, typename Duration>
static bool wait_until(const std::atomic<T>& val, T compare, std::chrono::time_point<Clock, Duration> time_point)
{
WaitEntry entry{ std::addressof(val) };
using I = to_integral_t<T>;
// Check before waiting
if (reinterpret_as<I>(val.load(std::memory_order_acquire)) != reinterpret_as<I>(compare))
{
return true;
}
WaitBucket& b = WaitBucket::bucket(std::addressof(val));
auto hint = b.lock();
// Check inside the lock to reduce spurious wakeups
if (CARB_UNLIKELY(reinterpret_as<I>(val.load(std::memory_order_acquire)) != reinterpret_as<I>(compare)))
{
b.unlockHint(hint);
return true;
}
entry.changeId = b.changeTracker().load(std::memory_order_relaxed);
b.appendAndUnlock(&entry);
// fence-fence synchronization with appearsEmpty()
this_thread::atomic_fence_seq_cst();
// Do the wait if everything is consistent
bool finished = true;
if (CARB_LIKELY(reinterpret_as<I>(val.load(std::memory_order_relaxed)) == reinterpret_as<I>(compare) &&
b.changeTracker().load(std::memory_order_relaxed) == entry.changeId))
{
finished = NativeFutex::wait_until(entry.wakeup, uint32_t(WaitEntry::kNoBits), time_point);
}
// Speculatively see if we've been removed
uint32_t v = entry.wakeup.load(std::memory_order_acquire);
if (CARB_UNLIKELY(!v))
{
// Need to remove
hint = b.lock();
// Check again under the lock (relaxed because we're under the lock)
v = entry.wakeup.load(std::memory_order_relaxed);
if (!v)
{
b.removeAndUnlock(&entry);
return finished;
}
else
{
// Already removed
b.unlockHint(hint);
finished = true;
}
}
// Spin briefly while the wait bit is set, though this should be rare
this_thread::spinWait([&] { return !(entry.wakeup.load(std::memory_order_acquire) & WaitEntry::kWaitBit); });
return finished;
}
static void notify_one(void* addr) noexcept
{
WaitBucket& b = WaitBucket::bucket(addr);
// Read empty state with full fence to avoid locking
if (b.appearsEmpty())
return;
WaitEntry* head = b.lock();
b.incChangeTracker();
for (WaitEntry* e = head; e; e = e->next)
{
if (e->addr == addr)
{
// Remove before setting the wakeup flag
b.remove(e);
// Even though we're under the lock, we need release semantics to synchronize-with the wait not under
// the lock.
e->wakeup.store(WaitEntry::kNotifyBit, std::memory_order_release);
b.unlock();
// Wake the waiter
NativeFutex::notify_one(e->wakeup);
return;
}
}
b.unlockHint(head);
}
constexpr static size_t kWakeCacheSize = 128;
private:
static CARB_NOINLINE void notify_n_slow(
void* addr, size_t n, WaitBucket& b, WaitEntry* e, std::atomic_uint32_t** wakeCache) noexcept
{
// We are waking a lot of things and the wakeCache is completely full. Now we need to start building a list
WaitEntry *wake = nullptr, *end = nullptr;
for (WaitEntry* next; e; e = next)
{
next = e->next;
if (e->addr == addr)
{
b.remove(e);
e->next = nullptr;
// Don't bother with prev pointers
if (end)
end->next = e;
else
wake = e;
end = e;
// Even though we're under the lock we use release semantics here to synchronize-with the waking thread
// possibly outside the lock.
// Need to set the wait bit since we're still reading/writing to the WaitEntry
e->wakeup.store(WaitEntry::kWaitBit | WaitEntry::kNotifyBit, std::memory_order_release);
if (!--n)
break;
}
}
b.unlock();
// Wake the entire cache since we know it's full
auto wakeCacheEnd = (wakeCache + kWakeCacheSize);
do
{
NativeFutex::notify_one(**(wakeCache++));
} while (wakeCache != wakeCacheEnd);
for (WaitEntry* next; wake; wake = next)
{
next = wake->next;
// Clear the wait bit so that only the wake bit is set
wake->wakeup.store(WaitEntry::kNotifyBit, std::memory_order_release);
NativeFutex::notify_one(wake->wakeup);
}
}
static CARB_NOINLINE void notify_all_slow(void* addr, WaitBucket& b, WaitEntry* e, std::atomic_uint32_t** wakeCache) noexcept
{
// We are waking a lot of things and the wakeCache is completely full. Now we need to start building a list
WaitEntry *wake = nullptr, *end = nullptr;
for (WaitEntry* next; e; e = next)
{
next = e->next;
if (e->addr == addr)
{
b.remove(e);
e->next = nullptr;
// Don't bother with prev pointers
if (end)
end->next = e;
else
wake = e;
end = e;
// Even though we're under the lock we use release semantics here to synchronize-with the waking thread
// possibly outside the lock.
// Need to set the wait bit since we're still reading/writing to the WaitEntry
e->wakeup.store(WaitEntry::kWaitBit | WaitEntry::kNotifyBit, std::memory_order_release);
}
}
b.unlock();
// Wake the entire cache since we know it's full
auto wakeCacheEnd = (wakeCache + kWakeCacheSize);
do
{
NativeFutex::notify_one(**(wakeCache++));
} while (wakeCache != wakeCacheEnd);
for (WaitEntry* next; wake; wake = next)
{
next = wake->next;
// Clear the wait bit so that only the wake bit is set
wake->wakeup.store(WaitEntry::kNotifyBit, std::memory_order_release);
NativeFutex::notify_one(wake->wakeup);
}
}
public:
static void notify_n(void* addr, size_t n) noexcept
{
if (CARB_UNLIKELY(n == 0))
{
return;
}
// It is much faster overall to not set kWaitBit and force the woken threads to wait until we're clear of their
// WaitEntry, so keep a local cache of addresses to wake here that don't require a WaitEntry.
// Note that we do retain a pointer to the std::atomic_uint32_t *contained in* the WaitEntry and tell the
// underlying OS system to wake by that address, but this is safe as it does not read that memory. The address
// is used as a lookup to find any waiters that registered with that address. If the memory was quickly reused
// for a different wait operation, this will cause a spurious wakeup which is allowed, but this should be
// exceedingly rare.
size_t wakeCount = 0;
std::atomic_uint32_t* wakeCache[kWakeCacheSize];
WaitBucket& b = WaitBucket::bucket(addr);
// Read empty state with full fence to avoid locking
if (b.appearsEmpty())
return;
WaitEntry* e = b.lock();
b.incChangeTracker();
for (WaitEntry* next; e; e = next)
{
next = e->next;
if (e->addr == addr)
{
b.remove(e);
// Even though we're under the lock we use release semantics here to synchronize-with the waking thread
// possibly outside the lock.
wakeCache[wakeCount++] = &e->wakeup;
e->wakeup.store(WaitEntry::kNotifyBit, std::memory_order_release);
if (!--n)
break;
if (CARB_UNLIKELY(wakeCount == kWakeCacheSize))
{
// Cache is full => transition to a list for the rest
notify_n_slow(addr, n, b, next, wakeCache);
return;
}
}
}
b.unlock();
auto start = wakeCache;
auto const end = wakeCache + wakeCount;
while (start != end)
NativeFutex::notify_one(**(start++));
}
static void notify_all(void* addr) noexcept
{
// It is much faster overall to not set kWaitBit and force the woken threads to wait until we're clear of their
// WaitEntry, so keep a local cache of addresses to wake here that don't require a WaitEntry.
// Note that we do retain a pointer to the std::atomic_uint32_t *contained in* the WaitEntry and tell the
// underlying OS system to wake by that address, but this is safe as it does not read that memory. The address
// is used as a lookup to find any waiters that registered with that address. If the memory was quickly reused
// for a different wait operation, this will cause a spurious wakeup which is allowed, but this should be
// exceedingly rare.
size_t wakeCount = 0;
std::atomic_uint32_t* wakeCache[kWakeCacheSize];
WaitBucket& b = WaitBucket::bucket(addr);
// Read empty state with full fence to avoid locking
if (b.appearsEmpty())
return;
WaitEntry* e = b.lock();
b.incChangeTracker();
for (WaitEntry* next; e; e = next)
{
next = e->next;
if (e->addr == addr)
{
b.remove(e);
// Even though we're under the lock we use release semantics here to synchronize-with the waking thread
// possibly outside the lock.
wakeCache[wakeCount++] = &e->wakeup;
e->wakeup.store(WaitEntry::kNotifyBit, std::memory_order_release);
if (CARB_UNLIKELY(wakeCount == kWakeCacheSize))
{
// Full => transition to a list for the rest of the items
notify_all_slow(addr, b, next, wakeCache);
return;
}
}
}
b.unlock();
auto start = wakeCache;
const auto end = wakeCache + wakeCount;
while (start != end)
NativeFutex::notify_one(**(start++));
}
}; // struct ParkingLot
// Futex types that must use the ParkingLot
template <class T, size_t S = sizeof(T)>
class Futex
{
static_assert(S == 1 || S == 2 || S == 4 || S == 8, "Unsupported size");
public:
using AtomicType = typename std::atomic<T>;
using Type = T;
static void wait(const AtomicType& val, T compare) noexcept
{
ParkingLot::wait(val, compare);
}
template <class Rep, class Period>
static bool wait_for(const AtomicType& val, T compare, std::chrono::duration<Rep, Period> duration)
{
return ParkingLot::wait_for(val, compare, duration);
}
template <class Clock, class Duration>
static bool wait_until(const AtomicType& val, T compare, std::chrono::time_point<Clock, Duration> time_point)
{
return ParkingLot::wait_until(val, compare, time_point);
}
static void notify_one(AtomicType& val) noexcept
{
ParkingLot::notify_one(std::addressof(val));
}
static void notify_n(AtomicType& val, size_t count) noexcept
{
ParkingLot::notify_n(std::addressof(val), count);
}
static void notify_all(AtomicType& val) noexcept
{
ParkingLot::notify_all(std::addressof(val));
}
};
#endif
} // namespace detail
} // namespace thread
} // namespace carb
| 42,914 | C | 33.059524 | 139 | 0.581162 |
omniverse-code/kit/include/carb/thread/Futex.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite Futex implementation.
#pragma once
#include "FutexImpl.h"
#include <atomic>
namespace carb
{
namespace thread
{
/**
* Futex namespace.
*
* @warning Futex is a very low-level system; generally its use should be avoided. There are plenty of higher level
* synchronization primitives built on top of Futex that should be used instead, such as `carb::cpp::atomic`.
*
* FUTEX stands for Fast Userspace muTEX. Put simply, it's a way of efficiently blocking threads by waiting on an
* address as long as the value at that address matches the expected value. Atomically the value at the address is
* checked and if it matches the expected value, the thread enters a wait-state (until notified). If the value does not
* match expectation, the thread does not enter a wait-state. This low-level system is the foundation for many
* synchronization primitives.
*
* On Windows, this functionality is achieved through APIs `WaitOnAddress`, `WakeByAddressSingle` and
* `WakeByAddressAll` and support values of 1, 2, 4 or 8 bytes. Much of the functionality is implemented without
* requiring system calls, so attempting to wait when the value is different, or notifying without any waiting threads
* are very efficient--only a few nanoseconds each. Calls which wait or notify waiting threads will enter the kernel and
* be on the order of microseconds.
*
* The Linux kernel provides a `futex` syscall for this functionality, with two downsides. First, a `futex` can be only
* four bytes (32-bit), and second due to being a syscall even calls with no work can take nearly a microsecond. macOS
* has a similar feature in the undocumented `__ulock_wait` and `__ulock_wake` calls.
*
* For Linux and macOS, the Carbonite futex system has a user-space layer called `ParkingLot` that supports values of 1,
* 2, 4 or 8 bytes and eliminates most syscalls unless work must actually be done. This causes no-op work to be on the
* order of just a few nanoseconds with worst-case timing being comparable to syscall times.
*
* Linux information: http://man7.org/linux/man-pages/man2/futex.2.html
*
* Windows information: https://docs.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-waitonaddress
*/
struct futex
{
/**
* Waits on a value until woken.
*
* The value at @p val is atomically compared with @p compare. If the values are not equal, this function returns
* immediately. Otherwise, if the values are equal, this function sleeps the current thread. Waking is not automatic
* when the value changes. The thread that changes the value must then call wake() to wake the waiting threads.
*
* @note Futexes are prone to spurious wakeups. It is the responsibility of the caller to determine whether a return
* from wait() is spurious or valid.
*
* @param val The value that is read atomically. If this matches @p compare, the thread sleeps.
* @param compare The expected value.
*/
template <class T>
inline static void wait(const std::atomic<T>& val, T compare) noexcept
{
detail::Futex<T>::wait(val, compare);
}
/**
* Waits on a value until woken or timed out.
*
* The value at @p val is atomically compared with @p compare. If the values are not equal, this function returns
* immediately. Otherwise, if the values are equal, this function sleeps the current thread. Waking is not automatic
* when the value changes. The thread that changes the value must then call wake() to wake the waiting threads.
*
* @note Futexes are prone to spurious wakeups. It is the responsibility of the caller to determine whether a return
* from wait() is spurious or valid.
*
* @note On Linux, interruptions by signals are treated as spurious wakeups.
*
* @param val The value that is read atomically. If this matches @p compare, the thread sleeps.
* @param compare The expected value.
* @param duration The relative time to wait.
* @return `true` if woken legitimately or spuriously; `false` if timed out.
*/
template <class T, class Rep, class Period>
inline static bool wait_for(const std::atomic<T>& val, T compare, std::chrono::duration<Rep, Period> duration)
{
return detail::Futex<T>::wait_for(val, compare, duration);
}
/**
* Waits on a value until woken or timed out.
*
* The value at @p val is atomically compared with @p compare. If the values are not equal, this function returns
* immediately. Otherwise, if the values are equal, this function sleeps the current thread. Waking is not automatic
* when the value changes. The thread that changes the value must then call wake() to wake the waiting threads.
*
* @note Futexes are prone to spurious wakeups. It is the responsibility of the caller to determine whether a return
* from wait() is spurious or valid.
*
* @param val The value that is read atomically. If this matches @p compare, the thread sleeps.
* @param compare The expected value.
* @param time_point The absolute time point to wait until.
* @return `true` if woken legitimately or spuriously; `false` if timed out.
*/
template <class T, class Clock, class Duration>
inline static bool wait_until(const std::atomic<T>& val, T compare, std::chrono::time_point<Clock, Duration> time_point)
{
return detail::Futex<T>::wait_until(val, compare, time_point);
}
/**
* Wakes threads that are waiting in one of the @p futex wait functions.
*
* @note To wake all threads waiting on @p val, use wake_all().
*
* @param val The same value that was passed to wait(), wait_for() or wait_until().
* @param count The number of threads to wake. To wake all threads, use wake_all().
* @param maxCount An optimization for Windows that specifies the total number of threads that are waiting on @p
* addr. If @p count is greater-than-or-equal-to @p maxCount then a specific API call that wakes all threads is
* used. Ignored on Linux.
*/
template <class T>
inline static void notify(std::atomic<T>& val, unsigned count, unsigned maxCount = unsigned(INT_MAX)) noexcept
{
if (count != 1 && count >= maxCount)
detail::Futex<T>::notify_all(val);
else
detail::Futex<T>::notify_n(val, count);
}
//! @copydoc notify()
template <class T>
CARB_DEPRECATED("use notify() instead")
inline static void wake(std::atomic<T>& val, unsigned count, unsigned maxCount = unsigned(INT_MAX)) noexcept
{
notify(val, count, maxCount);
}
/**
* Wakes one thread that is waiting in one of the @p futex wait functions.
*
* @param val The same value that was passed to wait(), wait_for() or wait_until().
*/
template <class T>
inline static void notify_one(std::atomic<T>& val) noexcept
{
detail::Futex<T>::notify_one(val);
}
//! @copydoc notify_one()
template <class T>
CARB_DEPRECATED("use notify_one() instead")
inline static void wake_one(std::atomic<T>& val) noexcept
{
notify_one(val);
}
/**
* Wakes all threads that are waiting in one of the @p futex wait functions
*
* @param val The same value that was passed to wait(), wait_for() or wait_until().
*/
template <class T>
inline static void notify_all(std::atomic<T>& val) noexcept
{
detail::Futex<T>::notify_all(val);
}
//! @copydoc notify_all()
template <class T>
CARB_DEPRECATED("Use notify_all() instead")
inline static void wake_all(std::atomic<T>& val) noexcept
{
notify_all(val);
}
}; // struct futex
} // namespace thread
} // namespace carb
| 8,265 | C | 42.505263 | 124 | 0.690381 |
omniverse-code/kit/include/carb/thread/IThreadUtil.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Provides an interface that handles various threading utility operations.
*/
#pragma once
#include "../Interface.h"
/** Namespace for all low level Carbonite functionality. */
namespace carb
{
/** Namespace for all threading operations. */
namespace thread
{
/** Base type for flags to the task relay system. These are the fRelayFlag* flags defined below.
* These are to be passed to the framework's runRelayTask() function through its descriptor.
*/
using RelayFlags = uint64_t;
/** Flag to indicate that a relay task should block until the task completes. When not used,
* the default behavior is to run the task as a fire-and-forget operation. In this case, the
* task descriptor will be shallow copied. It is the task's responsibility to clean up any
* resources used in the descriptor's @a context value before returning. When this flag is
* used, the runRelayTask() call will block until the task completes. In this case, either
* the task function itself or the caller can handle any resource clean up.
*
* Note that using this flag will effectively cause the task queue to be flushed. Any pending
* non-blocking calls will be completed before the new task is run.
*/
constexpr RelayFlags fRelayFlagBlocking = 0x8000000000000000ull;
/** Force the execution of the task even if a failure related to relaying the task occurs.
* This will effectively cause the task to run in the context of the thread that originally
* called Framework::runRelayTask() (and therefore imply the @ref fRelayFlagBlocking flag).
*/
constexpr RelayFlags fRelayFlagForce = 0x4000000000000000ull;
/** Flags available for use in the relay task itself. These flags will be passed to the relay
* function unmodified. The set bits in this mask may be used for any task-specific purpose.
* If any of the cleared bits in this mask are set in the task's flags (aside from the above
* defined flags), the runRelayTask() call will fail.
*/
constexpr RelayFlags fRelayAvailableFlagsMask = 0x0000ffffffffffffull;
/** Prototype for a relayed task function.
*
* @param[in] flags The flags controlling the behavior of this relay task. This may
* include either @ref fRelayFlagBlocking or any of the set bits in
* @ref fRelayAvailableFlagsMask. The bits in the mask may be used
* for any purpose specific to the task function.
* @param[inout] context An opaque value specific to this task. This will be passed unmodified
* to the task function from the task's descriptor when it is executed.
* If the task function needs to return a value, it may be done through
* this object.
* @returns No return value.
*
* @remarks The prototype for a task function to be executed on the relayed task thread. This
* function is expected to complete its task and return in a timely fashion. This
* should never block or perform a task that has the possibility of blocking for an
* extended period of time.
*
* @note Neither this function nor anything it calls may throw an exception unless the task
* function itself catches and handles that exception. Throwing an exception that goes
* uncaught by the task function will result in the process being terminated.
*/
using RelayTaskFn = void(CARB_ABI*)(RelayFlags flags, void* context);
/** A descriptor of the relay task to be performed. This provides the task function itself,
* the context value and flags to pass to it, and space to store the result for blocking
* task calls.
*
* For non-blocking tasks, this descriptor will be shallow copied and queued for
* execution. The caller must guarantee that any pointer parameters passed to the
* task function will remain valid until the task itself finishes execution. In this
* case the task function itself is also responsible for cleaning up any resources that
* are passed to the task function through its context object. As a result of this
* requirement, none of the values passed to the task should be allocated on the stack.
*
* For blocking calls, the task will be guaranteed to be completed by the time
* runRelayTask() returns. In this case, the result of the operation (if any) will be
* available in the task descriptor. Any of the task's objects may be allocated on the
* stack if needed since it is guaranteed to block until the task completes. Either the
* task or the caller may clean up any resources in this case.
*/
struct RelayTaskDesc
{
/** The task function to be executed. The task function itself is responsible for managing
* any thread safe access to any passed in values.
*/
RelayTaskFn task;
/** Flags that control the behavior of this task. This may be a combination of zero or
* more of the @ref RelayFlags flags and zero or more task-specific flags.
*/
RelayFlags flags;
/** An opaque context value to be passed to the task function when it executes. This will
* not be accessed or modified in any way before being passed to the task function. The
* task function itself is responsible for knowing how to properly interpret this value.
*/
void* context;
};
/** Possible result codes for Framework::runRelayTask(). */
enum class RelayResult
{
/** The task was executed successfully. */
eSuccess,
/** A bad flag bit was used by the caller. */
eBadParam,
/** The task thread failed to launch. */
eThreadFailure,
/** The relay system has been shutdown on process exit and will not accept any new tasks. */
eShutdown,
/** The task was successfully run, but had to be forced to run on the calling thread due to
* the relayed task thread failing to launch.
*/
eForced,
/** Failed to allocate memory for a non-blocking task. */
eNoMemory,
};
/** An interface to provide various thread utility operations. Currently the only defined
* operation is to run a task in a single common thread regardless of the thread that requests
* the operation.
*/
struct IThreadUtil
{
CARB_PLUGIN_INTERFACE("carb::thread::IThreadUtil", 1, 0)
/** Relays a task to run on an internal worker thread.
*
* @param[inout] desc The descriptor of the task to be run. This task includes a function
* to execute and a context value to pass to that function. This
* descriptor must remain valid for the entire lifetime of the execution
* of the task function. If the @ref fRelayFlagBlocking flag is used,
* this call will block until the task completes. In this case, the
* caller will be responsible for cleaning up any resources used or
* returned by the task function. If the flag is not used, the task
* function itself will be responsible for cleaning up any resources
* before it returns.
* @retval RelayResult::eSuccess if executing the task is successful.
* @returns An error code describing how the task relay failed.
*
* @remarks This relays a task to run on an internal worker thread. This worker thread will
* be guaranteed to continue running (in an efficient sleep state when not running
* a task) for the entire remaining lifetime of the process. The thread will be
* terminated during shutdown of the process.
*
* @remarks The intention of this function is to be able to run generic tasks on a worker
* thread that is guaranteed to live throughout the process's lifetime. Other
* similar systems in other plugins have the possibility of being unloaded before
* the end of the process which would lead to the task worker thread(s) being
* stopped early. Certain tasks such may require the instantiating thread to
* survive longer than the lifetime of a dynamic plugin.
*
* @remarks A task function may queue another task when it executes. However, the behavior
* may differ depending on whether the newly queued task is flagged as being
* blocking or non-blocking. A recursive blocking task will be executed immediately
* in the context of the task thread, but will interrupt any other pending tasks
* that were queued ahead of it. A recursive non-blocking task will always maintain
* queuing order however. Note that recursive tasks may require extra care to
* wait for or halt upon module shutdown or unload. In these cases, it is still
* the caller's responsibility to ensure all tasks queued by a module are safely
* and properly stopped before that module is unloaded.
*
* @note This should only be used in situations where it is absolutely necessary. In
* cases where performance or more flexibility are needed, other interfaces such as
* ITasking should be used instead.
*
* @note If a caller in another module queues a non-blocking task, it is that caller's
* responsibility to ensure that task has completed before its module is unloaded.
* This can be accomplished by queuing a do-nothing blocking task.
*/
RelayResult(CARB_ABI* runRelayTask)(RelayTaskDesc& desc);
};
} // namespace thread
} // namespace carb
| 10,109 | C | 51.113402 | 98 | 0.69354 |
omniverse-code/kit/include/carb/thread/ThreadLocal.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite dynamic thread-local storage implementation.
#pragma once
#include "../Defines.h"
#include <atomic>
#include <type_traits>
#if CARB_POSIX
# include <pthread.h>
#elif CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
# include "SharedMutex.h"
# include <map>
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
namespace carb
{
namespace thread
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
using TlsDestructor = void (*)(void*);
inline std::mutex& tlsMutex()
{
static std::mutex m;
return m;
}
# if CARB_POSIX
class ThreadLocalBase
{
pthread_key_t m_key;
public:
ThreadLocalBase(TlsDestructor destructor)
{
int res = pthread_key_create(&m_key, destructor);
CARB_FATAL_UNLESS(res == 0, "pthread_key_create failed: %d/%s", res, strerror(res));
}
~ThreadLocalBase()
{
pthread_key_delete(m_key);
}
// Not copyable or movable
CARB_PREVENT_COPY_AND_MOVE(ThreadLocalBase);
void* get() const
{
return pthread_getspecific(m_key);
}
void set(void* val) const
{
int res = pthread_setspecific(m_key, val);
CARB_CHECK(res == 0, "pthread_setspecific failed with %d/%s for key %u", res, strerror(res), m_key);
}
};
# elif CARB_PLATFORM_WINDOWS
__declspec(selectany) CARBWIN_SRWLOCK mutex = CARBWIN_SRWLOCK_INIT;
__declspec(selectany) bool destructed = false;
class CARB_VIZ ThreadLocalBase
{
CARB_VIZ DWORD m_key;
class Destructors
{
using DestructorMap = std::map<DWORD, TlsDestructor>;
DestructorMap m_map;
public:
Destructors() = default;
~Destructors()
{
AcquireSRWLockExclusive((PSRWLOCK)&mutex);
destructed = true;
// Destroy the map under the lock
DestructorMap{}.swap(m_map);
ReleaseSRWLockExclusive((PSRWLOCK)&mutex);
}
void add(DWORD slot, TlsDestructor fn)
{
// If there's no destructor, don't do anything
if (!fn)
return;
AcquireSRWLockExclusive((PSRWLOCK)&mutex);
m_map[slot] = fn;
ReleaseSRWLockExclusive((PSRWLOCK)&mutex);
}
void remove(DWORD slot)
{
AcquireSRWLockExclusive((PSRWLOCK)&mutex);
m_map.erase(slot);
ReleaseSRWLockExclusive((PSRWLOCK)&mutex);
}
void call()
{
AcquireSRWLockShared((PSRWLOCK)&mutex);
// It is possible for atexit destructors to run before other threads call destructors with thread-storage
// duration.
if (destructed)
{
ReleaseSRWLockShared((PSRWLOCK)&mutex);
return;
}
// This mimics the process of destructors with pthread_key_create which will iterate multiple (up to
// PTHREAD_DESTRUCTOR_ITERATIONS) times, which is typically 4.
bool again;
int iters = 0;
const int kMaxIters = 4;
do
{
again = false;
for (auto& pair : m_map)
{
if (void* val = ::TlsGetValue(pair.first))
{
// Set to nullptr and call destructor
::TlsSetValue(pair.first, nullptr);
pair.second(val);
again = true;
}
}
} while (again && ++iters < kMaxIters);
ReleaseSRWLockShared((PSRWLOCK)&mutex);
}
};
static Destructors& destructors()
{
static Destructors d;
return d;
}
public:
ThreadLocalBase(TlsDestructor destructor)
{
m_key = ::TlsAlloc();
CARB_FATAL_UNLESS(m_key != CARBWIN_TLS_OUT_OF_INDEXES, "TlsAlloc() failed: %" PRIu32 "", ::GetLastError());
destructors().add(m_key, destructor);
}
~ThreadLocalBase()
{
destructors().remove(m_key);
BOOL b = ::TlsFree(m_key);
CARB_CHECK(!!b);
}
// Not copyable or movable
CARB_PREVENT_COPY_AND_MOVE(ThreadLocalBase);
void* get() const
{
return ::TlsGetValue(m_key);
}
void set(void* val) const
{
BOOL b = ::TlsSetValue(m_key, val);
CARB_CHECK(!!b);
}
static void callDestructors(HINSTANCE, DWORD fdwReason, PVOID)
{
if (fdwReason == CARBWIN_DLL_THREAD_DETACH)
{
// Call for current thread
destructors().call();
}
}
};
extern "C"
{
// Hook the TLS destructors in the CRT
// see crt/src/vcruntime/tlsdtor.cpp
using TlsHookFunc = void(__stdcall*)(HINSTANCE, DWORD, PVOID);
// Reference these so that the linker knows to include them
extern DWORD _tls_used;
extern TlsHookFunc __xl_a[], __xl_z[];
# pragma comment(linker, "/include:pthread_thread_callback")
# pragma section(".CRT$XLD", long, read)
// Since this is a header file, the __declspec(selectany) enables weak linking so that the linker will throw away
// all the duplicates and leave only one instance of pthread_thread_callback in the binary.
// This is placed into the specific binary section used for TLS destructors
__declspec(allocate(".CRT$XLD")) __declspec(selectany)
TlsHookFunc pthread_thread_callback = carb::thread::detail::ThreadLocalBase::callDestructors;
}
# else
CARB_UNSUPPORTED_PLATFORM();
# endif
} // namespace detail
#endif
/**
* Base template. See specializations for documentation.
*/
template <class T,
bool Trivial = std::is_trivial<T>::value&& std::is_trivially_destructible<T>::value && (sizeof(T) <= sizeof(void*))>
class ThreadLocal
{
};
// Specializations
// Trivial and can fit within a pointer
/**
* A class for declaring a dynamic thread-local variable (Trivial/Pointer/POD specialization).
*
* This is necessary since C++11 the `thread_local` storage class specifier can only be used at namespace scope. There
* is no way to declare a `thread_local` variable at class scope unless it is static. ThreadLocal is dynamic.
*
* @note Most systems have a limit to the number of thread-local variables available. Each instance of ThreadLocal will
* consume some of that storage. Therefore, if a class contains a non-static ThreadLocal member, each instance of that
* class will consume another slot. Use sparingly.
*
* There are two specializations for ThreadLocal: a trivial version and a non-trivial version. The trivial version is
* designed for types like plain-old-data that are pointer-sized or less. The non-trivial version supports classes and
* large types. The heap is used for non-trivial ThreadLocal types, however these are lazy-initialize, so the per-thread
* memory is only allocated when used for the first time. The type is automatically destructed (and the memory returned
* to the heap) when a thread exits.
*
* On Windows, this class is implemented using [Thread Local Storage
* APIs](https://docs.microsoft.com/en-us/windows/win32/procthread/thread-local-storage). On Linux, this class is
* implemented using [pthread_key_t](https://linux.die.net/man/3/pthread_key_create).
*/
template <class T>
class ThreadLocal<T, true> : private detail::ThreadLocalBase
{
struct Union
{
union
{
T t;
void* p;
};
Union(void* p_) : p(p_)
{
}
Union(std::nullptr_t, T t_) : t(t_)
{
}
};
public:
/**
* Constructor. Allocates a thread-local storage slot from the operating system.
*/
ThreadLocal() : ThreadLocalBase(nullptr)
{
}
/**
* Destructor. Returns the previously allocated thread-local storage slot to the operating system.
*/
~ThreadLocal() = default;
/**
* Returns the specific value of this ThreadLocal variable for this thread.
*
* @note If the calling thread has not yet set() a value for this thread-local storage, the value returned will be
* default-initialized. For POD types this will be initialized to zeros.
*
* @returns A value previously set for the calling thread by set(), or a zero-initialized value if set() has not
* been called by the calling thread.
*/
T get() const
{
Union u(ThreadLocalBase::get());
return u.t;
}
/**
* Sets the specific value of this ThreadLocal variable for this thread.
* @param t The specific value to set for this thread.
*/
void set(T t)
{
Union u(nullptr, t);
ThreadLocalBase::set(u.p);
}
/**
* Alias for get().
* @returns The value as if by get().
*/
operator T()
{
return get();
}
/**
* Alias for get().
* @returns The value as if by get().
*/
operator T() const
{
return get();
}
/**
* Assignment operator and alias for set().
* @returns `*this`
*/
ThreadLocal& operator=(T t)
{
set(t);
return *this;
}
/**
* For types where `T` is a pointer, allows dereferencing the thread-local value.
* @returns The value as if by get().
*/
T operator->() const
{
static_assert(std::is_pointer<T>::value, "Requires pointer type");
return get();
}
/**
* For types where `T` is a pointer, allows dereferencing the thread-local value.
* @returns The value as if by set().
*/
auto operator*() const
{
static_assert(std::is_pointer<T>::value, "Requires pointer type");
return *get();
}
/**
* Tests the thread-local value for equality with @p rhs.
*
* @param rhs The parameter to compare against.
* @returns `true` if the value stored for the calling thread (as if by get()) matches @p rhs; `false` otherwise.
*/
bool operator==(const T& rhs) const
{
return get() == rhs;
}
/**
* Tests the thread-local value for inequality with @p rhs.
*
* @param rhs The compare to compare against.
* @returns `true` if the value stored for the calling thread (as if by get()) does not match @p rhs; `false`
* otherwise.
*/
bool operator!=(const T& rhs) const
{
return get() != rhs;
}
};
// Non-trivial or needs more than a pointer (uses the heap)
/**
* A class for declaring a dynamic thread-local variable (Large/Non-trivial specialization).
*
* This is necessary since C++11 the `thread_local` storage class specifier can only be used at namespace scope. There
* is no way to declare a `thread_local` variable at class scope unless it is static. ThreadLocal is dynamic.
*
* @note Most systems have a limit to the number of thread-local variables available. Each instance of ThreadLocal will
* consume some of that storage. Therefore, if a class contains a non-static ThreadLocal member, each instance of that
* class will consume another slot. Use sparingly.
*
* There are two specializations for ThreadLocal: a trivial version and a non-trivial version. The trivial version is
* designed for types like plain-old-data that are pointer-sized or less. The non-trivial version supports classes and
* large types. The heap is used for non-trivial ThreadLocal types, however these are lazy-initialize, so the per-thread
* memory is only allocated when used for the first time. The type is automatically destructed (and the memory returned
* to the heap) when a thread exits.
*
* On Windows, this class is implemented using [Thread Local Storage
* APIs](https://docs.microsoft.com/en-us/windows/win32/procthread/thread-local-storage). On Linux, this class is
* implemented using [pthread_key_t](https://linux.die.net/man/3/pthread_key_create).
*/
template <class T>
class ThreadLocal<T, false> : private detail::ThreadLocalBase
{
public:
/**
* Constructor. Allocates a thread-local storage slot from the operating system.
*/
ThreadLocal() : ThreadLocalBase(destructor), m_head(&m_head)
{
detail::tlsMutex(); // make sure this is constructed since we'll need it at shutdown
}
/**
* Destructor. Returns the previously allocated thread-local storage slot to the operating system.
*/
~ThreadLocal()
{
// Delete all instances for threads created by this object
ListNode n = m_head;
m_head.next = m_head.prev = _end();
while (n.next != _end())
{
Wrapper* w = reinterpret_cast<Wrapper*>(n.next);
n.next = n.next->next;
delete w;
}
// It would be very bad if a thread was using this while we're destroying it
CARB_ASSERT(m_head.next == _end() && m_head.prev == _end());
}
/**
* Returns the value of this ThreadLocal variable for this specific thread, if it has been constructed.
* \details If the calling thread has not called \ref get() or \ref set(const T&) on `*this` yet, calling this
* function will return `nullptr`. \note This function is only available for the non-trivial specialization of
* `ThreadLocal`.
* @returns `nullptr` if \ref set(const T&) or \ref get() has not been called by this thread on `*this` yet;
* otherwise returns `std::addressof(get())`.
*/
T* get_if()
{
return _get_if();
}
//! @copydoc get_if()
const T* get_if() const
{
return _get_if();
}
/**
* Returns the specific value of this ThreadLocal variable for this thread.
*
* @note If the calling thread has not yet set() a value for this thread-local storage, the value returned will be
* default-constructed.
*
* @returns A value previously set for the calling thread by set(), or a default-constructed value if set() has not
* been called by the calling thread.
*/
T& get()
{
return *_get();
}
/**
* Returns the specific value of this ThreadLocal variable for this thread.
*
* @note If the calling thread has not yet set() a value for this thread-local storage, the value returned will be
* default-constructed.
*
* @returns A value previously set for the calling thread by set(), or a default-constructed value if set() has not
* been called by the calling thread.
*/
const T& get() const
{
return *_get();
}
/**
* Sets the specific value of this ThreadLocal variable for this thread.
*
* @note If this is the first time set() has been called for this thread, the stored value is first default-
* constructed and then @p t is copy-assigned to the thread-local value.
* @param t The specific value to set for this thread.
*/
void set(const T& t)
{
*_get() = t;
}
/**
* Sets the specific value of this ThreadLocal variable for this thread.
*
* @note If this is the first time set() has been called for this thread, the stored value is first default-
* constructed and then @p t is move-assigned to the thread-local value.
* @param t The specific value to set for this thread.
*/
void set(T&& t)
{
*_get() = std::move(t);
}
/**
* Clears the specific value of this ThreadLocal variable for this thread.
*
* @note This function is only available on the non-trivial specialization of `ThreadLocal`.
* Postcondition: \ref get_if() returns `nullptr`.
*/
void reset()
{
if (auto p = get_if())
{
destructor(p);
ThreadLocalBase::set(nullptr);
}
}
/**
* Alias for get().
* @returns The value as if by get().
*/
operator T()
{
return get();
}
/**
* Alias for get().
* @returns The value as if by get().
*/
operator T() const
{
return get();
}
/**
* Assignment operator and alias for set().
* @returns `*this`
*/
ThreadLocal& operator=(const T& rhs)
{
set(rhs);
return *this;
}
/**
* Assignment operator and alias for set().
* @returns `*this`
*/
ThreadLocal& operator=(T&& rhs)
{
set(std::move(rhs));
return *this;
}
/**
* Pass-through support for operator->.
* @returns the value of operator->.
*/
auto operator->()
{
return get().operator->();
}
/**
* Pass-through support for operator->.
* @returns the value of operator->.
*/
auto operator->() const
{
return get().operator->();
}
/**
* Pass-through support for operator*.
* @returns the value of operator*.
*/
auto operator*()
{
return get().operator*();
}
/**
* Pass-through support for operator*.
* @returns the value of operator*.
*/
auto operator*() const
{
return get().operator*();
}
/**
* Pass-through support for operator[].
* @param u The value to pass to operator[].
* @returns the value of operator[].
*/
template <class U>
auto operator[](const U& u) const
{
return get().operator[](u);
}
/**
* Tests the thread-local value for equality with @p rhs.
*
* @param rhs The parameter to compare against.
* @returns `true` if the value stored for the calling thread (as if by get()) matches @p rhs; `false` otherwise.
*/
bool operator==(const T& rhs) const
{
return get() == rhs;
}
/**
* Tests the thread-local value for inequality with @p rhs.
*
* @param rhs The compare to compare against.
* @returns `true` if the value stored for the calling thread (as if by get()) does not match @p rhs; `false`
* otherwise.
*/
bool operator!=(const T& rhs) const
{
return get() != rhs;
}
private:
struct ListNode
{
ListNode* next;
ListNode* prev;
ListNode() = default;
ListNode(ListNode* init) : next(init), prev(init)
{
}
};
struct Wrapper : public ListNode
{
T t;
};
ListNode m_head;
ListNode* _tail() const
{
return const_cast<ListNode*>(m_head.prev);
}
ListNode* _end() const
{
return const_cast<ListNode*>(&m_head);
}
static void destructor(void* p)
{
// Can't use offsetof because of "offsetof within non-standard-layout type 'Wrapper' is undefined"
Wrapper* w = reinterpret_cast<Wrapper*>(reinterpret_cast<uint8_t*>(p) - size_t(&((Wrapper*)0)->t));
{
// Remove from the list
std::lock_guard<std::mutex> g(detail::tlsMutex());
w->next->prev = w->prev;
w->prev->next = w->next;
}
delete w;
}
T* _get_if() const
{
T* p = reinterpret_cast<T*>(ThreadLocalBase::get());
return p;
}
T* _get() const
{
T* p = _get_if();
return p ? p : _create();
}
T* _create() const
{
Wrapper* w = new Wrapper;
// Add to end of list
{
std::lock_guard<std::mutex> g(detail::tlsMutex());
w->next = _end();
w->prev = _tail();
w->next->prev = w;
w->prev->next = w;
}
T* p = std::addressof(w->t);
ThreadLocalBase::set(p);
return p;
}
};
} // namespace thread
} // namespace carb
| 20,022 | C | 28.018841 | 126 | 0.597693 |
omniverse-code/kit/include/carb/thread/SharedMutex.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief C++17-compatible Shared Mutex implementation for C++14 or higher.
#pragma once
#include "../Defines.h"
#include <mutex>
#include <shared_mutex>
#if CARB_ASSERT_ENABLED
# include <algorithm>
# include <thread>
# include <vector>
#endif
#if CARB_COMPILER_GNUC && (CARB_TEGRA || CARB_PLATFORM_LINUX)
# include <pthread.h>
#endif
#if CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
#endif
namespace carb
{
namespace thread
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
# if CARB_PLATFORM_WINDOWS
class SharedMutexBase
{
protected:
constexpr SharedMutexBase() noexcept = default;
~SharedMutexBase()
{
// NOTE: This assert can happen after main() has exited, since ExitProcess() kills all threads before running
// any destructors. In this case, a thread could have the shared_mutex locked and be terminated, abandoning the
// shared_mutex but leaving it in a busy state. This is not ideal. There is no easy way to determine if
// ExitProcess() has been called and the program is in this state. Therefore, if this assert happens after
// ExitProcess() has been called, ignore this assert.
CARB_ASSERT(!m_lock.Ptr); // Destroyed while busy
}
void lockExclusive()
{
AcquireSRWLockExclusive((PSRWLOCK)&m_lock);
}
bool tryLockExclusive()
{
return !!TryAcquireSRWLockExclusive((PSRWLOCK)&m_lock);
}
void unlockExclusive()
{
ReleaseSRWLockExclusive((PSRWLOCK)&m_lock);
}
void lockShared()
{
AcquireSRWLockShared((PSRWLOCK)&m_lock);
}
bool tryLockShared()
{
return !!TryAcquireSRWLockShared((PSRWLOCK)&m_lock);
}
void unlockShared()
{
ReleaseSRWLockShared((PSRWLOCK)&m_lock);
}
private:
CARBWIN_SRWLOCK m_lock = CARBWIN_SRWLOCK_INIT;
};
# else
class SharedMutexBase
{
protected:
constexpr SharedMutexBase() noexcept = default;
~SharedMutexBase()
{
int result = pthread_rwlock_destroy(&m_lock);
CARB_UNUSED(result);
CARB_ASSERT(result == 0); // Destroyed while busy
}
void lockExclusive()
{
int result = pthread_rwlock_wrlock(&m_lock);
CARB_CHECK(result == 0);
}
bool tryLockExclusive()
{
return pthread_rwlock_trywrlock(&m_lock) == 0;
}
void unlockExclusive()
{
int result = pthread_rwlock_unlock(&m_lock);
CARB_CHECK(result == 0);
}
void lockShared()
{
int result = pthread_rwlock_rdlock(&m_lock);
CARB_CHECK(result == 0);
}
bool tryLockShared()
{
return pthread_rwlock_tryrdlock(&m_lock) == 0;
}
void unlockShared()
{
int result = pthread_rwlock_unlock(&m_lock);
CARB_CHECK(result == 0);
}
private:
pthread_rwlock_t m_lock = PTHREAD_RWLOCK_INITIALIZER;
};
# endif
} // namespace detail
#endif
/**
* A shared mutex implementation conforming to C++17's
* [shared_mutex](https://en.cppreference.com/w/cpp/thread/shared_mutex).
*
* This implementation is non-recursive. See carb::thread::recursive_shared_mutex if a recursive shared_mutex is
* desired.
*
* @note The underlying implementations are based on [Slim Reader/Writer (SRW)
* Locks](https://docs.microsoft.com/en-us/windows/win32/sync/slim-reader-writer--srw--locks) for Windows, and [POSIX
* read/write lock objects](https://linux.die.net/man/3/pthread_rwlock_init) on Linux.
*/
class shared_mutex : private detail::SharedMutexBase
{
public:
/**
* Constructor.
*/
#if !CARB_ASSERT_ENABLED
constexpr
#endif
shared_mutex() = default;
/**
* Destructor.
*
* Debug builds assert that the mutex is not busy (locked) when destroyed.
*/
~shared_mutex() = default;
CARB_PREVENT_COPY(shared_mutex);
/**
* Blocks until an exclusive lock can be obtained.
*
* When this function returns, the calling thread exclusively owns the mutex. At some later point the calling thread
* will need to call unlock() to release the exclusive lock.
*
* @warning Debug builds will assert that the calling thread does not already own the lock.
*/
void lock();
/**
* Attempts to immediately take an exclusive lock, but will not block if one cannot be obtained.
*
* @warning Debug builds will assert that the calling thread does not already own the lock.
* @returns `true` if an exclusive lock could be obtained, and at some later point unlock() will need to be called
* to release the lock. If an exclusive lock could not be obtained immediately, `false` is returned.
*/
bool try_lock();
/**
* Releases an exclusive lock held by the calling thread.
*
* @warning Debug builds will assert that the calling thread owns the lock exclusively.
*/
void unlock();
/**
* Blocks until a shared lock can be obtained.
*
* When this function returns, the calling thread has obtained a shared lock on the resources protected by the
* mutex. At some later point the calling thread must call unlock_shared() to release the shared lock.
*
* @warning Debug builds will assert that the calling thread does not already own the lock.
*/
void lock_shared();
/**
* Attempts to immediately take a shared lock, but will not block if one cannot be obtained.
*
* @warning Debug builds will assert that the calling thread does not already own the lock.
* @returns `true` if a shared lock could be obtained, and at some later point unlock_shared() will need to be
* called to release the lock. If a shared lock could not be obtained immediately, `false` is returned.
*/
bool try_lock_shared();
/**
* Releases a shared lock held by the calling thread.
*
* @warning Debug builds will assert that the calling thread owns a shared lock.
*/
void unlock_shared();
private:
using Base = detail::SharedMutexBase;
#if CARB_ASSERT_ENABLED
using LockGuard = std::lock_guard<std::mutex>;
mutable std::mutex m_ownerLock;
std::vector<std::thread::id> m_owners;
void addThread()
{
LockGuard g(m_ownerLock);
m_owners.push_back(std::this_thread::get_id());
}
void removeThread()
{
LockGuard g(m_ownerLock);
auto current = std::this_thread::get_id();
auto iter = std::find(m_owners.begin(), m_owners.end(), current);
if (iter != m_owners.end())
{
*iter = m_owners.back();
m_owners.pop_back();
return;
}
// Thread not found
CARB_ASSERT(false);
}
void assertNotLockedByMe() const
{
LockGuard g(m_ownerLock);
CARB_ASSERT(std::find(m_owners.begin(), m_owners.end(), std::this_thread::get_id()) == m_owners.end());
}
#else
inline void addThread()
{
}
inline void removeThread()
{
}
inline void assertNotLockedByMe() const
{
}
#endif
};
inline void shared_mutex::lock()
{
assertNotLockedByMe();
Base::lockExclusive();
addThread();
}
inline bool shared_mutex::try_lock()
{
assertNotLockedByMe();
return Base::tryLockExclusive() ? (addThread(), true) : false;
}
inline void shared_mutex::unlock()
{
removeThread();
Base::unlockExclusive();
}
inline void shared_mutex::lock_shared()
{
assertNotLockedByMe();
Base::lockShared();
addThread();
}
inline bool shared_mutex::try_lock_shared()
{
assertNotLockedByMe();
return Base::tryLockShared() ? (addThread(), true) : false;
}
inline void shared_mutex::unlock_shared()
{
removeThread();
Base::unlockShared();
}
/**
* Alias for `std::shared_lock`.
*/
template <class Mutex>
using shared_lock = ::std::shared_lock<Mutex>;
} // namespace thread
} // namespace carb
| 8,345 | C | 26.27451 | 120 | 0.649371 |
omniverse-code/kit/include/carb/thread/Mutex.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite mutex and recursive_mutex implementation.
#pragma once
#include "Futex.h"
#include "Util.h"
#include "../cpp/Atomic.h"
#include <system_error>
#if CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
#endif
namespace carb
{
namespace thread
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
# if CARB_PLATFORM_WINDOWS
template <bool Recursive>
class BaseMutex
{
public:
constexpr static bool kRecursive = Recursive;
CARB_PREVENT_COPY_AND_MOVE(BaseMutex);
constexpr BaseMutex() noexcept = default;
~BaseMutex()
{
CARB_FATAL_UNLESS(m_count == 0, "Mutex destroyed while busy");
}
void lock()
{
uint32_t const tid = this_thread::getId();
if (!Recursive)
{
CARB_FATAL_UNLESS(tid != m_owner, "Recursion not allowed");
}
else if (tid == m_owner)
{
++m_count;
return;
}
AcquireSRWLockExclusive((PSRWLOCK)&m_lock);
m_owner = tid;
m_count = 1;
}
bool try_lock()
{
uint32_t const tid = this_thread::getId();
if (!Recursive)
{
CARB_FATAL_UNLESS(tid != m_owner, "Recursion not allowed");
}
else if (tid == m_owner)
{
++m_count;
return true;
}
if (CARB_LIKELY(TryAcquireSRWLockExclusive((PSRWLOCK)&m_lock)))
{
m_owner = tid;
m_count = 1;
return true;
}
return false;
}
void unlock()
{
uint32_t tid = this_thread::getId();
CARB_FATAL_UNLESS(m_owner == tid, "Not owner");
if (--m_count == 0)
{
m_owner = kInvalidOwner;
ReleaseSRWLockExclusive((PSRWLOCK)&m_lock);
}
}
bool is_current_thread_owner() const noexcept
{
// We don't need this to be an atomic op because one of the following must be true during this call:
// - m_owner is equal to this_thread::getId() and cannot change
// - m_owner is not equal and cannot become equal to this_thread::getId()
return m_owner == this_thread::getId();
}
private:
constexpr static uint32_t kInvalidOwner = uint32_t(0);
CARBWIN_SRWLOCK m_lock{ CARBWIN_SRWLOCK_INIT };
uint32_t m_owner{ kInvalidOwner };
int m_count{ 0 };
};
# else
template <bool Recursive>
class BaseMutex;
// BaseMutex (non-recursive)
template <>
class BaseMutex<false>
{
public:
constexpr static bool kRecursive = false;
constexpr BaseMutex() noexcept = default;
~BaseMutex()
{
CARB_FATAL_UNLESS(m_lock.load(std::memory_order_relaxed) == Unlocked, "Mutex destroyed while busy");
}
void lock()
{
// Blindly attempt to lock
LockState val = Unlocked;
if (CARB_UNLIKELY(
!m_lock.compare_exchange_strong(val, Locked, std::memory_order_acquire, std::memory_order_relaxed)))
{
CARB_FATAL_UNLESS(m_owner != this_thread::getId(), "Recursive locking not allowed");
// Failed to lock and need to wait
if (val == LockedMaybeWaiting)
{
m_lock.wait(LockedMaybeWaiting, std::memory_order_relaxed);
}
while (m_lock.exchange(LockedMaybeWaiting, std::memory_order_acquire) != Unlocked)
{
m_lock.wait(LockedMaybeWaiting, std::memory_order_relaxed);
}
CARB_ASSERT(m_owner == kInvalidOwner);
}
// Now inside the lock
m_owner = this_thread::getId();
}
bool try_lock()
{
// Blindly attempt to lock
LockState val = Unlocked;
if (CARB_LIKELY(m_lock.compare_exchange_strong(val, Locked, std::memory_order_acquire, std::memory_order_relaxed)))
{
m_owner = this_thread::getId();
return true;
}
CARB_FATAL_UNLESS(m_owner != this_thread::getId(), "Recursive locking not allowed");
return false;
}
void unlock()
{
CARB_FATAL_UNLESS(is_current_thread_owner(), "Not owner");
m_owner = kInvalidOwner;
LockState val = m_lock.exchange(Unlocked, std::memory_order_release);
if (val == LockedMaybeWaiting)
{
m_lock.notify_one();
}
}
bool is_current_thread_owner() const noexcept
{
// We don't need this to be an atomic op because one of the following must be true during this call:
// - m_owner is equal to this_thread::getId() and cannot change
// - m_owner is not equal and cannot become equal to this_thread::getId()
return m_owner == this_thread::getId();
}
private:
enum LockState : uint8_t
{
Unlocked = 0,
Locked = 1,
LockedMaybeWaiting = 2,
};
constexpr static uint32_t kInvalidOwner = 0;
cpp::atomic<LockState> m_lock{ Unlocked };
uint32_t m_owner{ kInvalidOwner };
};
// BaseMutex (recursive)
template <>
class BaseMutex<true>
{
public:
constexpr static bool kRecursive = true;
constexpr BaseMutex() noexcept = default;
~BaseMutex()
{
CARB_FATAL_UNLESS(m_lock.load(std::memory_order_relaxed) == 0, "Mutex destroyed while busy");
}
void lock()
{
// Blindly attempt to lock
uint32_t val = Unlocked;
if (CARB_UNLIKELY(
!m_lock.compare_exchange_strong(val, Locked, std::memory_order_acquire, std::memory_order_relaxed)))
{
// Failed to lock (or recursive)
if (m_owner == this_thread::getId())
{
val = m_lock.fetch_add(DepthUnit, std::memory_order_relaxed);
CARB_FATAL_UNLESS((val & DepthMask) != DepthMask, "Recursion overflow");
return;
}
// Failed to lock and need to wait
if ((val & ~DepthMask) == LockedMaybeWaiting)
{
m_lock.wait(val, std::memory_order_relaxed);
}
for (;;)
{
// Atomically set to LockedMaybeWaiting in a loop since the owning thread could be changing the depth
while (!m_lock.compare_exchange_weak(
val, (val & DepthMask) | LockedMaybeWaiting, std::memory_order_acquire, std::memory_order_relaxed))
CARB_HARDWARE_PAUSE();
if ((val & ~DepthMask) == Unlocked)
break;
m_lock.wait((val & DepthMask) | LockedMaybeWaiting, std::memory_order_relaxed);
}
CARB_ASSERT(m_owner == kInvalidOwner);
}
// Now inside the lock
m_owner = this_thread::getId();
}
bool try_lock()
{
// Blindly attempt to lock
uint32_t val = Unlocked;
if (CARB_LIKELY(m_lock.compare_exchange_strong(val, Locked, std::memory_order_acquire, std::memory_order_relaxed)))
{
// Succeeded, we now own the lock
m_owner = this_thread::getId();
return true;
}
// Failed (or recursive)
if (m_owner == this_thread::getId())
{
// Recursive, increment the depth
val = m_lock.fetch_add(DepthUnit, std::memory_order_acquire);
CARB_FATAL_UNLESS((val & DepthMask) != DepthMask, "Recursion overflow");
return true;
}
return false;
}
void unlock()
{
CARB_FATAL_UNLESS(is_current_thread_owner(), "Not owner");
uint32_t val = m_lock.load(std::memory_order_relaxed);
if (!(val & DepthMask))
{
// Depth count is at zero, so this is the last unlock().
m_owner = kInvalidOwner;
uint32_t val = m_lock.exchange(Unlocked, std::memory_order_release);
if (val == LockedMaybeWaiting)
{
m_lock.notify_one();
}
}
else
m_lock.fetch_sub(DepthUnit, std::memory_order_release);
}
bool is_current_thread_owner() const noexcept
{
// We don't need this to be an atomic op because one of the following must be true during this call:
// - m_owner is equal to this_thread::getId() and cannot change
// - m_owner is not equal and cannot become equal to this_thread::getId()
return m_owner == this_thread::getId();
}
private:
enum LockState : uint32_t
{
Unlocked = 0,
Locked = 1,
LockedMaybeWaiting = 2,
DepthUnit = 1 << 2, // Each recursion count increment
DepthMask = 0xFFFFFFFC // The 30 MSBs are used for the recursion count
};
constexpr static uint32_t kInvalidOwner = 0;
cpp::atomic_uint32_t m_lock{ Unlocked };
uint32_t m_owner{ kInvalidOwner };
};
# endif
} // namespace detail
#endif
/**
* A Carbonite implementation of [std::mutex](https://en.cppreference.com/w/cpp/thread/mutex).
*
* @note Windows: `std::mutex` uses `SRWLOCK` for Win 7+, `CONDITION_VARIABLE` for Vista and the massive
* `CRITICAL_SECTION` for pre-Vista. Due to this, the `std::mutex` class is about 80 bytes. Since Carbonite supports
* Windows 10 and later, `SRWLOCK` is used exclusively. This implementation is 16 bytes. This version that uses
* `SRWLOCK` is significantly faster on Windows than the portable implementation used for the linux version.
*
* @note Linux: `sizeof(std::mutex)` is 40 bytes on GLIBC 2.27, which is based on the size of `pthread_mutex_t`. The
* Carbonite implementation of mutex is 8 bytes and at least as performant as `std::mutex` in the contended case.
*/
class mutex : public detail::BaseMutex<false>
{
using Base = detail::BaseMutex<false>;
public:
/**
* Constructor.
*
* @note Unlike `std::mutex`, this implementation can be declared `constexpr`.
*/
constexpr mutex() noexcept = default;
/**
* Destructor.
* @warning `std::terminate()` is called if mutex is locked by a thread.
*/
~mutex() = default;
/**
* Locks the mutex, blocking until it becomes available.
* @warning `std::terminate()` is called if the calling thread already has the mutex locked. Use recursive_mutex if
* recursive locking is desired.
* The calling thread must call unlock() at a later time to release the lock.
*/
void lock()
{
Base::lock();
}
/**
* Attempts to immediately lock the mutex.
* @warning `std::terminate()` is called if the calling thread already has the mutex locked. Use recursive_mutex if
* recursive locking is desired.
* @returns `true` if the mutex was available and the lock was taken by the calling thread (unlock() must be called
* from the calling thread at a later time to release the lock); `false` if the mutex could not be locked by the
* calling thread.
*/
bool try_lock()
{
return Base::try_lock();
}
/**
* Unlocks the mutex.
* @warning `std::terminate()` is called if the calling thread does not own the mutex.
*/
void unlock()
{
Base::unlock();
}
/**
* Checks if the current thread owns the mutex.
* @note This is a non-standard Carbonite extension.
* @returns `true` if the current thread owns the mutex; `false` otherwise.
*/
bool is_current_thread_owner() const noexcept
{
return Base::is_current_thread_owner();
}
};
/**
* A Carbonite implementation of [std::recursive_mutex](https://en.cppreference.com/w/cpp/thread/recursive_mutex).
*
* @note Windows: `std::recursive_mutex` uses `SRWLOCK` for Win 7+, `CONDITION_VARIABLE` for Vista and the massive
* `CRITICAL_SECTION` for pre-Vista. Due to this, the `std::recursive_mutex` class is about 80 bytes. Since Carbonite
* supports Windows 10 and later, `SRWLOCK` is used exclusively. This implementation is 16 bytes. This version that uses
* `SRWLOCK` is significantly faster on Windows than the portable implementation used for the linux version.
*
* @note Linux: `sizeof(std::recursive_mutex)` is 40 bytes on GLIBC 2.27, which is based on the size of
* `pthread_mutex_t`. The Carbonite implementation of mutex is 8 bytes and at least as performant as
* `std::recursive_mutex` in the contended case.
*/
class recursive_mutex : public detail::BaseMutex<true>
{
using Base = detail::BaseMutex<true>;
public:
/**
* Constructor.
*
* @note Unlike `std::recursive_mutex`, this implementation can be declared `constexpr`.
*/
constexpr recursive_mutex() noexcept = default;
/**
* Destructor.
* @warning `std::terminate()` is called if recursive_mutex is locked by a thread.
*/
~recursive_mutex() = default;
/**
* Locks the recursive_mutex, blocking until it becomes available.
*
* The calling thread must call unlock() at a later time to release the lock. There must be symmetrical calls to
* unlock() for each call to lock() or successful call to try_lock().
*/
void lock()
{
Base::lock();
}
/**
* Attempts to immediately lock the recursive_mutex.
* @returns `true` if the recursive_mutex was available and the lock was taken by the calling thread (unlock() must
* be called from the calling thread at a later time to release the lock); `false` if the recursive_mutex could not
* be locked by the calling thread. If the lock was already held by the calling thread, `true` is always returned.
*/
bool try_lock()
{
return Base::try_lock();
}
/**
* Unlocks the recursive_mutex.
* @warning `std::terminate()` is called if the calling thread does not own the recursive_mutex.
*/
void unlock()
{
Base::unlock();
}
/**
* Checks if the current thread owns the mutex.
* @note This is a non-standard Carbonite extension.
* @returns `true` if the current thread owns the mutex; `false` otherwise.
*/
bool is_current_thread_owner() const noexcept
{
return Base::is_current_thread_owner();
}
};
} // namespace thread
} // namespace carb
| 14,595 | C | 30.456896 | 123 | 0.604591 |
omniverse-code/kit/include/carb/thread/Spinlock.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite Spinlock implementation.
#pragma once
#include "../Defines.h"
#include <atomic>
#include <thread>
namespace carb
{
namespace thread
{
/** Namespace for Carbonite private threading details. */
namespace detail
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
class RecursionPolicyDisallow
{
public:
constexpr RecursionPolicyDisallow() = default;
bool ownsLock() const
{
return std::this_thread::get_id() == m_owner;
}
void enter()
{
auto cur = std::this_thread::get_id();
CARB_FATAL_UNLESS(cur != m_owner, "Recursion is not allowed");
m_owner = cur;
}
bool tryLeave()
{
CARB_FATAL_UNLESS(ownsLock(), "Not owning thread");
m_owner = std::thread::id(); // clear the owner
return true;
}
private:
std::thread::id m_owner{};
};
class RecursionPolicyAllow
{
public:
constexpr RecursionPolicyAllow() = default;
bool ownsLock() const
{
return std::this_thread::get_id() == m_owner;
}
void enter()
{
auto cur = std::this_thread::get_id();
if (cur == m_owner)
++m_recursion;
else
{
CARB_ASSERT(m_owner == std::thread::id()); // owner should be clear
m_owner = cur;
m_recursion = 1;
}
}
bool tryLeave()
{
CARB_FATAL_UNLESS(ownsLock(), "Not owning thread");
if (--m_recursion == 0)
{
m_owner = std::thread::id(); // clear the owner
return true;
}
return false;
}
private:
std::thread::id m_owner{};
size_t m_recursion{ 0 };
};
#endif
/**
* Spinlock and RecursiveSpinlock are locking primitives that never enter the kernel to wait.
*
* @note Do not use SpinlockImpl directly; instead use Spinlock or RecursiveSpinlock.
*
* This class meets Cpp17BasicLockable and Cpp17Lockable named requirements.
*
* @warning Using Spinlock is generally discouraged and can lead to worse performance than using carb::thread::mutex or
* another synchronization primitive that can wait.
*/
template <class RecursionPolicy>
class SpinlockImpl
{
public:
/**
* Constructor.
*/
constexpr SpinlockImpl() = default;
/**
* Destructor.
*/
~SpinlockImpl() = default;
CARB_PREVENT_COPY(SpinlockImpl);
/**
* Locks the spinlock, spinning the current thread until it becomes available.
* If not called from RecursiveSpinlock and the calling thread already owns the lock, `std::terminate()` is called.
* The calling thread must call unlock() at a later time to release the lock.
*/
void lock()
{
if (!m_rp.ownsLock())
{
// Spin trying to set the lock bit
while (CARB_UNLIKELY(!!m_lock.fetch_or(1, std::memory_order_acquire)))
{
CARB_HARDWARE_PAUSE();
}
}
m_rp.enter();
}
/**
* Unlocks the spinlock.
* @warning `std::terminate()` is called if the calling thread does not own the spinlock.
*/
void unlock()
{
if (m_rp.tryLeave())
{
// Released the lock
m_lock.store(0, std::memory_order_release);
}
}
/**
* Attempts to immediately lock the spinlock.
* If not called from RecursiveSpinlock and the calling thread already owns the lock, `std::terminate()` is called.
* @returns `true` if the spinlock was available and the lock was taken by the calling thread (unlock() must be
* called from the calling thread at a later time to release the lock); `false` if the spinlock could not be locked
* by the calling thread.
*/
bool try_lock()
{
if (!m_rp.ownsLock())
{
// See if we can set the lock bit
if (CARB_UNLIKELY(!!m_lock.fetch_or(1, std::memory_order_acquire)))
{
// Failed!
return false;
}
}
m_rp.enter();
return true;
}
/**
* Returns true if the calling thread owns this spinlock.
* @returns `true` if the calling thread owns this spinlock; `false` otherwise.
*/
bool isLockedByThisThread() const
{
return m_rp.ownsLock();
}
private:
std::atomic<size_t> m_lock{ 0 };
RecursionPolicy m_rp;
};
} // namespace detail
/**
* A spinlock implementation that allows recursion.
*/
using RecursiveSpinlock = detail::SpinlockImpl<detail::RecursionPolicyAllow>;
/**
* A spinlock implementation that does not allow recursion.
* @warning Attempts to use this class in a recursive manner will call `std::terminate()`.
*/
using Spinlock = detail::SpinlockImpl<detail::RecursionPolicyDisallow>;
} // namespace thread
} // namespace carb
| 5,246 | C | 24.847291 | 119 | 0.613992 |
omniverse-code/kit/include/carb/thread/IpcLock.h | // Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Defines.h"
#if CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
#elif CARB_POSIX
# include <sys/stat.h>
# include <errno.h>
# include <fcntl.h>
# include <semaphore.h>
# include <string.h>
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
namespace carb
{
namespace thread
{
/** defines an implementation of an intra-process lock. This lock will only be functional within
* the threads of the process that creates it. The lock implementation will always be recursive.
* When a lock with the given name is created, it will initially be unlocked.
*/
#if CARB_PLATFORM_WINDOWS
/** defines an implementation of an inter-process lock. These locks are given a unique name
* to allow other processes to open a lock of the same name. The name may be any ASCII string
* that does not contain the slash character ('/'). The name may be limited to an implementation
* defined length. Lock names should be less than 250 characters in general. The name of the
* lock will be removed from the system when all processes that use that name destroy their
* objects. When a lock with the given name is created, it will initially be unlocked.
*/
class IpcLock
{
public:
IpcLock(const char* name)
{
m_mutex = CreateMutexA(nullptr, CARBWIN_FALSE, name);
CARB_FATAL_UNLESS(m_mutex != nullptr, "CreateMutex() failed: %u", ::GetLastError());
}
~IpcLock()
{
CloseHandle(m_mutex);
}
void lock()
{
WaitForSingleObject(m_mutex, CARBWIN_INFINITE);
}
void unlock()
{
ReleaseMutex(m_mutex);
}
bool try_lock()
{
return WaitForSingleObject(m_mutex, 0) == CARBWIN_WAIT_OBJECT_0;
}
private:
HANDLE m_mutex;
};
#elif CARB_POSIX
/** defines an implementation of an inter-process lock. These locks are given a unique name
* to allow other processes to open a lock of the same name. The name may be any string that
* does not contain the slash character ('/'). The name may be limited to an implementation
* defined length. Lock names should be less than 250 characters in general. The name of the
* lock will be removed from the system when all processes that use that name destroy their
* objects. When a lock with the given name is created, it will initially be unlocked.
*/
class IpcLock
{
public:
IpcLock(const char* name)
{
// create the name for the semaphore and remove all slashes within it (slashes are not
// allowed after the first character and the first character must always be a slash).
snprintf(m_name, CARB_COUNTOF(m_name) - 4, "/%s", name);
for (size_t i = 1; m_name[i] != 0; i++)
{
if (m_name[i] == '/')
m_name[i] = '_';
}
// create the named semaphore.
m_semaphore = sem_open(m_name, O_CREAT | O_RDWR, 0644, 1);
CARB_ASSERT(m_semaphore != SEM_FAILED);
}
~IpcLock()
{
sem_close(m_semaphore);
sem_unlink(m_name);
}
void lock()
{
int ret;
// keep trying the wait operation as long as we get interrupted by a signal.
do
{
ret = sem_wait(m_semaphore);
// Oddly enough, on Windows Subsystem for Linux, sem_wait can fail with ETIMEDOUT. Handle that case here
} while (ret == -1 && (errno == EINTR || errno == ETIMEDOUT));
}
void unlock()
{
sem_post(m_semaphore);
}
bool try_lock()
{
// keep trying the wait operation as long as we get interrupted by a signal.
int ret = CARB_RETRY_EINTR(sem_trywait(m_semaphore));
// if the lock was acquired, the return value will always be zero. If if failed either
// due to a non-signal error or because it would block, 'ret' will be -1. If the call
// was valid but would block, 'errno' is set to EAGAIN.
return ret == 0;
}
private:
sem_t* m_semaphore;
char m_name[NAME_MAX + 10];
};
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
} // namespace thread
} // namespace carb
| 4,541 | C | 29.07947 | 116 | 0.652059 |
omniverse-code/kit/include/carb/thread/Util.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite thread utilities.
#pragma once
#include "../Defines.h"
#include "../extras/ScopeExit.h"
#include "../math/Util.h"
#include "../process/Util.h"
#include "../profiler/IProfiler.h"
#include "../../omni/extras/ContainerHelper.h"
#if CARB_PLATFORM_WINDOWS
# include "../CarbWindows.h"
# include "../extras/Unicode.h"
#elif CARB_POSIX
# include <sys/syscall.h>
# include <pthread.h>
# include <sched.h>
# include <unistd.h>
# include <time.h>
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
#if CARB_PLATFORM_MACOS
# pragma push_macro("min")
# pragma push_macro("max")
# undef min
# undef max
# include <mach/thread_policy.h>
# include <mach/thread_act.h>
# pragma pop_macro("max")
# pragma pop_macro("min")
#endif
#include <atomic>
#include <thread>
namespace carb
{
namespace thread
{
/** The type for a process ID. */
using ProcessId = process::ProcessId;
/** The type for a thread ID. */
using ThreadId = uint32_t;
/**
* Each entry in the vector is a bitmask for a set of CPUs.
*
* On Windows each entry corresponds to a Processor Group.
*
* On Linux the entries are contiguous, like cpu_set_t.
*/
using CpuMaskVector = std::vector<uint64_t>;
/** The number of CPUs represented by an individual cpu mask. */
constexpr uint64_t kCpusPerMask = std::numeric_limits<CpuMaskVector::value_type>::digits;
#if CARB_PLATFORM_WINDOWS
static_assert(sizeof(ThreadId) >= sizeof(DWORD), "ThreadId type is too small");
#elif CARB_POSIX
static_assert(sizeof(ThreadId) >= sizeof(pid_t), "ThreadId type is too small");
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
/** The printf format macro to print a thread ID. */
#define OMNI_PRItid PRIu32
/** The printf format macro to print a thread ID in hexadecimal. */
#define OMNI_PRIxtid PRIx32
#if CARB_PLATFORM_WINDOWS
# ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
const DWORD MS_VC_EXCEPTION = 0x406D1388;
# pragma pack(push, 8)
typedef struct tagTHREADNAME_INFO
{
DWORD dwType;
LPCSTR szName;
DWORD dwThreadID;
DWORD dwFlags;
} THREADNAME_INFO;
# pragma pack(pop)
inline void setDebuggerThreadName(DWORD threadId, LPCSTR name)
{
// Do it the old way, which is only really useful if the debugger is running
if (::IsDebuggerPresent())
{
detail::THREADNAME_INFO info;
info.dwType = 0x1000;
info.szName = name;
info.dwThreadID = threadId;
info.dwFlags = 0;
# pragma warning(push)
# pragma warning(disable : 6320 6322)
__try
{
::RaiseException(detail::MS_VC_EXCEPTION, 0, sizeof(info) / sizeof(ULONG_PTR), (ULONG_PTR*)&info);
}
__except (CARBWIN_EXCEPTION_EXECUTE_HANDLER)
{
}
# pragma warning(pop)
}
}
} // namespace detail
# endif
//! The definition of a NativeHandleType. On Windows this is a `HANDLE` and on Linux it is a `pthread_t`.
using NativeHandleType = HANDLE;
#elif CARB_POSIX
//! The definition of a NativeHandleType. On Windows this is a `HANDLE` and on Linux it is a `pthread_t`.
using NativeHandleType = pthread_t;
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
/**
* Sets the name of the given thread.
*
* @note The length of the name is limited by the system.
*
* @param h The native handle to the thread.
* @param name The desired name for the thread.
*
* @note On Mac OS, it is not possible to name a thread that is not the current
* executing thread.
*/
inline void setName(NativeHandleType h, const char* name)
{
#if CARB_PLATFORM_WINDOWS
// Emulate CARB_NAME_THREAD but don't include Profile.h which would create a circular dependency.
if (g_carbProfiler)
g_carbProfiler->nameThreadDynamic(::GetThreadId(h), "%s", name);
// SetThreadDescription is only available starting with Windows 10 1607
using PSetThreadDescription = HRESULT(CARBWIN_WINAPI*)(HANDLE, PCWSTR);
static PSetThreadDescription SetThreadDescription =
(PSetThreadDescription)::GetProcAddress(::GetModuleHandleW(L"kernel32.dll"), "SetThreadDescription");
if (SetThreadDescription)
{
bool b = CARBWIN_SUCCEEDED(SetThreadDescription(h, extras::convertUtf8ToWide(name).c_str()));
CARB_UNUSED(b);
CARB_ASSERT(b);
}
else
{
detail::setDebuggerThreadName(::GetThreadId(h), name);
}
#elif CARB_PLATFORM_LINUX
if (h == pthread_self())
{
// Emulate CARB_NAME_THREAD but don't include Profile.h which would create a circular dependency.
if (g_carbProfiler)
g_carbProfiler->nameThreadDynamic(0, "%s", name);
}
if (pthread_setname_np(h, name) != 0)
{
// This is limited to 16 characters including NUL according to the man page.
char buffer[16];
strncpy(buffer, name, 15);
buffer[15] = '\0';
pthread_setname_np(h, buffer);
}
#elif CARB_PLATFORM_MACOS
if (h == pthread_self())
{
pthread_setname_np(name);
}
// not possible to name an external thread on mac
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Retrieves the name of the thread previously set with setName().
*
* @note The length of the name is limited by the system.
*
* @param h The native handle to the thread.
* @return The name of the thread.
*/
inline std::string getName(NativeHandleType h)
{
#if CARB_PLATFORM_WINDOWS
// GetThreadDescription is only available starting with Windows 10 1607
using PGetThreadDescription = HRESULT(CARBWIN_WINAPI*)(HANDLE, PWSTR*);
static PGetThreadDescription GetThreadDescription =
(PGetThreadDescription)::GetProcAddress(::GetModuleHandleW(L"kernel32.dll"), "GetThreadDescription");
if (GetThreadDescription)
{
PWSTR threadName;
if (CARBWIN_SUCCEEDED(GetThreadDescription(h, &threadName)))
{
std::string s = extras::convertWideToUtf8(threadName);
::LocalFree(threadName);
return s;
}
}
return std::string();
#elif CARB_PLATFORM_LINUX || CARB_PLATFORM_MACOS
char buffer[64];
if (pthread_getname_np(h, buffer, CARB_COUNTOF(buffer)) == 0)
{
return std::string(buffer);
}
return std::string();
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Sets the CPU affinity for the given thread handle
*
* Each bit represents a logical CPU; bit 0 for CPU 0, bit 1 for CPU 1, etc.
*
* @param h The native handle to the thread
* @param mask The bitmask representing the desired CPU affinity. Zero (no bits set) is ignored.
*
* @note On Mac OS, the CPU affinity works differently than on other systems.
* The mask is treated as a unique ID for groups of threads that should run
* on the same core, rather than specific CPUs.
* For single CPU masks, this will function similarly to other systems
* (aside from the fact that the specific core the threads are running on
* being different).
*
* @note M1 Macs do not support thread affinity so this will do nothing on those systems.
*/
inline void setAffinity(NativeHandleType h, size_t mask)
{
#if CARB_PLATFORM_WINDOWS
::SetThreadAffinityMask(h, mask);
#elif CARB_PLATFORM_LINUX
// From the man page: The cpu_set_t data type is implemented as a bit mask. However, the data structure should be
// treated as opaque: all manipulation of the CPU sets should be done via the macros described in this page.
if (!mask)
return;
cpu_set_t cpuSet;
CPU_ZERO(&cpuSet);
static_assert(sizeof(cpuSet) >= sizeof(mask), "Invalid assumption: use CPU_ALLOC");
do
{
int bit = __builtin_ctz(mask);
CPU_SET(bit, &cpuSet);
mask &= ~(size_t(1) << bit);
} while (mask != 0);
pthread_setaffinity_np(h, sizeof(cpu_set_t), &cpuSet);
#elif CARB_PLATFORM_MACOS
thread_affinity_policy policy{ static_cast<integer_t>(mask) };
thread_policy_set(pthread_mach_thread_np(h), THREAD_AFFINITY_POLICY, reinterpret_cast<thread_policy_t>(&policy),
THREAD_AFFINITY_POLICY_COUNT);
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Sets the CPU Affinity for the thread.
*
* On Windows each entry in the CpuMaskVector represents a Processor Group. Each thread can only belong to a single
* Processor Group, so this function will only set the CPU Affinity to the first non-zero entry in the provided
* CpuMaskVector. That is to say, if both \c masks[0] and \c masks[1] both have bits sets, only the CPUs in \c masks[0]
* will be set for the affinity.
*
* On Linux, the CpuMaskVector is analogous to a cpu_set_t. There are no restrictions on the number of CPUs that the
* affinity mask can contain.
*
* @param h The thread to set CPU Affinity for.
* @param masks Affinity masks to set.
*
* @return True if the function succeeded, false otherwise. If \c masks is empty, or has no bits set, false will be
* returned. If the underlying function for setting affinity failed, then \c errno or \c last-error will be set.
*
* @note On Mac OS, the CPU affinity works differently than on other systems.
* The mask is treated as a unique ID for groups of threads that should run
* on cores that share L2 cache, rather than specific CPUs.
* For single CPU masks, this will function somewhat similarly to other
* systems, but threads won't be pinned to a specific core.
*/
inline bool setAffinity(NativeHandleType h, const CpuMaskVector& masks)
{
if (masks.empty())
{
return false;
}
#if CARB_PLATFORM_WINDOWS
// Find the lowest mask with a value set. That is the CPU Group that we'll set the affinity for.
for (uint64_t i = 0; i < masks.size(); ++i)
{
if (masks[i])
{
CARBWIN_GROUP_AFFINITY affinity{};
affinity.Group = (WORD)i;
affinity.Mask = masks[i];
return ::SetThreadGroupAffinity(h, (const GROUP_AFFINITY*)&affinity, nullptr);
}
}
// Would only reach here if no affinity mask had a cpu set.
return false;
#elif CARB_PLATFORM_LINUX
uint64_t numCpus = kCpusPerMask * masks.size();
cpu_set_t* cpuSet = CPU_ALLOC(numCpus);
if (!cpuSet)
{
return false;
}
CARB_SCOPE_EXIT
{
CPU_FREE(cpuSet);
};
CPU_ZERO_S(CPU_ALLOC_SIZE(numCpus), cpuSet);
for (uint64_t i = 0; i < masks.size(); ++i)
{
CpuMaskVector::value_type mask = masks[i];
while (mask != 0)
{
int bit = cpp::countr_zero(mask);
CPU_SET(bit + (i * kCpusPerMask), cpuSet);
mask &= ~(CpuMaskVector::value_type(1) << bit);
}
}
if (pthread_setaffinity_np(h, CPU_ALLOC_SIZE(numCpus), cpuSet) != 0)
{
return false;
}
else
{
return true;
}
#elif CARB_PLATFORM_MACOS
size_t mask = 0;
for (uint64_t i = 0; i < masks.size(); ++i)
{
mask |= 1ULL << masks[i];
}
setAffinity(h, mask);
return true;
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Gets the current CPU Affinity for the thread.
*
* On Windows each entry in the CpuMaskVector represents a Processor Group.
* On Linux, the CpuMaskVector is analogous to a cpu_set_t.
*
* @param h The thread to get CPU Affinity for.
*
* @return A CpuMaskVector containing the cpu affinities for the thread. If the underlying functions to get thread
* affinity return an error, the returned CpuMaskVector will be empty and \c errno or \c last-error will be set.
*
* @note M1 Macs do not support thread affinity so this will always return an
* empty vector.
*/
inline CpuMaskVector getAffinity(NativeHandleType h)
{
CpuMaskVector results;
#if CARB_PLATFORM_WINDOWS
CARBWIN_GROUP_AFFINITY affinity;
if (!::GetThreadGroupAffinity(h, (PGROUP_AFFINITY)&affinity))
{
return results;
}
results.resize(affinity.Group + 1, 0);
results.back() = affinity.Mask;
return results;
#elif CARB_PLATFORM_LINUX
// Get the current affinity
cpu_set_t cpuSet;
CPU_ZERO(&cpuSet);
if (pthread_getaffinity_np(h, sizeof(cpu_set_t), &cpuSet) != 0)
{
return results;
}
// Convert the cpu_set_t to a CpuMaskVector
results.reserve(sizeof(cpu_set_t) / sizeof(CpuMaskVector::value_type));
CpuMaskVector::value_type* ptr = reinterpret_cast<CpuMaskVector::value_type*>(&cpuSet);
for (uint64_t i = 0; i < (sizeof(cpu_set_t) / sizeof(CpuMaskVector::value_type)); i++)
{
results.push_back(ptr[i]);
}
return results;
#elif CARB_PLATFORM_MACOS
boolean_t def = false; // if the value retrieved was the default
mach_msg_type_number_t count = 0; // the length of the returned struct in integer_t
thread_affinity_policy policy{ 0 };
int res = thread_policy_get(
pthread_mach_thread_np(h), THREAD_AFFINITY_POLICY, reinterpret_cast<thread_policy_t>(&policy), &count, &def);
if (res != 0 || def)
{
return results;
}
for (uint64_t i = 0; i < (sizeof(policy.affinity_tag) * CHAR_BIT); i++)
{
if ((policy.affinity_tag & (1ULL << i)) != 0)
{
results.push_back(i);
}
}
return results;
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* A utility class for providing a growing number of pause instructions, followed by yielding.
*
* The pause instruction is effectively \ref CARB_HARDWARE_PAUSE().
*
* Very fast to construct, often used in a loop such as:
* ```cpp
* for (AtomicBackoff<> b;; b.pause())
* if (condition())
* break;
* ```
* @tparam PausesBeforeYield the number of pauses that will occur before yielding begins. See
* \ref AtomicBackoff::pause().
*/
template <size_t PausesBeforeYield = 16>
class AtomicBackoff
{
public:
//! The number of pauses that should be executed before yielding the thread.
static constexpr size_t kPausesBeforeYield = PausesBeforeYield;
static_assert(carb::cpp::has_single_bit(kPausesBeforeYield), "Must be a power of 2");
//! Constructor.
constexpr AtomicBackoff() noexcept = default;
CARB_PREVENT_COPY_AND_MOVE(AtomicBackoff);
/**
* A helper function for executing the CPU pause instruction `count` times.
* @param count The number of times to execute \ref CARB_HARDWARE_PAUSE().
*/
static void pauseLoop(size_t count) noexcept
{
while (count-- > 0)
CARB_HARDWARE_PAUSE();
}
/**
* Resets `*this`.
*/
void reset() noexcept
{
m_growth = 1;
}
/**
* Every time called, will pause for exponentially longer, and after a certain amount will instead yield.
*
* Pause is as via \ref CARB_HARDWARE_PAUSE. Yield is as via `std::this_thread::yield()`.
* The pause count starts at 1 when \ref reset() or newly constructed. Each time this function is called, the CPU
* pause instruction is executed `count` times and `count` is doubled. If called when `count` exceeds
* \ref kPausesBeforeYield, a yield occurs instead. Calling \ref reset() resets the `count` to 1.
*/
void pause() noexcept
{
if (m_growth <= kPausesBeforeYield)
{
// Execute pauses
pauseLoop(m_growth);
// Pause twice as many times next time
m_growth *= 2;
}
else
{
// Too much contention; just yield to the OS
std::this_thread::yield();
}
}
/**
* Similar to \ref pause() but if would yield, instead returns false.
* @returns true if the internal `count` is less than \ref kPausesBeforeYield; `false` otherwise.
*/
bool pauseWithoutYield() noexcept
{
pauseLoop(m_growth);
if (m_growth >= kPausesBeforeYield)
return false;
// Pause twice as many times next time
m_growth *= 2;
return true;
}
private:
size_t m_growth{ 1 };
};
/**
* Similar to `std::thread::hardware_concurrency()`, but pays attention to docker cgroup config and CPU limits.
*
* Docker container CPU limits are based on the ratio of `/sys/fs/cgroup/cpu/cpu.cfs_quota_us` to
* `/sys/fs/cgroup/cpu/cpu.cfs_period_us`. Fractional CPUs of a half or larger will round up to a full CPU. It is
* possible to have an odd number reported by this function.
* Examples:
* * Docker `--cpus="3.75"` will produce `4` (rounds fractional up)
* * Docker `--cpus="3.50"` will produce `4` (rounds fractional up)
* * Docker `--cpus="3.25"` will produce `3` (rounds fractional down)
* * Docker `--cpus="0.25"` will produce `1` (minimum of 1)
*
* @returns The number of CPUs available on the current system or within the current container, if applicable.
*/
inline unsigned hardware_concurrency() noexcept
{
#if CARB_PLATFORM_LINUX
static auto dockerLimit = omni::extras::getDockerCpuLimit();
if (dockerLimit > 0)
{
return unsigned(dockerLimit);
}
#endif
return std::thread::hardware_concurrency();
}
} // namespace thread
/**
* Namespace for utilities that operate on the current thread specifically.
*/
namespace this_thread
{
/**
* A simple sleep for the current thread that does not include the overhead of `std::chrono`.
*
* @param microseconds The number of microseconds to sleep for
*/
inline void sleepForUs(uint32_t microseconds) noexcept
{
#if CARB_PLATFORM_WINDOWS
::Sleep(microseconds / 1000);
#elif CARB_POSIX
uint64_t nanos = uint64_t(microseconds) * 1'000;
struct timespec rem, req{ time_t(nanos / 1'000'000'000), long(nanos % 1'000'000'000) };
while (nanosleep(&req, &rem) != 0 && errno == EINTR)
req = rem; // Complete remaining sleep
#else
CARB_PLATFORM_UNSUPPORTED()
#endif
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
inline unsigned contentionSpins()
{
// These must be power-of-two-minus-one so that they function as bitmasks
constexpr static unsigned kSpinsMax = 128 - 1;
constexpr static unsigned kSpinsMin = 32 - 1;
// Use randomness to prevent threads from resonating at the same frequency and permanently contending. Use a
// simple LCG for randomness.
static std::atomic_uint _seed; // Use random initialization value as the starting seed
unsigned int next = _seed.load(std::memory_order_relaxed);
_seed.store(next * 1103515245 + 12345, std::memory_order_relaxed);
return ((next >> 24) & kSpinsMax) | kSpinsMin;
}
// This function name breaks naming paradigms so that it shows up prominently in stack traces. As the name implies, this
// function waits until f() returns true.
template <class Func>
void __CONTENDED_WAIT__(Func&& f) noexcept(noexcept(f()))
{
thread::AtomicBackoff<> backoff;
while (CARB_UNLIKELY(!f()))
backoff.pause();
}
} // namespace detail
#endif
/**
* Returns the native handle for the current thread.
*
* @note Windows: This handle is not unique to the thread but instead is a pseudo-handle representing "current thread".
* To obtain a unique handle to the current thread, use the Windows API function `DuplicateHandle()`.
*
* @return The native handle for the current thread.
*/
inline thread::NativeHandleType get()
{
#if CARB_PLATFORM_WINDOWS
return ::GetCurrentThread();
#elif CARB_POSIX
return pthread_self();
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Returns the ID of the currently executing process.
* @returns The current ID of the process.
*/
CARB_DEPRECATED("Use this_process::getId() instead") static inline thread::ProcessId getProcessId()
{
return this_process::getId();
}
/**
* Get the ID of the currently executing process.
* @note Linux: This value is cached, so this can be unsafe if you are using fork() or clone() without calling exec()
* after. This should be safe if you're only using @ref carb::launcher::ILauncher to launch processes.
* @returns The current ID of the process.
*/
CARB_DEPRECATED("Use this_process::getIdCached() instead") static inline thread::ProcessId getProcessIdCached()
{
return this_process::getIdCached();
}
/**
* Retrieve the thread ID for the current thread.
* @return The thread ID for the current thread.
*/
inline thread::ThreadId getId()
{
#if CARB_PLATFORM_WINDOWS
return thread::ThreadId(::GetCurrentThreadId());
#elif CARB_PLATFORM_LINUX
// This value is stored internally within the pthread_t, but this is opaque and there is no public API for
// retrieving it. Therefore, we can only do this for the current thread.
// NOTE: We do not store this in a thread_local because on older versions of glibc (especially 2.17, which is what
// Centos7 uses), this will require a lock that is also shared with loading shared libraries, which can cause a
// deadlock.
thread::ThreadId tid = (thread::ThreadId)(pid_t)syscall(SYS_gettid);
return tid;
#elif CARB_PLATFORM_MACOS
return thread::ThreadId(pthread_mach_thread_np(pthread_self()));
#else
CARB_UNSUPPORTED_PLATFORM();
#endif
}
/**
* Sets the name for the current thread.
*
* @note The length of the name is limited by the system and may be truncated.
*
* @param name The desired name for the current thread.
*/
inline void setName(const char* name)
{
thread::setName(get(), name);
}
/**
* Retrieves the name of the current thread.
*
* @return The name of the current thread.
*/
inline std::string getName()
{
return thread::getName(get());
}
/**
* Sets the affinity of the current thread.
*
* Each bit represents a logical CPU; bit 0 for CPU 0, bit 1 for CPU 1, etc.
*
* @note This function is limited to the first 64 CPUs in a system.
*
* @param mask The bitmask representing the desired CPU affinity. Zero (no bits set) is ignored.
*/
inline void setAffinity(size_t mask)
{
thread::setAffinity(get(), mask);
}
/**
* Sets the CPU Affinity for the current thread.
*
* On Windows each entry in the CpuMaskVector represents a Processor Group. Each thread can only belong to a single
* Processor Group, so this function will only set the CPU Affinity to the first non-zero entry in the provided
* CpuMaskVector. That is to say, if both \c masks[0] and \c masks[1] have bits sets, only the CPUs in \c masks[0]
* will be set for the affinity.
*
* On Linux, the CpuMaskVector is analogous to a cpu_set_t. There are no restrictions on the number of CPUs that the
* affinity mask can contain.
*
* @param masks Affinity masks to set.
*
* @return True if the function succeeded, false otherwise. If \c masks is empty, or has no bits set, false will be
* returned. If the underlying function for setting affinity failed, then \c errno or \c last-error will be set.
*/
inline bool setAffinity(const thread::CpuMaskVector& masks)
{
return thread::setAffinity(get(), masks);
}
/**
* Gets the current CPU Affinity for the current thread.
*
* On Windows each entry in the CpuMaskVector represents a Processor Group.
* On Linux, the CpuMaskVector is analogous to a cpu_set_t.
*
* @return A CpuMaskVector containing the cpu affinities for the thread. If the underlying functions to get thread
* affinity return an error, the returned CpuMaskVector will be empty and \c errno or \c last-error will be set.
*/
inline thread::CpuMaskVector getAffinity()
{
return thread::getAffinity(get());
}
/**
* Calls a predicate repeatedly until it returns \c true.
*
* This function is recommended only for situations where exactly one thread is waiting on another thread. For multiple
* threads waiting on a predicate, use \ref spinWaitWithBackoff().
*
* @param f The predicate to call repeatedly until it returns `true`.
*/
template <class Func>
void spinWait(Func&& f) noexcept(noexcept(f()))
{
while (!CARB_LIKELY(f()))
{
CARB_HARDWARE_PAUSE();
}
}
/**
* Calls a predicate until it returns true with progressively increasing delays between calls.
*
* This function is a low-level utility for high-contention cases where multiple threads will be calling @p f
* simultaneously, @p f needs to succeed (return `true`) before continuing, but @p f will only succeed for one thread at
* a time. This function does not return until @p f returns `true`, at which point this function returns immediately.
* High contention is assumed when @p f returns `false` for several calls, at which point the calling thread will
* progressively sleep between bursts of calls to @p f. This is a back-off mechanism to allow one thread to move forward
* while other competing threads wait their turn.
*
* @param f The predicate to call repeatedly until it returns `true`.
*/
template <class Func>
void spinWaitWithBackoff(Func&& f) noexcept(noexcept(f()))
{
if (CARB_UNLIKELY(!f()))
{
detail::__CONTENDED_WAIT__(std::forward<Func>(f));
}
}
/**
* Calls a predicate until it returns true or a random number of attempts have elapsed.
*
* This function is a low-level utility for high-contention cases where multiple threads will be calling @p f
* simultaneously, and @p f needs to succeed (return `true`) before continuing, but @p f will only succeed for one
* thread at a time. This function picks a pseudo-random maximum number of times to call the function (the randomness is
* so that multiple threads will not choose the same number and perpetually block each other) and repeatedly calls the
* function that number of times. If @p f returns `true`, spinTryWait() immediately returns `true`.
*
* @param f The predicate to call repeatedly until it returns `true`.
* @returns `true` immediately when @p f returns `true`. If a random number of attempts to call @p f all return `false`
* then `false` is returned.
*/
template <class Func>
bool spinTryWait(Func&& f) noexcept(noexcept(f()))
{
thread::AtomicBackoff<> backoff;
while (CARB_UNLIKELY(!f()))
if (!backoff.pauseWithoutYield())
return false;
return true;
}
/**
* A replacement function for `std::atomic_thread_fence(std::memory_order_seq_cst)` that performs better on some older
* compilers.
*/
inline void atomic_fence_seq_cst() noexcept
{
#if CARB_X86_64 && CARB_COMPILER_GNUC && __GNUC__ < 11
// On x86_64 CPUs we can use any lock-prefixed instruction as a StoreLoad operation to achieve sequential
// consistency (see https://shipilev.net/blog/2014/on-the-fence-with-dependencies/). The 'notb' instruction here has
// the added benefit of not affecting flags or other registers (see https://www.felixcloutier.com/x86/not).
// It is also likely that our 'unused' variable at the top of the stack is in L1 cache.
unsigned char unused{};
__asm__ __volatile__("lock; notb %0" : "+m"(unused)::"memory");
#else
std::atomic_thread_fence(std::memory_order_seq_cst);
#endif
}
} // namespace this_thread
} // namespace carb
| 27,229 | C | 31.455304 | 120 | 0.676705 |
omniverse-code/kit/include/carb/thread/RecursiveSharedMutex.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Recursive Shared Mutex implementation.
#pragma once
#include "SharedMutex.h"
#include "ThreadLocal.h"
#include <algorithm>
#include <vector>
namespace carb
{
namespace thread
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
class recursive_shared_mutex;
namespace detail
{
using LockEntry = std::pair<recursive_shared_mutex*, ptrdiff_t>;
using LockList = std::vector<LockEntry>;
// TL;DR: Gymnastics to get around SIOF (Static Initialization Order Fiasco) with supported compilers
//
// For GCC this is pretty easy. The init_priority attribute allows us to specify a priority value to use for
// initialization order. For recursive_shared_mutex's lockList, we really only care that it's constructed before
// application initializers run.
//
// We have to jump through some hoops here for MSVC since this is a header-only class. MSVC does have pragma init_seg,
// BUT a given translation unit (i.e. cpp files) may have only one. Since this exists as a header-only class and we
// don't want to force linkage of a cpp file specifically for this, we can get around it by injecting our initializer
// function into the appropriate segment for initializer order at link time.
//
// This is a fairly good reference for the various C-Runtime initializer sections:
// https://gist.github.com/vaualbus/622099d88334fbba1d4ae703642c2956
//
// #pragma init_seg(lib) corresponds to section .CRT$XCL (the L seems to indicate `lib`). Ironically, C=compiler,
// L=lib, and U=user are also in alphabetical order and make nice delimiters between .CRT$XCA (__xc_a) and .CRT$XCZ
// (__xc_z).
# if CARB_COMPILER_MSC
// If we just specified a variable of type carb::thread::ThreadLocal<LockList> (even allocating it into a specific
// custom section) the compiler will still try to instantiate it during the init_seg(user) order. To circumvent this
// behavior, we instead contain this variable inside `DataContainer`, but are careful to have the DataContainer()
// constructor well defined with zero side-effects. This is because constructLockList() will be called first (during the
// compiler's init_seg(lib) initialization order), which will construct the TLS member inside of DataContainer, but the
// DataContainer() constructor for lockListData runs after (during the compiler's init_seg(user) initialization order).
// clang-format off
// (for brevity)
struct DataContainer
{
struct DummyType { constexpr DummyType() noexcept {} };
union
{
DummyType empty;
carb::thread::ThreadLocal<LockList> tls;
};
constexpr DataContainer() noexcept : empty() {}
~DataContainer() noexcept {}
} __declspec(selectany) lockListData;
// clang-format on
__declspec(selectany) bool constructed{ false };
inline carb::thread::ThreadLocal<LockList>& lockList() noexcept
{
// Should have been constructed with either pConstructLockList (initializer) or ensureLockList()
CARB_ASSERT(constructed);
return lockListData.tls;
}
inline void constructLockList() noexcept
{
// Construct the lock list and then register a function to destroy it at exit time
CARB_ASSERT(!constructed);
new (&lockListData.tls) carb::thread::ThreadLocal<LockList>();
constructed = true;
::atexit([] {
lockList().~ThreadLocal();
constructed = false;
});
}
inline void ensureLockList() noexcept
{
// OVCC-1298: With LTCG turned on sometimes the linker doesn't obey the segment information below and puts
// pConstructLockList that is supposed to construct the lock list into the wrong segment, not in the initializer
// list. Which means it gets skipped at startup. As a work-around we can construct it when the
// recursive_shared_mutex constructor is called, though this may be late and cause SIOF issues (see OM-18917).
if (CARB_UNLIKELY(!constructed))
{
static std::once_flag flag;
std::call_once(flag, [] {
if (!constructed)
constructLockList();
});
CARB_ASSERT(constructed);
}
}
extern "C"
{
// Declare these so the linker knows to include them
using CRTConstructor = void(__cdecl*)();
extern CRTConstructor __xc_a[], __xc_z[];
// Force the linker to include this symbol
# pragma comment(linker, "/include:pConstructLockList")
// Inject a pointer to our constructLockList() function at XCL, the same section that #pragma init_seg(lib) uses
# pragma section(".CRT$XCL", long, read)
__declspec(allocate(".CRT$XCL")) __declspec(selectany) CRTConstructor pConstructLockList = constructLockList;
}
# else
// According to this GCC bug: https://gcc.gnu.org/bugzilla//show_bug.cgi?id=65115
// The default priority if init_priority is not specified is 65535. So we use one value lower than that.
# define DEFAULT_INIT_PRIORITY (65535)
# define LIBRARY_INIT_PRIORITY (DEFAULT_INIT_PRIORITY - 1)
struct Constructed
{
bool constructed;
constexpr Constructed() : constructed{ true }
{
}
~Constructed()
{
constructed = false;
}
explicit operator bool() const
{
return constructed;
}
} constructed CARB_ATTRIBUTE(weak, init_priority(LIBRARY_INIT_PRIORITY));
carb::thread::ThreadLocal<LockList> lockListTls CARB_ATTRIBUTE(weak, init_priority(LIBRARY_INIT_PRIORITY));
inline carb::thread::ThreadLocal<LockList>& lockList()
{
CARB_ASSERT(constructed);
return lockListTls;
}
constexpr inline void ensureLockList() noexcept
{
}
# endif
} // namespace detail
#endif
/**
* A recursive shared mutex. Similar to `std::shared_mutex` or carb::thread::shared_mutex, but can be used recursively.
*
* This primitive supports lock conversion: If a thread already holds one or more shared locks and attempts to take an
* exclusive lock, the shared locks are released and the same number of exclusive locks are added. However, this is not
* done atomically. @see recursive_shared_mutex::lock() for more info.
*
* A single thread-local storage entry is used to track the list of recursive_shared_mutex objects that a thread has
* locked and their recursive lock depth. However, as this is a header-only class, all modules that use this class will
* allocate their own thread-local storage entry.
*/
class recursive_shared_mutex : private carb::thread::shared_mutex
{
public:
/**
* Constructor.
*/
#if !CARB_DEBUG && !CARB_COMPILER_MSC
constexpr
#endif
recursive_shared_mutex()
{
detail::ensureLockList();
}
/**
* Destructor.
*
* Debug builds assert that the mutex is not busy (locked) when destroyed.
*/
~recursive_shared_mutex() = default;
/**
* Blocks until an exclusive lock can be obtained.
*
* When this function returns, the calling thread exclusively owns the mutex. At some later point the calling thread
* will need to call unlock() to release the exclusive lock.
*
* @note If the calling thread has taken shared locks on this mutex, all of the shared locks are converted to
* exclusive locks.
*
* @warning If existing shared locks must be converted to exclusive locks, the mutex must convert these shared locks
* to exclusive locks. In order to do this, it must first release all shared locks which potentially allows another
* thread to gain exclusive access and modify the shared resource. Therefore, any time an exclusive lock is taken,
* assume that the shared resource may have been modified, even if the calling thread held a shared lock before.
*/
void lock();
/**
* Attempts to immediately take an exclusive lock, but will not block if one cannot be obtained.
*
* @note If the calling thread has taken shared locks on this mutex, `false` is returned and no attempt to convert
* the locks is made. If the calling thread already has an exclusive lock on this mutex, `true` is always returned.
*
* @returns `true` if an exclusive lock could be obtained, and at some later point unlock() will need to be called
* to release the lock. If an exclusive lock could not be obtained immediately, `false` is returned.
*/
bool try_lock();
/**
* Releases either a single shared or exclusive lock on this mutex. Synonymous with unlock_shared().
*
* @note If the calling thread has recursively locked this mutex, unlock() will need to be called symmetrically for
* each call to a successful locking function.
*
* @warning `std::terminate()` will be called if the calling thread does not have the mutex locked.
*/
void unlock();
/**
* Blocks until a shared lock can be obtained.
*
* When this function returns, the calling thread has obtained a shared lock on the resources protected by the
* mutex. At some later point the calling thread must call unlock_shared() to release the shared lock.
*
* @note If the calling thread already owns an exclusive lock, then calling lock_shared() will actually increase the
* exclusive lock count.
*/
void lock_shared();
/**
* Attempts to immediately take a shared lock, but will not block if one cannot be obtained.
*
* @note If the calling thread already owns an exclusive lock, then calling try_lock_shared() will always return
* `true` and will actually increase the exclusive lock count.
*
* @returns `true` if a shared lock could be obtained, and at some later point unlock_shared() will need to be
* called to release the lock. If a shared lock could not be obtained immediately, `false` is returned.
*/
bool try_lock_shared();
/**
* Releases either a single shared or exclusive lock on this mutex. Synonymous with unlock().
*
* @note If the calling thread has recursively locked this mutex, unlock() or unlock_shared() will need to be called
* symmetrically for each call to a successful locking function.
*
* @warning `std::terminate()` will be called if calling thread does not have the mutex locked.
*/
void unlock_shared();
/**
* Returns true if the calling thread owns the lock.
* @note Use \ref owns_lock_shared() or \ref owns_lock_exclusive() for a more specific check.
* @returns `true` if the calling thread owns the lock, either exclusively or shared; `false` otherwise.
*/
bool owns_lock() const;
/**
* Returns true if the calling thread owns a shared lock.
* @returns `true` if the calling thread owns a shared lock; `false` otherwise.
*/
bool owns_lock_shared() const;
/**
* Returns true if the calling thread owns an exclusive lock.
* @returns `true` if the calling thread owns an exclusive lock; `false` otherwise.
*/
bool owns_lock_exclusive() const;
private:
const detail::LockEntry* hasLockEntry() const
{
auto& list = detail::lockList().get();
auto iter = std::find_if(list.begin(), list.end(), [this](detail::LockEntry& e) { return e.first == this; });
return iter == list.end() ? nullptr : std::addressof(*iter);
}
detail::LockEntry& lockEntry()
{
auto& list = detail::lockList().get();
auto iter = std::find_if(list.begin(), list.end(), [this](detail::LockEntry& e) { return e.first == this; });
if (iter == list.end())
iter = (list.emplace_back(this, 0), list.end() - 1);
return *iter;
}
void removeLockEntry(detail::LockEntry& e)
{
auto& list = detail::lockList().get();
CARB_ASSERT(std::addressof(e) >= std::addressof(list.front()) && std::addressof(e) <= std::addressof(list.back()));
e = list.back();
list.pop_back();
}
};
// Function implementations
inline void recursive_shared_mutex::lock()
{
detail::LockEntry& e = lockEntry();
if (e.second < 0)
{
// Already locked exclusively (negative lock count). Increase the negative count.
--e.second;
}
else
{
if (e.second > 0)
{
// This thread already has shared locks for this lock. We need to convert to exclusive.
shared_mutex::unlock_shared();
}
// Acquire the lock exclusively
shared_mutex::lock();
// Now inside the lock
e.second = -(e.second + 1);
}
}
inline bool recursive_shared_mutex::try_lock()
{
detail::LockEntry& e = lockEntry();
if (e.second < 0)
{
// Already locked exclusively (negative lock count). Increase the negative count.
--e.second;
return true;
}
else if (e.second == 0)
{
if (shared_mutex::try_lock())
{
// Inside the lock
e.second = -1;
return true;
}
// Lock failed
removeLockEntry(e);
}
// Either we already have shared locks (that can't be converted to exclusive without releasing the lock and possibly
// not being able to acquire it again) or the try_lock failed.
return false;
}
inline void recursive_shared_mutex::unlock()
{
detail::LockEntry& e = lockEntry();
CARB_CHECK(e.second != 0);
if (e.second > 0)
{
if (--e.second == 0)
{
shared_mutex::unlock_shared();
removeLockEntry(e);
}
}
else if (e.second < 0)
{
if (++e.second == 0)
{
shared_mutex::unlock();
removeLockEntry(e);
}
}
else
{
// unlock() without being locked!
std::terminate();
}
}
inline void recursive_shared_mutex::lock_shared()
{
detail::LockEntry& e = lockEntry();
if (e.second < 0)
{
// We already own an exclusive lock, which is stronger than shared. So just increase the exclusive lock.
--e.second;
}
else
{
if (e.second == 0)
{
shared_mutex::lock_shared();
// Now inside the lock
}
++e.second;
}
}
inline bool recursive_shared_mutex::try_lock_shared()
{
detail::LockEntry& e = lockEntry();
if (e.second < 0)
{
// We already own an exclusive lock, which is stronger than shared. So just increase the exclusive lock.
--e.second;
return true;
}
else if (e.second == 0 && !shared_mutex::try_lock_shared())
{
// Failed to get the shared lock
removeLockEntry(e);
return false;
}
++e.second;
return true;
}
inline void recursive_shared_mutex::unlock_shared()
{
unlock();
}
inline bool recursive_shared_mutex::owns_lock() const
{
auto entry = hasLockEntry();
return entry ? entry->second != 0 : false;
}
inline bool recursive_shared_mutex::owns_lock_exclusive() const
{
auto entry = hasLockEntry();
return entry ? entry->second < 0 : false;
}
inline bool recursive_shared_mutex::owns_lock_shared() const
{
auto entry = hasLockEntry();
return entry ? entry->second > 0 : false;
}
} // namespace thread
} // namespace carb
| 15,467 | C | 33.916478 | 123 | 0.666128 |
omniverse-code/kit/include/carb/l10n/IL10n.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The L10n interface.
*/
#pragma once
#include "../Defines.h"
#include "../logging/Log.h"
namespace carb
{
/** Utilities for localizing text. */
namespace l10n
{
/** The return type for @ref IL10n::getHashFromKeyString(). */
using StringIdentifier = uint64_t;
/** An opaque struct representing a localization table. */
struct LanguageTable
{
};
/** An opaque struct representing a language ID. */
struct LanguageIdentifier
{
};
/** Use the main language table for the process if this is passed. */
const LanguageTable* const kLanguageTableMain = nullptr;
/** The currently set language will be used when this is passed. */
const LanguageIdentifier* const kLanguageCurrent = nullptr;
/** The entry point to getLocalizedStringFromHash().
* @copydoc IL10n::getLocalizedStringFromHash
*/
using localizeStringFn = const char*(CARB_ABI*)(const LanguageTable* table,
StringIdentifier id,
const LanguageIdentifier* language);
/** The default language will be used when this is passed.
* The default language will always be US English.
*/
const LanguageIdentifier* const kLanguageDefault = reinterpret_cast<const LanguageIdentifier*>(0xFFFFFFFFFFFFFFFF);
/** This is returned from some interface functions when an unknown language is
* requested.
*/
const LanguageIdentifier* const kLanguageUnknown = reinterpret_cast<const LanguageIdentifier*>(0xFFFFFFFFFFFFFFFE);
/** A definition that can be used for loading a language table embedded in C++ code. */
struct LanguageTableData
{
/** The number of languages in the table. */
size_t languagesLength;
/** The number of translation entries in the table.
* Any valid language table will have at least 4 rows, since the first 4
* rows have special meanings.
*/
size_t keysLength;
/** The list of translation languages. These are specified as POSIX locale identifiers.
* The length of this array is @ref languagesLength.
* The first language in this array must be "en_US*"
*/
const char* const* languages;
/** The hashes of the key strings for the translations.
* The length of this array is @ref keysLength.
* Note that this contains keys for the first 4 rows in the table, even
* though the first 4 rows have a special purpose. The first 4 keys are
* never read.
*/
const uint64_t* keys;
/** The translation table.
* This is a matrix with @ref languagesLength columns and @ref keysLength rows.
* languageTable[i][j] refers to the translation of keys[i] in languages[j].
* The first 4 rows have special usages:
* 0: The language names for each column in US English
* 1: The territory names for each column in US English
* 2: The language names for each column in the language for that column
* 3: The territory names for each column in the language for that column
*/
const char* const* languageTable;
};
/** Boolean value tags for the getLanguageName() and getTerritoryName()
* functions. These determine how the language and territory names will be
* returned. Note, returning the name of the language in any other arbitrary
* supported language is beyond the scope of the automatic behavior of the
* tables. If such an arbitrary translation is needed, the language's name
* would have to be added to each table and translated into each target
* language. Accessing the arbitrary translations in that case would end up
* as a lookupString() call.
*/
enum class LocalizedName
{
/** Retrieve the name in US English (ie: "Polish"). Note that this will
* always be the first or second string entries in any given translation
* table.
*/
eUsEnglish,
/** Retrieve the name in the language the identifier specifies (ie:
* "Polski"). Note that this will always be the third or fourth string
* entries in any given translation table.
*/
eLocalized,
};
/** The localization interface. */
struct IL10n
{
CARB_PLUGIN_INTERFACE("carb::l10n::IL10n", 1, 0)
/** Calculates the lookup hash for a US English key string.
*
* @param[in] keyString The string to calculate the hash identifier for.
* This may not be nullptr or an empty string.
* @returns The calculated hash of the string. This will be the same
* algorithm that is used by the `String Table Conversion Tool`
* to generate the table and mapping structure.
* @returns 0 if the input string is nullptr or empty.
*
* @remarks This calculates the hash value for a string. This is useful
* for scripts to be able to pre-hash and cache their string
* identifiers for quicker lookups later.
*
* @note This is not intended to be directly used in most situations.
* Typical C++ code should use CARB_LOCALIZE() and typical python
* code should use carb_localize() or carb_localize_hashed().
*/
StringIdentifier(CARB_ABI* getHashFromKeyString)(const char* keyString) noexcept;
/** Looks up a string's translation in the localization system.
*
* @param[in] table The optional local language table to search first
* for the requested key string. If this is
* non-nullptr and the key string is not found in this
* table or the requested language is not supported by
* this table, the framework's registered main table
* will be checked as well. This may be nullptr to
* only search the framework's main table.
* @param[in] id The hashed string identifier of the string to look
* up.
* @param[in] language The language to retrieve the translated string in.
* This may be set to @ref kLanguageCurrent to use the
* current language for the localization system (this
* is the default behavior). This can also be any
* specific language identifier to retrieve the string
* in another supported language. This may also be
* @ref kLanguageDefault to retrieve the string in the
* system's default language if a translation is
* available.
* @returns The translated string is a supported language is requested and
* the string with the requested hash is found in the table.
* @returns nullptr if no translation is found in the table, if an
* unsupported language is requested, or if the key string has no
* mapping in the table.
* @returns An error message if the config setting to return noticeable
* failure strings is enabled.
*
* @note This is not intended to be directly used in most situations.
* Typical C++ code should use CARB_LOCALIZE() and typical python
* code should use carb_localize() or carb_localize_hashed().
*/
const char*(CARB_ABI* getLocalizedStringFromHash)(const LanguageTable* table,
StringIdentifier id,
const LanguageIdentifier* language) noexcept;
/** Retrieves the current system locale information.
*
* @returns A language identifier for the current system language if it
* matches one or more of the supported translation tables.
* @returns The language identifier for US English if no matching
* translation tables are found.
*/
const LanguageIdentifier*(CARB_ABI* getSystemLanguage)() noexcept;
/** Enumerates available/supported language identifiers in the localization system.
*
* @param[in] table The optional local table to also search for unique
* language identifiers to return. If this is
* non-nullptr, the supported language identifiers in
* this table will be enumerated first, followed by any
* new unique language identifiers in the framework's
* registered main table. This may be nullptr to only
* enumerate identifiers in the main table.
* @param[in] index The index of the language identifier number to be
* returned. Set this to 0 to retrieve the first
* supported language (this will always return the
* language identifier corresponding to US English as the
* first supported language identifier). Set this to
* increasing consecutive indices to retrieve following
* supported language codes.
* @returns The language identifier corresponding to the supported
* language at index @p index.
* @retval kLanguageUnknown if the given index is out of range of
* the supported languages.
*/
const LanguageIdentifier*(CARB_ABI* enumLanguageIdentifiers)(const LanguageTable* table, size_t index) noexcept;
/** Retrieves the language identifier for a given locale name.
*
* @param[in] table The optional local table to also search for a
* matching language identifier in. This may be
* nullptr to only search the framework's 'main'
* table.
* @param[in] language The standard Unix locale name in the format
* "<language>_<territory>" where "<language>" is a
* two character ISO-639-1 language code and
* "<territory>" is a two-character ISO-3166-1
* Alpha-2 territory code. An optional encoding
* string may follow this but will be ignored. This
* must not be nullptr or an empty string.
* @returns The language identifier corresponding to the selected Unix
* locale name if a table for the requested language and
* territory is found. If multiple matching supported tables are
* found for the requested language (ie: Canadian French, France
* French, Swiss French, etc), the one for the matching territory
* will be returned instead. If no table exists for the
* requested territory in the given language, the language
* identifier for an arbitrary table for the requested language
* will be returned instead. This behavior may be modified by a
* runtime config setting that instead causes @ref
* kLanguageUnknown to be returned if no exact language/territory
* match exists.
* @retval kLanguageUnknown if the requested language does not have
* a translation table for it in the localization system, or if
* the config setting to only allow exact matches is enabled and
* no exact language/territory match could be found.
*/
const LanguageIdentifier*(CARB_ABI* getLanguageIdentifier)(const LanguageTable* table, const char* language) noexcept;
/** Retrieves a language's or territory's name as a friendly string.
*
* @param[in] table The optional local language table to check for
* the requested name first. If this is nullptr
* or the requested language identifier is not
* supported by the given table, the framework's
* main registered table will be checked.
* @param[in] language The language identifier of the language or
* territory name to retrieve. This may not be
* @ref kLanguageUnknown. This may be @ref
* kLanguageCurrent to retrieve the name for the
* currently selected language.
* @param[in] retrieveIn The language to return the string in. This can
* be used to force the language's or territory's
* name to be returned in US English or the name
* of @p language in @p language.
* @returns The name of the language or territory in the specified
* localization.
* @returns An empty string if the no translation table exists for the
* requested language or an invalid language identifier is given.
* @returns An error message if the config setting to return noticeable
* failure strings is enabled.
*
* @note This will simply return the strings in the second and third, or
* fourth and fifth rows of the CSV table (which should have become
* properties of the table once loaded).
*/
const char*(CARB_ABI* getLanguageName)(const LanguageTable* table,
const LanguageIdentifier* language,
LocalizedName retrieveIn) noexcept;
/** @copydoc getLanguageName */
const char*(CARB_ABI* getTerritoryName)(const LanguageTable* table,
const LanguageIdentifier* language,
LocalizedName retrieveIn) noexcept;
/** Retrieves the standard Unix locale name for the requested language identifier.
*
* @param[in] table The optional local language table to retrieve the
* locale identifier from. This may be nullptr to
* only search the framework's registered main
* language table.
* @param[in] language The language identifier to retrieve the Unix locale
* name for. This may not be @ref kLanguageUnknown.
* This may be @ref kLanguageCurrent to retrieve the
* locale name for the currently selected language.
* @returns The standard Unix locale name for the requested language
* identifier.
* @returns an empty string if the language identifier is invalid or no translation table exist
* for it.
* @returns an error message if the config setting to return noticeable failure string is
* enabled.
*/
const char*(CARB_ABI* getLocaleIdentifierName)(const LanguageTable* table,
const LanguageIdentifier* language) noexcept;
/** Sets the new current language from a standard Unix locale name or language identifier.
*
* @param[in] table The optional local language table to check to see
* if the requested language is supported or not.
* This may be nullptr to only search the framework's
* registered main table. If the local table doesn't
* support the requested language, the framework's
* main table will still be searched.
* @param[in] language Either the locale name or identifier for the new
* language to set as current for the calling process.
* For the string version, this may be nullptr or an
* empty string to switch back to the system default
* language. For the language identifier version,
* this may be set to @ref kLanguageDefault to switch
* back to the system default language.
* @returns true if the requested language is supported and is
* successfully set.
* @returns false if the requested language is not supported.
* In this case, the current language will not be modified.
*
* @note the variant that takes a string locale identifier will just be a
* convenience helper function that first looks up the language
* identifier for the locale then passes it to the other variant.
* If the locale lookup fails, the call will fail since it would be
* requesting an unsupported language.
*/
bool(CARB_ABI* setCurrentLanguage)(const LanguageTable* table, const LanguageIdentifier* language) noexcept;
/** @copydoc setCurrentLanguage */
bool(CARB_ABI* setCurrentLanguageFromString)(const LanguageTable* table, const char* language) noexcept;
/** Retrieves the language identifier for the current language.
*
* @returns The identifier for the current language.
* @retval kLanguageDefault if an error occurs.
*/
const LanguageIdentifier*(CARB_ABI* getCurrentLanguage)() noexcept;
/** Registers the host app's main language translation table.
*
* @param[in] table The table to register as the app's main lookup table.
* This may be nullptr to indicate that no language table
* should be used and that only US English strings will
* be used by the app.
* @returns true if the new main language table is successfully set.
* @returns false if the new main language table could not be set.
*
* @note This is a per-process setting.
*/
bool(CARB_ABI* setMainLanguageTable)(const LanguageTable* table) noexcept;
/** Creates a new local language translation table.
*
* @param[in] data The language table to load.
* This language table must remain valid and constant
* until unloadLanguageTable() is called.
* The intended use of this function is to load a static
* constant data table.
* @returns The newly loaded and created language table if the data file
* exists and was successfully loaded. This must be destroyed
* with unloadLanguageTable() when it is no longer needed.
* @returns nullptr if an unrecoverable error occurred.
*/
LanguageTable*(CARB_ABI* loadLanguageTable)(const LanguageTableData* data) noexcept;
/** Creates a new local language translation table from a data file.
*
* @param[in] filename The name of the data file to load as a language
* translation table. This may not be nullptr or an
* empty string. If this does not have an extension,
* both the given filename and one ending in ".lang"
* will be tried.
* @returns The newly loaded and created language table if the data file
* exists and was successfully loaded. This must be destroyed
* with unloadLanguageTable() when it is no longer needed.
* @returns nullptr if the data file was not found with or without the
* ".lang" extension, or the file was detected as corrupt while
* loading.
*
* @note The format of the localization file is as follows:
* byte count | segment description
* [0-13] | File signature. The exact UTF-8 text: "nvlocalization".
* [14-15] | File format version. Current version is 00.
* | This version number is 2 hex characters.
* [16-19] | Number of languages.
* | This corresponds to @ref LanguageTableData::languagesLength.
* [20-23] | Number of keys.
* | This corresponds to @ref LanguageTableData::keysLength.
* [24-..] | Table of @ref LanguageTableData::keysLength 64 bit keys.
* | This is @ref LanguageTableData::keysLength * 8 bytes long.
* | This corresponds to @ref LanguageTableData::keys.
* [..-..] | Block of @ref LanguageTableData::languagesLength null
* | terminated language names.
* | This will contain exactly @ref LanguageTableData::languagesLength
* | 0x00 bytes; each of those bytes indicates the end of a string.
* | The length of this segment depends on the data within it;
* | the full segment must be read to find the start of the
* | next section.
* | This corresponds to @ref LanguageTableData::languages.
* [..-..] | Block of @ref LanguageTableData::languagesLength *
* | @ref LanguageTableData::keysLength
* | null terminated translations.
* | This will contain exactly @ref LanguageTableData::languagesLength *
* | @ref LanguageTableData::keysLength 0x00 bytes; each of those bytes
* | indicates the end of a string.
* | The last byte of the file should be the null terminator of the last
* | string in the file.
* | The length of this section also depends on the length of
* | the data contained within these strings.
* | If the end of the file is past the final 0x00 byte in this
* | segment, the reader will assume the file is corrupt.
* | This corresponds to @ref LanguageTableData::languageTable.
*/
LanguageTable*(CARB_ABI* loadLanguageTableFromFile)(const char* fileName) noexcept;
/** The language table to be destroyed.
*
* @param[in] table The language table to be destroyed.
* This must not be nullptr.
* This should be a table that was previously returned
* from loadLanguageTable().
* It is the caller's responsibility to ensure this table
* will no longer be needed or accessed.
*/
void(CARB_ABI* unloadLanguageTable)(LanguageTable* table) noexcept;
/** Sets the current search path for finding localization files for a module.
*
* @param[in] searchPath The search path for where to look for
* localization data files.
* This can be an absolute or relative path.
* @returns true if the new search path is successfully set.
* @returns false if the new search path could not be set.
*
* @remarks This sets the search path to use for finding localization
* files when modules load. By default, only the same directory
* as the loaded module or script will be searched. This can be
* used to specify additional directories to search for
* localization files in. For example, the localization files
* may be stored in the 'lang/' folder for the app instead of in
* the 'bin/' folder.
*/
bool(CARB_ABI* addLanguageSearchPath)(const char* searchPath) noexcept;
/** Sets the current search path for finding localization files for a module.
*
* @param[in] searchPath The search path to remove from the search path
* list.
* @returns true if the search path was successfully removed.
* @returns false if the search path was not found.
*
* @remarks This removes a search path added by addLanguageSearchPath().
* If the same path was added multiple times, it will have to be
* removed multiple times.
*
* @note The executable directory can be removed from the search path
* list, if that is desired.
*/
bool(CARB_ABI* removeLanguageSearchPath)(const char* searchPath) noexcept;
/** Enumerate the search paths that are currently set.
* @param[in] index The index of the search path to retrieve.
* The first search path index will always be 0.
* The valid search paths are a contiguous range of
* indices, so the caller can pass incrementing values
* beginning at 0 for @p index to enumerate all of the
* search paths.
*
* @returns The search path corresponding to @p index if one exists at index.
* @returns nullptr if there is no search path corresponding to @p index.
*
* @remarks The example usage of this function would be to call this in a
* loop where @p index starts at 0 and increments until a call to
* enumLanguageSearchPaths(@p index) returns nullptr. This would
* enumerate all search paths that are currently set.
* The index is no longer valid if the search path list has been
* modified.
*/
const char*(CARB_ABI* enumLanguageSearchPaths)(size_t index) noexcept;
};
/** A version of getLocalizedStringFromHash() for when the localization plugin is unloaded.
* @param[in] table The localization table to use for the lookup.
* @param[in] id The hash of @p string.
* @param[in] language The language to perform the lookup in.
* @returns nullptr.
*/
inline const char* CARB_ABI getLocalizedStringFromHashNoPlugin(const LanguageTable* table,
StringIdentifier id,
const LanguageIdentifier* language) noexcept
{
CARB_UNUSED(table, id, language);
CARB_LOG_ERROR("localization is being used with carb.l10n.plugin not loaded");
return nullptr;
}
} // namespace l10n
} // namespace carb
/** Pointer to the interface for use from CARB_LOCALIZE(). Defined in @ref CARB_LOCALIZATION_GLOBALS. */
CARB_WEAKLINK CARB_HIDDEN carb::l10n::IL10n* g_carbLocalization;
/** Pointer to the function called by CARB_LOCALIZE(). Defined in @ref CARB_LOCALIZATION_GLOBALS. */
CARB_WEAKLINK CARB_HIDDEN carb::l10n::localizeStringFn g_localizationFn = carb::l10n::getLocalizedStringFromHashNoPlugin;
/* Exhale can't handle these for some reason and they aren't meant to be used directly */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace carb
{
namespace l10n
{
/** An internal helper for CARB_LOCALIZE()
* @param[in] id The hash of @p string.
* @param[in] string The localization keystring.
* @returns The translated string is a supported language is requested and
* the string with the requested hash is found in the table.
* @returns @p string if no translation is found in the table, if an
* unsupported language is requested, or if the key string has no
* mapping in the table.
* @returns An error message if the config setting to return noticeable
* failure strings is enabled.
*
* @note This is an internal implementation for CARB_LOCALIZE() as well as the
* script bindings. Do not directly call this function.
*/
inline const char* getLocalizedString(StringIdentifier id, const char* string) noexcept
{
const char* s = g_localizationFn(kLanguageTableMain, id, kLanguageCurrent);
return (s != nullptr) ? s : string;
}
} // namespace l10n
} // namespace carb
#endif
/** Look up a string from the localization database for the current plugin.
* @param string A string literal.
* This must not be nullptr.
* This is the key string to look up in the database.
*
* @returns The localized string for the keystring @p string, given the current
* localization that has been set for the process.
* @returns If there is no localized string for the given keystring @p string,
* the US English string will be returned.
* @returns If @p string is not found in the localization database at all,
* @p string will be returned.
* @returns An error message if the localized string is found and the config
* setting to return noticeable failure strings is enabled.
*/
#define CARB_LOCALIZE(string) carb::l10n::getLocalizedString(CARB_HASH_STRING(string), string)
| 29,066 | C | 51.467509 | 122 | 0.617113 |
omniverse-code/kit/include/carb/l10n/L10nUtils.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief The L10n interface.
*/
#pragma once
#include "../Framework.h"
#include "IL10n.h"
/** Placeholder for global scope work that needs to be done for localization. Do not call
* this directly. This is called by @ref CARB_GLOBALS().
*/
#define CARB_LOCALIZATION_GLOBALS()
namespace carb
{
namespace l10n
{
/** Called during client initialization to obtain the globals needed for localization. */
inline void registerLocalizationForClient() noexcept
{
g_carbLocalization = getFramework()->tryAcquireInterface<IL10n>();
if (g_carbLocalization != nullptr)
g_localizationFn = g_carbLocalization->getLocalizedStringFromHash;
}
/** Called during client shutdown to clear out the global state. */
inline void deregisterLocalizationForClient() noexcept
{
g_carbLocalization = nullptr;
g_localizationFn = carb::l10n::getLocalizedStringFromHashNoPlugin;
}
} // namespace l10n
} // namespace carb
| 1,378 | C | 28.97826 | 90 | 0.755443 |
omniverse-code/kit/include/carb/l10n/L10nBindingsPython.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "IL10n.h"
#include "L10nUtils.h"
namespace carb
{
namespace l10n
{
inline void definePythonModule(py::module& m)
{
m.doc() = "pybind11 carb.l10n bindings";
py::class_<LanguageTable>(m, "LanguageTable");
py::class_<LanguageIdentifier>(m, "LanguageIdentifier");
m.def("register_for_client", carb::l10n::registerLocalizationForClient,
R"(Register the l10n plugin for the current client.
This must be called before using any of the localization plugins, if
carb::startupFramework() has not been called.
This use case is only encountered in the tests. Standard Carbonite applications
call carb::startupFramework() so they should never have to call this.
If this is not called, the localization system will be non-functional.)",
py::call_guard<py::gil_scoped_release>());
m.def("deregister_localization_for_client", carb::l10n::deregisterLocalizationForClient,
R"(Deregister the localization plugin for the current client.
This can be called to deregister the localization plugin for the current client,
if carb::shutdownFramework will not be called.)",
py::call_guard<py::gil_scoped_release>());
m.def("get_localized_string",
[](const char* string) {
return carb::l10n::getLocalizedString(
(g_carbLocalization == nullptr) ? 0 : g_carbLocalization->getHashFromKeyString(string), string);
},
R"(Retrieve a string from the localization database, given its hash.
This function retrieves a localized string based on the hash of the keystring.
This should be used on all strings found in the UI, so that they can
automatically be shown in the correct language. Strings returned from this
function should never be cached, so that changing the language at runtime will
not result in stale strings being shown in the UI.
Args:
string: The keystring that identifies the set of localized strings to
return. This will typically correspond to the US English string
for this UI text. This string will be returned if there is no
localization table entry for this key.
Returns:
The localized string for the input hash in the currently set language, if
a string exists for that language.
If no localized string from the currently set language exists for the hash,
the US English string will be returned.
If the hash is not found in the localization database, the string parameter
will be returned. Alternatively, if a config setting is enabled, error
messages will be returned in this case.)",
py::call_guard<py::gil_scoped_release>());
m.def("get_hash_from_key_string",
[](const char* string) {
return (g_carbLocalization == nullptr) ? 0 : g_carbLocalization->getHashFromKeyString(string);
},
R"(Hash a keystring for localization.
This hashes a keystring that can be looked up with carb_localize_hashed().
Strings must be hashed before passing them into carb_localize_hashed(); this is done
largely so that automated tools can easily find all of the localized strings in
scripts by searching for this function name.
In cases where a string will be looked up many times, it is ideal to cache the
hash returned, so that it is not recalculated excessively.
Args:
string: The keystring to hash.
This must be a string.
This must not be None.
Returns:
The hash for the string argument.
This hash can be used in carb_localize_hashed().)",
py::call_guard<py::gil_scoped_release>());
m.def("get_localized_string_from_hash",
[](StringIdentifier id, const char* string) { return carb::l10n::getLocalizedString(id, string); },
R"(Retrieve a string from the localization database, given its hash.
This function retrieves a localized string based on the hash of the keystring.
This should be used on all strings found in the UI, so that they can
automatically be shown in the correct language. Strings returned from this
function should never be cached, so that changing the language at runtime will
not result in stale strings being shown in the UI.
Args:
id: A hash that was previously returned by hash_localization_string().
string: The keystring that was hashed with hash_localization_string().
This is passed to ensure that a readable string is returned if
the hash is not found in the localization table.
Returns:
The localized string for the input hash in the currently set language, if
a string exists for that language.
If no localized string from the currently set language exists for the hash,
the US English string will be returned.
If the hash is not found in the localization database, the string parameter
will be returned. Alternatively, if a config setting is enabled, error
messages will be returned in this case.)",
py::arg("id") = 0, py::arg("string") = "{TRANSLATION NOT FOUND}", py::call_guard<py::gil_scoped_release>());
}
} // namespace l10n
} // namespace carb
| 5,576 | C | 40.619403 | 118 | 0.720947 |
omniverse-code/kit/include/carb/crashreporter/ICrashReporter.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
///! @file
///! @brief Main interface header for ICrashReporter and related types and values.
#pragma once
#include "../Interface.h"
#include "../Types.h"
namespace carb
{
/** Namespace for the crash reporter. */
namespace crashreporter
{
/** Prototype for a callback that indicates when a crash dump upload has completed.
*
* @param[in] userData The opaque user data object that was originally passed to the
* @ref ICrashReporter::sendAndRemoveLeftOverDumpsAsync() function
* in the @a userData parameter.
* @returns No return value.
*
* @remarks This callback function will be performed when the upload of old crash dump files
* has completed, successfully or otherwise. At this point, the upload request made
* by the corresponding @ref ICrashReporter::sendAndRemoveLeftOverDumpsAsync() call
* has completed. However, this does not necessarily mean that the thread created
* by it has exited. If another call was made, a new request would have been queued
* on that same thread and would be serviced next by the same thread.
*
* @note This callback is both separate and different from the callback specified by the
* @ref OnCrashSentFn prototype. This particular callback is only performed when the
* full upload request of all existing old crash dump files completes whereas the
* @ref OnCrashSentFn callback is performed every time any single upload completes.
*/
using OnDumpSubmittedFn = void (*)(void* userData);
/** Result codes used to notify subscribers of crash dump uploads whether an upload succeed
* or not. These result codes are passed to the callback function specified in calls to
* @ref ICrashReporter::addCrashSentCallback().
*/
enum class CrashSentResult
{
eSuccess, ///< The upload completed successfully.
eFailure ///< The upload failed for some unspecified reason.
};
/** Possible types that a volatile metadata value could be. These are used to determine which
* type of value is to be returned from a volatile metadata callback function and how that value
* is to be converted into a string to be sent as metadata. The return type of the callback is
* split into common primitive types to discourage implementors of the callbacks from using their
* own potentially dangerous methods of converting the metadata value to a string.
*/
enum class MetadataValueType
{
eInteger, ///< The callback will return a signed 64-bit integer value.
eUInteger, ///< The callback will return an unsigned 64-bit integer value.
eFloat, ///< The callback will return a 64-bit floating point value.
eString, ///< The callback will return an arbitrary length UTF-8 encoded string.
eWideString, ///< The callback will return an arbitrary length wide string (`wchar_t` characters).
};
/** Provides a single piece of additional information or context to a crash upload complete
* callback function. This is stored as a key/value pair. An array of these objects is
* passed to the @ref OnCrashSentFn callback to provide extra context to why a crash dump
* upload may have failed or additional information about a successful upload. This
* information is typically only useful for display to a user or to be output to a log.
*/
struct CrashSentInfo
{
const char* key; ///< The key name for this piece of information.
const char* value; ///< The specific value associated with the given key.
};
/** Prototype for a callback function that is performed any time a dump is successfully uploaded.
*
* @param[in] crashSentResult The result code of the upload operation. Currently this only
* indicates whether the upload was successful or failed. Further
* information about the upload operation can be found in the
* @p infoData array.
* @param[in] infoData An array of zero or more key/value pairs containing additional
* information for the upload operation. On failure, this may
* include the status code or status message from the server. On
* success, this may include a unique fingerprint for the crash
* dump that was uploaded. This array will contain exactly
* @p infoDataCount items.
* @param[in] infoDataCount The total number of items in the @p infoData array.
* @param[in] userData The opaque caller specified data object that was provided when
* this callback was originally registered. It is the callee's
* responsibility to know how to successfully make use of this
* value.
* @returns No return value.
*
* @remarks This callback is performed every time a crash dump file upload completes. This
* will be called whether the upload is successful or not. This will not however
* be called if crash dump uploads are disabled (ie: the
* `/crashreporter/devOnlyOverridePrivacyAndForceUpload` setting is false and the
* user has not provided 'performance' consent) or the file that an upload was requested
* for was missing some required metadata (ie: the `/crashreporter/product` and
* `/crashreporter/version` settings). In both those cases, no upload attempt will be
* made.
*
* @remarks The following key/value pair is defined for this callback when using the
* `carb.crashreporter-breakpad.plugin` implementation:
* * "response": A string containing the HTTP server's response to the upload
* attempt. If this string needs to persist, it must be copied
* by the callee.
*
* @thread_safety Calls to this callback will be serialized. It is however the callee's
* responsibility to safely access any additional objects including the
* @p userData object and any global resources.
*/
using OnCrashSentFn = void (*)(CrashSentResult crashSentResult,
const CrashSentInfo* infoData,
size_t infoDataCount,
void* userData);
/** Opaque handle for a single registered @ref OnCrashSentFn callback function. This is
* returned from ICrashReporter::addCrashSentCallback() and can be passed back to
* ICrashReporter::removeCrashSentCallback() to unregister it.
*/
struct CrashSentCallbackId;
/** Prototype for a callback function used to resolve symbol information.
*
* @param[in] address The address of the symbol being resolved.
* @param[in] name If the symbol resolution was successful, this will be the name of the
* symbol that @p address is contained in. If the resolution fails, this
* will be `nullptr`. If non-`nullptr`, this string must be copied before
* returning from the callback function if it needs to persist.
* @param[in] userData The opaque user data passed to the @ref ICrashReporter::resolveSymbol()
* function.
* @returns No return value.
*
* @remarks This callback is used to deliver the results of an attempt to resolve the name of
* a symbol in the current process. This callback is always performed synchronously
* to the call to ICrashReporter::resolveSymbol().
*/
using ResolveSymbolFn = void (*)(const void* address, const char* name, void* userData);
/** Metadata value callback function prototype.
*
* @param[in] context The opaque context value that was used when the metadata value was
* originally registered.
* @returns The current value of the metadata at the time of the call.
*
* @note Because these callbacks may be called during the handling of a crash, the calling thread
* and other threads may be in an unstable or undefined state when these are called.
* Implementations of these callbacks should avoid any allocations and locks if in any way
* avoidable. See ICrashReporter::addVolatileMetadataValue() for more information on how
* these callbacks should behave.
*/
using OnGetMetadataIntegerFn = int64_t (*)(void* context);
/** @copydoc OnGetMetadataIntegerFn */
using OnGetMetadataUIntegerFn = uint64_t (*)(void* context);
/** @copydoc OnGetMetadataIntegerFn */
using OnGetMetadataFloatFn = double (*)(void* context);
/** Metadata value callback function prototype.
*
* @param[out] buffer Receives the string value. This must be UTF-8 encoded and must not
* exceed @p maxLength bytes including the null terminator. This buffer
* will never be `nullptr`. Writing a null terminator is optional.
* @param[in] maxLength The maximum number of bytes including the null terminator that can fit
* in the buffer @p buffer. This will never be 0. It is the callback's
* responsibility to ensure no more than this many bytes is written to
* the output buffer.
* @param[in] context The opaque context value that was used when the metadata value was
* originally registered.
* @returns The total number of bytes **not including the null terminator character** that were
* written to the output buffer. This value **MUST** not exceed \p maxLength.
*/
using OnGetMetadataStringFn = size_t (*)(char* buffer, size_t maxLength, void* context);
/** Metadata value callback function prototype.
*
* @param[out] buffer Receives the string value. This must be wide characters (`wchar_t`) and not
* exceed @p maxLength *characters* including the null terminator. This buffer
* will never be `nullptr`. Writing a null terminator is optional.
* @param[in] maxLength The maximum number of *characters* including the null terminator that can fit
* in the buffer @p buffer. This will never be 0. It is the callback's
* responsibility to ensure no more than this many characters is written to
* the output buffer.
* @param[in] context The opaque context value that was used when the metadata value was
* originally registered.
* @returns The total number of *characters* **not including any null terminator** that were
* written to the output buffer. This value **MUST** not exceed \p maxLength.
*/
using OnGetMetadataWideStringFn = size_t (*)(wchar_t* buffer, size_t maxLength, void* context);
/** Descriptor of a single metadata callback function. This describes which type of callback is
* being contained and the pointer to the function to call.
*/
struct MetadataValueCallback
{
/** The type of the callback. This indicates which of the callbacks in the @ref fn union
* below will be called to retrieve the value.
*/
MetadataValueType type;
/** A union containing the different types of function pointers for this callback. Exactly
* one of these will be chosen based on @ref type.
*/
union
{
OnGetMetadataIntegerFn getInteger; ///< Callback returning a signed 64-bit integer.
OnGetMetadataUIntegerFn getUInteger; ///< Callback returning an unsigned 64-bit integer.
OnGetMetadataFloatFn getFloat; ///< Callback returning a 64-bit floating point value.
OnGetMetadataStringFn getString; ///< Callback returning an arbitrary length string.
OnGetMetadataWideStringFn getWString; ///< Callback returning an arbitrary length wide string.
} fn;
};
/** Registration identifier for a single metadata value. This is only used to unregister the
* callback that was registered with the original metadata.
*/
using MetadataId = size_t;
/** Special metadata identifier to indicate an invalid metadata value or general failure in
* registering the value with addVolatileMetadata*().
*/
constexpr MetadataId kInvalidMetadataId = (MetadataId)(-1ll);
/** Special metadata identifier to indicate that a bad parameter was passed into one of the
* ICrashReporter::addVolatileMetadata*() functions. This is not a valid identifier and will be
* ignored if passed to ICrashReporter::removeVolatileMetadataValue().
*/
constexpr MetadataId kMetadataFailBadParameter = (MetadataId)(-2ll);
/** Special metadata identifier to indicate that the key being registered is either a known
* reserved key or has already been registered as a volatile metadata key. This is not a valid
* identifier and will be ignored if passed to ICrashReporter::removeVolatileMetadataValue().
*/
constexpr MetadataId kMetadataFailKeyAlreadyUsed = (MetadataId)(-3ll);
/** ICrashReporter is the interface to implement a plugin that catches and reports information
* about the crash to either a local file, a server, or both.
*
* ICrashReporter is an optional plugin that is automatically loaded by the framework and doesn't
* need to be specifically listed in the configuration. If an ICrashReporter plugin is found,
* it's enabled. Only one ICrashReporter instance is supported at a time.
*
* The crash report itself consists of multiple parts. Some parts are only present on certain
* supported platforms. All generated crash dump files will appear in the directory named by the
* "/crashreporter/dumpDir" setting. If no value is provided, the current working directory
* is used instead. The following parts could be expected:
* * A minidump file. This is only generated on Windows. This file will contain the state of
* the process's threads, stack memory, global memory space, register values, etc at the time
* of the crash. This file will end in '.dmp'.
* * A stack trace of the crash point file. This could be produced on all platforms. This
* file will end in '.txt'.
* * A metadata file. This is a TOML formatted file that contains all the metadata values that
* were known by the crash reporter at the time of the crash. This file will end in '.toml'.
*
* The crash reporter may have any number of arbitrary metadata values associated with it. These
* values are defined as key/value pair strings. There are two ways a metadata value can be
* defined:
* * Add a value to the `/crashreporter/data/` branch of the settings registry. This can be
* done directly through the ISettings interface, adding a value to one of the app's config
* files, or by using the addCrashMetadata() utility function. These values should be set
* once and either never or very rarely modified. There is a non-trivial amount of work
* related to collecting a new metadata value in this manner that could lead to an overall
* performance impact if done too frequently.
* * Add a key and data callback to collect the current value of a metadata key for something
* that changes frequently. This type of metadata value is added with addVolatileMetadata()
* on this interface. These values may change as frequently as needed. The current value
* will only ever be collected when a crash does occur or when the callback is removed.
*
* Once a metadata value has been added to the crash reporter, it cannot be removed. The value
* will remain even if the key is removed from `/crashreporter/data/` or its value callback is
* removed. This is intentional so that as much data as possible can be collected to be sent
* with the crash report as is possible.
*
* If a metadata key is registered as a volatile value, it will always override a key of the
* same name that is found under the `/crashreporter/data/` branch of the settings registry.
* Even if the volatile metadata value is removed or unregistered, it will still override any
* key of the same name found in the settings registry.
*
* Metadata key names may or may not be case sensitive depending on their origin. If a metadata
* value comes from the settings registry, its name is case sensitive since the settings registry
* is also case sensitive. Metadata values that are registered as volatile metadata values do
* not have case sensitive names. Attempting to register a new value under the same key but with
* different casing will fail since it would overwrite an existing name. This difference is
* intentional to avoid confusion in the metadata output. When adding metadata values through
* the settings registry, care should be taken to use consistent casing to avoid confusion in
* the output.
*/
struct ICrashReporter
{
// 2.3: Added MetadataValueType::eWideString
CARB_PLUGIN_INTERFACE("carb::crashreporter::ICrashReporter", 2, 3)
/**
* Upon crash, a crash dump is written to disk, uploaded, and then removed. However, due to settings or because the
* application is in an undefined state, the upload may fail. This method can be used on subsequent runs of the
* application to attempt to upload/cleanup previous failed uploads.
*
* This method returns immediately, performing all uploads/removals asynchronously. Supply an optional callback to
* be notified when the uploads/removals have been completed. The callback will be performed regardless of whether
* the upload is successful. However, each crash dump file will only be removed from the local file system if its
* upload was successful and the "/crashreporter/preserveDump" setting is `false`. A future call to this function
* will try the upload again on failed crash dumps.
*
* The callback will be performed on the calling thread before return if there is no upload task to perform or if
* the crash reporter is currently disabled. In all other cases, the callback will be performed in the context of
* another thread. It is the caller's responsibility to ensure all accesses made in the callback are thread safe.
* The supplied callback may neither directly nor indirectly access this instance of ICrashReporter.
*
* @thread_safety This method is thread safe and can be called concurrently.
*
* @param onDumpSubmitted The callback function to be called when the dumps are uploaded and deleted.
* @param userData The user data to be passed to the callback function.
*/
void(CARB_ABI* sendAndRemoveLeftOverDumpsAsync)(OnDumpSubmittedFn onDumpSubmitted, void* userData);
/**
* Adds a new callback that is called after sending (successfully or not) a crash dump to a server.
*
* Registration of multiple callbacks is allowed and all registered callbacks will be called serially (the order in
* which callbacks are called is undefined). It is allowed to use the same callback function (and userData) multiple
* times.
*
* This method is thread safe and can be called concurrently.
*
* The supplied callback may neither directly nor indirectly access this instance of ICrashReporter.
*
* @param onCrashSent The new callback to register, must not be nullptr.
* @param userData The user data to be passed to the callback function, can be nullptr.
*
* @return Not null if the provided callback was successfully registered, nullptr otherwise.
*/
CrashSentCallbackId*(CARB_ABI* addCrashSentCallback)(OnCrashSentFn onCrashSent, void* userData);
/**
* Removes previously registered callback.
*
* This method is thread safe and can be called concurrently.
*
* The given parameter is the id returned from addCrashSentCallback.
*
* The given callback id can be nullptr or an invalid id.
*
* @param callbackId The callback to remove. A null or invalid pointer is accepted (though may produce an error
* message).
*/
void(CARB_ABI* removeCrashSentCallback)(CrashSentCallbackId* callbackId);
/**
* Attempts to resolve a given address to a symbolic name using debugging features available to the system.
*
* If symbol resolution fails or is not available, @p func is called with a `nullptr` name.
*
* @note This function can be extremely slow. Use for debugging only.
*
* @param address The address to attempt to resolve.
* @param func The func to call upon resolution
* @param user User-specific data to be passed to @p func
*
* @thread_safety The callback function is always performed synchronously to this call. It
* is the callee's responsibility to ensure safe access to both the @p user
* pointer and any global resources.
*/
void(CARB_ABI* resolveSymbol)(const void* address, ResolveSymbolFn func, void* user);
/** Adds a new volatile metadata value to the crash report.
*
* @param[in] keyName The name of the metadata key to set. This must only contain
* printable ASCII characters except for a double quote ('"'),
* slash ('/'), or whitespace. It is the caller's responsibility
* to ensure the key name will not be overwriting another system's
* metadata value. One way to do this is to prefix the key name
* with the name of the extension or plugin (sanitized to follow
* the above formatting rules). Volatile metadata key names are
* not case sensitive. This may not be nullptr or an empty string.
* @param[in] maxLength The maximum number of characters, including the null terminator,
* that the metadata's value will occupy when its value is retrieved.
* This is ignored for integer and floating point values (the maximum
* size for those types will always be used regardless of the value).
* When retrieved, if the value is longer than this limit, the new
* metadata value will truncated. This may be 0 for integer and
* floating point value types. For string values, there may be
* an arbitrary amount of extra space added internally. This is
* often for padding or alignment purposes. Callers should however
* neither count on this space being present nor expect any strings
* to always be truncated at an exact length.
* @param[in] callback The callback and data type that will provide the value for the new
* metadata key. This may not contain a `nullptr` callback function.
* See below for notes on what the callback function may and may not
* do.
* @param[in] context An opaque context pointer that will be passed to the callback
* function when called. This will not be accessed or evaluated in
* any way, but must remain valid for the entire duration that the
* callback is registered here.
* @returns An identifier that can be used to unregister the callback in the event that the
* owning module needs to be unloaded. It is the caller's responsibility to ensure
* that the metadata callback is properly unregistered with a call to
* removeVolatileMetadataValue() before it unloads.
*
* @retval kMetadataFailBadParameter if an invalid parameter is passed in.
* @retval kMetadataFailKeyAlreadyUsed if the given key name is already in use or is a reserved name.
* @retval kInvalidMetadataId if a crash dump is currently in progress during this call.
*
* @remarks This registers a new volatile metadata value with the crash reporter. This new
* value includes a callback that will be used to acquire the most recent value of
* the metadata key when a crash does occur. The value may be provided as either a
* signed or unsigned integer (64 bit), a floating point value (64 bit), or a string
* of arbitrary length. Callback types are intentionally provided for each type to
* discourage the implementations from doing their own string conversions that could
* be dangerous while handling a crash event.
*
* @remarks Because the process may be in an unstable or delicate state when the callback
* is performed to retrieve the metadata values, there are several restrictions on
* what the callback function can and cannot do. In general, the callback function
* should provide the metadata value as quickly and simply as possible. An ideal
* case would be just to return the current value of a local, global, or member
* variable. Some guidelines are:
* * Do not perform any allocations or call into anything that may perform an
* allocation. At the time of a crash many things could have gone wrong and the
* allocations could fail or hang for various reasons.
* * Do not use any STL container classes other than to retrieve a current value.
* Many STL container class operations can implicitly perform an allocation
* to resize a buffer, array, new node, etc. If a resize, copy, or assign
* operation is unavoidable, try to use a container class that provides the
* possibility to reserve space for expected operations early (ie: string,
* vector, etc).
* * Avoid doing anything that may use a mutex or other locking primitive that
* is not in a strictly known state at the time. During a crash, the state of
* any lock could be undefined leading to a hang if an attempt is made to
* acquire it. If thread safety is a concern around accessing the value, try
* using an atomic variable instead of depending on a lock.
* * Do not make any calls into ICrashReporter from the callback function. This
* will result in a deadlock.
* * Under no circumstances should a new thread be created by the callback.
*
* @note The addVolatileMetadata() helper functions have been provided to make it easier
* to register callbacks for each value type. Using these is preferable to calling
* into internalAddVolatileMetadata() directly.
*
* @sa internalAddVolatileMetadata(), addVolatileMetadata().
*/
/** @private */
MetadataId(CARB_ABI* internalAddVolatileMetadata)(const char* keyName,
size_t maxLength,
MetadataValueCallback* callback,
void* context);
/** Adds a new volatile metadata value to the crash report.
*
* @param[in] keyName The name of the metadata key to set. This must only contain
* printable ASCII characters except for a double quote ('"'),
* slash ('/'), or whitespace. It is the caller's responsibility
* to ensure the key name will not be overwriting another system's
* metadata value. One way to do this is to prefix the key name
* with the name of the extension or plugin (sanitized to follow
* the above formatting rules). Volatile metadata key names are
* not case sensitive. This may not be `nullptr` or an empty string.
* @param[in] callback The callback function that will provide the value for the new
* metadata key. This may not be a `nullptr` callback function.
* See below for notes on what the callback function may and may not
* do.
* @param[in] context An opaque context pointer that will be passed to the callback
* function when called. This will not be accessed or evaluated in
* any way, but must remain valid for the entire duration that the
* callback is registered here.
* @returns An identifier that can be used to unregister the callback in the event that the
* owning module needs to be unloaded. It is the caller's responsibility to ensure
* that the metadata callback is properly unregistered with a call to
* removeVolatileMetadataValue() before it unloads.
*
* @retval kMetadataFailBadParameter if an invalid parameter is passed in.
* @retval kMetadataFailKeyAlreadyUsed if the given key name is already in use or is a reserved name.
* @retval kInvalidMetadataId if a crash dump is currently in progress during this call.
*
* @remarks This registers a new volatile metadata value with the crash reporter. This new
* value includes a callback that will be used to acquire the most recent value of
* the metadata key when a crash does occur. The value may be provided as either a
* signed or unsigned integer (64 bit), a floating point value (64 bit), or a string
* of arbitrary length. Callback types are intentionally provided for each type to
* discourage the implementations from doing their own string conversions that could
* be dangerous while handling a crash event.
*
* @remarks Because the process may be in an unstable or delicate state when the callback
* is performed to retrieve the metadata values, there are several restrictions on
* what the callback function can and cannot do. In general, the callback function
* should provide the metadata value as quickly and simply as possible. An ideal
* case would be just to return the current value of a local, global, or member
* variable. Some guidelines are:
* * Do not perform any allocations or call into anything that may perform an
* allocation. At the time of a crash, many things could have gone wrong and
* allocations could fail or hang for various reasons.
* * Do not use any STL container classes other than to retrieve a current value.
* Many STL container class operations can implicitly perform an allocation
* to resize a buffer, array, new node, etc. If a resize, copy, or assign
* operation is unavoidable, try to use a container class that provides the
* possibility to reserve space for expected operations early (ie: string,
* vector, etc).
* * Avoid doing anything that may use a mutex or other locking primitive that
* is not in a strictly known state at the time. During a crash, the state of
* any lock could be undefined leading to a hang if an attempt is made to
* acquire it. If thread safety is a concern around accessing the value, try
* using an atomic variable instead of depending on a lock.
* * Do not make any calls into ICrashReporter from the callback function. This
* will result in a deadlock.
* * Under no circumstances should a new thread be created by the callback.
*
* @thread_safety This call is thread safe.
*/
MetadataId addVolatileMetadata(const char* keyName, OnGetMetadataIntegerFn callback, void* context);
/** @copydoc addVolatileMetadata(const char*,OnGetMetadataIntegerFn,void*) */
MetadataId addVolatileMetadata(const char* keyName, OnGetMetadataUIntegerFn callback, void* context);
/** @copydoc addVolatileMetadata(const char*,OnGetMetadataIntegerFn,void*) */
MetadataId addVolatileMetadata(const char* keyName, OnGetMetadataFloatFn callback, void* context);
/** @copydoc addVolatileMetadata(const char*,OnGetMetadataIntegerFn,void*)
* @param[in] maxLength The maximum number of characters, including the null terminator,
* that the metadata's value will occupy when its value is retrieved.
* When retrieved, if the value is longer than this limit, this new
* metadata value will be truncated. There may be an arbitrary
* amount of extra space added internally. This is often done for
* padding or alignment purposes. Callers should however neither
* count on this space being present nor expect any strings to always
* be truncated at an exact length.
*/
MetadataId addVolatileMetadata(const char* keyName, size_t maxLength, OnGetMetadataStringFn callback, void* context);
/** @copydoc addVolatileMetadata(const char*,size_t,OnGetMetadataStringFn,void*) */
MetadataId addVolatileMetadata(const char* keyName, size_t maxLength, OnGetMetadataWideStringFn callback, void* context);
/** Removes a previously registered volatile metadata value.
*
* @param[in] id The identifier of the metadata value to remove. This was returned from
* a previous successful call to addVolatileMetadata*(). This call will be
* ignored if the identifier is invalid.
* @returns No return value.
*
* @remarks This removes a volatile metadata value from the crash reporter. The value will
* be retrieved from the callback and stored internally before it is removed from
* the crash reporter. The given identifier will be invalid upon return.
*
* @sa internalAddVolatileMetadata(), addVolatileMetadata().
*/
void(CARB_ABI* removeVolatileMetadataValue)(MetadataId id);
};
inline MetadataId ICrashReporter::addVolatileMetadata(const char* keyName, OnGetMetadataIntegerFn callback, void* context)
{
MetadataValueCallback data;
data.type = MetadataValueType::eInteger;
data.fn.getInteger = callback;
return internalAddVolatileMetadata(keyName, 0, &data, context);
}
inline MetadataId ICrashReporter::addVolatileMetadata(const char* keyName, OnGetMetadataUIntegerFn callback, void* context)
{
MetadataValueCallback data;
data.type = MetadataValueType::eUInteger;
data.fn.getUInteger = callback;
return internalAddVolatileMetadata(keyName, 0, &data, context);
}
inline MetadataId ICrashReporter::addVolatileMetadata(const char* keyName, OnGetMetadataFloatFn callback, void* context)
{
MetadataValueCallback data;
data.type = MetadataValueType::eFloat;
data.fn.getFloat = callback;
return internalAddVolatileMetadata(keyName, 0, &data, context);
}
inline MetadataId ICrashReporter::addVolatileMetadata(const char* keyName,
size_t maxLength,
OnGetMetadataStringFn callback,
void* context)
{
MetadataValueCallback data;
data.type = MetadataValueType::eString;
data.fn.getString = callback;
return internalAddVolatileMetadata(keyName, maxLength, &data, context);
}
inline MetadataId ICrashReporter::addVolatileMetadata(const char* keyName,
size_t maxLength,
OnGetMetadataWideStringFn callback,
void* context)
{
MetadataValueCallback data;
data.type = MetadataValueType::eWideString;
data.fn.getWString = callback;
return internalAddVolatileMetadata(keyName, maxLength, &data, context);
}
} // namespace crashreporter
} // namespace carb
| 37,221 | C | 59.62215 | 125 | 0.665834 |
omniverse-code/kit/include/carb/crashreporter/CrashReporterUtils.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
///! @file
///! @brief Utility helper functions for the crash reporter.
#pragma once
#include "../Framework.h"
#include "../InterfaceUtils.h"
#include "../logging/Log.h"
#include "../settings/ISettings.h"
#include "ICrashReporter.h"
#if CARB_PLATFORM_WINDOWS && !defined(_DLL)
# include "../CarbWindows.h"
# include "../extras/Library.h"
#endif
#include <signal.h>
#include <string.h>
#include <future>
/** Global accessor object for the loaded ICrashReporter object. This is intended to be used
* as a shortcut for accessing the @ref carb::crashreporter::ICrashReporter instance if the
* crash reporter plugin has been loaded in the process. This will be `nullptr` if the
* crash reporter plugin is not loaded. This symbol is unique to each plugin module and
* will be filled in by the framework upon load if the crash reporter plugin is present.
* Callers should always check if this value is `nullptr` before accessing it. This should
* not be accessed during or after framework shutdown.
*/
CARB_WEAKLINK carb::crashreporter::ICrashReporter* g_carbCrashReporter;
#ifdef DOXYGEN_BUILD
/** Defines global symbols specifically related to the crash reporter. */
# define CARB_CRASH_REPORTER_GLOBALS()
#else
// only install the signal handler for modules that have been statically linked to the
// Windows CRT (OVCC-1379). This is done because plugins that statically link to the
// CRT have their own copies of the signal handlers table and the crash reporter is
// unable to directly manipulate those. By setting the signal handler here in the
// context of the statically linked plugin, we provide a way to relay that abort
// signal to the crash reporter.
# if CARB_PLATFORM_WINDOWS && !defined(_DLL)
# if !CARB_COMPILER_MSC
static_assert(false, "Unsupported compiler!");
# endif
# define CARB_CRASH_REPORTER_GLOBALS() \
bool g_carbSignalHandlerInstalled = carb::crashreporter::detail::installSignalHandler();
namespace carb
{
namespace crashreporter
{
namespace detail
{
/** Installs a SIGABRT signal handler to act as a relay.
*
* @returns `true` if the signal handler is successfully installed. Returns `false` otherwise.
*
* @remarks This installs a SIGABRT signal handler to act as an event relay for plugins and apps
* that are statically linked to the Windows CRT. This allows each statically linked
* module's own signal handler chain to catch `abort()` and `std::terminate()` calls
* and pass that on to a special handler function in `carb.dll` that will then relay
* the event to the crash reporter plugin.
*
* @note This signal handler can be disabled by defining the `CARB_DISABLE_ABORT_HANDLER`
* environment variable and setting its value to '1'.
*
* @note This should not be called directly. This is called automatically as needed during
* plugin and app load.
*/
inline bool installSignalHandler()
{
using SignalHandlerFn = void (*)(int);
static bool disableHandler = []() {
WCHAR envVarValue[32] = { 0 };
return GetEnvironmentVariableW(L"CARB_DISABLE_ABORT_HANDLER", envVarValue, CARB_COUNTOF32(envVarValue)) != 0 &&
envVarValue[0] == '1' && envVarValue[1] == '\0';
}();
if (disableHandler)
return false;
static SignalHandlerFn handler = []() -> SignalHandlerFn {
SignalHandlerFn fn;
carb::extras::LibraryHandle handle = carb::extras::loadLibrary(
"carb", carb::extras::fLibFlagMakeFullLibName | carb::extras::fLibFlagLoadExisting);
if (handle == carb::extras::kInvalidLibraryHandle)
return nullptr;
fn = carb::extras::getLibrarySymbol<SignalHandlerFn>(handle, "carbSignalHandler");
if (fn == nullptr)
{
carb::extras::unloadLibrary(handle);
return nullptr;
}
return fn;
}();
if (handler == nullptr)
return false;
// install the signal handler for this thread in this module. Since signals on Windows
// are a bonus feature and rarely used, we don't care about preserving the previous
// signal handler.
signal(SIGABRT, handler);
return true;
}
} // namespace detail
} // namespace crashreporter
} // namespace carb
# else
# define CARB_CRASH_REPORTER_GLOBALS()
# endif
#endif
namespace carb
{
/** Namespace for the crash reporter. */
namespace crashreporter
{
/** Base magic signature value used to verify crash reporter resources. The lower 8 bits of this
* value can be incremented to allow for different versions of this resources this signature
* protects.
*/
constexpr uintptr_t kBaseMagicSignature = 0xc7a547e907137700ull;
/** Current magic signature used to verify crash reporter resources. This value is intended to
* be incremented for versioning purposes if the handling of the crash reporter resources needs
* to change in the future.
*/
constexpr uintptr_t kMagicSignature = kBaseMagicSignature;
#if CARB_PLATFORM_LINUX || defined(DOXYGEN_BUILD)
/** Signal number to use to handle external termination requests. This signal is intentionally
* a seldom used one so that it is unlikely to interfere with other normal signal usage in the
* process. Even with the rarely used signal, we'll still include other safety checks on the
* received signal before scheduling an intentional termination.
*/
static int kExternalTerminationSignal = SIGRTMAX - 1;
#elif CARB_PLATFORM_MACOS
/** MacOS doesn't support realtime signals. We'll use SIGUSR2 instead. */
constexpr int kExternalTerminationSignal = SIGUSR2;
#endif
/** Registers the crash reporter for this process and sets it up.
*
* @returns No return value.
*
* @remarks This installs the crash reporter in the calling process. This will include
* installing the crash handler hook and setting up its state according to the
* current values in the `/crashreporter/` branch of the settings registry.
* If the ISettings interface is not available, the crash reporter will only
* use its default settings and many features will be disabled. In this case
* the disabled features will include monitoring for changes to the various
* `/crashreporter/` settings, specifying metadata to include in crash reports,
* and controlling how and where the crash dump files are written out.
*
* @note When the process is shutting down, the crash reporter should be disabled
* by calling @ref carb::crashreporter::deregisterCrashReporterForClient().
* It is the host app's responsibility to properly disable the crash reporter
* before the plugin is unloaded.
*
* @thread_safety This operation is not thread safe. It is the caller's responsibility
* to ensure this is only called from a single thread at any given time.
* However, this will be automatically called during Carbonite framework
* startup (in carb::startupFramework()) and does not necessarily need
* to be called directly.
*/
inline void registerCrashReporterForClient()
{
g_carbCrashReporter = getFramework()->tryAcquireInterface<ICrashReporter>();
}
/** Deregisters and disables the crash reporter for the calling process.
*
* @returns No return value.
*
* @remarks This removes the crash reporter interface from the global variable
* @ref g_carbCrashReporter so that callers cannot access it further.
* The crash reporter plugin is also potentially unloaded.
*
* @thread_safety This operation is not thread safe. It is the caller's responsibility
* to ensure this is only called from a single thread at any given time.
* However, this will be automatically called during Carbonite framework
* shutdown (in carb::shutdownFramework()) and does not necessarily need
* to be called directly.
*/
inline void deregisterCrashReporterForClient()
{
if (g_carbCrashReporter)
{
getFramework()->releaseInterface(g_carbCrashReporter);
g_carbCrashReporter = nullptr;
}
}
/** Attempts to upload any crash dump files left by a previously crashed process.
*
* @returns A future that can be used to check on the completion of the upload operation.
* The operation is fully asynchronous and will proceed on its own. The future
* object will be signaled once the operation completes, successfully or otherwise.
*
* @remarks This starts off the process of checking for and uploading old crash dump files
* that may have been left over by a previous crashed process. This situation can
* occur if the upload failed in the previous process (ie: network connection
* issue, etc), or the process crashed again during the upload. A list of old
* crash dump files will be searched for in the currently set dump directory
* (as set by `/crashreporter/dumpDir`). If any are found, they will be uploaded
* one by one to the currently set upload URL (`/crashreporter/url`). Each
* crash dump file will be uploaded with its original metadata if the matching
* metadata file can be found. Once a file has been successfully uploaded to
* the given upload URL, it will be deleted from local storage unless the
* `/crashreporter/preserveDump` setting is `true`. This entire process will
* be skipped if the `/crashreporter/skipOldDumpUpload` setting is `true` and
* this call will simply return immediately.
*
* @thread_safety This function is thread safe. If multiple calls are made while an upload
* is still in progress, a new task will just be added to the upload queue
* instead of starting off another upload thread.
*
* @note If an upload is in progress when the process tries to exit or the crash reporter
* plugin tries to unload, any remaining uploads will be canceled, but the current
* upload operation will wait to complete. If this is a large file being uploaded
* or the internet connection's upload speed is particularly slow, this could potentially
* take a long time. There is unfortunately no reliable way to cancel this upload
* in progress currently.
*/
inline std::future<void> sendAndRemoveLeftOverDumpsAsync()
{
std::unique_ptr<std::promise<void>> sentPromise(new std::promise<void>());
std::future<void> sentFuture(sentPromise->get_future());
if (g_carbCrashReporter)
{
const auto finishCallback = [](void* promisePtr) {
auto sentPromise = reinterpret_cast<std::promise<void>*>(promisePtr);
sentPromise->set_value();
delete sentPromise;
};
g_carbCrashReporter->sendAndRemoveLeftOverDumpsAsync(finishCallback, sentPromise.release());
}
else
{
CARB_LOG_WARN("No crash reporter present, dumps uploading isn't available.");
sentPromise->set_value();
}
return sentFuture;
}
/** Namespace for internal helper functions. */
namespace detail
{
/** Sanitizes a string to be usable as a key name in the settings registry.
*
* @param[in] keyName The key string to be sanitized. This may be any string in theory, but
* should really be a short descriptive name for a crash metadata value or
* extra crash file. All non-ASCII, non-numeric characters will be replaced
* with underscores.
* @returns A string containing the sanitized key name.
*
* @note This is called internally by the addExtraCrashFile() and isExtraCrashFileKeyUsed()
* functions and should not be called directly.
*/
inline std::string sanitizeExtraCrashFileKey(const char* keyName)
{
std::string key = keyName;
// sanitize the key name so that it contains only database friendly characters.
for (auto& c : key)
{
if (c <= ' ' || c >= 127 || strchr("\"'\\/,#$%^&*()!~`[]{}|<>?;:=+.\t\b\n\r ", c) != nullptr)
{
c = '_';
}
}
return key;
}
} // namespace detail
/** Adds a metadata value to the crash reporter.
*
* @tparam T The type of the value to set. This may be any value type that is
* compatible with @a std::to_string().
* @param[in] keyName The name of the metadata key to set. This must only contain printable
* ASCII characters except for a double quote ('"'), slash ('/'), or
* whitespace. These rules get the key to a format that can be accepted
* by the settings registry. Note that further sanitization on the key
* name may also occur later. Any character that is not suitable for a
* database key name will be replaced by an underscore ('_'). It is the
* caller's responsibility to ensure the key name will not be overwriting
* another system's metadata value. One way to do this is to prefix the
* key name with the name of the extension or plugin (sanitized to follow
* the above formatting rules).
* @param[in] value The value to add to the crash reporter's metadata table. This may be
* any string that is accepted by carb::settings::ISettings::setString()
* as a new value. Note that this will remove the metadata value if it is
* set to `nullptr` or an empty string.
* @returns `true` if the new metadata value is successfully set. Returns `false` otherwise.
*
* @remarks This adds a new metadata value to the crash reporter. When a crash occurs, all
* values added through here will be collected and transmitted as metadata to
* accompany the crash report. The metadata value will value will be added (or
* updated) to the crash reporter by adding (or updating) a key under the
* "/crashreporter/data/" settings branch.
*
* @note This should not be called frequently to update the value of a piece of metadata.
* Doing so will be likely to incur a performance hit since the crash reporter watches
* for changes on the "/crashreporter/data/" settings branch that is modified here.
* Each time the branch changes, the crash reporter's metadata list is updated. If
* possible, the value for any given piece of metadata should only be updated when
* it either changes or just set once on startup and left alone.
*/
template <typename T>
inline bool addCrashMetadata(const char* keyName, T value)
{
return addCrashMetadata(keyName, std::to_string(value).c_str());
}
/** @copydoc carb::crashreporter::addCrashMetadata(const char*,T). */
template <>
inline bool addCrashMetadata(const char* keyName, const char* value)
{
carb::settings::ISettings* settings = carb::getCachedInterface<carb::settings::ISettings>();
std::string key;
if (settings == nullptr)
return false;
key = detail::sanitizeExtraCrashFileKey(keyName);
settings->setString((std::string("/crashreporter/data/") + key).c_str(), value);
return true;
}
/** Retrieves the value of a crash metadata value (if defined).
*
* @param[in] keyName The name of the metadata key to retrieve the value for. This must only
* contain printable ASCII characters except for a double quote ('"'), slash
* ('/'), or whitespace. These rules get the key to a format that can be
* accepted by the settings registry. Note that further sanitization on the
* key name may also occur later. Any character that is not suitable for a
* database key name will be replaced by an underscore ('_'). It is the
* caller's responsibility to ensure the key name will not be overwriting
* another system's metadata value. One way to do this is to prefix the
* key name with the name of the extension or plugin (sanitized to follow
* the above formatting rules).
* @returns The value of the requested crash metadata if it is defined. Returns `nullptr` if
* the requested metadata value has not been defined. This will not modify any existing
* crash metadata keys or values.
*/
inline const char* getCrashMetadataValue(const char* keyName)
{
carb::settings::ISettings* settings = carb::getCachedInterface<carb::settings::ISettings>();
std::string key;
if (settings == nullptr)
return nullptr;
key = "/crashreporter/data/" + detail::sanitizeExtraCrashFileKey(keyName);
return settings->getStringBuffer(key.c_str());
}
/** Adds an extra file to be uploaded when a crash occurs.
*
* @param[in] keyName The name of the key to give to the file. This is what the file will be
* uploaded as. Using the file's original name should be fine in most
* cases, however it should not contain characters such as '/' or '\'
* at the very least. Non-ASCII characters should be avoided if possible
* too. It is the caller's responsibility to ensure adding this new file
* will not overwrite another upload file with the same key name. This
* may not use the reserved name 'upload_file_minidump'. This key name
* string will always be sanitized to only contain database friendly
* characters. All invalid characters will be replaced by an underscore
* ('_').
* @param[in] filename The full path to the file to upload. This may be a relative or absolute
* path. The file may or may not exist at the time of this call, it will
* still be added to the list of files to be uploaded. If the file does not
* exist at the time of the crash, it will be filtered out of the list at
* that point. A warnings message will be written out for each listed file
* that is missing at the time of the crash however.
* @returns `true` if the new entry is added to the list. Returns `false` if the file could
* not be added. This failure will only occur if the \ref carb::settings::ISettings interface is not
* available. Note that a `true` return does not necessarily mean that the new file
* was fully added to the list. It would have been written to the list in the settings
* registry, but may have been ignored by the crash reporter if the same key was given
* as a previous file.
*
* @remarks This adds a filename to be tracked to upload with the next crash report that is
* generated. This setting is not persistent across sessions. If no crash occurs,
* the file will not be uploaded anywhere. This cannot be used to rename a file that
* has already been added to the upload list (ie: change the filename under an existing
* key). If a second filename is specified with the same key, it will be ignored.
*
* @note Extra files added with this function will not be deleted once a crash report is
* successfully uploaded. Only the crash report's main dump file and metadata files
* will be deleted in this case.
*/
inline bool addExtraCrashFile(const char* keyName, const char* filename)
{
carb::settings::ISettings* settings = carb::getCachedInterface<carb::settings::ISettings>();
std::string key;
if (settings == nullptr)
return false;
// sanitize the key name so that it contains only database friendly characters.
key = detail::sanitizeExtraCrashFileKey(keyName);
settings->setString(("/crashreporter/files/" + key).c_str(), filename);
return true;
}
/** Checks whether a key for an extra crash report file has already been used.
*
* @param[in] keyName The name of the key to be used. This will be used to identify the extra
* file in the settings registry. See addExtraCrashFile() for more
* information on how this value is used.
* @returns `true` if the crash file key has been used already. Returns `false` otherwise.
*
* @remarks When adding new extra files to a crash report, it is the caller's responsibility
* that an existing filename will not be overwritten by addExtraCrashFile(). This
* function can be used to check whether a given key had already been used to add
* an extra file to the crash report.
*/
inline bool isExtraCrashFileKeyUsed(const char* keyName)
{
carb::settings::ISettings* settings = carb::getCachedInterface<carb::settings::ISettings>();
std::string key;
if (settings == nullptr)
return false;
// sanitize the key name so that it contains only database friendly characters.
key = detail::sanitizeExtraCrashFileKey(keyName);
return settings->isAccessibleAs(carb::dictionary::ItemType::eString, ("/crashreporter/files/" + key).c_str());
}
} // namespace crashreporter
} // namespace carb
| 22,003 | C | 46.938998 | 120 | 0.671454 |
omniverse-code/kit/include/carb/input/InputTypes.h | // Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Types.h"
namespace carb
{
namespace input
{
struct InputDevice;
struct Keyboard;
struct Mouse;
struct Gamepad;
/**
* Type used as an identifier for all subscriptions.
*/
typedef uint32_t SubscriptionId;
/**
* Subscription order.
*
* [0..N-1] requires to insert before the position from the beginning and shift tail on the right.
* [-1..-N] requires to insert after the position relative from the end and shift head on the left.
*
* Please look at the examples below:
*
* Assume we initially have a queue of N subscribers a b c .. y z:
* +---+---+---+-- --+---+---+
* | a | b | c | | y | z | -----events--flow--->
* +---+---+---+-- --+---+---+
* | 0 | 1 | 2 | |N-2|N-1| ---positive-order--->
* +---+---+---+-- --+---+---+
* | -N| | | | -2| -1| <---negative-order---
* +---+---+---+-- --+---+---+
* first last
*
* After inserting subscriber e with the order 1:
* +---+---+---+---+-- --+---+---+
* | a | e | b | c | | y | z |
* +---+---+---+---+-- --+---+---+
* | 0 | 1 | 2 | 3 | |N-1| N |
* +---+---+---+---+-- --+---+---+
* first last
*
* After inserting subscriber f with the order -1:
* +---+---+---+---+-- --+---+---+---+
* | a | e | b | c | | y | z | f |
* +---+---+---+---+-- --+---+---+---+
* | 0 | 1 | 2 | 3 | |N-1| N |N+1|
* +---+---+---+---+-- --+---+---+---+
* | 0 | 1 | 2 | 3 | |M-3|M-2|M-1|
* +---+---+---+---+-- --+---+---+---+
* first last
*
*/
using SubscriptionOrder = int32_t;
/**
* Default subscription order.
*/
static constexpr SubscriptionOrder kSubscriptionOrderFirst = 0;
static constexpr SubscriptionOrder kSubscriptionOrderLast = -1;
static constexpr SubscriptionOrder kSubscriptionOrderDefault = kSubscriptionOrderLast;
/**
* Defines possible input event types.
* TODO: This is not supported yet.
*/
enum class EventType : uint32_t
{
eUnknown
};
/**
* Defines event type mask.
* TODO: Flags are not customized yet.
*/
typedef uint32_t EventTypeMask;
static constexpr EventTypeMask kEventTypeAll = EventTypeMask(-1);
/**
* Defines possible press states.
*/
typedef uint32_t ButtonFlags;
const uint32_t kButtonFlagTransitionUp = 1;
const uint32_t kButtonFlagStateUp = (1 << 1);
const uint32_t kButtonFlagTransitionDown = (1 << 2);
const uint32_t kButtonFlagStateDown = (1 << 3);
/**
* Defines possible device types.
*/
enum class DeviceType
{
eKeyboard,
eMouse,
eGamepad,
eCount,
eUnknown = eCount
};
/**
* Defines keyboard modifiers.
*/
typedef uint32_t KeyboardModifierFlags;
const uint32_t kKeyboardModifierFlagShift = 1 << 0;
const uint32_t kKeyboardModifierFlagControl = 1 << 1;
const uint32_t kKeyboardModifierFlagAlt = 1 << 2;
const uint32_t kKeyboardModifierFlagSuper = 1 << 3;
const uint32_t kKeyboardModifierFlagCapsLock = 1 << 4;
const uint32_t kKeyboardModifierFlagNumLock = 1 << 5;
/**
* Defines totl number of keyboard modifiers.
*/
const uint32_t kKeyboardModifierFlagCount = 6;
/**
* Defines keyboard event type.
*/
enum class KeyboardEventType
{
eKeyPress, ///< Sent when key is pressed the first time.
eKeyRepeat, ///< Sent after a platform-specific delay if key is held down.
eKeyRelease, ///< Sent when the key is released.
eChar, ///< Sent when a character is produced by the input actions, for example during key presses.
// Must always be last
eCount ///< The number of KeyboardEventType elements.
};
/**
* Defines input code type.
*
*/
typedef uint32_t InputType;
/**
* Defines keyboard key codes
*
* The key code represents the physical key location in the standard US keyboard layout keyboard, if they exist
* in the US keyboard.
*
* eUnknown is sent for key events that do not have a key code.
*/
enum class KeyboardInput : InputType
{
eUnknown,
eSpace,
eApostrophe,
eComma,
eMinus,
ePeriod,
eSlash,
eKey0,
eKey1,
eKey2,
eKey3,
eKey4,
eKey5,
eKey6,
eKey7,
eKey8,
eKey9,
eSemicolon,
eEqual,
eA,
eB,
eC,
eD,
eE,
eF,
eG,
eH,
eI,
eJ,
eK,
eL,
eM,
eN,
eO,
eP,
eQ,
eR,
eS,
eT,
eU,
eV,
eW,
eX,
eY,
eZ,
eLeftBracket,
eBackslash,
eRightBracket,
eGraveAccent,
eEscape,
eTab,
eEnter,
eBackspace,
eInsert,
eDel,
eRight,
eLeft,
eDown,
eUp,
ePageUp,
ePageDown,
eHome,
eEnd,
eCapsLock,
eScrollLock,
eNumLock,
ePrintScreen,
ePause,
eF1,
eF2,
eF3,
eF4,
eF5,
eF6,
eF7,
eF8,
eF9,
eF10,
eF11,
eF12,
eNumpad0,
eNumpad1,
eNumpad2,
eNumpad3,
eNumpad4,
eNumpad5,
eNumpad6,
eNumpad7,
eNumpad8,
eNumpad9,
eNumpadDel,
eNumpadDivide,
eNumpadMultiply,
eNumpadSubtract,
eNumpadAdd,
eNumpadEnter,
eNumpadEqual,
eLeftShift,
eLeftControl,
eLeftAlt,
eLeftSuper,
eRightShift,
eRightControl,
eRightAlt,
eRightSuper,
eMenu,
eCount
};
/**
* UTF8 RFC3629 - max 4 bytes per character
*/
const uint32_t kCharacterMaxNumBytes = 4;
/**
* Defines a keyboard event.
*/
struct KeyboardEvent
{
union
{
Keyboard* keyboard;
InputDevice* device;
};
KeyboardEventType type;
union
{
KeyboardInput key;
InputType inputType;
char character[kCharacterMaxNumBytes];
};
KeyboardModifierFlags modifiers;
};
/**
* Defines the mouse event types.
*/
enum class MouseEventType
{
eLeftButtonDown,
eLeftButtonUp,
eMiddleButtonDown,
eMiddleButtonUp,
eRightButtonDown,
eRightButtonUp,
eMove,
eScroll,
// Must always be last
eCount ///< The number of MouseEventType elements.
};
/**
* Defines the mouse event.
*
* normalizedCoords - mouse coordinates only active in move events, normalized to [0.0, 1.0] relative to the
* associated window size.
* unscaledCoords - mouse coordinates only active in move events, not normalized.
* scrollDelta - scroll delta, only active in scroll events.
*/
struct MouseEvent
{
union
{
Mouse* mouse;
InputDevice* device;
};
MouseEventType type;
union
{
Float2 normalizedCoords;
Float2 scrollDelta;
};
KeyboardModifierFlags modifiers;
Float2 pixelCoords;
};
/**
* Defines a mouse input.
*/
enum class MouseInput : InputType
{
eLeftButton,
eRightButton,
eMiddleButton,
eForwardButton,
eBackButton,
eScrollRight,
eScrollLeft,
eScrollUp,
eScrollDown,
eMoveRight,
eMoveLeft,
eMoveUp,
eMoveDown,
eCount
};
/**
* Defines a gamepad input.
*
* Expected ABXY buttons layout:
* Y
* X B
* A
* eMenu1 - maps to View (XBone) / Share (DS4)
* eMenu2 - maps to Menu (XBone) / Options (DS4)
*/
enum class GamepadInput : InputType
{
eLeftStickRight,
eLeftStickLeft,
eLeftStickUp,
eLeftStickDown,
eRightStickRight,
eRightStickLeft,
eRightStickUp,
eRightStickDown,
eLeftTrigger,
eRightTrigger,
eA,
eB,
eX,
eY,
eLeftShoulder,
eRightShoulder,
eMenu1,
eMenu2,
eLeftStick,
eRightStick,
eDpadUp,
eDpadRight,
eDpadDown,
eDpadLeft,
eCount
};
/**
* Defines a gamepad event.
*/
struct GamepadEvent
{
union
{
Gamepad* gamepad;
InputDevice* device;
};
union
{
GamepadInput input;
InputType inputType;
};
float value;
};
/**
* Defines the gamepad connection event types.
*/
enum class GamepadConnectionEventType
{
eCreated,
eConnected,
eDisconnected,
eDestroyed
};
/**
* Defines the gamepad connection event.
*/
struct GamepadConnectionEvent
{
union
{
Gamepad* gamepad;
InputDevice* device;
};
GamepadConnectionEventType type;
};
/**
* Defines the unified input event.
*/
struct InputEvent
{
DeviceType deviceType;
union
{
KeyboardEvent keyboardEvent;
MouseEvent mouseEvent;
GamepadEvent gamepadEvent;
InputDevice* device;
};
};
/**
* Defines action mapping description.
*/
struct ActionMappingDesc
{
DeviceType deviceType;
union
{
Keyboard* keyboard;
Mouse* mouse;
Gamepad* gamepad;
InputDevice* device;
};
union
{
KeyboardInput keyboardInput;
MouseInput mouseInput;
GamepadInput gamepadInput;
InputType inputType;
};
KeyboardModifierFlags modifiers;
};
/**
* Defines an action event.
*/
struct ActionEvent
{
const char* action;
float value;
ButtonFlags flags;
};
/**
* Function type that describes keyboard event callback.
*
* @param evt The event description.
* @param userData Pointer to the user data.
* @return Whether event should be processed by subsequent event subscribers.
*/
typedef bool (*OnActionEventFn)(const ActionEvent& evt, void* userData);
/**
* Function type that describes keyboard event callback.
*
* @param evt The event description.
* @param userData Pointer to the user data.
* @return Whether event should be processed by subsequent event subscribers.
*/
typedef bool (*OnKeyboardEventFn)(const KeyboardEvent& evt, void* userData);
/**
* Function type that describes mouse event callback.
*
* @param evt The event description.
* @param userData Pointer to the user data.
* @return Whether event should be processed by subsequent event subscribers.
*/
typedef bool (*OnMouseEventFn)(const MouseEvent& evt, void* userData);
/**
* Function type that describes gamepad event callback.
*
* @param evt The event description.
* @param userData Pointer to the user data.
* @return Whether event should be processed by subsequent event subscribers.
*/
typedef bool (*OnGamepadEventFn)(const GamepadEvent& evt, void* userData);
/**
* Function type that describes gamepad connection event callback.
*
* @param evt The event description.
* @param userData Pointer to the user data.
* @return Whether event should not be processed anymore by subsequent event subscribers.
*/
typedef void (*OnGamepadConnectionEventFn)(const GamepadConnectionEvent& evt, void* userData);
/**
* Function type that describes input event callback.
*
* @param evt The event description.
* @param userData Pointer to the user data.
* @return Whether event should be processed by subsequent event subscribers.
*/
typedef bool (*OnInputEventFn)(const InputEvent& evt, void* userData);
/**
* The result returned by InputEventFilterFn.
*/
enum class FilterResult : uint8_t
{
//! The event should be retained and sent later when IInput::distributeBufferedEvents() is called.
eRetain = 0,
//! The event has been fully processed by InputEventFilterFn and should NOT be sent later when
//! IInput::distributeBufferedEvents() is called.
eConsume = 1,
};
/**
* Callback function type for filtering events.
*
* @see IInput::filterBufferedEvents() for more information.
*
* @param evt A reference to the unified event description. The event may be modified.
* @param userData A pointer to the user data passed to IInput::filterBufferedEvents().
* @return The FilterResult indicating what should happen with the event.
*/
typedef FilterResult (*InputEventFilterFn)(InputEvent& evt, void* userData);
static const char* const kAnyDevice = nullptr;
} // namespace input
} // namespace carb
| 12,006 | C | 20.101933 | 111 | 0.637181 |
omniverse-code/kit/include/carb/input/InputBindingsPython.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "../BindingsPythonTypes.h"
#include "../Framework.h"
#include "IInput.h"
#include "InputProvider.h"
#include "InputUtils.h"
#include <memory>
#include <string>
#include <vector>
namespace carb
{
namespace input
{
struct InputDevice
{
};
struct Gamepad
{
};
class ActionMappingSet
{
};
} // namespace input
namespace input
{
namespace detail
{
inline ActionMappingDesc toMouseMapping(Mouse* mouse, MouseInput input, KeyboardModifierFlags modifiers)
{
ActionMappingDesc mapping{};
mapping.deviceType = DeviceType::eMouse;
mapping.mouse = mouse;
mapping.mouseInput = input;
mapping.modifiers = modifiers;
return mapping;
}
inline ActionMappingDesc toGamepadMapping(Gamepad* gamepad, GamepadInput input)
{
ActionMappingDesc mapping{};
mapping.deviceType = DeviceType::eGamepad;
mapping.gamepad = gamepad;
mapping.gamepadInput = input;
return mapping;
}
} // namespace detail
inline void definePythonModule(py::module& m)
{
m.doc() = "pybind11 carb.input bindings";
py::class_<InputDevice> device(m, "InputDevice");
py::class_<Keyboard>(m, "Keyboard", device);
py::class_<Mouse>(m, "Mouse", device);
py::class_<Gamepad>(m, "Gamepad", device);
py::class_<ActionMappingSet>(m, "ActionMappingSet");
py::enum_<EventType>(m, "EventType").value("UNKNOWN", EventType::eUnknown);
m.attr("EVENT_TYPE_ALL") = py::int_(kEventTypeAll);
m.attr("SUBSCRIPTION_ORDER_FIRST") = py::int_(kSubscriptionOrderFirst);
m.attr("SUBSCRIPTION_ORDER_LAST") = py::int_(kSubscriptionOrderLast);
m.attr("SUBSCRIPTION_ORDER_DEFAULT") = py::int_(kSubscriptionOrderDefault);
py::enum_<DeviceType>(m, "DeviceType")
.value("KEYBOARD", DeviceType::eKeyboard)
.value("MOUSE", DeviceType::eMouse)
.value("GAMEPAD", DeviceType::eGamepad);
py::enum_<KeyboardEventType>(m, "KeyboardEventType")
.value("KEY_PRESS", KeyboardEventType::eKeyPress)
.value("KEY_REPEAT", KeyboardEventType::eKeyRepeat)
.value("KEY_RELEASE", KeyboardEventType::eKeyRelease)
.value("CHAR", KeyboardEventType::eChar);
py::enum_<KeyboardInput>(m, "KeyboardInput")
.value("UNKNOWN", KeyboardInput::eUnknown)
.value("SPACE", KeyboardInput::eSpace)
.value("APOSTROPHE", KeyboardInput::eApostrophe)
.value("COMMA", KeyboardInput::eComma)
.value("MINUS", KeyboardInput::eMinus)
.value("PERIOD", KeyboardInput::ePeriod)
.value("SLASH", KeyboardInput::eSlash)
.value("KEY_0", KeyboardInput::eKey0)
.value("KEY_1", KeyboardInput::eKey1)
.value("KEY_2", KeyboardInput::eKey2)
.value("KEY_3", KeyboardInput::eKey3)
.value("KEY_4", KeyboardInput::eKey4)
.value("KEY_5", KeyboardInput::eKey5)
.value("KEY_6", KeyboardInput::eKey6)
.value("KEY_7", KeyboardInput::eKey7)
.value("KEY_8", KeyboardInput::eKey8)
.value("KEY_9", KeyboardInput::eKey9)
.value("SEMICOLON", KeyboardInput::eSemicolon)
.value("EQUAL", KeyboardInput::eEqual)
.value("A", KeyboardInput::eA)
.value("B", KeyboardInput::eB)
.value("C", KeyboardInput::eC)
.value("D", KeyboardInput::eD)
.value("E", KeyboardInput::eE)
.value("F", KeyboardInput::eF)
.value("G", KeyboardInput::eG)
.value("H", KeyboardInput::eH)
.value("I", KeyboardInput::eI)
.value("J", KeyboardInput::eJ)
.value("K", KeyboardInput::eK)
.value("L", KeyboardInput::eL)
.value("M", KeyboardInput::eM)
.value("N", KeyboardInput::eN)
.value("O", KeyboardInput::eO)
.value("P", KeyboardInput::eP)
.value("Q", KeyboardInput::eQ)
.value("R", KeyboardInput::eR)
.value("S", KeyboardInput::eS)
.value("T", KeyboardInput::eT)
.value("U", KeyboardInput::eU)
.value("V", KeyboardInput::eV)
.value("W", KeyboardInput::eW)
.value("X", KeyboardInput::eX)
.value("Y", KeyboardInput::eY)
.value("Z", KeyboardInput::eZ)
.value("LEFT_BRACKET", KeyboardInput::eLeftBracket)
.value("BACKSLASH", KeyboardInput::eBackslash)
.value("RIGHT_BRACKET", KeyboardInput::eRightBracket)
.value("GRAVE_ACCENT", KeyboardInput::eGraveAccent)
.value("ESCAPE", KeyboardInput::eEscape)
.value("TAB", KeyboardInput::eTab)
.value("ENTER", KeyboardInput::eEnter)
.value("BACKSPACE", KeyboardInput::eBackspace)
.value("INSERT", KeyboardInput::eInsert)
.value("DEL", KeyboardInput::eDel)
.value("RIGHT", KeyboardInput::eRight)
.value("LEFT", KeyboardInput::eLeft)
.value("DOWN", KeyboardInput::eDown)
.value("UP", KeyboardInput::eUp)
.value("PAGE_UP", KeyboardInput::ePageUp)
.value("PAGE_DOWN", KeyboardInput::ePageDown)
.value("HOME", KeyboardInput::eHome)
.value("END", KeyboardInput::eEnd)
.value("CAPS_LOCK", KeyboardInput::eCapsLock)
.value("SCROLL_LOCK", KeyboardInput::eScrollLock)
.value("NUM_LOCK", KeyboardInput::eNumLock)
.value("PRINT_SCREEN", KeyboardInput::ePrintScreen)
.value("PAUSE", KeyboardInput::ePause)
.value("F1", KeyboardInput::eF1)
.value("F2", KeyboardInput::eF2)
.value("F3", KeyboardInput::eF3)
.value("F4", KeyboardInput::eF4)
.value("F5", KeyboardInput::eF5)
.value("F6", KeyboardInput::eF6)
.value("F7", KeyboardInput::eF7)
.value("F8", KeyboardInput::eF8)
.value("F9", KeyboardInput::eF9)
.value("F10", KeyboardInput::eF10)
.value("F11", KeyboardInput::eF11)
.value("F12", KeyboardInput::eF12)
.value("NUMPAD_0", KeyboardInput::eNumpad0)
.value("NUMPAD_1", KeyboardInput::eNumpad1)
.value("NUMPAD_2", KeyboardInput::eNumpad2)
.value("NUMPAD_3", KeyboardInput::eNumpad3)
.value("NUMPAD_4", KeyboardInput::eNumpad4)
.value("NUMPAD_5", KeyboardInput::eNumpad5)
.value("NUMPAD_6", KeyboardInput::eNumpad6)
.value("NUMPAD_7", KeyboardInput::eNumpad7)
.value("NUMPAD_8", KeyboardInput::eNumpad8)
.value("NUMPAD_9", KeyboardInput::eNumpad9)
.value("NUMPAD_DEL", KeyboardInput::eNumpadDel)
.value("NUMPAD_DIVIDE", KeyboardInput::eNumpadDivide)
.value("NUMPAD_MULTIPLY", KeyboardInput::eNumpadMultiply)
.value("NUMPAD_SUBTRACT", KeyboardInput::eNumpadSubtract)
.value("NUMPAD_ADD", KeyboardInput::eNumpadAdd)
.value("NUMPAD_ENTER", KeyboardInput::eNumpadEnter)
.value("NUMPAD_EQUAL", KeyboardInput::eNumpadEqual)
.value("LEFT_SHIFT", KeyboardInput::eLeftShift)
.value("LEFT_CONTROL", KeyboardInput::eLeftControl)
.value("LEFT_ALT", KeyboardInput::eLeftAlt)
.value("LEFT_SUPER", KeyboardInput::eLeftSuper)
.value("RIGHT_SHIFT", KeyboardInput::eRightShift)
.value("RIGHT_CONTROL", KeyboardInput::eRightControl)
.value("RIGHT_ALT", KeyboardInput::eRightAlt)
.value("RIGHT_SUPER", KeyboardInput::eRightSuper)
.value("MENU", KeyboardInput::eMenu)
.value("COUNT", KeyboardInput::eCount);
py::enum_<MouseEventType>(m, "MouseEventType")
.value("LEFT_BUTTON_DOWN", MouseEventType::eLeftButtonDown)
.value("LEFT_BUTTON_UP", MouseEventType::eLeftButtonUp)
.value("MIDDLE_BUTTON_DOWN", MouseEventType::eMiddleButtonDown)
.value("MIDDLE_BUTTON_UP", MouseEventType::eMiddleButtonUp)
.value("RIGHT_BUTTON_DOWN", MouseEventType::eRightButtonDown)
.value("RIGHT_BUTTON_UP", MouseEventType::eRightButtonUp)
.value("MOVE", MouseEventType::eMove)
.value("SCROLL", MouseEventType::eScroll);
py::enum_<MouseInput>(m, "MouseInput")
.value("LEFT_BUTTON", MouseInput::eLeftButton)
.value("RIGHT_BUTTON", MouseInput::eRightButton)
.value("MIDDLE_BUTTON", MouseInput::eMiddleButton)
.value("FORWARD_BUTTON", MouseInput::eForwardButton)
.value("BACK_BUTTON", MouseInput::eBackButton)
.value("SCROLL_RIGHT", MouseInput::eScrollRight)
.value("SCROLL_LEFT", MouseInput::eScrollLeft)
.value("SCROLL_UP", MouseInput::eScrollUp)
.value("SCROLL_DOWN", MouseInput::eScrollDown)
.value("MOVE_RIGHT", MouseInput::eMoveRight)
.value("MOVE_LEFT", MouseInput::eMoveLeft)
.value("MOVE_UP", MouseInput::eMoveUp)
.value("MOVE_DOWN", MouseInput::eMoveDown)
.value("COUNT", MouseInput::eCount);
py::enum_<GamepadInput>(m, "GamepadInput")
.value("LEFT_STICK_RIGHT", GamepadInput::eLeftStickRight)
.value("LEFT_STICK_LEFT", GamepadInput::eLeftStickLeft)
.value("LEFT_STICK_UP", GamepadInput::eLeftStickUp)
.value("LEFT_STICK_DOWN", GamepadInput::eLeftStickDown)
.value("RIGHT_STICK_RIGHT", GamepadInput::eRightStickRight)
.value("RIGHT_STICK_LEFT", GamepadInput::eRightStickLeft)
.value("RIGHT_STICK_UP", GamepadInput::eRightStickUp)
.value("RIGHT_STICK_DOWN", GamepadInput::eRightStickDown)
.value("LEFT_TRIGGER", GamepadInput::eLeftTrigger)
.value("RIGHT_TRIGGER", GamepadInput::eRightTrigger)
.value("A", GamepadInput::eA)
.value("B", GamepadInput::eB)
.value("X", GamepadInput::eX)
.value("Y", GamepadInput::eY)
.value("LEFT_SHOULDER", GamepadInput::eLeftShoulder)
.value("RIGHT_SHOULDER", GamepadInput::eRightShoulder)
.value("MENU1", GamepadInput::eMenu1)
.value("MENU2", GamepadInput::eMenu2)
.value("LEFT_STICK", GamepadInput::eLeftStick)
.value("RIGHT_STICK", GamepadInput::eRightStick)
.value("DPAD_UP", GamepadInput::eDpadUp)
.value("DPAD_RIGHT", GamepadInput::eDpadRight)
.value("DPAD_DOWN", GamepadInput::eDpadDown)
.value("DPAD_LEFT", GamepadInput::eDpadLeft)
.value("COUNT", GamepadInput::eCount);
m.attr("BUTTON_FLAG_RELEASED") = py::int_(kButtonFlagTransitionUp);
m.attr("BUTTON_FLAG_UP") = py::int_(kButtonFlagStateUp);
m.attr("BUTTON_FLAG_PRESSED") = py::int_(kButtonFlagTransitionDown);
m.attr("BUTTON_FLAG_DOWN") = py::int_(kButtonFlagStateDown);
m.attr("KEYBOARD_MODIFIER_FLAG_SHIFT") = py::int_(kKeyboardModifierFlagShift);
m.attr("KEYBOARD_MODIFIER_FLAG_CONTROL") = py::int_(kKeyboardModifierFlagControl);
m.attr("KEYBOARD_MODIFIER_FLAG_ALT") = py::int_(kKeyboardModifierFlagAlt);
m.attr("KEYBOARD_MODIFIER_FLAG_SUPER") = py::int_(kKeyboardModifierFlagSuper);
m.attr("KEYBOARD_MODIFIER_FLAG_CAPS_LOCK") = py::int_(kKeyboardModifierFlagCapsLock);
m.attr("KEYBOARD_MODIFIER_FLAG_NUM_LOCK") = py::int_(kKeyboardModifierFlagNumLock);
py::class_<KeyboardEvent>(m, "KeyboardEvent")
.def_readonly("device", &KeyboardEvent::device)
.def_readonly("keyboard", &KeyboardEvent::keyboard)
.def_readonly("type", &KeyboardEvent::type)
.def_property_readonly("input",
[](const KeyboardEvent& desc) {
switch (desc.type)
{
case KeyboardEventType::eChar:
return pybind11::cast(std::string(
desc.character, strnlen(desc.character, kCharacterMaxNumBytes)));
default:
return pybind11::cast(desc.key);
}
})
.def_readonly("modifiers", &KeyboardEvent::modifiers);
py::class_<MouseEvent>(m, "MouseEvent")
.def_readonly("device", &MouseEvent::device)
.def_readonly("mouse", &MouseEvent::mouse)
.def_readonly("type", &MouseEvent::type)
.def_readonly("normalized_coords", &MouseEvent::normalizedCoords)
.def_readonly("pixel_coords", &MouseEvent::pixelCoords)
.def_readonly("scrollDelta", &MouseEvent::scrollDelta)
.def_readonly("modifiers", &MouseEvent::modifiers);
py::class_<GamepadEvent>(m, "GamepadEvent")
.def_readonly("device", &GamepadEvent::device)
.def_readonly("gamepad", &GamepadEvent::gamepad)
.def_readonly("input", &GamepadEvent::input)
.def_readonly("value", &GamepadEvent::value);
py::enum_<GamepadConnectionEventType>(m, "GamepadConnectionEventType")
.value("CREATED", GamepadConnectionEventType::eCreated)
.value("CONNECTED", GamepadConnectionEventType::eConnected)
.value("DISCONNECTED", GamepadConnectionEventType::eDisconnected)
.value("DESTROYED", GamepadConnectionEventType::eDestroyed);
py::class_<GamepadConnectionEvent>(m, "GamepadConnectionEvent")
.def_readonly("type", &GamepadConnectionEvent::type)
.def_readonly("gamepad", &GamepadConnectionEvent::gamepad)
.def_readonly("device", &GamepadConnectionEvent::device);
py::class_<InputEvent>(m, "InputEvent")
.def_readonly("deviceType", &InputEvent::deviceType)
.def_readonly("device", &InputEvent::device)
.def_property_readonly("event", [](const InputEvent& desc) {
switch (desc.deviceType)
{
case DeviceType::eKeyboard:
return pybind11::cast(desc.keyboardEvent);
case DeviceType::eMouse:
return pybind11::cast(desc.mouseEvent);
case DeviceType::eGamepad:
return pybind11::cast(desc.gamepadEvent);
default:
return py::cast(nullptr);
}
});
py::class_<ActionMappingDesc>(m, "ActionMappingDesc")
.def_readonly("deviceType", &ActionMappingDesc::deviceType)
.def_readonly("modifiers", &ActionMappingDesc::modifiers)
.def_property_readonly("device",
[](const ActionMappingDesc& desc) {
switch (desc.deviceType)
{
case DeviceType::eKeyboard:
return pybind11::cast(desc.keyboard);
case DeviceType::eMouse:
return pybind11::cast(desc.mouse);
case DeviceType::eGamepad:
return pybind11::cast(desc.gamepad);
default:
return py::cast(nullptr);
}
})
.def_property_readonly("input", [](const ActionMappingDesc& desc) {
switch (desc.deviceType)
{
case DeviceType::eKeyboard:
return pybind11::cast(desc.keyboardInput);
case DeviceType::eMouse:
return pybind11::cast(desc.mouseInput);
case DeviceType::eGamepad:
return pybind11::cast(desc.gamepadInput);
default:
return py::cast(nullptr);
}
});
py::class_<ActionEvent>(m, "ActionEvent")
.def_readonly("action", &ActionEvent::action)
.def_readonly("value", &ActionEvent::value)
.def_readonly("flags", &ActionEvent::flags);
m.def("get_action_mapping_desc_from_string", [](const std::string& str) {
std::string deviceId;
ActionMappingDesc actionMappingDesc;
{
py::gil_scoped_release nogil;
actionMappingDesc = getActionMappingDescFromString(str.c_str(), &deviceId);
}
py::tuple t(4);
t[0] = actionMappingDesc.deviceType;
t[1] = actionMappingDesc.modifiers;
switch (actionMappingDesc.deviceType)
{
case DeviceType::eKeyboard:
{
t[2] = actionMappingDesc.keyboardInput;
break;
}
case DeviceType::eMouse:
{
t[2] = actionMappingDesc.mouseInput;
break;
}
case DeviceType::eGamepad:
{
t[2] = actionMappingDesc.gamepadInput;
break;
}
default:
{
t[2] = py::none();
break;
}
}
t[3] = deviceId;
return t;
});
m.def("get_string_from_action_mapping_desc",
[](KeyboardInput keyboardInput, KeyboardModifierFlags modifiers) {
ActionMappingDesc actionMappingDesc = {};
actionMappingDesc.deviceType = DeviceType::eKeyboard;
actionMappingDesc.keyboardInput = keyboardInput;
actionMappingDesc.modifiers = modifiers;
return getStringFromActionMappingDesc(actionMappingDesc, nullptr);
},
py::call_guard<py::gil_scoped_release>())
.def("get_string_from_action_mapping_desc",
[](MouseInput mouseInput, KeyboardModifierFlags modifiers) {
ActionMappingDesc actionMappingDesc = {};
actionMappingDesc.deviceType = DeviceType::eMouse;
actionMappingDesc.mouseInput = mouseInput;
actionMappingDesc.modifiers = modifiers;
return getStringFromActionMappingDesc(actionMappingDesc, nullptr);
},
py::call_guard<py::gil_scoped_release>())
.def("get_string_from_action_mapping_desc",
[](GamepadInput gamepadInput) {
ActionMappingDesc actionMappingDesc = {};
actionMappingDesc.deviceType = DeviceType::eGamepad;
actionMappingDesc.gamepadInput = gamepadInput;
actionMappingDesc.modifiers = 0;
return getStringFromActionMappingDesc(actionMappingDesc, nullptr);
},
py::call_guard<py::gil_scoped_release>());
static ScriptCallbackRegistryPython<size_t, bool, const InputEvent&> s_inputEventCBs;
static ScriptCallbackRegistryPython<size_t, bool, const KeyboardEvent&> s_keyboardEventCBs;
static ScriptCallbackRegistryPython<size_t, bool, const MouseEvent&> s_mouseEventCBs;
static ScriptCallbackRegistryPython<size_t, bool, const GamepadEvent&> s_gamepadEventCBs;
static ScriptCallbackRegistryPython<size_t, void, const GamepadConnectionEvent&> s_gamepadConnectionEventCBs;
static ScriptCallbackRegistryPython<size_t, bool, const ActionEvent&> s_actionEventCBs;
defineInterfaceClass<IInput>(m, "IInput", "acquire_input_interface")
.def("get_device_name", wrapInterfaceFunction(&IInput::getDeviceName), py::call_guard<py::gil_scoped_release>())
.def("get_device_type", wrapInterfaceFunction(&IInput::getDeviceType), py::call_guard<py::gil_scoped_release>())
.def("subscribe_to_input_events",
[](IInput* iface, const decltype(s_inputEventCBs)::FuncT& eventFn, EventTypeMask eventTypes,
InputDevice* device, SubscriptionOrder order) {
auto eventFnCopy = s_inputEventCBs.create(eventFn);
SubscriptionId id =
iface->subscribeToInputEvents(device, eventTypes, s_inputEventCBs.call, eventFnCopy, order);
s_inputEventCBs.add(hashPair(0x3e1, id), eventFnCopy);
return id;
},
py::arg("eventFn"), py::arg("eventTypes") = kEventTypeAll, py::arg("device") = nullptr,
py::arg("order") = kSubscriptionOrderDefault, py::call_guard<py::gil_scoped_release>())
.def("unsubscribe_to_input_events",
[](IInput* iface, SubscriptionId id) {
iface->unsubscribeToInputEvents(id);
s_inputEventCBs.removeAndDestroy(hashPair(0x3e1, id));
},
py::call_guard<py::gil_scoped_release>())
.def("get_keyboard_name", wrapInterfaceFunction(&IInput::getKeyboardName),
py::call_guard<py::gil_scoped_release>())
.def("subscribe_to_keyboard_events",
[](IInput* iface, Keyboard* keyboard, const decltype(s_keyboardEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_keyboardEventCBs.create(eventFn);
SubscriptionId id = iface->subscribeToKeyboardEvents(keyboard, s_keyboardEventCBs.call, eventFnCopy);
s_keyboardEventCBs.add(hashPair(keyboard, id), eventFnCopy);
return id;
},
py::call_guard<py::gil_scoped_release>())
.def("unsubscribe_to_keyboard_events",
[](IInput* iface, Keyboard* keyboard, SubscriptionId id) {
iface->unsubscribeToKeyboardEvents(keyboard, id);
s_keyboardEventCBs.removeAndDestroy(hashPair(keyboard, id));
},
py::call_guard<py::gil_scoped_release>())
.def("get_keyboard_value", wrapInterfaceFunction(&IInput::getKeyboardValue),
py::call_guard<py::gil_scoped_release>())
.def("get_keyboard_button_flags", wrapInterfaceFunction(&IInput::getKeyboardButtonFlags),
py::call_guard<py::gil_scoped_release>())
.def("get_mouse_name", wrapInterfaceFunction(&IInput::getMouseName), py::call_guard<py::gil_scoped_release>())
.def("get_mouse_value", wrapInterfaceFunction(&IInput::getMouseValue), py::call_guard<py::gil_scoped_release>())
.def("get_mouse_button_flags", wrapInterfaceFunction(&IInput::getMouseButtonFlags),
py::call_guard<py::gil_scoped_release>())
.def("get_mouse_coords_normalized", wrapInterfaceFunction(&IInput::getMouseCoordsNormalized),
py::call_guard<py::gil_scoped_release>())
.def("get_mouse_coords_pixel", wrapInterfaceFunction(&IInput::getMouseCoordsPixel),
py::call_guard<py::gil_scoped_release>())
.def("subscribe_to_mouse_events",
[](IInput* iface, Mouse* mouse, const decltype(s_mouseEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_mouseEventCBs.create(eventFn);
SubscriptionId id = iface->subscribeToMouseEvents(mouse, s_mouseEventCBs.call, eventFnCopy);
s_mouseEventCBs.add(hashPair(mouse, id), eventFnCopy);
return id;
},
py::call_guard<py::gil_scoped_release>())
.def("unsubscribe_to_mouse_events",
[](IInput* iface, Mouse* mouse, SubscriptionId id) {
iface->unsubscribeToMouseEvents(mouse, id);
s_mouseEventCBs.removeAndDestroy(hashPair(mouse, id));
},
py::call_guard<py::gil_scoped_release>())
.def("get_gamepad_name", wrapInterfaceFunction(&IInput::getGamepadName), py::call_guard<py::gil_scoped_release>())
.def("get_gamepad_guid", wrapInterfaceFunction(&IInput::getGamepadGuid), py::call_guard<py::gil_scoped_release>())
.def("get_gamepad_value", wrapInterfaceFunction(&IInput::getGamepadValue),
py::call_guard<py::gil_scoped_release>())
.def("get_gamepad_button_flags", wrapInterfaceFunction(&IInput::getGamepadButtonFlags),
py::call_guard<py::gil_scoped_release>())
.def("subscribe_to_gamepad_events",
[](IInput* iface, Gamepad* gamepad, const decltype(s_gamepadEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_gamepadEventCBs.create(eventFn);
SubscriptionId id = iface->subscribeToGamepadEvents(gamepad, s_gamepadEventCBs.call, eventFnCopy);
s_gamepadEventCBs.add(hashPair(gamepad, id), eventFnCopy);
return id;
},
py::call_guard<py::gil_scoped_release>())
.def("unsubscribe_to_gamepad_events",
[](IInput* iface, Gamepad* gamepad, SubscriptionId id) {
iface->unsubscribeToGamepadEvents(gamepad, id);
s_gamepadEventCBs.removeAndDestroy(hashPair(gamepad, id));
},
py::call_guard<py::gil_scoped_release>())
.def("subscribe_to_gamepad_connection_events",
[](IInput* iface, const decltype(s_gamepadConnectionEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_gamepadConnectionEventCBs.create(eventFn);
SubscriptionId id =
iface->subscribeToGamepadConnectionEvents(s_gamepadConnectionEventCBs.call, eventFnCopy);
s_gamepadConnectionEventCBs.add(id, eventFnCopy);
return id;
},
py::call_guard<py::gil_scoped_release>())
.def("unsubscribe_to_gamepad_connection_events",
[](IInput* iface, SubscriptionId id) {
iface->unsubscribeToGamepadConnectionEvents(id);
s_gamepadConnectionEventCBs.removeAndDestroy(id);
},
py::call_guard<py::gil_scoped_release>())
.def("get_actions",
[](const IInput* iface, ActionMappingSet* actionMappingSet) {
std::vector<std::string> res(iface->getActionCount(actionMappingSet));
auto actions = iface->getActions(actionMappingSet);
for (size_t i = 0; i < res.size(); i++)
{
res[i] = actions[i];
}
return res;
},
py::call_guard<py::gil_scoped_release>())
.def("add_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, Keyboard* keyboard,
KeyboardInput keyboardInput, KeyboardModifierFlags modifiers) {
return iface->addActionMapping(
actionMappingSet, action,
ActionMappingDesc{ DeviceType::eKeyboard, { keyboard }, { keyboardInput }, modifiers });
},
py::call_guard<py::gil_scoped_release>())
.def("add_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, Gamepad* gamepad,
GamepadInput gamepadInput) {
return iface->addActionMapping(
actionMappingSet, action, detail::toGamepadMapping(gamepad, gamepadInput));
},
py::call_guard<py::gil_scoped_release>())
.def("add_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, Mouse* mouse,
MouseInput mouseInput, KeyboardModifierFlags modifiers) {
return iface->addActionMapping(
actionMappingSet, action, detail::toMouseMapping(mouse, mouseInput, modifiers));
},
py::call_guard<py::gil_scoped_release>())
.def("set_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, uint32_t index,
Keyboard* keyboard, KeyboardInput keyboardInput, KeyboardModifierFlags modifiers) {
return iface->setActionMapping(
actionMappingSet, action, index,
ActionMappingDesc{ DeviceType::eKeyboard, { keyboard }, { keyboardInput }, modifiers });
},
py::call_guard<py::gil_scoped_release>())
.def("set_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, uint32_t index, Gamepad* gamepad,
GamepadInput gamepadInput) {
return iface->setActionMapping(
actionMappingSet, action, index, detail::toGamepadMapping(gamepad, gamepadInput));
},
py::call_guard<py::gil_scoped_release>())
.def("set_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, uint32_t index, Mouse* mouse,
MouseInput mouseInput, KeyboardModifierFlags modifiers) {
return iface->setActionMapping(
actionMappingSet, action, index, detail::toMouseMapping(mouse, mouseInput, modifiers));
},
py::call_guard<py::gil_scoped_release>())
.def("remove_action_mapping", wrapInterfaceFunction(&IInput::removeActionMapping),
py::call_guard<py::gil_scoped_release>())
.def("clear_action_mappings", wrapInterfaceFunction(&IInput::clearActionMappings),
py::call_guard<py::gil_scoped_release>())
.def("get_action_mappings",
[](const IInput* iface, ActionMappingSet* actionMappingSet, const char* action) {
auto size = iface->getActionMappingCount(actionMappingSet, action);
std::vector<ActionMappingDesc> res;
res.reserve(size);
auto mappings = iface->getActionMappings(actionMappingSet, action);
std::copy(mappings, mappings + size, std::back_inserter(res));
return res;
},
py::call_guard<py::gil_scoped_release>())
.def("get_action_mapping_count", wrapInterfaceFunction(&IInput::getActionMappingCount),
py::call_guard<py::gil_scoped_release>())
.def("set_default_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, Keyboard* keyboard,
KeyboardInput keyboardInput, KeyboardModifierFlags modifiers) {
return setDefaultActionMapping(
iface, actionMappingSet, action,
ActionMappingDesc{ DeviceType::eKeyboard, { keyboard }, { keyboardInput }, modifiers });
},
py::call_guard<py::gil_scoped_release>())
.def("set_default_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, Gamepad* gamepad,
GamepadInput gamepadInput) {
return setDefaultActionMapping(
iface, actionMappingSet, action, detail::toGamepadMapping(gamepad, gamepadInput));
},
py::call_guard<py::gil_scoped_release>())
.def("set_default_action_mapping",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action, Mouse* mouse,
MouseInput mouseInput, KeyboardModifierFlags modifiers) {
return setDefaultActionMapping(
iface, actionMappingSet, action, detail::toMouseMapping(mouse, mouseInput, modifiers));
},
py::call_guard<py::gil_scoped_release>())
.def("get_action_value", wrapInterfaceFunction(&IInput::getActionValue), py::call_guard<py::gil_scoped_release>())
.def("get_action_button_flags", wrapInterfaceFunction(&IInput::getActionButtonFlags),
py::call_guard<py::gil_scoped_release>())
.def("subscribe_to_action_events",
[](IInput* iface, ActionMappingSet* actionMappingSet, const char* action,
const decltype(s_actionEventCBs)::FuncT& eventFn) {
auto eventFnCopy = s_actionEventCBs.create(eventFn);
SubscriptionId id =
iface->subscribeToActionEvents(actionMappingSet, action, s_actionEventCBs.call, eventFnCopy);
s_actionEventCBs.add(id, eventFnCopy);
return id;
},
py::call_guard<py::gil_scoped_release>())
.def("unsubscribe_to_action_events",
[](IInput* iface, SubscriptionId id) {
iface->unsubscribeToActionEvents(id);
s_actionEventCBs.removeAndDestroy(id);
},
py::call_guard<py::gil_scoped_release>())
.def("get_action_mapping_set_by_path", wrapInterfaceFunction(&IInput::getActionMappingSetByPath),
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>())
.def("get_modifier_flags",
[](IInput* iface, KeyboardModifierFlags modifierFlags, const std::vector<const InputDevice*>& inputDev,
const std::vector<DeviceType>& inputDevTypes, const std::vector<MouseInput>& mouseButtons) {
return iface->getModifierFlags(modifierFlags, inputDev.data(), inputDev.size(), inputDevTypes.data(),
inputDevTypes.size(), mouseButtons.data(), mouseButtons.size());
},
py::arg("modifiers") = KeyboardModifierFlags(0),
py::arg("input_devices") = std::vector<const InputDevice*>(),
py::arg("device_types") = std::vector<DeviceType>(), py::arg("mouse_buttons") = std::vector<MouseInput>(),
py::call_guard<py::gil_scoped_release>())
.def("get_global_modifier_flags",
[](IInput* iface, KeyboardModifierFlags modifierFlags, const std::vector<MouseInput>& mouseButtons) {
return iface->getGlobalModifierFlags(modifierFlags, mouseButtons.data(), mouseButtons.size());
},
py::arg("modifiers") = KeyboardModifierFlags(0), py::arg("mouse_buttons") = std::vector<MouseInput>(),
py::call_guard<py::gil_scoped_release>())
;
m.def("acquire_input_provider",
[](const char* pluginName, const char* libraryPath) {
return libraryPath ? acquireInterfaceFromLibraryForBindings<IInput>(libraryPath)->getInputProvider() :
acquireInterfaceForBindings<IInput>(pluginName)->getInputProvider();
},
py::arg("plugin_name") = nullptr, py::arg("library_path") = nullptr, py::return_value_policy::reference,
py::call_guard<py::gil_scoped_release>());
py::class_<InputProvider>(m, "InputProvider")
.def("create_keyboard", wrapInterfaceFunction(&InputProvider::createKeyboard),
py::return_value_policy::reference, py::call_guard<py::gil_scoped_release>())
.def("destroy_keyboard", wrapInterfaceFunction(&InputProvider::destroyKeyboard),
py::call_guard<py::gil_scoped_release>())
.def("update_keyboard", wrapInterfaceFunction(&InputProvider::updateKeyboard),
py::call_guard<py::gil_scoped_release>())
.def("buffer_keyboard_key_event",
[](InputProvider* iface, Keyboard* keyboard, KeyboardEventType type, KeyboardInput key,
KeyboardModifierFlags modifiers) {
KeyboardEvent event;
event.keyboard = keyboard;
event.type = type;
event.key = key;
event.modifiers = modifiers;
iface->bufferKeyboardEvent(event);
},
py::call_guard<py::gil_scoped_release>())
.def("buffer_keyboard_char_event",
[](InputProvider* iface, Keyboard* keyboard, py::str character, KeyboardModifierFlags modifiers) {
// Cast before releasing GIL
auto characterStr = character.cast<std::string>();
py::gil_scoped_release nogil;
KeyboardEvent event{};
event.keyboard = keyboard;
event.type = KeyboardEventType::eChar;
event.modifiers = modifiers;
size_t maxCopyBytes = ::carb_min(characterStr.length(), size_t(kCharacterMaxNumBytes));
memcpy((void*)event.character, characterStr.c_str(), maxCopyBytes);
iface->bufferKeyboardEvent(event);
})
.def("create_mouse", wrapInterfaceFunction(&InputProvider::createMouse), py::return_value_policy::reference,
py::call_guard<py::gil_scoped_release>())
.def("destroy_mouse", wrapInterfaceFunction(&InputProvider::destroyMouse),
py::call_guard<py::gil_scoped_release>())
.def("update_mouse", wrapInterfaceFunction(&InputProvider::updateMouse), py::call_guard<py::gil_scoped_release>())
.def("buffer_mouse_event",
[](InputProvider* iface, Mouse* mouse, MouseEventType type, Float2 value, KeyboardModifierFlags modifiers,
Float2 pixelValue) {
MouseEvent event;
event.mouse = mouse;
event.type = type;
if (type == MouseEventType::eScroll)
{
event.scrollDelta = value;
}
else
{
event.normalizedCoords = value;
}
event.pixelCoords = pixelValue;
event.modifiers = modifiers;
iface->bufferMouseEvent(event);
},
py::call_guard<py::gil_scoped_release>())
.def("create_gamepad", wrapInterfaceFunction(&InputProvider::createGamepad), py::return_value_policy::reference,
py::call_guard<py::gil_scoped_release>())
.def("set_gamepad_connected", wrapInterfaceFunction(&InputProvider::setGamepadConnected),
py::call_guard<py::gil_scoped_release>())
.def("destroy_gamepad", wrapInterfaceFunction(&InputProvider::destroyGamepad),
py::call_guard<py::gil_scoped_release>())
.def("update_gamepad", wrapInterfaceFunction(&InputProvider::updateGamepad),
py::call_guard<py::gil_scoped_release>())
.def("buffer_gamepad_event",
[](InputProvider* iface, Gamepad* gamepad, GamepadInput input, float value) {
GamepadEvent event;
event.gamepad = gamepad;
event.input = input;
event.value = value;
iface->bufferGamepadEvent(event);
},
py::call_guard<py::gil_scoped_release>());
}
} // namespace input
} // namespace carb
| 38,370 | C | 49.822516 | 122 | 0.603284 |
omniverse-code/kit/include/carb/input/InputProvider.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Defines.h"
#include "InputTypes.h"
namespace carb
{
namespace input
{
/**
* Defines an input provider interface.
* This interface is meant to be used only by the input providers. Hence it is in the separate file.
* The examples of input providers could be windowing system or network input stream.
*/
struct InputProvider
{
/**
* Create a logical keyboard.
*
* @param name Logical keyboard name.
* @return The keyboard created.
*/
Keyboard*(CARB_ABI* createKeyboard)(const char* name);
/**
* Destroys the keyboard.
*
* @param keyboard The logical keyboard.
*/
void(CARB_ABI* destroyKeyboard)(Keyboard* keyboard);
/**
* Input "tick" for specific keyboard. Is meant to be called in the beginning of a new frame, right before sending
* events. It saves old device state, allowing to differentiate pressed and released state of the buttons. @see
* ButtonFlags.
*
* @param keyboard Logical keyboard to update.
*/
void(CARB_ABI* updateKeyboard)(Keyboard* keyboard);
/**
* Sends keyboard event.
*
* @param evt Keyboard event.
*/
void(CARB_ABI* bufferKeyboardEvent)(const KeyboardEvent& evt);
/**
* Create a logical mouse.
*
* @param name Logical mouse name.
* @return The mouse created.
*/
Mouse*(CARB_ABI* createMouse)(const char* name);
/**
* Destroys the mouse.
*
* @param mouse The logical mouse.
*/
void(CARB_ABI* destroyMouse)(Mouse* mouse);
/**
* Input "tick" for specific mouse. Is meant to be called in the beginning of a new frame, right before sending
* events. It saves old device state, allowing to differentiate pressed and released state of the buttons. @see
* ButtonFlags.
*
* @param mouse Logical mouse to update.
*/
void(CARB_ABI* updateMouse)(Mouse* mouse);
/**
* Sends mouse event.
*
* @param evt Mouse event.
*/
void(CARB_ABI* bufferMouseEvent)(const MouseEvent& evt);
/**
* Create a logical gamepad.
*
* @param name Logical gamepad name.
* @param guid Device GUID.
* @return The gamepad created.
*/
Gamepad*(CARB_ABI* createGamepad)(const char* name, const char* guid);
/**
* Create a logical gamepad.
*
* @param gamepad The logical gamepad.
* @param connected Is the gamepad connected?.
*/
void(CARB_ABI* setGamepadConnected)(Gamepad* gamepad, bool connected);
/**
* Destroys the gamepad.
*
* @param gamepad The logical gamepad.
*/
void(CARB_ABI* destroyGamepad)(Gamepad* gamepad);
/**
* Input "tick" for specific gamepad. Is meant to be called in the beginning of a new frame, right before sending
* events. It saves old device state, allowing to differentiate pressed and released state of the buttons. @see
* ButtonFlags.
*
* @param gamepad Logical gamepad to update.
*/
void(CARB_ABI* updateGamepad)(Gamepad* gamepad);
/**
* Send gamepad event.
*
* @param evt Mouse event.
*/
void(CARB_ABI* bufferGamepadEvent)(const GamepadEvent& evt);
/**
* Sends unified input event.
*
* @param evt A reference to unified input event description.
*/
void(CARB_ABI* bufferInputEvent)(const InputEvent& evt);
};
} // namespace input
} // namespace carb
| 3,890 | C | 27.195652 | 118 | 0.650643 |
omniverse-code/kit/include/carb/input/InputUtils.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../logging/Log.h"
#include "IInput.h"
#include <map>
#include <string>
#include <cstring>
#include <functional>
namespace carb
{
namespace input
{
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Name Mapping //
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
namespace detail
{
template <typename Key, typename LessFn, typename ExtractKeyFn, typename StaticMappingDesc, size_t count>
const StaticMappingDesc* getMappingByKey(Key key, const StaticMappingDesc (&items)[count])
{
static std::map<Key, const StaticMappingDesc*, LessFn> s_mapping;
static bool s_isInitialized = false;
if (!s_isInitialized)
{
for (size_t i = 0; i < count; ++i)
{
s_mapping.insert(std::make_pair(ExtractKeyFn().operator()(items[i]), &items[i]));
}
s_isInitialized = true;
}
auto found = s_mapping.find(key);
if (found != s_mapping.end())
{
return found->second;
}
return nullptr;
}
template <typename T>
struct Less
{
bool operator()(const T& a, const T& b) const
{
return std::less<T>(a, b);
}
};
template <>
struct Less<const char*>
{
bool operator()(const char* a, const char* b) const
{
return std::strcmp(a, b) < 0;
}
};
template <typename Struct, typename String>
struct ExtractName
{
String operator()(const Struct& item) const
{
return item.name;
}
};
template <typename Struct, typename Ident>
struct ExtractIdent
{
Ident operator()(const Struct& item) const
{
return item.ident;
}
};
template <typename Ident, typename String, typename StaticMappingDesc, size_t count>
Ident getIdentByName(String name, const StaticMappingDesc (&items)[count], Ident defaultIdent)
{
using LessFn = Less<String>;
using ExtractNameFn = ExtractName<StaticMappingDesc, String>;
using ExtractIdentFn = ExtractIdent<StaticMappingDesc, Ident>;
const auto* item = getMappingByKey<String, LessFn, ExtractNameFn, StaticMappingDesc, count>(name, items);
return (item != nullptr) ? ExtractIdentFn().operator()(*item) : defaultIdent;
}
template <typename String, typename Ident, typename StaticMappingDesc, size_t count>
String getNameByIdent(Ident ident, const StaticMappingDesc (&items)[count], String defaultName)
{
using LessFn = std::less<Ident>;
using ExtractIdentFn = ExtractIdent<StaticMappingDesc, Ident>;
using ExtractNameFn = ExtractName<StaticMappingDesc, String>;
const auto* item = getMappingByKey<Ident, LessFn, ExtractIdentFn, StaticMappingDesc, count>(ident, items);
return (item != nullptr) ? ExtractNameFn().operator()(*item) : defaultName;
}
} // namespace detail
static constexpr struct
{
DeviceType ident;
const char* name;
} g_deviceTypeToName[] = {
// clang-format off
{ DeviceType::eKeyboard, "Keyboard" },
{ DeviceType::eMouse, "Mouse" },
{ DeviceType::eGamepad, "Gamepad" }
// clang-format on
};
inline const char* getDeviceTypeString(DeviceType deviceType)
{
using namespace detail;
return getNameByIdent(deviceType, g_deviceTypeToName, "Unknown");
}
inline DeviceType getDeviceTypeFromString(const char* deviceTypeString)
{
using namespace detail;
return getIdentByName(deviceTypeString, g_deviceTypeToName, DeviceType::eUnknown);
}
static constexpr struct
{
KeyboardInput ident;
const char* name;
} kKeyboardInputCodeName[] = {
// clang-format off
{ KeyboardInput::eUnknown, "Unknown" },
{ KeyboardInput::eSpace, "Space" },
{ KeyboardInput::eApostrophe, "'" },
{ KeyboardInput::eComma, "," },
{ KeyboardInput::eMinus, "-" },
{ KeyboardInput::ePeriod, "." },
{ KeyboardInput::eSlash, "/" },
{ KeyboardInput::eKey0, "0" },
{ KeyboardInput::eKey1, "1" },
{ KeyboardInput::eKey2, "2" },
{ KeyboardInput::eKey3, "3" },
{ KeyboardInput::eKey4, "4" },
{ KeyboardInput::eKey5, "5" },
{ KeyboardInput::eKey6, "6" },
{ KeyboardInput::eKey7, "7" },
{ KeyboardInput::eKey8, "8" },
{ KeyboardInput::eKey9, "9" },
{ KeyboardInput::eSemicolon, ";" },
{ KeyboardInput::eEqual, "=" },
{ KeyboardInput::eA, "A" },
{ KeyboardInput::eB, "B" },
{ KeyboardInput::eC, "C" },
{ KeyboardInput::eD, "D" },
{ KeyboardInput::eE, "E" },
{ KeyboardInput::eF, "F" },
{ KeyboardInput::eG, "G" },
{ KeyboardInput::eH, "H" },
{ KeyboardInput::eI, "I" },
{ KeyboardInput::eJ, "J" },
{ KeyboardInput::eK, "K" },
{ KeyboardInput::eL, "L" },
{ KeyboardInput::eM, "M" },
{ KeyboardInput::eN, "N" },
{ KeyboardInput::eO, "O" },
{ KeyboardInput::eP, "P" },
{ KeyboardInput::eQ, "Q" },
{ KeyboardInput::eR, "R" },
{ KeyboardInput::eS, "S" },
{ KeyboardInput::eT, "T" },
{ KeyboardInput::eU, "U" },
{ KeyboardInput::eV, "V" },
{ KeyboardInput::eW, "W" },
{ KeyboardInput::eX, "X" },
{ KeyboardInput::eY, "Y" },
{ KeyboardInput::eZ, "Z" },
{ KeyboardInput::eLeftBracket, "[" },
{ KeyboardInput::eBackslash, "\\" },
{ KeyboardInput::eRightBracket, "]" },
{ KeyboardInput::eGraveAccent, "`" },
{ KeyboardInput::eEscape, "Esc" },
{ KeyboardInput::eTab, "Tab" },
{ KeyboardInput::eEnter, "Enter" },
{ KeyboardInput::eBackspace, "Backspace" },
{ KeyboardInput::eInsert, "Insert" },
{ KeyboardInput::eDel, "Del" },
{ KeyboardInput::eRight, "Right" },
{ KeyboardInput::eLeft, "Left" },
{ KeyboardInput::eDown, "Down" },
{ KeyboardInput::eUp, "Up" },
{ KeyboardInput::ePageUp, "PageUp" },
{ KeyboardInput::ePageDown, "PageDown" },
{ KeyboardInput::eHome, "Home" },
{ KeyboardInput::eEnd, "End" },
{ KeyboardInput::eCapsLock, "CapsLock" },
{ KeyboardInput::eScrollLock, "ScrollLock" },
{ KeyboardInput::eNumLock, "NumLock" },
{ KeyboardInput::ePrintScreen, "PrintScreen" },
{ KeyboardInput::ePause, "Pause" },
{ KeyboardInput::eF1, "F1" },
{ KeyboardInput::eF2, "F2" },
{ KeyboardInput::eF3, "F3" },
{ KeyboardInput::eF4, "F4" },
{ KeyboardInput::eF5, "F5" },
{ KeyboardInput::eF6, "F6" },
{ KeyboardInput::eF7, "F7" },
{ KeyboardInput::eF8, "F8" },
{ KeyboardInput::eF9, "F9" },
{ KeyboardInput::eF10, "F10" },
{ KeyboardInput::eF11, "F11" },
{ KeyboardInput::eF12, "F12" },
{ KeyboardInput::eNumpad0, "Num0" },
{ KeyboardInput::eNumpad1, "Num1" },
{ KeyboardInput::eNumpad2, "Num2" },
{ KeyboardInput::eNumpad3, "Num3" },
{ KeyboardInput::eNumpad4, "Num4" },
{ KeyboardInput::eNumpad5, "Num5" },
{ KeyboardInput::eNumpad6, "Num6" },
{ KeyboardInput::eNumpad7, "Num7" },
{ KeyboardInput::eNumpad8, "Num8" },
{ KeyboardInput::eNumpad9, "Num9" },
{ KeyboardInput::eNumpadDel, "NumDel" },
{ KeyboardInput::eNumpadDivide, "NumDivide" },
{ KeyboardInput::eNumpadMultiply, "NumMultiply" },
{ KeyboardInput::eNumpadSubtract, "NumSubtract" },
{ KeyboardInput::eNumpadAdd, "NumAdd" },
{ KeyboardInput::eNumpadEnter, "NumEnter" },
{ KeyboardInput::eNumpadEqual, "NumEqual" },
{ KeyboardInput::eLeftShift, "LeftShift" },
{ KeyboardInput::eLeftControl, "LeftControl" },
{ KeyboardInput::eLeftAlt, "LeftAlt" },
{ KeyboardInput::eLeftSuper, "LeftSuper" },
{ KeyboardInput::eRightShift, "RightShift" },
{ KeyboardInput::eRightControl, "RightControl" },
{ KeyboardInput::eRightAlt, "RightAlt" },
{ KeyboardInput::eRightSuper, "RightSuper" },
{ KeyboardInput::eMenu, "Menu" }
// clang-format on
};
inline const char* getKeyboardInputString(KeyboardInput key)
{
using namespace detail;
return getNameByIdent(key, kKeyboardInputCodeName, "");
}
inline KeyboardInput getKeyboardInputFromString(const char* inputString)
{
using namespace detail;
return getIdentByName(inputString, kKeyboardInputCodeName, KeyboardInput::eUnknown);
}
static constexpr struct
{
KeyboardModifierFlags ident;
const char* name;
} kModifierFlagName[] = {
// clang-format off
{ kKeyboardModifierFlagShift, "Shift" },
{ kKeyboardModifierFlagControl, "Ctrl" },
{ kKeyboardModifierFlagAlt, "Alt" },
{ kKeyboardModifierFlagSuper, "Super" },
{ kKeyboardModifierFlagCapsLock, "CapsLock" },
{ kKeyboardModifierFlagNumLock, "NumLock" }
// clang-format on
};
inline const char* getModifierFlagString(KeyboardModifierFlags flag)
{
using namespace detail;
return getNameByIdent(flag, kModifierFlagName, "");
}
inline KeyboardModifierFlags getModifierFlagFromString(const char* inputString)
{
using namespace detail;
return getIdentByName(inputString, kModifierFlagName, 0);
}
const char kDeviceNameSeparator[] = "::";
const char kModifierSeparator[] = " + ";
inline std::string getModifierFlagsString(KeyboardModifierFlags mod)
{
std::string res = "";
for (const auto& desc : kModifierFlagName)
{
const auto& flag = desc.ident;
if ((mod & flag) != flag)
continue;
if (!res.empty())
res += kModifierSeparator;
res += desc.name;
}
return res;
}
inline KeyboardModifierFlags getModifierFlagsFromString(const char* modString)
{
KeyboardModifierFlags res = KeyboardModifierFlags(0);
const size_t kModifierSeparatorSize = strlen(kModifierSeparator);
std::string modifierNameString;
const char* modifierName = modString;
while (true)
{
const char* modifierNameEnd = strstr(modifierName, kModifierSeparator);
if (modifierNameEnd)
{
modifierNameString = std::string(modifierName, modifierNameEnd - modifierName);
}
else
{
modifierNameString = std::string(modifierName);
}
KeyboardModifierFlags mod = getModifierFlagFromString(modifierNameString.c_str());
if (mod)
{
res = (KeyboardModifierFlags)((uint32_t)res | (uint32_t)mod);
}
else
{
CARB_LOG_VERBOSE("Unknown hotkey modifier encountered: %s in %s", modifierNameString.c_str(), modString);
}
if (!modifierNameEnd)
{
break;
}
modifierName = modifierNameEnd;
modifierName += kModifierSeparatorSize;
}
return res;
}
static constexpr struct
{
MouseInput ident;
const char* name;
} kMouseInputCodeName[] = {
// clang-format off
{ MouseInput::eLeftButton, "LeftButton" },
{ MouseInput::eRightButton, "RightButton" },
{ MouseInput::eMiddleButton, "MiddleButton" },
{ MouseInput::eForwardButton, "ForwardButton" },
{ MouseInput::eBackButton, "BackButton" },
{ MouseInput::eScrollRight, "ScrollRight" },
{ MouseInput::eScrollLeft, "ScrollLeft" },
{ MouseInput::eScrollUp, "ScrollUp" },
{ MouseInput::eScrollDown, "ScrollDown" },
{ MouseInput::eMoveRight, "MoveRight" },
{ MouseInput::eMoveLeft, "MoveLeft" },
{ MouseInput::eMoveUp, "MoveUp" },
{ MouseInput::eMoveDown, "MoveDown" }
// clang-format on
};
inline const char* getMouseInputString(MouseInput key)
{
using namespace detail;
return getNameByIdent(key, kMouseInputCodeName, "");
}
inline MouseInput getMouseInputFromString(const char* inputString)
{
using namespace detail;
return getIdentByName(inputString, kMouseInputCodeName, MouseInput::eCount);
}
static constexpr struct
{
GamepadInput ident;
const char* name;
} kGamepadInputCodeName[] = {
// clang-format off
{ GamepadInput::eLeftStickRight, "LeftStickRight" },
{ GamepadInput::eLeftStickLeft, "LeftStickLeft" },
{ GamepadInput::eLeftStickUp, "LeftStickUp" },
{ GamepadInput::eLeftStickDown, "LeftStickDown" },
{ GamepadInput::eRightStickRight, "RightStickRight" },
{ GamepadInput::eRightStickLeft, "RightStickLeft" },
{ GamepadInput::eRightStickUp, "RightStickUp" },
{ GamepadInput::eRightStickDown, "RightStickDown" },
{ GamepadInput::eLeftTrigger, "LeftTrigger" },
{ GamepadInput::eRightTrigger, "RightTrigger" },
{ GamepadInput::eA, "ButtonA" },
{ GamepadInput::eB, "ButtonB" },
{ GamepadInput::eX, "ButtonX" },
{ GamepadInput::eY, "ButtonY" },
{ GamepadInput::eLeftShoulder, "LeftShoulder" },
{ GamepadInput::eRightShoulder, "RightShoulder" },
{ GamepadInput::eMenu1, "Menu1" },
{ GamepadInput::eMenu2, "Menu2" },
{ GamepadInput::eLeftStick, "LeftStick" },
{ GamepadInput::eRightStick, "RightStick" },
{ GamepadInput::eDpadUp, "DpadUp" },
{ GamepadInput::eDpadRight, "DpadRight" },
{ GamepadInput::eDpadDown, "DpadDown" },
{ GamepadInput::eDpadLeft, "DpadLeft" }
// clang-format on
};
inline const char* getGamepadInputString(GamepadInput key)
{
using namespace detail;
return getNameByIdent(key, kGamepadInputCodeName, "");
}
inline GamepadInput getGamepadInputFromString(const char* inputString)
{
using namespace detail;
return getIdentByName(inputString, kGamepadInputCodeName, GamepadInput::eCount);
}
enum class PreviousButtonState
{
kUp,
kDown
};
inline PreviousButtonState toPreviousButtonState(bool wasDown)
{
return wasDown ? PreviousButtonState::kDown : PreviousButtonState::kUp;
}
enum class CurrentButtonState
{
kUp,
kDown
};
inline CurrentButtonState toCurrentButtonState(bool isDown)
{
return isDown ? CurrentButtonState::kDown : CurrentButtonState::kUp;
}
inline ButtonFlags toButtonFlags(PreviousButtonState previousButtonState, CurrentButtonState currentButtonState)
{
ButtonFlags flags = 0;
if (currentButtonState == CurrentButtonState::kDown)
{
flags = kButtonFlagStateDown;
if (previousButtonState == PreviousButtonState::kUp)
flags |= kButtonFlagTransitionDown;
}
else
{
flags = kButtonFlagStateUp;
if (previousButtonState == PreviousButtonState::kDown)
flags |= kButtonFlagTransitionUp;
}
return flags;
}
inline std::string getDeviceNameString(DeviceType deviceType, const char* deviceId)
{
if ((size_t)deviceType >= (size_t)DeviceType::eCount)
return "";
std::string result = getDeviceTypeString(deviceType);
if (deviceId)
{
result.append("[");
result.append(deviceId);
result.append("]");
}
return result;
}
inline void parseDeviceNameString(const char* deviceName, DeviceType* deviceType, std::string* deviceId)
{
if (!deviceName)
{
CARB_LOG_WARN("parseDeviceNameString: Empty device name");
if (deviceType)
{
*deviceType = DeviceType::eCount;
}
return;
}
const char* deviceIdString = strstr(deviceName, "[");
if (deviceType)
{
if (deviceIdString)
{
std::string deviceTypeString(deviceName, deviceIdString - deviceName);
*deviceType = getDeviceTypeFromString(deviceTypeString.c_str());
}
else
{
*deviceType = getDeviceTypeFromString(deviceName);
}
}
if (deviceId)
{
if (deviceIdString)
{
const char* deviceNameEnd = deviceIdString + strlen(deviceIdString);
*deviceId = std::string(deviceIdString + 1, deviceNameEnd - deviceIdString - 2);
}
else
{
*deviceId = "";
}
}
}
inline bool getDeviceInputFromString(const char* deviceInputString,
DeviceType* deviceTypeOut,
KeyboardInput* keyboardInputOut,
MouseInput* mouseInputOut,
GamepadInput* gamepadInputOut,
std::string* deviceIdOut = nullptr)
{
if (!deviceTypeOut)
return false;
const char* deviceInputStringTrimmed = deviceInputString;
// Skip initial spaces
while (*deviceInputStringTrimmed == ' ')
++deviceInputStringTrimmed;
// Skip device name
const char* inputNameString = strstr(deviceInputStringTrimmed, kDeviceNameSeparator);
std::string deviceName;
// No device name specified - fall back
if (!inputNameString)
inputNameString = deviceInputStringTrimmed;
else
{
deviceName = std::string(deviceInputStringTrimmed, inputNameString - deviceInputStringTrimmed);
const size_t kDeviceNameSeparatorLen = strlen(kDeviceNameSeparator);
inputNameString += kDeviceNameSeparatorLen;
}
parseDeviceNameString(deviceName.c_str(), deviceTypeOut, deviceIdOut);
if ((*deviceTypeOut == DeviceType::eKeyboard) && keyboardInputOut)
{
KeyboardInput keyboardInput = getKeyboardInputFromString(inputNameString);
*keyboardInputOut = keyboardInput;
return (keyboardInput != KeyboardInput::eCount);
}
if ((*deviceTypeOut == DeviceType::eMouse) && mouseInputOut)
{
MouseInput mouseInput = getMouseInputFromString(inputNameString);
*mouseInputOut = mouseInput;
return (mouseInput != MouseInput::eCount);
}
if ((*deviceTypeOut == DeviceType::eGamepad) && gamepadInputOut)
{
GamepadInput gamepadInput = getGamepadInputFromString(inputNameString);
*gamepadInputOut = gamepadInput;
return (gamepadInput != GamepadInput::eCount);
}
return false;
}
inline ActionMappingDesc getActionMappingDescFromString(const char* hotkeyString, std::string* deviceId)
{
const size_t kModifierSeparatorSize = strlen(kModifierSeparator);
ActionMappingDesc actionMappingDesc;
actionMappingDesc.keyboard = nullptr;
actionMappingDesc.mouse = nullptr;
actionMappingDesc.gamepad = nullptr;
actionMappingDesc.modifiers = (KeyboardModifierFlags)0;
std::string modifierNameString;
const char* modifierName = hotkeyString;
while (true)
{
const char* modifierNameEnd = strstr(modifierName, kModifierSeparator);
if (modifierNameEnd)
{
modifierNameString = std::string(modifierName, modifierNameEnd - modifierName);
}
else
{
modifierNameString = std::string(modifierName);
}
KeyboardModifierFlags mod = getModifierFlagFromString(modifierNameString.c_str());
if (mod)
{
actionMappingDesc.modifiers = (KeyboardModifierFlags)((uint32_t)actionMappingDesc.modifiers | (uint32_t)mod);
}
else
{
getDeviceInputFromString(modifierNameString.c_str(), &actionMappingDesc.deviceType,
&actionMappingDesc.keyboardInput, &actionMappingDesc.mouseInput,
&actionMappingDesc.gamepadInput, deviceId);
}
if (!modifierNameEnd)
{
break;
}
modifierName = modifierNameEnd;
modifierName += kModifierSeparatorSize;
}
return actionMappingDesc;
}
inline std::string getStringFromActionMappingDesc(const ActionMappingDesc& actionMappingDesc,
const char* deviceName = nullptr)
{
std::string result = getModifierFlagsString(actionMappingDesc.modifiers);
if (!result.empty())
{
result.append(kModifierSeparator);
}
if (deviceName)
{
result.append(deviceName);
}
else
{
result.append(getDeviceTypeString(actionMappingDesc.deviceType));
}
result.append(kDeviceNameSeparator);
switch (actionMappingDesc.deviceType)
{
case DeviceType::eKeyboard:
{
result.append(getKeyboardInputString(actionMappingDesc.keyboardInput));
break;
}
case DeviceType::eMouse:
{
result.append(getMouseInputString(actionMappingDesc.mouseInput));
break;
}
case DeviceType::eGamepad:
{
result.append(getGamepadInputString(actionMappingDesc.gamepadInput));
break;
}
default:
{
break;
}
}
return result;
}
inline bool setDefaultActionMapping(IInput* input,
ActionMappingSet* actionMappingSet,
const char* actionName,
const ActionMappingDesc& desc)
{
size_t actionMappingsCount = input->getActionMappingCount(actionMappingSet, actionName);
if (actionMappingsCount > 0)
{
return false;
}
input->addActionMapping(actionMappingSet, actionName, desc);
return true;
}
/**
* Subscribes to the keyboard event stream for a specified keyboard.
*
* @param input A pointer to input interface.
* @param keyboard A pointer to Logical keyboard, or nullptr if subscription to events from all keyboards is desired.
* @param functor A universal reference to function-like callable object to be called on each keyboard event.
* @return Subscription identifier.
*/
template <typename Functor>
inline SubscriptionId subscribeToKeyboardEvents(IInput* input, Keyboard* keyboard, Functor&& functor)
{
return input->subscribeToKeyboardEvents(
keyboard,
[](const KeyboardEvent& evt, void* userData) -> bool { return (*static_cast<Functor*>(userData))(evt); },
&functor);
}
/**
* Subscribes to the mouse event stream for a specified mouse.
*
* @param input A pointer to input interface.
* @param mouse A pointer to Logical mouse, or nullptr if subscription to events from all mice is desired.
* @param functor A universal reference to function-like callable object to be called on each mouse event.
* @return Subscription identifier.
*/
template <typename Functor>
inline SubscriptionId subscribeToMouseEvents(IInput* input, Mouse* mouse, Functor&& functor)
{
return input->subscribeToMouseEvents(
mouse, [](const MouseEvent& evt, void* userData) -> bool { return (*static_cast<Functor*>(userData))(evt); },
&functor);
}
/**
* Subscribes to the gamepad event stream for a specified gamepad.
*
* @param input A pointer to input interface.
* @param gamepad A pointer to Logical gamepad, or nullptr if subscription to events from all gamepads is desired.
* @param functor A universal reference to function-like callable object to be called on each gamepad event.
* @return Subscription identifier.
*/
template <typename Functor>
inline SubscriptionId subscribeToGamepadEvents(IInput* input, Gamepad* gamepad, Functor&& functor)
{
return input->subscribeToGamepadEvents(
gamepad, [](const GamepadEvent& evt, void* userData) -> bool { return (*static_cast<Functor*>(userData))(evt); },
&functor);
}
/**
* Subscribes to the gamepad connection event stream.
* Once subscribed callback is called for all previously created gamepads.
*
* @param input A pointer to input interface.
* @param functor A universal reference to function-like callable object to be called on each gamepad connection event.
* @return Subscription identifier.
*/
template <typename Functor>
inline SubscriptionId subscribeToGamepadConnectionEvents(IInput* input, Functor&& functor)
{
return input->subscribeToGamepadConnectionEvents(
[](const GamepadConnectionEvent& evt, void* userData) { (*static_cast<Functor*>(userData))(evt); }, &functor);
}
/**
* Subscribes to the action event stream for a specified action.
* Event is triggered on any action value change.
*
* @param input A pointer to input interface.
* @param actionMappingSet A pointer to action mapping set
* @param actionName A pointer to action string identifier.
* @param functor A universal reference to function-like callable object to be called on the action event.
* @return Subscription identifier.
*/
template <typename Functor>
inline SubscriptionId subscribeToActionEvents(IInput* input,
ActionMappingSet* actionMappingSet,
const char* actionName,
Functor&& functor)
{
return input->subscribeToActionEvents(
actionMappingSet, actionName,
[](const ActionEvent& evt, void* userData) -> bool { return (*static_cast<Functor*>(userData))(evt); }, &functor);
}
/**
* Filter and modify a unified input events in the event buffer.
*
* @param input A pointer to input interface.
* @param functor A universal reference to function-like callable object to be called on each input event.
*/
template <typename Callable>
inline void filterBufferedEvents(IInput* input, Callable&& callable)
{
using Func = std::decay_t<Callable>;
input->filterBufferedEvents(
[](InputEvent& evt, void* userData) { return (*static_cast<Func*>(userData))(evt); }, &callable);
}
} // namespace input
} // namespace carb
| 25,506 | C | 30.725124 | 122 | 0.647299 |
omniverse-code/kit/include/carb/input/IInput.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../Interface.h"
#include "InputTypes.h"
namespace carb
{
namespace input
{
struct InputProvider;
class ActionMappingSet;
/**
* Defines an input interface.
*
* Input plugin allows user to listen to the input devices, but it
* is not intended to work with the input hardware. The input hardware processing
* is delegated to the input providers, which should be implemented as a separate
* plugins.
* Input providers create logical input devices. For example, a window may have a keyboard and mouse associated
* with it, i.e. a physical keyboard state may be different from a logical
* keyboard associated with a window, due to some physical key state changes
* being sent to a different window.
*
* Everything to be used by input providers is put into the InputProvider struct in the separate file.
* All the functions from Input.h is meant to be used by input consumers (end user).
*
* User can subscribe to the device events, as well as device connection events,
* and upon subscribing to device connection events, user immediately receives
* "connect" notifications for all already present events of the kind. Similar is
* true for unsubscribing - user will immediately get "disconnect" notifications
* for all still present events.
*
* One notable feature of device handling is that there is no logical difference
* between a button(key) and an axis: both can be either polled by value, producing
* floating-point value, or by button flags, which allow to treat analog inputs
* as buttons (one example is treat gamepad stick as discrete d-pad).
*
* The plugins also allows to map actions to device inputs, allowing to
* set up multiple slots per action mapping. Those actions could be polled in
* a similar manner (i.e. by value or as button flags).
*/
struct IInput
{
CARB_PLUGIN_INTERFACE("carb::input::IInput", 1, 1)
/**
* Gets the input provider's part of the input interface.
*
* @return Input provider interface.
*/
InputProvider*(CARB_ABI* getInputProvider)();
/**
* Start processing input.
*/
void(CARB_ABI* startup)();
/**
* Shutdown and stop processing input.
*/
void(CARB_ABI* shutdown)();
/**
* Get keyboard logical device name.
*
* @param keyboard Logical keyboard.
* @return Specified keyboard logical device name string.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use getDeviceName instead.
@endrst
*/
const char*(CARB_ABI* getKeyboardName)(Keyboard* keyboard);
/**
* Subscribes plugin user to the keyboard event stream for a specified keyboard.
*
* @param keyboard Logical keyboard, or nullptr if subscription to events from all keyboards is desired.
* @param fn Callback function to be called on received event.
* @param userData Pointer to the user data to be passed into the callback.
* @return Subscription identifier.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use subscribeToInputEvents instead.
@endrst
*/
SubscriptionId(CARB_ABI* subscribeToKeyboardEvents)(Keyboard* keyboard, OnKeyboardEventFn fn, void* userData);
/**
* Unsubscribes plugin user from the keyboard event stream for a specified keyboard.
*
* @param keyboard Logical keyboard.
* @param subscriptionId Subscription identifier.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use unsubscribeToInputEvents instead.
@endrst
*/
void(CARB_ABI* unsubscribeToKeyboardEvents)(Keyboard* keyboard, SubscriptionId id);
/**
* Gets the value for the specified keyboard input kind or number of keys that are pressed.
*
* @param keyboard Logical keyboard or nullptr to test all keyboards.
* @param input Keyboard input kind (key) to test, or KeyboardInput::eCount to count the number of keys down.
* @return Specified keyboard input value when key is specific, or count of keys pressed for KeyboardInput::eCount.
*/
float(CARB_ABI* getKeyboardValue)(Keyboard* keyboard, KeyboardInput input);
/**
* Gets the button flag for the specified keyboard input kind.
* Each input is treated as button, based on the press threshold.
*
* @param keyboard Logical keyboard.
* @param input Keyboard input kind (key).
* @return Specified keyboard input as button flags.
*/
ButtonFlags(CARB_ABI* getKeyboardButtonFlags)(Keyboard* keyboard, KeyboardInput input);
/**
* Get mouse logical device name.
*
* @param mouse Logical mouse.
* @return Specified mouse logical device name string.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use getDeviceName instead.
@endrst
*/
const char*(CARB_ABI* getMouseName)(Mouse* mouse);
/**
* Gets the value for the specified mouse input kind.
*
* @param mouse Logical mouse.
* @param input Mouse input kind (button/axis).
* @return Specified mouse input value.
*/
float(CARB_ABI* getMouseValue)(Mouse* mouse, MouseInput input);
/**
* Gets the button flag for the specified mouse input kind.
* Each input is treated as button, based on the press threshold.
*
* @param mouse Logical mouse.
* @param input Mouse input kind (button/axis).
* @return Specified mouse input as button flags.
*/
ButtonFlags(CARB_ABI* getMouseButtonFlags)(Mouse* mouse, MouseInput input);
/**
* Gets the mouse coordinates for the specified mouse, normalized by the associated window size.
*
* @param mouse Logical mouse.
* @return Coordinates.
*/
Float2(CARB_ABI* getMouseCoordsNormalized)(Mouse* mouse);
/**
* Gets the absolute mouse coordinates for the specified mouse.
*
* @param mouse Logical mouse.
* @return Coordinates.
*/
Float2(CARB_ABI* getMouseCoordsPixel)(Mouse* mouse);
/**
* Subscribes plugin user to the mouse event stream for a specified mouse.
*
* @param mouse Logical mouse, or nullptr if subscription to events from all mice is desired.
* @param fn Callback function to be called on received event.
* @param userData Pointer to the user data to be passed into the callback.
* @return Subscription identifier.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use subscribeToInputEvents instead.
@endrst
*/
SubscriptionId(CARB_ABI* subscribeToMouseEvents)(Mouse* mouse, OnMouseEventFn fn, void* userData);
/**
* Unsubscribes plugin user from the mouse event stream for a specified mouse.
*
* @param mouse Logical mouse.
* @param subscriptionId Subscription identifier.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use unsubscribeToInputEvents instead.
@endrst
*/
void(CARB_ABI* unsubscribeToMouseEvents)(Mouse* mouse, SubscriptionId id);
/**
* Get gamepad logical device name.
*
* @param gamepad Logical gamepad.
* @return Specified gamepad logical device name string.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use getDeviceName instead.
@endrst
*/
const char*(CARB_ABI* getGamepadName)(Gamepad* gamepad);
/**
* Get gamepad GUID.
*
* @param gamepad Logical gamepad.
* @return Specified gamepad logical device GUID.
*/
const char*(CARB_ABI* getGamepadGuid)(Gamepad* gamepad);
/**
* Gets the value for the specified gamepad input kind.
*
* @param gamepad Logical gamepad.
* @param input Gamepad input kind (button/axis).
* @return Specified gamepad input value.
*/
float(CARB_ABI* getGamepadValue)(Gamepad* gamepad, GamepadInput input);
/**
* Gets the button flag for the specified gamepad input kind.
* Each input is treated as button, based on the press threshold.
*
* @param gamepad Logical gamepad.
* @param input Gamepad input kind (button/axis).
* @return Specified gamepad input as button flags.
*/
ButtonFlags(CARB_ABI* getGamepadButtonFlags)(Gamepad* gamepad, GamepadInput input);
/**
* Subscribes plugin user to the gamepad event stream for a specified gamepad.
*
* @param gamepad Logical gamepad, or nullptr if subscription to events from all gamepads is desired.
* @param fn Callback function to be called on received event.
* @param userData Pointer to the user data to be passed into the callback.
* @return Subscription identifier.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use subscribeToInputEvents instead.
@endrst
*/
SubscriptionId(CARB_ABI* subscribeToGamepadEvents)(Gamepad* gamepad, OnGamepadEventFn fn, void* userData);
/**
* Unsubscribes plugin user from the gamepad event stream for a specified gamepad.
*
* @param gamepad Logical gamepad.
* @param subscriptionId Subscription identifier.
*
* @rst
.. deprecated:: 100.1
This method is deprecated and will be removed soon, please use unsubscribeToInputEvents instead.
@endrst
*/
void(CARB_ABI* unsubscribeToGamepadEvents)(Gamepad* gamepad, SubscriptionId id);
/**
* Subscribes plugin user to the gamepad connection event stream.
* Once subscribed callback is called for all previously created gamepads.
*
* @param fn Callback function to be called on received event.
* @param userData Pointer to the user data to be passed into the callback.
* @return Subscription identifier.
*/
SubscriptionId(CARB_ABI* subscribeToGamepadConnectionEvents)(OnGamepadConnectionEventFn fn, void* userData);
/**
* Unsubscribes plugin user from the gamepad connection event stream.
* Unsubscription triggers callback to be called with all devices left as being destroyed.
*
* @param subscriptionId Subscription identifier.
*/
void(CARB_ABI* unsubscribeToGamepadConnectionEvents)(SubscriptionId id);
/**
* Processes buffered events queue and sends unconsumed events as device events, action mapping events, and
* updates device states. Clears buffered events queues.
*/
void(CARB_ABI* distributeBufferedEvents)();
/**
* Create action mapping set - a place in settings where named action mappings are stored.
*
* @param settingsPath Path in settings where the set mappings are stored.
* @return Opaque pointer to the action mapping set.
*/
ActionMappingSet*(CARB_ABI* createActionMappingSet)(const char* settingsPath);
/**
* Get existing action mapping set from the settings path provided.
*
* @param settingsPath Path in settings where the set mappings are stored.
* @return Opaque pointer to the action mapping set.
*/
ActionMappingSet*(CARB_ABI* getActionMappingSetByPath)(const char* settingsPath);
/**
* Destroy action mapping set.
*
* @param actionMappingSet Opaque pointer to the action mapping set.
*/
void(CARB_ABI* destroyActionMappingSet)(ActionMappingSet* actionMappingSet);
/**
* Get total action count registered in the plugin with 1 or more action mapping.
*
* @return The number of the actions.
*/
size_t(CARB_ABI* getActionCount)(ActionMappingSet* actionMappingSet);
/**
* Get array of all actions.
* The size of an array is equal to the Input::getActionCount().
*
* @return The array of actions.
*/
const char* const*(CARB_ABI* getActions)(ActionMappingSet* actionMappingSet);
/**
* Adds action mapping to the specified action.
* Each action keeps a list of mappings. This function push mapping to the end of the list.
*
* @param actionName Action string identifier.
* @param desc Action mapping description.
* @return The index of added mapping.
*/
size_t(CARB_ABI* addActionMapping)(ActionMappingSet* actionMappingSet,
const char* actionName,
const ActionMappingDesc& desc);
/**
* Sets and overrides the indexed action mapping for the specified action.
* Each action keeps a list of mappings. This function sets list item according by the index.
*
* @param actionName Action string identifier.
* @param index The index of mapping to override. It should be in range [0, mapping count).
* @param desc Action mapping description.
*/
void(CARB_ABI* setActionMapping)(ActionMappingSet* actionMappingSet,
const char* actionName,
size_t index,
const ActionMappingDesc& desc);
/**
* Remove indexed action mapping for the specified action.
* Each action keeps a list of mappings. This function removes list item by the index.
*
* @param actionName Action string identifier.
* @param index The index of mapping to remove. It should be in range [0, mapping count).
*/
void(CARB_ABI* removeActionMapping)(ActionMappingSet* actionMappingSet, const char* actionName, size_t index);
/**
* Clears and removes all mappings associated with the action.
*
* @param actionName Action string identifier.
*/
void(CARB_ABI* clearActionMappings)(ActionMappingSet* actionMappingSet, const char* actionName);
/**
* Get mappings count associated with the action.
*
* @param action Action string identifier.
* @return The number of the mapping in the list for an action.
*/
size_t(CARB_ABI* getActionMappingCount)(ActionMappingSet* actionMappingSet, const char* actionName);
/**
* Get array of mappings associated with the action.
* The size of an array is equal to the Input::getMappingCount().
*
* @param actionName Action string identifier.
* @return The array of mappings for an action.
*/
const ActionMappingDesc*(CARB_ABI* getActionMappings)(ActionMappingSet* actionMappingSet, const char* actionName);
/**
* Gets the value for the specified action.
* If multiple mapping are associated with the action the biggest value is returned.
*
* @param actionName Action string identifier.
* @return Specified action value.
*/
float(CARB_ABI* getActionValue)(ActionMappingSet* actionMappingSet, const char* actionName);
/**
* Gets the button flag for the specified action.
* Each mapping is treated as button, based on the press threshold.
*
* @param actionName Action string identifier.
* @return Specified action value as button flags.
*/
ButtonFlags(CARB_ABI* getActionButtonFlags)(ActionMappingSet* actionMappingSet, const char* actionName);
/**
* Subscribes plugin user to the action event stream for a specified action.
* Event is triggered on any action value change.
*
* @param action Action string identifier.
* @param fn Callback function to be called on received event.
* @param userData Pointer to the user data to be passed into the callback.
* @return Subscription identifier.
*/
SubscriptionId(CARB_ABI* subscribeToActionEvents)(ActionMappingSet* actionMappingSet,
const char* actionName,
OnActionEventFn fn,
void* userData);
/**
* Unsubscribes plugin user from the action event stream for a specified action.
*
* @param action Action string identifier.
* @param subscriptionId Subscription identifier.
*/
void(CARB_ABI* unsubscribeToActionEvents)(SubscriptionId id);
/**
* Filters all buffered events by calling the specified filter function on each event.
*
* The given @p fn may modify events in-place and/or may add additional events via the InputProvider obtained from
* getInputProvider(). Any additional events that are added during a call to filterBufferedEvents() will not be
* passed to @p fn during that call. However, future calls to filterBufferedEvents() will pass the events to @p fn.
* Any new buffered events added by InputProvider during @p fn will be added to the end of the event list. Events
* modified during @p fn remain in their relative position in the event list.
*
* The outcome of an event is based on what @p fn returns for that event. If FilterResult::eConsume is returned, the
* event is considered processed and is removed from the list of buffered events. Future calls to
* filterBufferedEvents() will not receive the event and it will not be sent when distributeBufferedEvents() is
* called. If FilterResult::eRetain is returned, the (possibly modified) event remains in the list of buffered
* events. Future calls to filterBufferedEvents() will receive the event and it will be sent when
* distributeBufferedEvents() is called.
*
* This function may be called multiple times to re-filter events. For instance, the given @p fn may be interested
* in only certain types of events.
*
* The remaining buffered events are sent when distributeBufferedEvents() is called, at which point the list of
* buffered events is cleared.
*
* @warning Calling filterBufferedEvents() or distributeBufferedEvents() from @p fn is expressly disallowed.
*
* @thread_safety An internal lock is held while @p fn is called on all events, which synchronizes-with
* distributeBufferedEvents() and the various InputProvider functions to buffer events. Although the lock provides
* thread safety to synchronize these operations, if buffered events are added from other threads it is conceivable
* that events could be added between filterBufferedEvents() and distributeBufferedEvents(), causing them to be sent
* before being filtered. If this is a cause for concern, use of an external lock is recommended.
*
* @param fn A pointer to a callback function to be called on each input event.
* @param userData A pointer to the user data to be passed into the callback.
*/
void(CARB_ABI* filterBufferedEvents)(InputEventFilterFn fn, void* userData);
/**
* Get input device name.
*
* @param device Input device.
* @return Specified input device name string.
*/
const char*(CARB_ABI* getDeviceName)(InputDevice* device);
/**
* Get input device type.
*
* @param device Input device.
* @return Specified input device type or DeviceType::eUnknown.
*/
DeviceType(CARB_ABI* getDeviceType)(InputDevice* device);
/**
* Subscribes plugin user to the input event stream for a specified device.
*
* @param device Input device, or nullptr if subscription to events from all devices is desired.
* @param events A bit mask to event types to subscribe to. Currently kEventTypeAll is only supported.
* @param fn Callback function to be called on received event.
* @param userData Pointer to the user data to be passed into the callback.
* @param order Subscriber position hint [0..N-1] from the beginning, [-1, -N] from the end (-1 is default).
* @return Subscription identifier.
*/
SubscriptionId(CARB_ABI* subscribeToInputEvents)(
InputDevice* device, EventTypeMask events, OnInputEventFn fn, void* userData, SubscriptionOrder order);
/**
* Unsubscribes plugin user from the input event stream for a specified device.
*
* @param subscriptionId Subscription identifier.
*/
void(CARB_ABI* unsubscribeToInputEvents)(SubscriptionId id);
/**
* Gets the modifer state on specific devices and/or device-types.
*
* @param modifierFlags The modifiers to check against, or 0 to check against all modifiers.
* @param devices An array of InputDevice pointers.
* @param nDevices The number of devices in the devices array.
* @param deviceTypes An array of device-types to check against.
* @param nDeviceTypes The number of device-types in the devices array.
* @param mouseButtons An array of mouse buttons to test against.
* @param numMouseButtons The number of buttons in the mouseButtons array.
* @return KeyboardModifierFlags for all devices queried.
*/
KeyboardModifierFlags(CARB_ABI* getModifierFlags)(KeyboardModifierFlags modifierFlags,
const InputDevice* const* devices,
size_t nDevices,
const DeviceType* const deviceTypes,
size_t nDeviceTypes,
const MouseInput* mouseButtons,
size_t numMouseButtons);
/**
* Gets the modifer state on all known keyboard and mouse devices.
*
* @param modifierFlags The modifiers to check against, or 0 to check against all modifiers.
* @param mouseButtons An array of mouse buttons to test against (providing nullptr will test against all mouse
* buttons).
* @param numMouseButtons The number of buttons in the mouseButtons array.
* @return KeyboardModifierFlags for all devices queried.
*/
KeyboardModifierFlags(CARB_ABI* getGlobalModifierFlags)(KeyboardModifierFlags modifierFlags,
const MouseInput* mouseButtons,
size_t numMouseButtons);
};
} // namespace input
} // namespace carb
| 22,764 | C | 41.001845 | 120 | 0.672685 |
omniverse-code/kit/include/carb/delegate/Delegate.h | // Copyright (c) 2021-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Carbonite Delegate implementation.
#pragma once
#include "../Defines.h"
#include "../Strong.h"
#include "../container/IntrusiveList.h"
#include "../cpp/Tuple.h"
#include "../thread/Mutex.h"
#include "../thread/Util.h"
#include <type_traits>
#include <vector>
#include <memory>
namespace carb
{
//! Namespace for Carbonite delegate implementation.
namespace delegate
{
template <class T>
class Delegate;
template <class T>
class DelegateRef;
/**
* Implements a thread-safe callback system that can have multiple subscribers.
*
* A delegate is a weak-coupling callback system. Essentially, a system uses Delegate to have a callback that can
* be received by multiple subscribers.
*
* Delegate has two ways to uniquely identify a bound callback: \ref Bind() will output a \ref Handle, or the
* caller can provide a key of any type with BindWithKey(). Either the \ref Handle or the given key can be passed to
* \ref Unbind() in order to remove a callback.
*
* Delegate can call all bound callbacks with the Call() function. Recursive calling is allowed with caveats listed
* below.
*
* Delegate is thread-safe for all operations. Call() can occur simultaneously in multiple threads. An Unbind()
* will wait if the bound callback is currently executing in another thread.
*
* Delegate can be destroyed from a binding (during \ref Call()) as the internal state is not disposed of
* until all active calls have been completed. See ~Delegate().
*
* Delegate does not hold any internal locks while calling bound callbacks. It is strongly recommended to avoid
* holding locks when invoking Delegate's \ref Call() function.
*
* These tenets make up the basis of Carbonite's Basic Callback Hygiene as described in the @rstdoc{../../../../CODING}.
*/
template <class... Args>
class Delegate<void(Args...)>
{
public:
//! A type representing the function type
using FunctionType = void(Args...);
/**
* A quasi-unique identifier outputted from Bind()
*
* \ref Handle is unique as long as it has not rolled over.
*/
CARB_STRONGTYPE(Handle, size_t);
CARB_DOC_CONSTEXPR static Handle kInvalidHandle{ 0 }; //!< A value representing an invalid \ref Handle value
/**
* Constructs an empty delegate
*/
Delegate() = default;
/**
* Move constructor.
*
* @param other The Delegate to move from. This Delegate will be left in a valid but empty state.
*/
Delegate(Delegate&& other);
/**
* Move-assign operator
*
* @param other The Delegate to move-assign from. Will be swapped with `*this`.
*
* @returns `*this`
*/
Delegate& operator=(Delegate&& other);
/**
* Destructor.
*
* The destructor unbinds all bindings and follows the waiting paradigm explained by \ref UnbindAll(). As the
* internal state of the delegate is held until all active calls have completed, it is valid to destroy Delegate
* from a callback.
*/
~Delegate();
/**
* Binds a callable (with optional additional arguments) to the delegate.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* \note This function can be done from within a callback. If done during a callback, the newly bound callable will
* not be available to be called until \ref Call() returns, at which point the callback can be called by other
* threads or outer \ref Call() calls (in the case of recursive calls to \ref Call()).
*
* @param hOut An optional pointer that receives a \ref Handle representing the binding to \c Callable. This can
* be \c nullptr to ignore the \ref Handle. The same \ref Handle is also returned. In a multi-threaded environment,
* it is possible for \p func to be called before \ref Bind() returns, but \p hOut will have already been assigned.
* @param func A callable object, such as lambda, functor or [member-]function. Return values are ignored. The
* callable must take as parameters \p args followed by the \c Args declared in the delegate template signature.
* @param args Additional optional arguments to bind with \p func. If \p func is a member function pointer the
* first argument must be the \c this pointer to call the member function with.
* @return The \ref Handle also passed to \p hOut.
*/
template <class Callable, class... BindArgs>
Handle Bind(Handle* hOut, Callable&& func, BindArgs&&... args);
/**
* Binds a callable (with optional additional arguments) to the delegate with a user-defined key.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* \note This function can be done from within a callback. If done during a callback, the newly bound callable will
* not be available to be called until \ref Call() returns, at which point the callback can be called by other
* threads or outer \ref Call() calls (in the case of recursive calls to \ref Call()).
*
* @param key A user-defined key of any type that supports equality (==) to identify this binding. Although multiple
* bindings can be referenced by the same key, Unbind() will only remove a single binding.
* @param func A callable object, such as lambda, functor or [member-]function. Return values are ignored. The
* callable must take as parameters \p args followed by the \c Args declared in the delegate template signature.
* @param args Additional optional arguments to bind with \p func. If \p func is a member function pointer the
* first argument must be the \c this pointer to call the member function with.
*/
template <class KeyType, class Callable, class... BindArgs>
void BindWithKey(KeyType&& key, Callable&& func, BindArgs&&... args);
/**
* Unbinds any single binding referenced by the given key.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* This function can be done from within a callback. If the referenced binding is currently executing in
* another thread, Unbind() will not return until it has finished. Any binding can be safely unbound during a
* callback. If a binding un-binds itself, the captured arguments and callable object will not be destroyed
* until just before \ref Call() returns.
*
* \note It is guaranteed that when \ref Unbind() returns, the callback is not running and will never run in any
* threads.
*
* @param key A \ref Handle or user-defined key previously passed to \ref BindWithKey().
* @return \c true if a binding was un-bound; \c false if no binding matching key was found.
*/
template <class KeyType>
bool Unbind(KeyType&& key);
/**
* Indicates if a binding exists in `*this` with the given key or Handle.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
* However, without external synchronization, it is possible for the result of this function to be incorrect by the
* time it is used.
*
* @param key A \ref Handle or user-defined key previously passed to \ref BindWithKey().
* @returns \c true if a binding exists with the given \p key; \c false if no binding matching key was found.
*/
template <class KeyType>
bool HasKey(KeyType&& key) const noexcept;
/**
* Unbinds the currently executing callback without needing an identifying key.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* \note If not done within the context of a callback, this function has no effect.
*
* @return \c true if a binding was un-bound; \c false if there is no current binding.
*/
bool UnbindCurrent();
/**
* Unbinds all bound callbacks, possibly waiting for active calls to complete.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* Unbinds all currently bound callbacks. This function will wait to return until bindings that it unbinds have
* completed all calls in other threads. It is safe to perform this operation from within a callback.
*/
void UnbindAll();
/**
* Returns the number of active bound callbacks.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* \note This function returns the count of \a active bound callbacks only. Pending callbacks (that were added with
* \ref Bind() during \ref Call()) are not counted. Use \ref HasPending() to determine if pending bindings exist.
*
* @returns the number of active bound callbacks.
*/
size_t Count() const noexcept;
/**
* Checks whether the Delegate has any pending bindings.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
* The nature of this function is such that the result may be stale by the time it is read in the calling thread,
* unless the calling thread has at least one pending binding.
*
* \note This function returns \c true if any \a pending bound callbacks exist. This will only ever be non-zero if
* one or more threads are currently in the \ref Call() function.
*
* @returns \c true if any pending bindings exist; \c false otherwise.
*/
bool HasPending() const noexcept;
/**
* Checks whether the Delegate contains no pending or active bound callbacks.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
* However, without external synchronization, it is possible for the result of this function to be incorrect by the
* time it is used.
*
* @returns \c true if there are no active or pending callbacks present in `*this`; \c false otherwise.
*/
bool IsEmpty() const noexcept;
/**
* Given a type, returns a \c std::vector containing a copy of all keys used for bindings.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* \note This function can be done from within a callback. Pending callbacks (that were added with \ref Bind()
* during \ref Call()) are included, even if they are pending in other threads. Note that in a multi-threaded
* environment, the actual keys in use by Delegate may change after this function returns; in such cases, an
* external mutex is recommended. \c KeyType must be Copyable in order for this function to compile.
*
* @tparam KeyType \ref Handle or a type previously passed to \ref BindWithKey()
* @return a \c std::vector of copies of keys of the given type in use by this Delegate.
*/
template <class KeyType>
std::vector<std::decay_t<KeyType>> GetKeysByType() const;
/**
* Calls all bound callbacks for this Delegate.
*
* \thread_safety: Thread-safe with respect to other Delegate operations except for construction and destruction.
*
* \note This function can be done concurrently in multiple threads simultaneously. Recursive calls to \ref Call()
* are allowed but the caller must take care to avoid endless recursion. Callbacks are free to call \ref Bind(),
* \ref Unbind() or any other Delegate function. No internal locks are held while callbacks are called.
*
* @param args The arguments to pass to the callbacks.
*/
void Call(Args... args);
/**
* Syntactic sugar for \ref Call()
*/
void operator()(Args... args);
/**
* Swaps with another Delegate.
*
* @param other The Delegate to swap with.
*/
void swap(Delegate& other);
CARB_PREVENT_COPY(Delegate);
private:
template <class U>
friend class DelegateRef;
struct BaseBinding;
template <class Key>
struct KeyedBinding;
using Container = carb::container::IntrusiveList<BaseBinding, &BaseBinding::link>;
struct ActiveCall;
using ActiveCallList = carb::container::IntrusiveList<ActiveCall, &ActiveCall::link>;
struct Impl : public std::enable_shared_from_this<Impl>
{
mutable carb::thread::mutex m_mutex;
Container m_entries;
ActiveCallList m_activeCalls;
~Impl();
};
constexpr Delegate(std::nullptr_t);
Delegate(std::shared_ptr<Impl> pImpl);
ActiveCall* lastCurrentThreadCall();
const ActiveCall* lastCurrentThreadCall() const;
void UnbindInternal(std::unique_lock<carb::thread::mutex>& g, typename Container::iterator iter);
static size_t nextHandle();
std::shared_ptr<Impl> m_impl{ std::make_shared<Impl>() };
};
/**
* Holds a reference to a Delegate.
*
* Though Delegate is non-copyable, \c DelegateRef can be thought of as a `std::shared_ptr` for Delegate.
* This allows a Delegate's bindings to remain active even though the original Delegate has been destroyed, which can
* allow calls in progress to complete, or a mutex protecting the original Delegate to be unlocked.
*/
template <class... Args>
class DelegateRef<void(Args...)>
{
public:
//! The Delegate type that is referenced.
using DelegateType = Delegate<void(Args...)>;
/**
* Default constructor.
*
* Creates an empty DelegateRef such that `bool(*this)` would be `false`.
*/
constexpr DelegateRef() noexcept;
/**
* Constructor.
*
* Constructs a DelegateRef that holds a strong reference to \p delegate.
* @param delegate The Delegate object to hold a reference to.
*/
explicit DelegateRef(DelegateType& delegate);
/**
* Copy constructor.
*
* References the same underlying Delegate that \p other references. If \p other is empty, `*this` will also be
* empty.
* @param other A DelegateRef to copy.
*/
DelegateRef(const DelegateRef& other);
/**
* Move constructor.
*
* Moves the reference from \p other to `*this`. If \p other is empty, `*this` will also be empty. \p other is left
* in a valid but empty state.
* @param other A DelegateRef to move.
*/
DelegateRef(DelegateRef&& other) = default;
/**
* Destructor
*/
~DelegateRef();
/**
* Copy-assign.
*
* References the same underlying Delegate that \p other references and releases any existing reference. The order
* of these operations is unspecified, so assignment from `*this` is undefined behavior.
* @param other A DelegateRef to copy.
* @returns `*this`.
*/
DelegateRef& operator=(const DelegateRef& other);
/**
* Move-assign.
*
* Moves the reference from \p other to `*this` and releases any existing reference. The order of these operations
* is unspecified, so assignment from `*this` is undefined behavior. If \p other is empty, `*this` will also be
* empty. \p other is left in a valid but empty state.
* @param other A DelegateRef to move.
* @returns `*this`.
*/
DelegateRef& operator=(DelegateRef&& other) = default;
/**
* Checks whether the DelegateRef holds a valid reference.
* @returns `true` if `*this` holds a valid reference; `false` otherwise.
*/
explicit operator bool() const noexcept;
/**
* Clears the DelegateRef to an empty reference.
*
* Postcondition: `bool(*this)` will be `false`.
*/
void reset();
/**
* References a different Delegate and releases any existing reference.
* @param delegate The Delegate to reference.
*/
void reset(DelegateType& delegate);
/**
* Swaps the reference with another DelegateRef.
* @param other A DelegateRef to swap with.
*/
void swap(DelegateRef& other);
/**
* Retrieves the underlying DelegateType.
* @returns a pointer to the referenced Delegate, or `nullptr` if `bool(*this)` would return false.
*/
DelegateType* get() const noexcept;
/**
* Dereferences *this.
* @returns a reference to the referenced Delegate. If `bool(*this)` would return false, behavior is undefined.
*/
DelegateType& operator*() const noexcept;
/**
* Dereferences *this.
* @returns a pointer to the referenced Delegate. If `bool(*this)` would return false, behavior is undefined.
*/
DelegateType* operator->() const noexcept;
private:
DelegateType m_delegate;
};
//! A helper class for determining the type of a \ref carb::delegate::DelegateRef based on a
//! \ref carb::delegate::Delegate. @tparam Del a \ref carb::delegate::Delegate
template <class Del>
struct RefFromDelegate
{
//! The type of \ref DelegateRef that should be used for a \ref Delegate of type `Del`
using type = DelegateRef<typename Del::FunctionType>;
};
//! Definition helper for `RefFromDelegate<Del>::type`
template <class Del>
using RefFromDelegate_t = typename RefFromDelegate<Del>::type;
} // namespace delegate
} // namespace carb
#include "DelegateImpl.inl"
CARB_INCLUDE_PURIFY_TEST({
using namespace carb::delegate;
Delegate<void()> d, d2{ Delegate<void()>{} }, d3 = Delegate<void()>();
auto b = d.Bind(nullptr, [] {});
d.Bind(nullptr, [](bool) {}, true);
d.BindWithKey(0, [] {});
d.BindWithKey(1, [](bool) {}, false);
d.Unbind(1);
d.Unbind(b);
d.HasKey(0);
d.UnbindCurrent();
d2.UnbindAll();
d.Count();
d.HasPending();
d.IsEmpty();
d.GetKeysByType<int>();
d.Call();
d();
d.swap(d3);
DelegateRef<void()> dr(d), dr2{};
DelegateRef<void()> dr3(dr);
DelegateRef<void()> dr4(std::move(dr2));
DelegateRef<void()> dr5 = std::move(dr4);
DelegateRef<void()> dr6 = dr5;
CARB_UNUSED(bool(dr6));
dr6.reset();
dr5.reset(d);
dr5.get();
(*dr).Call();
dr->Call();
});
| 18,622 | C | 37.240246 | 120 | 0.679519 |
omniverse-code/kit/include/carb/launcher/ILauncher.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Simple external process launcher helper interface.
*/
#pragma once
#include "../Interface.h"
#if CARB_PLATFORM_LINUX
# include <sys/prctl.h>
# include <sys/signal.h>
#endif
namespace carb
{
/** Namespace for the Carbonite process launch helper interface. */
namespace launcher
{
// ****************************** structs, enums, and constants ***********************************
/** Opaque object used to represent a process that has been launched using the ILauncher
* interface. A value of `nullptr` indicates an invalid process object.
*/
struct Process;
/** Base type for a process exit code. Process exit codes differ between Windows and Linux - on
* Windows a process exit code is a DWORD, while on Linux it is an int. This type should be able
* to successfully hold any value from either platform.
*/
using ExitCode = int64_t;
/** Base type for the identifier of a process. This does not conform directly to the local
* definitions of a process ID for either Windows or Linux, but it should at least be large
* enough to properly contain either.
*/
using ProcessId = uint64_t;
/** Format code to use for the @ref carb::launcher::ProcessId data type in printf() style format
* strings.
*/
#define OMNI_ILauncher_PRIpid PRIu64
/** Special value to indicate a bad process identifier. This can be returned from
* ILauncher::getProcessId() if the given child process is no longer running.
*/
constexpr ProcessId kBadId = ~0ull;
/** Prototype for a stream read callback function.
*
* @param[in] data The buffer of data that was read from the child process's stream. This
* will never be `nullptr`. Only the first @p bytes bytes of data in this
* buffer will contain valid data. Any data beyond that should be considered
* undefined and not accessed.
* @param[in] bytes The number of bytes of valid data in the @p data buffer. This will never
* be 0 as long as the connection to the child process is active. When the
* child process exits and the read thread has read all of the data from the
* child process, one final callback will be performed passing 0 for the byte
* count to indicate the end of the stream. This count will not exceed the
* buffer size specified in the original call to ILauncher::openProcess().
* @param[in] context The context value that was originally passed to ILauncher::openProcess()
* when the child process was created.
* @returns No return value.
*
* @remarks This callback will be performed any time data is successfully read from one of the
* child process's output streams (ie: `stdout` or `stderr`). The call will be performed
* on a worker thread that was created specifically for the child process. This
* callback will be performed as soon after reading the data as possible. The reader
* thread will remain in an efficient wait state while there is no data read to be
* read. It is the callback's responsibility to ensure any shared resources that are
* accessed in the callback are appropriately protected from race conditions and
* general thread safety issues.
*
* @remarks When reading from one of the child process' output streams, every effort will be
* taken to ensure the contents of at least one 'message' is delivered to the callback
* at a time. A message can be thought of as the unit of data that was last written
* to the stream on the child process's side - for example, the output of a single call
* to fwrite() or fprintf(). However, there are a some caveats to this behavior that
* the callback and its owner need to be able to handle:
* * It is possible that depending on the size and arrival times of messages, multiple
* messages may be concatenated into a single callback call. The callback needs to
* be able to handle this by being able to identify expected message ends and
* properly parse them out if needed.
* * If the current message or set of messages fills up the read buffer, the buffer
* as it is will be delivered to the callback with the last message truncated. The
* remainder of the message will be sent in the next callback. The callback needs
* to be able to handle this by either using a buffer size appropriate for the
* expected output of the child process, or by having the callback simply concatenate
* incoming data onto a data queue that is then processed elsewhere.
*
* @remarks This callback should attempt to complete its task as quickly as possible to avoid
* blocking the read thread. If the callback blocks or takes a long time to process
* it may result in blocking the child process's attempts to write to the stream. The
* child process' thread will be effectively stopped until buffer space is freed up
* on the parent's read side. It is best practice to have the callback simply queue
* up new data for later consumption on another thread in the parent process or to do
* a few simple string or data checks if searching for a specific incoming data message.
*
* @remarks When the stream for this callback ends due to either the child or parent process
* closing it, one final callback will be performed. The last callback will always
* have a @p bytes value of 0 in this case. All other callbacks during the stream
* will have a non-zero @p bytes value. Even in this final callback case however,
* a non-`nullptr` @p data buffer will still be provided. Once the zero sized buffer
* has been delivered, the parent process can safely assume that the child process
* is done transmitting any data to the parent.
*/
using OnProcessReadFn = void (*)(const void* data, size_t bytes, void* context);
/** A default buffer size to use for reading from a child process's `stdout` or `stderr` streams. */
constexpr size_t kDefaultProcessBufferSize = 1ull << 17;
/** Launcher flags
* @{
*/
/** Base type for flags to the @ref carb::launcher::ILauncher::launchProcess function. Valid flags for this
* type are the carb::launcher::fLaunchFlag* flags.
*/
using LauncherFlags = uint32_t;
/** Flag to indicate that the stdin stream for the child process should be opened and accessible
* on the side of the parent process. If this flag is not present, any attempts to call
* ILauncher::writeProcessStdin() will fail immediately. If this flag is present, the parent
* process may write information to the child process through its stdin stream. The child
* process will be able to poll its stdin stream for input and read it. If this is used, the
* child process will only be able to read input from the parent process. If not used, the
* child process should assume that stdin cannot be read (though the actual behavior may
* differ by platform following native stdin inheritance rules).
*/
constexpr LauncherFlags fLaunchFlagOpenStdin = 0x00000001;
/** Flag to indicate that the new child process should be killed when the calling parent process
* exits. If this flag is not present, the child process will only exit when it naturally exits
* on its own or is explicitly killed by another process. If this flag is present, if the parent
* process exits in any way (ie: ends naturally, crashes, is killed, etc), the child process
* will also be killed. Note that the child process will be killed without warning or any
* chance to clean up. Any state in the child process that was not already saved to persistent
* storage will be lost. Also, if the child process is in the middle of modifying persistent
* storage when it is killed, that resource may be left in an undefined state.
*
* @note This flag is not supported on Mac. It will be ignored if used on Mac and the child
* process(es) must be manually terminated by the parent process if necessary.
*/
constexpr LauncherFlags fLaunchFlagKillOnParentExit = 0x00000002;
/** When the @ref fLaunchFlagKillOnParentExit flag is also used, this indicates that the child
* process should be forcibly terminated instead of just being asked to exit when the parent
* process dies. This flag is only used on Linux where there is the possibility of a child
* process catching and handling a SIGTERM signal. If the child process generally installs
* a SIGTERM handler and doesn't exit as a result, this flag should be used to allow a SIGKILL
* to be sent instead (which can neither be caught nor ignored). Generally, sending a SIGTERM
* is considered the 'correct' or 'appropriate' way to kill a process on Linux. This flag is
* ignored on Windows.
*/
constexpr LauncherFlags fLaunchFlagForce = 0x00000004;
/** Flag to indicate that reading from the `stdout` or `stderr` streams of the child process should
* be handled as a byte stream. Data will be delivered to the stream callback as soon as it is
* available. The delivered bytes may only be a small portion of a complete message sent from
* the child process. At least one byte will be sent when in this mode. This is the default
* mode for all child processes. This flag may not be combined with @ref fLaunchFlagMessageMode.
* When using this read mode, it is the callback's responsibility to process the incoming data
* and wait for any delimiters to arrive as is necessary for the task. The message mode may not
* be changed after the child process has been launched.
*
* @note [Windows] This mode is the only mode that is currently supported on Windows. This may
* be fixed in a future version of the interface.
*/
constexpr LauncherFlags fLaunchFlagByteMode = 0x00000000;
/** Flag to indicate that reading from the `stdout` or `stderr` streams of the child process should
* be handled as a message stream. Data will not be delivered to the stream callback until a
* complete message has been received. A message is considered to be the contents of a single
* write call on the child's process side (up to a reasonable limit). The data passed to the
* callbacks may be split into multiple messages if a very large message is sent in a single
* write call. On Linux at least, this message limit is 4KB. The message mode may not be
* changed after the child process has been launched.
*
* @note [Windows] This mode is not currently supported on Windows. This may be fixed in a
* future version of the interface.
*/
constexpr LauncherFlags fLaunchFlagMessageMode = 0x00000008;
/** Flag to indicate that the calling process's environment should not be inherited by the child
* process in addition to the new environment variables specified in the launch descriptor. When
* no environment block is given in the descriptor, the default behavior is for the child
* process to inherit the parent's (ie: this calling process) environment block. Similarly for
* when a non-empty environment block is specified in the launch descriptor - the environment
* block of the calling process will be prepended to the environment variables given in the
* launch descriptor. However, when this flag is used, that will indicate that the new child
* process should only get the environment block that is explicitly given in the launch
* descriptor.
*/
constexpr LauncherFlags fLaunchFlagNoInheritEnv = 0x00000010;
/** Flag to indicate that the child process should still continue to be launched even if the
* environment block for it could not be created for any reason. This flag is ignored if
* @ref LaunchDesc::env is `nullptr` or the block environment block object is successfully
* created. The most common cause for failing to create the environment block is an out of
* memory situation or invalid UTF-8 codepoints being used in the given environment block.
* This flag is useful when the additional environment variables for the child process are
* optional to its functionality.
*/
constexpr LauncherFlags fLaunchFlagAllowBadEnv = 0x00000020;
/** Flag to indicate that the requested command should be launched as a script. An attempt
* will be made to determine an appropriate command interpreter for it based on its file
* extension if no interpreter command is explicitly provided in @ref LaunchDesc::interpreter.
* When this flag is not present, the named command will be assumed to be a binary executable.
*
* @note [Linux] This flag is not necessary when launching a script that contains a shebang
* on its first line. The shebang indicates the command interpreter to be used when
* executing the script. In this case, the script will also need to have its executable
* permission bit set for the current user. If the shebang is missing however, this
* flag will be needed.
*/
constexpr LauncherFlags fLaunchFlagScript = 0x00000040;
/** Flags to indicate that the child process' standard output streams should be closed upon
* launch. This is useful if the output from the child is not interesting or would otherwise
* garble up the parent process' standard streams log. An alternative to this would be to
* create a dummy read function for both `stdout` and `stderr` where the parent process just drops
* all incoming messages from the child process. This however also has its drawbacks since it
* would create one to two threads to listen for messages that would just otherwise be
* ignored. If these flags are not used, the OS's default behavior of inheriting the parent
* process' standard streams will be used. Each standard output stream can be disabled
* individually or together if needed depending on which flag(s) are used.
*
* @note Any callbacks specified for @ref LaunchDesc::onReadStdout or
* @ref LaunchDesc::onReadStderr will be ignored if the corresponding flag(s) to disable
* those streams is also used.
*/
constexpr LauncherFlags fLaunchFlagNoStdOut = 0x00000080;
/** @copydoc fLaunchFlagNoStdOut */
constexpr LauncherFlags fLaunchFlagNoStdErr = 0x00000100;
/** @copydoc fLaunchFlagNoStdOut */
constexpr LauncherFlags fLaunchFlagNoStdStreams = fLaunchFlagNoStdOut | fLaunchFlagNoStdErr;
/** Flag to indicate that launching the child process should not fail if either of the log
* files fails to open for write. This flag is ignored if the @ref LaunchDesc::stdoutLog
* and @ref LaunchDesc::stderrLog log filenames are `nullptr` or empty strings. If either
* log file fails to open, the child process will still be launched but the default behavior
* of inheriting the parent's standard output streams will be used instead. If this flag
* is not used, the default behavior is to fail the operation and not launch the child
* process.
*/
constexpr LauncherFlags fLaunchFlagAllowBadLog = 0x00000200;
/** Flag to indicate that the child process should be launched fully detached from the launching
* (ie: parent) process. This flag only has an effect on Linux and Mac OS. On Windows this
* flag is simply ignored. This intentionally orphans the child process so that the terminal
* session or @a initd becomes the one responsible for waiting on the orphaned child process
* instead of the launching parent process. This allows the child process to be a fully fire-
* and-forget process on all platforms. Note that using this flag may make communication
* with the child process difficult or impossible. This flag should generally not be used
* in combination with child processes that need to read stdout and stderr output.
*/
constexpr LauncherFlags fLaunchFlagLaunchDetached = 0x00000400;
/** @} */
/** Stream waiting flags
* @{
*/
/** Base type for flags to the @ref carb::launcher::ILauncher::waitForStreamEnd() function.
* Valid flags for this type are the carb::launcher::fWaitFlag* flags.
*/
using WaitFlags = uint32_t;
/** Flag to indicate that the `stdout` stream should be waited on. The stream will be signaled
* when it is closed by either the child process and all of the data on the stream has been
* consumed, or by using the @ref fWaitFlagCloseStdOutStream flag.
*/
constexpr WaitFlags fWaitFlagStdOutStream = 0x00000001;
/** Flag to indicate that the `stderr` stream should be waited on. The stream will be signaled
* when it is closed by either the child process and all of the data on the stream has been
* consumed, or by using the @ref fWaitFlagCloseStdErrStream flag.
*/
constexpr WaitFlags fWaitFlagStdErrStream = 0x00000002;
/** Flag to indicate that the `stdout` stream for a child should be closed before waiting on it.
* Note that doing so will truncate any remaining incoming data on the stream. This is useful
* for closing the stream and exiting the reader thread when the parent process is no longer
* interested in the output of the child process (ie: the parent only wanted to wait on a
* successful startup signal from the child). This flag has no effect if no read callback was
* provided for the `stdout` stream when the child process was launched.
*
* @note [Linux] If this is used on a child process to close the parent process's end of the
* `stdout` stream, the child process will be terminated with SIGPIPE if it ever tries
* to write to `stdout` again. This is the default handling of writing to a broken
* pipe or socket on Linux. The only way around this default behavior is to ensure
* that the child process ignores SIGPIPE signals. Alternatively, the parent could
* just wait for the child process to exit before destroying its process handle or
* closing the stream.
*/
constexpr WaitFlags fWaitFlagCloseStdOutStream = 0x00000004;
/** Flag to indicate that the `stderr` stream for a child should be closed before waiting on it.
* Note that doing so will truncate any remaining incoming data on the stream. This is useful
* for closing the stream and exiting the reader thread when the parent process is no longer
* interested in the output of the child process (ie: the parent only wanted to wait on a
* successful startup signal from the child). This flag has no effect if no read callback was
* provided for the `stderr` stream when the child process was launched.
*
* @note [Linux] If this is used on a child process to close the parent process's end of the
* `stderr` stream, the child process will be terminated with SIGPIPE if it ever tries
* to write to `stderr` again. This is the default handling of writing to a broken
* pipe or socket on Linux. The only way around this default behavior is to ensure
* that the child process ignores SIGPIPE signals. Alternatively, the parent could
* just wait for the child process to exit before destroying its process handle or
* closing the stream.
*/
constexpr WaitFlags fWaitFlagCloseStdErrStream = 0x00000008;
/** Flag to indicate that the wait should succeed when any of the flagged streams have been
* successfully waited on. The default behavior is to wait for all flagged streams to be
* completed before returning or timing out.
*/
constexpr WaitFlags fWaitFlagAnyStream = 0x00000010;
/** @} */
/** Process kill flags.
* @{
*/
/** Base type for flags to the @ref carb::launcher::ILauncher::killProcess() function. Valid flags for this
* type are the carb::launcher::fKillFlag* flags.
*/
using KillFlags = uint32_t;
/** Flag to indicate that any direct child processes of the process being terminated should
* also be terminated. Note that this will not cause the full hierarchy of the process's
* ancestors to be terminated as well. The caller should manage its process tree directly
* if multiple generations are to be terminated as well.
*/
constexpr KillFlags fKillFlagKillChildProcesses = 0x00000001;
/** Flag to indicate that a child process should be force killed. This only has an effect
* on Linux where a SIGKILL signal will be sent to the process instead of SIGTERM. This
* flag is ignored on Windows. The potential issue with SIGTERM is that a process can
* trap and handle that signal in a manner other than terminating the process. The SIGKILL
* signal however cannot be trapped and will always terminate the process.
*/
constexpr KillFlags fKillFlagForce = 0x00000002;
/** Flag to indicate that ILauncher::killProcess() or ILauncher::killProcessWithTimeout() calls
* should simply fail if a debugger is currently attached to the child process being terminated.
* The default behavior is to still attempt to kill the child process and wait for it to exit.
* On Linux, this will work as intended. On Windows however, a process being debugged cannot
* be terminated without first detaching the debugger. The attempt to terminate the child
* process will be queued for after the debugger has been attached.
*/
constexpr KillFlags fKillFlagFailOnDebugger = 0x00000004;
/** Flag to indicate that the ILauncher::killProcess() or ILauncher::killProcessWithTimeout()
* calls should not wait for the child process to fully exit before returning. This allows
* calls to return more quickly, but could result in other functions such as
* ILauncher::isProcessActive() and ILauncher::getProcessExitCode() returning false results
* for a short period after ILauncher::killProcess() returns. This period is usually only a
* few milliseconds, but may be inconsistent due to other system behavior and load.
*/
constexpr KillFlags fKillFlagSkipWait = 0x00000008;
/** @} */
/** Special value that can be passed to ILauncher::writeProcessStdin() for the @a bytes parameter
* to indicate that the input is a null terminated UTF-8 string. When this special length value
* is used, it is the caller's responsibility to ensure the input string is actually null
* terminated.
*/
constexpr size_t kNullTerminated = ~0ull;
/** Special exit code to indicate that the process is still running and has not exited yet.
* This can be returned from ILauncher::waitProcessExit() and ILauncher::getProcessExitCode().
*/
constexpr ExitCode kStillActive = 0x8000000000000000ll;
/** Indicates an infinite timeout for use in the ILauncher::waitProcessExit() function in its
* @a timeout parameter. The call will block until the requested process ends.
*/
constexpr uint64_t kInfiniteTimeout = ~0ull;
/** Return statuses for ILauncher::killProcessWithTimeout(). These indicate how the termination
* attempt completed.
*/
enum class KillStatus
{
/** The child process was successfully terminated. It will also have been confirmed to
* have exited fully if the @ref fKillFlagSkipWait flag was not used. If the
* @ref fKillFlagSkipWait flag is used in the call, this status only indicates that the
* signal to terminate the child process was successfully sent. The child process will
* exit at some point in the near future. If a very short timeout was used in a call to
* ILauncher::killProcessWithTimeout(), and the child process had exited within that
* period, this will be returned, otherwise @ref KillStatus::eWaitFailed will be returned.
* In most situations, the time period between termination and when the child process fully
* exits will only be a few milliseconds. However, within that time period, calls to
* functions such as ILauncher::isProcessActive() or ILauncher::getProcessExitCode() may
* return false results.
*/
eSuccess,
/** A debugger was attached to the child process at the time the termination attempt was
* made. This will only be returned if the @ref fKillFlagFailOnDebugger flag is used
* and a debugger is attached to the child process. No attempt to terminate the process
* will be made in this case. A future call to ILauncher::killProcess() or
* ILauncher::killProcessWithTimeout() (once the debugger has been detached) will be
* needed to actually terminate the child process.
*/
eDebuggerAttached,
/** A debugger was attached to the child process and that prevented it from being terminated.
* This will only be returned on Windows. A similar situation can still occur on Linux,
* except that on Linux the child process will be terminated successfully. In that case,
* the debugger process will just be left in an invalid state where the only course of action
* is to detach from the terminated process. Note that when this value is returned, the
* child process will be marked for termination by the system, but it will not actually be
* terminated until the debugger is detached from it.
*/
eDebuggerFail,
/** The attempt to signal the child process to terminate failed. This can occur if the
* child process' handle is invalid or there is a permission problem. This will not
* happen in most common situations.
*/
eTerminateFailed,
/** Waiting for the child process to exit failed or timed out. When this is returned, the
* child process has still been successfully signaled to exit, but it didn't fully exit
* before the timeout expired. This may still be viewed as a successful result however.
* This status code can be suppressed in successful cases with the @ref fKillFlagSkipWait
* flag. That flag is especially useful when a zero timeout is desired but a successful
* result should still be returned. If this value is returned, the caller is responsible
* for ensuring the child process successfully exits. This state can be verified with
* calls such as ILauncher::isProcessActive(), ILauncher::getProcessExitCode(), and
* ILauncher::waitProcessExit().
*/
eWaitFailed,
/** An invalid parameter was passed into ILauncher::killProcessWithTimeout(). */
eInvalidParameter,
};
/** Standard command interpreters for Windows and Linux. These can be used in the launch
* descriptor's @ref LaunchDesc::interpreter value to override some default interpreter
* detection functionality.
*
* @note These interpreter names are just 'safe' interpreters. If a caller has additional
* knowledge of the functional requirements of a script (ie: requires python 3.6+,
* requires a specific install of python, requires additional options for the interpreter,
* etc), it is the caller's responsibility to ensure an appropriate interpreter path and
* command is provided in @ref LaunchDesc::interpreter. If no interpreter path is given
* in the launch descriptor, one of these interpreters will be chosen based on the
* extension of the script file.
*
* @note If you need to use `cmd /C`, you must use @ref kInterpreterShellScript so that ILauncher
* can properly quote your arguments, since `cmd /C` does not interpret a command argument
* in the way that almost every other interpreter does.
*/
#if CARB_PLATFORM_WINDOWS
constexpr const char* const kInterpreterShellScript = "cmd /C";
constexpr const char* const kInterpreterShellScript2 = "cmd /C";
#else
constexpr const char* const kInterpreterShellScript = "sh";
/** @copydoc kInterpreterShellScript */
constexpr const char* const kInterpreterShellScript2 = "bash";
#endif
/** Interpreter names for python scripts. Using this command assumes that at least one version
* of python is installed locally on the system and is available through the system PATH
* variable. It is the caller's responsibility to ensure that a global python instance is
* installed on the calling system before either using this interpreter string in a launch
* descriptor or attempting to run a python script with a `nullptr` interpreter.
*
* To check if the global python interpreter is installed on the calling system, a call to
* ILauncher::launchProcess() with a @ref kInterpreterPythonCommand as the interpreter and
* the simple script "quit" can be used. If ILauncher::launchProcess() succeeds, the global
* python interpreter is installed. If it fails, it is not installed. In the latter case,
* it is the caller's responsibility to either find or install an appropriate python interpreter
* before attempting to launch a python script.
*/
constexpr const char* const kInterpreterPythonScript = "python";
/** @copydoc kInterpreterPythonScript */
constexpr const char* const kInterpreterPythonCommand = "python -c";
/** Descriptor of the new process to be launched by ILauncher::openProcess(). This contains
* all the information needed to launch and communicate with the new child process.
*/
struct LaunchDesc
{
/** A vector of command line arguments for the new process to launch. This may not be
* `nullptr`. The first argument in the vector must be the path to the executable to run.
* This may be a relative or absolute path. All following arguments will be passed to the
* executable as command line arguments. Each string must be UTF-8 encoded. Note that if
* a relative path is used for the first argument, it must be given relative to the current
* working directory for the parent (ie: calling) process, not the path given by @ref path.
* The @ref path value will become the current working directory for the child process, not
* the path to find the executable image at.
*/
const char* const* argv = nullptr;
/** The total number of arguments in the @ref argv vector. */
size_t argc = 0;
/** The optional initial working directory of the new process. If not specified, this will
* default to the calling process's current working directory. Once the child process has
* been successfully started, its current working directory will be set to this path. This
* will neither affect the current working directory of the parent process nor will it be
* used as the path to find the child process' executable.
*/
const char* path = nullptr;
/** Callback to be performed whenever data is successfully read from the child process's
* `stdout` or `stderr` streams. These may be `nullptr` if nothing needs to be read from the
* child process's `stdout` or `stderr` streams. Note that providing a callback here will
* spawn a new thread per callback to service read requests on the child process's `stdout`
* or `stderr` streams. See @ref OnProcessReadFn for more information on how these callbacks
* should be implemented and what their responsibilities are.
*
* @note [Linux] If this is non-`nullptr` and the parent process destroys its process handle
* for the child process before the child process exits, the child process will be
* terminated with SIGPIPE if it ever tries to write to the corresponding stream again
* This is the default Linux kernel behavior for writing to a broken pipe or socket.
* It is best practice to first wait for the child process to exit before destroying
* the process handle in the parent process.
*/
OnProcessReadFn onReadStdout = nullptr;
/** @copydoc onReadStdout */
OnProcessReadFn onReadStderr = nullptr;
/** The opaque context value to be passed to the read callbacks when they are performed. This
* will never be accessed directly by the process object, just passed along to the callbacks.
* It is the responsibility of the callbacks to know how to appropriately interpret these
* values. These values are ignored if both @ref onReadStdout and @ref onReadStderr are
* `nullptr`.
*/
void* readStdoutContext = nullptr;
/** @copydoc readStdoutContext */
void* readStderrContext = nullptr;
/** Flags to control the behavior of the new child process. This is zero or more of the
* @ref LauncherFlags flags.
*/
LauncherFlags flags = 0;
/** A hint for the size of the buffer to use when reading from the child process's `stdout`
* and `stderr` streams. This represents the maximum amount of data that can be read at
* once and returned through the onRead*() callbacks. This is ignored if both
* @ref onReadStdout and @ref onReadStderr are `nullptr`.
*
* Note that this buffer size is only a hint and may be adjusted internally to meet a
* reasonable minimum read size for the platform.
*/
size_t bufferSize = kDefaultProcessBufferSize;
/** A block of environment variables to pass to the child process. If the @ref flags
* include the @ref fLaunchFlagNoInheritEnv flag, this environment block will be used
* explicitly if non-`nullptr`. If that flag is not used, the calling process's current
* environment will be prepended to the block specified here. Any environment variables
* specified in here will replace any variables in the calling process's environment
* block. Each string in this block must be UTF-8 encoded. If this is `nullptr`, the
* default behavior is for the child process to inherit the entire environment of the
* parent process. If an empty non-`nullptr` environment block is specified here, the
* child process will be launched without any environment.
*/
const char* const* env = nullptr;
/** The number of environment variables specified in the environment block @ref env. This
* may only be 0 if the environment block is empty or `nullptr`.
*/
size_t envCount = 0;
/** An optional command interpreter name to use when launching the new process. This can be
* used when launching a script file (ie: shell script, python script, etc). This must be
* `nullptr` if the command being launched is a binary executable. If this is `nullptr`
* and a script file is being executed, an attempt will be made to determine the appropriate
* command interpreter based on the file extension of the first argument in @ref argv.
* The ILauncher::launchProcess() call may fail if this is `nullptr`, an appropriate
* interpreter could not be found for the named script, and the named script could not
* be launched directly on the calling platform (ie: a script using a shebang on its
* first line will internally specify its own command interpreter). This value is ignored
* if the @ref fLaunchFlagScript flag is not present in @ref flags.
*
* This can be one of the kInterpreter* names to use a standard command interpreter that
* is [presumably] installed on the system. If a specific command interpreter is to be
* used instead, it is the caller's responsibility to set this appropriately.
*
* @note This interpreter process will be launched with a search on the system's 'PATH'
* variable. On Windows this is always the behavior for launching any process.
* However, on Linux a process must always be identified by its path (relative or
* absolute) except in the case of launching a command interpreter.
*/
const char* interpreter = nullptr;
/** Optional names of log files to redirect `stdout` and `stderr` output from the child process
* to in lieu of a callback. The output from these streams won't be visible to the parent
* process (unless it is also reading from the log file). If either of these are
* non-`nullptr` and not an empty string, and the callbacks (@ref onReadStdout or
* @ref onReadStderr) are also `nullptr`, the corresponding stream from the child process
* will be redirected to these files(s) on disk. It is the caller's responsibility to ensure
* the requested filename is valid and writable. If the log fails to open, launching the
* child process will be silently ignored or fail depending on whether the
* @ref fLaunchFlagAllowBadLog flag is used or not. These logs will be ignored if any
* of the @ref fLaunchFlagNoStdStreams flags are used. The log file corresponding to the
* flag(s) used will be disabled.
*
* When a log is requested, it will be opened in a sharing mode. The log will be opened
* with shared read and write permissions. If the named log file already exists, it will
* always be truncated when opened. It is the caller's responsibility to ensure the previous
* file is moved or renamed if its contents need to be preserved. The log will also be
* opened in 'append' mode (ie: as if "a+" had been passed to fopen()) so that all new
* messages are written at the end of the file. It is the child process's responsibility
* to ensure that all messages written to the log files are synchronized so that messages
* do not get incorrectly interleaved. If both log files are given the same name, it is
* also the child process's responsibility to ensure writes to `stdout` and `stderr` are
* appropriately serialized.
*
* Setting log file names here will behave roughly like shell redirection to a file. The
* two streams can be independently specified (as in "> out.txt & err.txt"), or they can
* both be redirected to the same file (as in "&> log.txt" or > log.txt & log.txt"). The
* files will behave as expected in the child process - writing to `stdout` will be buffered
* while writing to `stderr` will be unbuffered. If the named log file already exists, it
* will always be overwritten and truncated.
*
* This filename can be either an absolute or relative path. Relative paths will be opened
* relative to the current working directory at the time. The caller is responsible for
* ensuring all path components leading up to the log filename exist before calling. Note
* that the log file(s) will be created before the child process is launched. If the child
* process fails to launch, it will be the caller's responsibility to clean up the log file
* if necessary.
*
* @note if a non-`nullptr` callback is given for either `stdout` or `stderr`, that will
* override the log file named here. Each log file will only be created if its
* corresponding callback is not specified.
*/
const char* stdoutLog = nullptr;
/** @copydoc stdoutLog */
const char* stderrLog = nullptr;
/** Reserved for future expansion. This must be `nullptr`. */
void* ext = nullptr;
};
// ********************************** interface declaration ***************************************
/** A simple process launcher helper interface. This is responsible for creating child processes,
* tracking their lifetime, and communicating with the child processes. All operations on this
* interface are thread safe within themselves. It is the caller's responsibility to manage the
* lifetime of and any multi-threaded access to each process handle object that is returned from
* launchProcess(). For example, destroying a process handle object while another thread is
* operating on it will result in undefined behavior.
*
* Linux notes:
* * If any other component of the software using this plugin sets the SIGCHLD handler back to
* default behavior (ie: SIG_DFL) or installs a SIGCHLD handler function, any child process
* that exits while the parent is still running will become a zombie process. The only way
* to remove a zombie process in this case is to wait on it in the parent process with
* waitProcessExit() or getProcessExitCode() at some point after the child process has
* exited. Explicitly killing the child process with killProcess() will also avoid creating
* a zombie process.
* * Setting the SIGCHLD handler to be ignored (ie: SIG_IGN) will completely break the ability
* to wait on the exit of any child process for this entire process. Any call to wait on a
* child process such as waitProcessExit() or getProcessExitCode() will fail immediately.
* There is no way to detect or work around this situation on the side of this interface
* since signal handlers are process-wide and can be installed at any time by any component
* of the process.
* * The problem with leaving a zombie processes hanging around is that it continues to take
* up a slot in the kernel's process table. If this process table fills up, the kernel
* will not be able to launch any new processes (or threads). All of the zombie children
* of a process will be automatically cleaned up when the parent exits however.
* * If a read callback is provided for either `stdout` or `stderr` of the child process and
* the parent process destroys its process handle for the child process before the child
* process exits, the child process will be terminated with SIGPIPE if it ever tries to
* write to either stream again. This is the default Linux kernel behavior for writing
* to a broken pipe or socket. The only portable way around this is to ensure the child
* process will ignore SIGPIPE signals. It is generally best practice to ensure the parent
* process waits on all child processes before destroying its process handle. This also
* prevents the appearance of zombie processes as mentioned above.
*
* Windows notes:
* * Reading from a child process's `stdout` or `stderr` streams will not necessarily be
* aligned to the end of a single 'message' (ie: the contents of a single write call on the
* child process's end of the stream). This means that a partial message may be received in
* the callbacks registered during the launch of a child process. It is left up to the
* caller to accumulate input from these streams until an appropriate delimiter has been
* reached and the received data can be fully parsed. This may be fixed in a future version
* of this interface.
*/
struct ILauncher
{
CARB_PLUGIN_INTERFACE("carb::launcher::ILauncher", 1, 3)
/** Launches a new child process.
*
* @param[in] desc A descriptor of the child process to launch. At least the
* @ref LaunchDesc::argc and @ref LaunchDesc::argv members must be
* filled in. Default values on all other members are sufficient.
* @returns A new process object if the child process is successfully launched. This must
* be destroyed with destroyProcessHandle() when it is no longer needed by the
* caller. Note that closing the process object will not terminate the child
* process. It simply means that the calling process can no longer communicate
* with or kill the child process. If the child process needs to be killed first,
* it is the caller's responsibility to call kill() before destroying the handle.
* @returns `nullptr` if the new process could not be launched for any reason. This may
* include insufficient permissions, failed memory or resource allocations, etc.
*
* @remarks This attempts to launch a new child process. The new process will be created
* and start to run before successful return here. Depending on what flags and
* callbacks are provided in the launch descriptor, it may be possible for this
* process to communicate with the new child process.
*
* @note On Linux, the child process's executable should not have the set-user-ID or set-
* group-ID capabilities set on it when using the @ref carb::launcher::fLaunchFlagKillOnParentExit
* flag. These executables will clear the setting that allows the child process
* to receive a signal when the parent process exits for any reason (ie: exits
* gracefully, crashes, is externally terminated, etc). Setting these capabilities
* on an executable file requires running something along the lines of:
* * @code{.sh}
* sudo setcap cap_setuid+ep <filename>
* sudo setcap cap_setgid+ep <filename>
* @endcode
*
* @note Any built executable will, be default, not have any of these capabilities set.
* They will have to be explicitly set by a user, installer, or script. These
* executables can be identified in an "ls -laF" output by either being highlighted
* in red (default bash color scheme), or by having the '-rwsr-xr-x' permissions
* (or similar) instead of '-rwxr-xr-x', or by passing the executable path to
* 'capsh --print' to see what it's effective or permissive capabilities are.
*
* @note If a set-user-ID or set-group-ID executable needs to be launched as a child process
* and the @ref fLaunchFlagKillOnParentExit flag is desired for it, the child process
* should call @code{.cpp}prctl(PR_SET_PDEATHSIG, SIGTERM)@endcode early in its main()
* function to regain this behavior. The restoreParentDeathSignal() helper function
* is also offered here to make that call easier in Carbonite apps. Note however that
* there will be a possible race condition in this case - if the parent exits before
* the child process calls prctl(), the child process will not be signaled. Also note
* that unconditionally calling one of these functions in a child process will result
* in the @ref fLaunchFlagKillOnParentExit behavior being imposed on that child
* process regardless of whether the flag was used by the parent process.
*
* @note Since we can neither guarantee the child process will be a Carbonite app nor that
* it will even be source under control of the same developer (ie: a command line
* tool), resetting this death signal is unfortunately not handled as a task in this
* interface.
*/
Process*(CARB_ABI* launchProcess)(LaunchDesc& desc);
/** Launches a detached child process.
*
* @param[in] desc A descriptor of the child process to launch. At least the
* @ref LaunchDesc::argc and @ref LaunchDesc::argv members must be
* filled in. Default values on all other members are sufficient.
* Note that setting a read callback for `stdout` or `stderr` is
* not allowed in a detached process. The @ref LaunchDesc::onReadStderr
* and @ref LaunchDesc::onReadStdout parameters will be cleared to
* `nullptr` before launching the child process. Callers may still
* redirect `stdout` and `stderr` to log files however. The
* @ref fLaunchFlagLaunchDetached flag will also be added to the
* descriptor so that zombie processes are not inadvertently created
* on Unix based platforms.
* @returns The process ID of the new child process if successfully launched.
* @retval kBadId if the new process could not be launched for any reason. This may
* include insufficient permissions, failed memory or resource allocations, etc.
*
* @remarks This is a convenience version of launchProcess() that launches a child process
* but does not return the process handle. Instead the operating system's process
* ID for the new child process is returned. This is intended to be used for
* situations where the parent process neither needs to communicate with the child
* process nor know when it has exited. Using this should be reserved for child
* processes that manage their own lifetime and communication with the parent in
* another prearranged manner. The returned process ID may be used in OS level
* process management functions, but is not useful to pass into any other ILauncher
* functions.
*/
ProcessId launchProcessDetached(LaunchDesc& desc)
{
ProcessId id;
Process* proc;
// registering read callbacks is not allowed in a detached process since we'll be
// immediately destroying the handle before return. If there were set the child
// process would be killed on Linux if it ever tried to write to one of its streams.
// On both Windows and Linux having these as non-`nullptr` would also cause a lot
// of unnecessary additional work to be done both during and after the launch.
desc.onReadStderr = nullptr;
desc.onReadStdout = nullptr;
// add the 'launch detached' flag to ensure we don't need to wait on the child process
// on Linux. This is to avoid leaving a zombie process lying around.
desc.flags |= fLaunchFlagLaunchDetached;
proc = launchProcess(desc);
if (proc == nullptr)
return kBadId;
id = getProcessId(proc);
destroyProcessHandle(proc);
return id;
}
/** Destroys a process handle when it is no longer needed.
*
* @param[in] process The process handle to destroy. This will no longer be valid upon
* return. This call will be silently ignored if `nullptr` is passed in.
* @returns No return value.
*
* @remarks This destroys a process handle object that was previously returned by a call
* to launchProcess(). The process handle will no longer be valid upon return.
*
* @note Calling this does *not* kill the child process the process handle refers to.
* It simply recovers the resources taken up by the process handle object. In order
* to kill the child process, the caller must call killProcess() first.
*
* @note [Linux] If the child process was started with a read callback for one or both of
* its standard streams, destroying the handle here will cause the child process to
* be terminated with SIGPIPE if it ever tries to write to any of the standard streams
* that were redirected to the read callbacks. This is the default Linux kernel
* behavior for attempting to write to a broken pipe or socket. The only portable
* way to work around this is to ensure the child process ignores SIGPIPE signals.
* However, the general best practice is for the parent process to wait for the
* child process to exit (or explicitly kill it) before destroying the process handle.
*/
void(CARB_ABI* destroyProcessHandle)(Process* process);
/** Retrieves the process identifier for a child process.
*
* @param[in] process The process handle object representing the child process to retrieve
* the identifier for. This may not be `nullptr`.
* @returns The integer identifier of the child process if it is still running.
* @retval kBadId if the child process if it is not running.
*
* @remarks This retrieves the process identifier for a child process. This can be used
* to gain more advanced platform specific access to the child process if needed,
* or simply for debugging or logging identification purposes.
*/
ProcessId(CARB_ABI* getProcessId)(Process* process);
/** Waits for a child process to exit.
*
* @param[in] process The process handle object representing the child process to wait
* for. This may not be `nullptr`. This is returned from a previous
* call to launchProcess().
* @param[in] timeout The maximum time in milliseconds to wait for the child process to
* exit. This may be @ref kInfiniteTimeout to specify that this should
* block until the child process exits. This may be 0 to simply poll
* whether the child process has exited or not.
* @returns The exit code of the child process if it successfully exited in some manner.
* @retval kStillActive if the wait timed out and the child process had not exited yet.
* @returns `EXIT_FAILURE` if @p process is `nullptr`.
*
* @remarks This waits for a child process to exit and retrieves its exit code if the exit
* has occurred. Note that this does not in any way signal the child process to
* exit. That is left up to the caller since that method would be different for
* each child process. This simply waits for the exit to occur. If the child
* process doesn't exit within the allotted timeout period, it will remain running
* and the special @ref kStillActive exit code will be returned.
*
* @note Despite the timeout value being a 64-bit value, on Windows this will only wait
* for up to ~49.7 days at a time (ie: 32 bits) for the child process to exit. This
* is due to all the underlying timing functions only taking a 32-bit timeout value.
* If a longer wait is required, the wait will be repeated with the remaining time.
* However, if this process is blocking for that long waiting for the child process,
* that might not be the most desirable behavior and a redesign might be warranted.
*
* @note [Linux] if the calling process sets a SIG_IGN signal handler for the SIGCHLD signal,
* this call will fail immediately regardless of the child process's current running
* state. If a handler function is installed for SIGCHLD or that signal's handler is
* still set to its default behavior (ie: SIG_DFL), the child process will become a
* zombie process once it exits. This will continue to occupy a slot in the kernel's
* process table until the child process is waited on by the parent process. If the
* kernel's process table fills up with zombie processes, the system will no longer
* be able to create new processes or threads.
*
* @note [Linux] It is considered an programming error to allow a child process to be leaked
* or to destroy the process handle without first waiting on the child process. If
* the handle is destroyed without waiting for the child process to [successfully] exit
* first, a zombie process will be created. The only exception to this is if the
* parent process exits before the child process. In this case, any zombie child
* child processes will be inherited by the init (1) system process which will wait
* on them and recover their resources.
*
* @note In general it is best practice to always wait on all child processes before
* destroying the process handle object. This guarantees that any zombie children
* will be removed and that all resources will be cleaned up from the child process.
*/
ExitCode(CARB_ABI* waitProcessExit)(Process* process, uint64_t timeout);
/** Attempts to retrieve the exit code for a child process.
*
* @param[in] process The process handle object representing the child process to retrieve
* the exit code for. The child process may or may not still be running.
* This may not be `nullptr`.
* @returns The exit code of the child process if it has already exited in some manner.
* @retval kStillActive if the child process is still running.
* @returns `EXIT_FAILURE` if @p process is `nullptr`.
*
* @remarks This attempts to retrieve the exit code for a child process if it has exited.
* The exit code isn't set until the child process exits, is killed, or crashes.
* The special exit code @ref kStillActive will be returned if the child process
* is still running.
*
* @note [Linux] see the notes about zombie processes in waitProcessExit(). These also
* apply to this function since it will also perform a short wait to see if the
* child process has exited. If it has exited already, calling this will also
* effectively clean up the child zombie process. However, if another component
* of this process has set the SIGCHLD signal handler to be ignored (ie: SIG_IGN),
* this call will also fail immediately.
*/
ExitCode(CARB_ABI* getProcessExitCode)(Process* process);
/** Writes a buffer of data to the stdin stream of a child process.
*
* @param[in] process The process handle object representing the child process to write
* the data to. This may not be `nullptr`. The child process must
* have been opened using the @ref fLaunchFlagOpenStdin flag in
* order for this to succeed.
* @param[in] data The buffer of data to write to the child process.
* @param[in] bytes The total number of bytes to write to the child process or the
* special value @ref kNullTerminated to indicate that the buffer
* @p data is a null-terminated UTF-8 string. If the latter value
* is used, it is the caller's responsibility to ensure the data
* buffer is indeed null terminated.
* @returns `true` if the buffer of data is successfully written to the child process's
* stdin stream.
* @returns `false` if the entire data buffer could not be written to the child process's
* stdin stream. In this case, the child process's stdin stream will be left
* in an unknown state. It is the responsibility of the caller and the child
* process to negotiate a way to resynchronize the stdin stream.
* @returns `false` if @p process is `nullptr`.
*
* @remarks This attempts to write a buffer of data to a child process's stdin stream.
* This call will be ignored if the child process was not launched using the
* @ref fLaunchFlagOpenStdin flag or if the stdin handle for the process has
* since been closed with closeProcessStdin(). The entire buffer will be
* written to the child process's stdin stream. If even one byte cannot be
* successfully written, this call will fail. This can handle data buffers
* larger than 4GB if needed. This will block until all data is written.
*
* @remarks When the @ref kNullTerminated value is used in @p bytes, the data buffer is
* expected to contain a null terminated UTF-8 string. The caller is responsible
* for ensuring this. In the case of a null terminated string, all of the string
* up to but not including the null terminator will be sent to the child process.
* If the null terminator is to be sent as well, the caller must specify an
* explicit byte count.
*/
bool(CARB_ABI* writeProcessStdin)(Process* process, const void* data, size_t bytes);
/** Closes the stdin stream of a child process.
*
* @param[in] process The process handle object representing the child process to close
* the stdin stream for. This may not be `nullptr`.
* @returns No return value.
*
* @remarks This closes the stdin stream of a child process. This call will be ignored if
* the stdin stream for the child process either was never opened or if it has
* already been closed by a previous call to closeProcessStdin(). Closing the
* stdin stream only closes the side of the stream that is owned by the calling
* process. It will not close the actual stream owned by the child process itself.
* Other processes may still retrieve the child process's stdin stream handle in
* other ways if needed to communicate with it.
*/
void(CARB_ABI* closeProcessStdin)(Process* process);
/** Kills a running child process.
*
* @param[in] process The process handle object representing the child process to kill.
* This may not be `nullptr`.
* @param[in] flags Flags to affect the behavior of this call. This may be zero or
* more of the @ref KillFlags flags.
* @returns No return value.
*
* @remarks This kills a running child process. If the process has already exited on its
* own, this call will be ignored. The child process will be terminated without
* being given any chance for it to clean up any of its state or save any
* information to persistent storage. This could result in corrupted data if
* the child process is in the middle of writing to persistent storage when it
* is terminated. It is the caller's responsibility to ensure the child process
* is as safe as possible to terminate before calling.
*
* @remarks On both Windows and Linux, this will set an exit code of either 137 if the
* @ref fKillFlagForce flag is used or 143 otherwise. These values are the
* exit codes that are set in Linux by default for a terminated process. They
* are 128 plus the signal code used to terminate the process. In the case of
* a forced kill, this sends SIGKILL (9). In the case of a normal kill, this
* sends SIGTERM (15). On Windows, this behavior is simply mimicked.
*
* @note On Linux, the @ref fKillFlagForce flag is available to cause the child process to
* be sent a SIGKILL signal instead of the default SIGTERM. The difference between
* the two signals is that SIGTERM can be caught and handled by the process whereas
* SIGKILL cannot. Having SIGTERM be sent to end the child process on Linux does
* allow for the possibility of a graceful shutdown for apps that handle the signal.
* On Linux, it is recommended that if a child process needs to be killed, it is
* first sent SIGTERM (by not using the @ref fKillFlagForce flag), then if after a
* short time (ie: 2-5 seconds, depending on the app's shutdown behavior) has not
* exited, kill it again using the @ref fKillFlagForce flag.
*/
void(CARB_ABI* killProcess)(Process* process, KillFlags flags);
/** Tests whether a process is still running.
*
* @param[in] process The process handle object representing the child process to query.
* This may not be `nullptr`.
* @returns `true` if the given child process is still running.
* @returns `false` if the child process has exited.
*/
inline bool isProcessActive(Process* process)
{
return getProcessExitCode(process) == kStillActive;
}
/** @copydoc killProcess().
*
* @param[in] timeout The time in milliseconds to wait for the child process to fully
* exit. This may be 0 to indicate that no wait should occur after
* signaling the child process to terminate. This may also be
* @ref kInfiniteTimeout to wait indefinitely for the child process
* to exit.
* @retval KillStatus::eSuccess if the child process is successfully terminated
* and was confirmed to have exited or the @ref fKillFlagSkipWait flag is used
* and the child process is successfully signaled to exit, or if the child process
* had already terminated on its own or was otherwise killed before this call.
* @retval KillStatus::eWaitFailed if the child process was successfully signaled to
* exit but the timeout for the wait for it to fully exit expired before it exited.
* This may still indicate successful termination, but it is left up to the caller
* to determine that.
* @returns Another @ref KillStatus code if the termination failed in any way.
*
* @remarks This variant of killProcess() can be used to have more control over how the
* child process is terminated and whether it was successful or not. The timeout
* allows the caller control over how long the call should wait for the child
* process to exit. This can also be used in combination with other functions
* such as ILauncher::isDebuggerAttached() to figure out how and when a child
* process should be terminated.
*/
KillStatus(CARB_ABI* killProcessWithTimeout)(Process* process, KillFlags flags, uint64_t timeout);
/** Tests whether a debugger is currently attached to a child process.
*
* @param[in] process The child process to check the debugger status for. This may not be
* `nullptr`. This may be a handle to a child process that has already
* exited.
* @returns `true` if there is a debugger currently attached to the given child process.
* @returns `false` if the child process has exited or no debugger is currently attached to
* it.
* @returns `false` if @p process is `nullptr`.
*
* @remarks This tests whether a debugger is currently attached to the given child process.
* On Windows at least, having a debugger attached to a child process will prevent
* it from being terminated with killProcess(). This can be queried to see if the
* debugger task has completed before attempting to kill it.
*/
bool(CARB_ABI* isDebuggerAttached)(Process* process);
/** Waits for one or more standard streams from a child process to end.
*
* @param[in] process The child process to wait on the standard streams for. This may not
* be `nullptr`. This may be a handle to a child process that has
* already exited. This call will be ignored if the flagged stream(s)
* were not opened for the given child process.
* @param[in] flags Flags to control how the operation occurs and which stream(s) to wait
* on. At least one flag must be specified. This may not be 0. It is
* not an error to specify flags for a stream that was not opened by the
* child process. In this case, the corresponding flag(s) will simply be
* ignored.
* @param[in] timeout The maximum amount of time in milliseconds to wait for the flagged
* streams to end. This may be @ref kInfiniteTimeout to wait infinitely
* for the stream(s) to end. A stream ends when it is closed by either
* the child process (by it exiting or explicitly closing its standard
* streams) or by the parent process closing it by using one of the
* @ref fWaitFlagCloseStdOutStream or @ref fWaitFlagCloseStdErrStream
* flags. When a stream ends due to the child process closing it, all
* of the pending data will have been consumed by the reader thread and
* already delivered to the read callback function for that stream.
* @returns `true` if the wait operation specified by @p flags completed successfully. This
* means that at least one, possibly both, streams have ended and been fully
* consumed.
* @returns `false` if the flagged streams did not end within the timeout period.
*
* @remarks This is used to wait on one or more of the standard streams (`stdout` or `stderr`)
* from the child process to end. This ensures that all data coming from the
* child process has been consumed and delivered to the reader callbacks.
*
* @note This does not allow for waiting on the standard streams of child processes that
* are writing directly to log files (ie: using the @ref LaunchDesc::stdoutLog and
* @ref LaunchDesc::stderrLog parameters). This only affects child processes that
* were launched with a read callback specified for `stdout`, `stderr`, or both.
*/
bool(CARB_ABI* waitForStreamEnd)(Process* process, WaitFlags flags, uint64_t timeout);
};
/** Restores the parent death signal on set-user-ID and set-group-ID images.
*
* @param[in] flags Flags to indicate which signal should be sent on on parent process
* exit. This may be 0 to cause the child process to be asked to
* gracefully terminate or @ref fKillFlagForce to forcibly terminate
* the child process. In the latter case, the child process will not
* get any chance to clean up or release resources.
* @returns No return value.
*
* @remarks This restores the parent death signal on Linux after executing an image file
* that has a set-user-ID or set-group-ID capability set on it. Unfortunately,
* executing one of these image files has the result of clearing the parent
* death signal attribute that is set when using the @ref fLaunchFlagKillOnParentExit
* flag. These capabilities are set on the image file with the "setcap" command
* line tool and require super user access. The capabilities of an executable image
* file can be discovered with the "capsh --print" command line tool. See the notes
* on ILauncher::launch() for more information.
*
* @note This only needs to be called when a child process's image file has a set-user-ID
* or set-group-ID capability set on it on Linux and the @ref fLaunchFlagKillOnParentExit
* flag was used when launching the child process. This is still safe to call on
* Windows and will simply do nothing. Note that calling this when the child was not
* launched with the @ref fLaunchFlagKillOnParentExit flag will cause that behavior
* to be imposed on the child process. Communicating the need for this call is left
* as an exercise for both the child and parent processes.
*/
inline void restoreParentDeathSignal(KillFlags flags = 0)
{
CARB_UNUSED(flags);
#if CARB_PLATFORM_LINUX
prctl(PR_SET_PDEATHSIG, (flags & fKillFlagForce) != 0 ? SIGKILL : SIGTERM);
#endif
}
} // namespace launcher
} // namespace carb
| 72,024 | C | 62.069177 | 109 | 0.692866 |
omniverse-code/kit/include/carb/launcher/LauncherUtils.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
/** @file
* @brief Helper classes and functions for the ILauncher interface.
*/
#pragma once
#include "../Defines.h"
#include "../extras/StringSafe.h"
#include "../../omni/extras/PathMap.h"
#include "../settings/SettingsUtils.h"
#include <string>
#include <unordered_map>
#include <vector>
#include <sstream>
#if CARB_PLATFORM_LINUX
# include <unistd.h>
#elif CARB_PLATFORM_MACOS
# include <crt_externs.h>
#else
# include "../CarbWindows.h"
# include "../extras/Unicode.h"
#endif
namespace carb
{
/** Namespace for the Carbonite process launch helper interface. */
namespace launcher
{
/** Base type for the flags used when adding a settings tree to an argument collector object. */
using SettingsEnumFlags = uint32_t;
/** Flag to indicate that the settings in the requested tree should be added recursively to
* the argument collector. If this flag is not present, only the settings directly in the
* named path will be added to the object.
*/
constexpr SettingsEnumFlags fSettingsEnumFlagRecursive = 0x01;
/** Prototype for a callback function used to check if a setting should be added.
*
* @param[in] path The full path to the setting being queried. This will never be `nullptr`.
* @param[in] context A caller specified context value that is passed to the callback.
* @returns `true` if the setting should be added to the argument collector. Returns `false`
* if the setting should not be added to the argument collector.
*
* @remarks Prototype for a callback predicate function that is used to allow the caller to
* determine if a particular setting value should be added to the argument collector.
* This is called for each value setting (ie: for `int`, `bool`, `float` and `string`
* items). The return value gives the caller an opportunity to provide more fine
* grained control over which settings are added to the argument collector than just
* the full tree.
*/
using AddSettingPredicateFn = bool (*)(const char* path, void* context);
/** A simple child process argument collector helper class. This allows arguments of different
* types to be accumulated into a list that can then later be retrieved as a Unix style argument
* list that can be passed to ILauncher::launchProcess() in its @ref LaunchDesc::argv descriptor
* member. This allows for string arguments and various integer type arguments to be trivially
* added to the argument list without needing to locally convert all of them to strings. The
* argument count is also tracked as the arguments are collected. Once all arguments have been
* collected, the final Unix style argument list can be retrieved with getArgs() and the count
* with getCount(). All collected arguments will remain in the order they are originally
* added in.
*
* The basic usage of this is to create a new object, add one or more arguments of various
* types to it using the '+=' operators, then retrieve the Unix style argument list with
* getArgs() to assign to @ref LaunchDesc::argv and getCount() to assign to
* @ref LaunchDesc::argc before calling ILauncher::launchProcess(). Copy and move operators
* and constructors are also provided to make it easier to assign other argument lists to
* another object to facilitate more advanced multiple process launches (ie: use a set of
* base arguments for each child process then add other child specific arguments to each
* one before launching).
*
* This helper class is not thread safe. It is the caller's responsibility to ensure thread
* safe access to objects of this class if needed.
*/
class ArgCollector
{
public:
ArgCollector() = default;
/** Copy constructor: copies another argument collector object into this one.
*
* @param[in] rhs The argument collector object to copy from. This will be left unmodified.
*/
ArgCollector(const ArgCollector& rhs)
{
*this = rhs;
}
/** Move constructor: moves the contents of another argument collector object into this one.
*
* @param[in] rhs The argument collector object to move from. This object will be reset to
* an empty state.
*/
ArgCollector(ArgCollector&& rhs)
{
*this = std::move(rhs);
}
~ArgCollector()
{
clear();
}
/** Clears out this object and resets it back to its initially constructed state.
*
* @returns No return value.
*
* @remarks This clears out all content collected into this object so far. This object
* will be reset back to its original constructed state and will be suitable
* for reuse.
*/
void clear()
{
m_argList.reset();
m_args.clear();
m_allocCount = 0;
}
/** Retrieves the final argument list as a Unix style null terminated list.
*
* @param[out] argCountOut Optionally receives the number of arguments as by via getCount().
* @returns A Unix style argument list. This list will always be terminated by a `nullptr`
* entry so that it can be self-counted if needed. This returned argument list
* object is owned by this object and should not be deleted or freed. See the
* remarks below for more information on the lifetime and use of this object.
* @returns `nullptr` if the buffer for the argument list could not be allocated.
*
* @remarks This retrieves the final argument list for this object. The list object is
* owned by this object and should not be freed or deleted. The returned list
* will be valid until this object is destroyed or until getArgs() is called
* again after adding new arguments. If the caller needs to keep a copy of the
* returned argument list, the caller must perform a deep copy on the returned
* object. This task is out of the scope of this object and is left as an
* exercise for the caller.
*/
const char* const* getArgs(size_t* argCountOut = nullptr)
{
if (argCountOut)
{
*argCountOut = m_args.size();
}
if (m_args.empty())
{
return emptyArgList();
}
if (m_allocCount < m_args.size())
{
m_allocCount = m_args.size();
m_argList.reset(new (std::nothrow) const char*[m_args.size() + 1]);
if (CARB_UNLIKELY(m_argList == nullptr))
{
if (argCountOut)
{
*argCountOut = 0;
}
m_allocCount = 0;
return nullptr;
}
}
for (size_t i = 0; i < m_args.size(); i++)
{
m_argList[i] = m_args[i].c_str();
}
// null terminate the list since some platforms and apps expect that behavior.
m_argList[m_args.size()] = nullptr;
return m_argList.get();
}
/** Retrieves the argument count for this object.
*
* @returns The number of arguments that have been collected into this object so far. This
* is incremented each time the '+=' operator is used.
*/
size_t getCount() const
{
return m_args.size();
}
/** Copy assignment operator.
*
* @param[in] rhs The argument collector object to copy from. This object will receive a
* copy of all the arguments currently listed in the @p rhs argument
* collector object. The @p rhs object will not be modified.
* @returns A reference to this object suitable for chaining other operators or calls.
*/
ArgCollector& operator=(const ArgCollector& rhs)
{
if (this == &rhs)
return *this;
clear();
if (rhs.m_args.size() == 0)
return *this;
m_args = rhs.m_args;
return *this;
}
/** Move assignment operator.
*
* @param[inout] rhs The argument collector object to move from. This object will
* steal all arguments from @p rhs and will clear out the other
* object before returning.
* @returns A reference to this object suitable for chaining other operators or calls.
*/
ArgCollector& operator=(ArgCollector&& rhs)
{
if (this == &rhs)
return *this;
clear();
m_args = std::move(rhs.m_args);
return *this;
}
/** Compare this object to another argument collector object for equality.
*
* @param[in] rhs The argument collector object to compare to this one.
* @returns `true` if the two objects contain the same list of arguments. Note that each
* object must contain the same arguments in the same order in order for them
* to match.
* @returns `false` if the argument lists in the two objects differ.
*/
bool operator==(const ArgCollector& rhs)
{
size_t count = m_args.size();
if (&rhs == this)
return true;
if (count != rhs.m_args.size())
return false;
for (size_t i = 0; i < count; i++)
{
if (m_args[i] != rhs.m_args[i])
return false;
}
return true;
}
/** Compare this object to another argument collector object for inequality.
*
* @param[in] rhs The argument collector object to compare to this one.
* @returns `true` if the two objects contain a different list of arguments. Note that each
* object must contain the same arguments in the same order in order for them
* to match. If either the argument count differs or the order of the arguments
* differs, this will succeed.
* @returns `false` if the argument lists in the two objects match.
*/
bool operator!=(const ArgCollector& rhs)
{
return !(*this == rhs);
}
/** Tests whether this argument collector is empty.
*
* @returns `true` if this argument collector object is empty.
* @returns `false` if argument collector has at least one argument in its list.
*/
bool operator!() const
{
return m_args.size() == 0;
}
/** Tests whether this argument collector is non-empty.
*
* @returns `true` if argument collector has at least one argument in its list.
* @returns `false` if this argument collector object is empty.
*/
explicit operator bool() const
{
return !m_args.empty();
}
/** Adds a formatted string as an argument.
*
* @param[in] fmt The printf-style format string to use to create the new argument. This
* may not be `nullptr`.
* @param[in] ... The arguments required by the format string.
* @returns A references to this object suitable for chaining other operators or calls.
*/
ArgCollector& format(const char* fmt, ...) CARB_PRINTF_FUNCTION(2, 3)
{
CARB_FORMATTED(fmt, [&](const char* p) { add(p); });
return *this;
}
/** Adds a new argument or set of arguments to the end of the list.
*
* @param[in] value The value to add as a new argument. This may be a string or any
* primitive integer or floating point type value. For integer and
* floating point values, they will be converted to a string before
* being added to the argument list. For the variants that add
* another argument collector list or a `nullptr` terminated string
* list, or a vector of strings to this one, all arguments in the
* other object will be copied into this one in the same order. All
* new argument(s) will always be added at the end of the list.
* @returns A reference to this object suitable for chaining other operators or calls.
*/
ArgCollector& add(const char* value)
{
m_args.push_back(value);
return *this;
}
/** @copydoc add(const char*) */
ArgCollector& add(const std::string& value)
{
m_args.push_back(value);
return *this;
}
/** @copydoc add(const char*) */
ArgCollector& add(const ArgCollector& value)
{
for (auto& arg : value.m_args)
m_args.push_back(arg);
return *this;
}
/** @copydoc add(const char*) */
ArgCollector& add(const char* const* value)
{
for (const char* const* arg = value; arg[0] != nullptr; arg++)
m_args.push_back(arg[0]);
return *this;
}
/** @copydoc add(const char*) */
ArgCollector& add(const std::vector<const char*>& value)
{
for (auto& v : value)
add(v);
return *this;
}
/** @copydoc add(const char*) */
ArgCollector& add(const std::vector<std::string>& value)
{
for (auto& v : value)
add(v);
return *this;
}
/** @copydoc add(const char*) */
ArgCollector& operator+=(const char* value)
{
return add(value);
}
/** @copydoc add(const char*) */
ArgCollector& operator+=(const std::string& value)
{
return add(value);
}
/** @copydoc add(const char*) */
ArgCollector& operator+=(const ArgCollector& value)
{
return add(value);
}
/** @copydoc add(const char*) */
ArgCollector& operator+=(const char* const* value)
{
return add(value);
}
/** @copydoc add(const char*) */
ArgCollector& operator+=(const std::vector<const char*>& value)
{
return add(value);
}
/** @copydoc add(const char*) */
ArgCollector& operator+=(const std::vector<std::string>& value)
{
return add(value);
}
/** Macro to add other [almost identical] variants of the add() and operator+=() functions.
* Note that this unfortunately can't be a template because a 'const char*' value is not
* allowed as a template argument since it doesn't lead to a unique instantiation. This
* is similar to the reasoning for a float value not being allowed as a template argument.
* Using a macro here saves 140+ lines of code (mostly duplicated) and documentation.
* @private
*/
#define ADD_PRIMITIVE_HANDLER(type, fmt) \
/** Adds a new primitive value to this argument collector object. \
@param[in] value The primitive numerical value to add to this argument collector \
object. This will be converted to a string before adding to the \
collector. \
@returns A reference to this argument collector object. \
*/ \
ArgCollector& add(type value) \
{ \
char buffer[128]; \
carb::extras::formatString(buffer, CARB_COUNTOF(buffer), fmt, value); \
m_args.push_back(buffer); \
return *this; \
} \
/** @copydoc add(type) */ \
ArgCollector& operator+=(type value) \
{ \
return add(value); \
}
// unsigned integer handlers.
ADD_PRIMITIVE_HANDLER(unsigned char, "%u")
ADD_PRIMITIVE_HANDLER(unsigned short, "%u")
ADD_PRIMITIVE_HANDLER(unsigned int, "%u")
ADD_PRIMITIVE_HANDLER(unsigned long, "%lu")
ADD_PRIMITIVE_HANDLER(unsigned long long, "%llu")
// signed integer handlers.
ADD_PRIMITIVE_HANDLER(char, "%d")
ADD_PRIMITIVE_HANDLER(short, "%d")
ADD_PRIMITIVE_HANDLER(int, "%d")
ADD_PRIMITIVE_HANDLER(long, "%ld")
ADD_PRIMITIVE_HANDLER(long long, "%lld")
// other numerical handlers. Note that some of these can be trivially implicitly cast to
// other primitive types so we can't define them again. Specifically the size_t,
// intmax_t, and uintmax_t types often match other types with handlers defined above.
// Which handler each of these matches to will differ by platform however.
ADD_PRIMITIVE_HANDLER(float, "%.10f")
ADD_PRIMITIVE_HANDLER(double, "%.20f")
#undef ADD_PRIMITIVE_HANDLER
/** Adds all settings under a branch in the settings registry to this object.
*
* @param[in] root The root of the settings tree to copy into this argument
* collector. This may be `nullptr` or an empty string to
* add all settings starting from the root of the settings
* registry. This string should start with a '/' so that it is
* always an absolute settings path.
* @param[in] prefix The prefix to add to each option before adding it to this
* argument collector. This may be `nullptr` or an empty string
* to not use any prefix.
* @param[in] flags Flags to control the behavior of this operation. This may be
* zero or more of the @ref SettingsEnumFlags flags. This defaults
* to 0.
* @param[in] predicate A predicate function that will be called for each value to give
* the caller a chance to decide whether it should be added to this
* object or not. This may be `nullptr` if all settings under the
* given root should always be added. This defaults to `nullptr`.
* @param[in] context An opaque context value that will be passed to the predicate
* function @p predicate. This will not be accessed or used in
* any way except to pass to the predicate function. This defaults
* to `nullptr`.
* @returns A reference to this argument collector object.
*
* @remarks This adds echoes of all settings under a given root branch as arguments in this
* argument collector. Each setting that is found is given the prefix @p prefix
* (typically something like "--/"). This is useful for passing along certain
* subsets of a parent process's settings tree to a child process.
*
* @note It is the caller's responsibility to ensure that only expected settings are added
* to this argument collector. A predicate function can be provided to allow per-item
* control over which settings get added. By default, the search is not recursive.
* This is intentional since adding a full tree could potentially add a lot of new
* arguments to this object.
*/
ArgCollector& add(const char* root,
const char* prefix,
SettingsEnumFlags flags = 0,
AddSettingPredicateFn predicate = nullptr,
void* context = nullptr)
{
dictionary::IDictionary* dictionary = getCachedInterface<dictionary::IDictionary>();
settings::ISettings* settings = getCachedInterface<settings::ISettings>();
std::string rootPath;
auto addSetting = [&](const char* path, int32_t elementData, void* context) -> int32_t {
dictionary::ItemType type;
CARB_UNUSED(context);
type = settings->getItemType(path);
// skip dictionaries since we're only interested in leaves here.
if (type == dictionary::ItemType::eDictionary)
return elementData + 1;
if ((flags & fSettingsEnumFlagRecursive) == 0 && elementData > 1)
return elementData;
// verify that the caller wants this setting added.
if (predicate != nullptr && !predicate(path, context))
return elementData + 1;
switch (type)
{
case dictionary::ItemType::eBool:
format("%s%s=%s", prefix, &path[1], settings->getAsBool(path) ? "true" : "false");
break;
case dictionary::ItemType::eInt:
format("%s%s=%" PRId64, prefix, &path[1], settings->getAsInt64(path));
break;
case dictionary::ItemType::eFloat:
format("%s%s=%g", prefix, &path[1], settings->getAsFloat64(path));
break;
case dictionary::ItemType::eString:
format("%s%s=\"%s\"", prefix, &path[1], settings->getStringBuffer(path));
break;
default:
break;
}
return elementData;
};
// unexpected root prefix (not an absolute settings path) => fail.
if (root == nullptr || root[0] == 0)
root = "/";
// avoid a `nullptr` check later.
if (prefix == nullptr)
prefix = "";
// make sure to strip off any trailing separators since that would break the lookups.
rootPath = root;
if (rootPath.size() > 1 && rootPath[rootPath.size() - 1] == '/')
rootPath = rootPath.substr(0, rootPath.size() - 1);
// walk the settings tree to collect all the requested settings.
settings::walkSettings(
dictionary, settings, dictionary::WalkerMode::eIncludeRoot, rootPath.c_str(), 0, addSetting, context);
return *this;
}
/** Retrieves the argument string at a given index.
*
* @param[in] index The zero based index of the argument to retrieve. This must be
* strictly less than the number of arguments in the list as returned
* by getCount(). If this index is out of range, an empty string
* will be returned instead.
* @returns A reference to the string contained in the requested argument in the list.
* This returned string should not be modified by the caller.
*
* @remarks This retrieves the argument string stored at the given index in the argument
* list. This string will be the one stored in the list itself and should not
* be modified.
*/
const std::string& at(size_t index) const
{
if (index >= m_args.size())
return m_empty;
return m_args[index];
}
/** @copydoc at() */
const std::string& operator[](size_t index) const
{
return at(index);
}
/** Removes the last argument from the list.
*
* @returns No return value.
*
* @remarks This removes the last argument from the list. If this is called, any previous
* returned object from getArgs() will no longer be valid. The updated list object
* must be retrieved again with another call to getArgs().
*/
void pop()
{
if (m_args.empty())
return;
m_args.pop_back();
}
/** Removes an argument from the list by its index.
*
* @returns `true` if the item is successfully removed.
* @returns `false` if the given index is out of range of the argument list's size.
*
* @remarks This removes an argument from the list. If this is called, any previous returned
* object from getArgs() will no longer be valid. The updated list object must be
* retrieved again with another call to getArgs().
*/
bool erase(size_t index)
{
if (index >= m_args.size())
return false;
m_args.erase(m_args.begin() + index);
return true;
}
/** Returns a string of all arguments for debugging purposes.
* @returns A `std::string` of all arguments concatenated. This is for debugging/logging purposes only.
*/
std::string toString() const
{
std::ostringstream stream;
for (auto& arg : m_args)
{
size_t index = size_t(-1);
for (;;)
{
size_t start = index + 1;
index = arg.find_first_of("\\\" '", start); // Characters that must be escaped
stream << arg.substr(start, index - start);
if (index == std::string::npos)
break;
stream << '\\' << arg[index];
}
// Always add a trailing space. It will be popped before return.
stream << ' ';
}
std::string out = stream.str();
if (!out.empty())
out.pop_back(); // Remove the extra space
return out;
}
private:
static const char* const* emptyArgList()
{
static const char* const empty{ nullptr };
return ∅
}
/** An empty string to be retrieved from operator[] in the event of an out of range index.
* This is used to avoid the undesirable behavior of having an exception thrown by the
* underlying implementation of std::vector<>.
*/
std::string m_empty;
/** The vector of collected arguments. This represents the most current list of arguments
* for this object. The list in @p m_argList may be out of date if new arguments are
* added or existing ones removed. The argument count is always taken from the size of
* this vector.
*/
std::vector<std::string> m_args;
/** The Unix style list of arguments as last retrieved by getArgs(). This is only updated
* when getArgs() is called. This object may be destroyed and recreated in subsequent
* calls to getArgs() if the argument list is modified.
*/
std::unique_ptr<const char*[]> m_argList;
/** The last allocation size of the @p m_argList object in items. This is used to avoid
* reallocating the previous object if it is already large enough for a new call to
* getArgs().
*/
size_t m_allocCount = 0;
};
/** A simple environment variable collector helper class. This provides a way to collect a set of
* environment variables and their values for use in ILauncher::launchProcess(). Each variable
* in the table will be unique. Attempting to add a variable multiple times will simply replace
* any previous value. Specifying a variable without a value will remove it from the table.
* Values for variables may be specified in any primitive integer or floating point type as
* well as string values. Once all desired variables have been collected into the object, a
* Unix style environment table can be retrieved with getEnv(). and the could with getCount().
* The order of the variables in the environment block will be undefined.
*
* The basic usage of this is to create a new object, add one or more variables and their
* values (of various types) using the various add() or '+=' operators, the retrieve the Unix
* style environment block with getEnv() to assign to @ref LaunchDesc::env, and getCount() to
* assign to @ref LaunchDesc::envCount. This environment block is then passed through the
* launch descriptor to ILauncher::launchProcess(). Copy and move constructors are also
* provided to make it easier to assign and combine other environment lists.
*
* The calling process's current environment can also be added using the add() function without
* any arguments. This can be used to allow a child process to explicitly inherit the parent
* process's environment block while also adding other variables or changing existing ones.
*
* On Windows all environment variable names used in this object are treated as case insensitive.
* All values set set for the variables will be case preserving. This matches Windows' native
* behavior in handling environment variables. If multiple casings are used in specifying the
* variable name when modifying any given variable, the variable's name will always keep the
* casing from when it was first added. Later changes to that variable regardless of the casing
* will only modify the variable's value.
*
* On Linux, all environment variable names used in this object are treated as case sensitive.
* All values set for the variables will be case preserving. This matches Linux's native
* behavior in handling environment variables. It is the caller's responsibility to ensure
* the proper casing is used when adding or modifying variables. Failure to match the case
* of an existing variable for example will result in two variables with the same name but
* different casing being added. This can be problematic for example when attempting to
* modify a standard variable such as "PATH" or "LD_LIBRARY_PATH".
*
* Also note that using this class does not affect or modify the calling process's environment
* variables in any way. This only collects variables and their values in a format suitable
* for setting as a child process's new environment.
*
* This helper class is not thread safe. It is the caller's responsibility to ensure thread
* safe access to objects of this class if needed.
*/
class EnvCollector
{
public:
EnvCollector() = default;
/** Copy constructor: copies another environment collector object into this one.
*
* @param[in] rhs The other environment collector object whose contents will be copied
* into this one. This other object will not be modified.
*/
EnvCollector(const EnvCollector& rhs)
{
*this = rhs;
}
/** Move constructor: moves the contents of an environment collector object into this one.
*
* @param[in] rhs The other environment collector object whose contents will be moved
* into this one. Upon return, this other object will be reset to an
* empty state.
*/
EnvCollector(EnvCollector&& rhs)
{
*this = std::move(rhs);
}
~EnvCollector()
{
clear();
}
/** Clears out this environment block object.
*
* @returns No return value.
*
* @remarks This clears out this environment block object. Any existing variables and their
* values will be lost and the object will be reset to its default constructed
* state for reuse.
*/
void clear()
{
m_env.clear();
m_args.clear();
}
/** Retrieves the Unix style environment block representing the variables in this object.
*
* @returns A Unix style environment block. This will be an array of string pointers.
* The last entry in the array will always be a `nullptr` string. This can be
* used to count the length of the environment block without needing to explicitly
* pass in its size as well.
* @returns `nullptr` if the buffer for the environment block could not be allocated.
*
* @remarks This retrieves the Unix style environment block for this object. The environment
* block object is owned by this object and should not be freed or deleted. The
* returned block will be valid until this object is destroyed or until getEnv()
* is called again. If the caller needs to keep a copy of the returned environment
* block object, the caller must perform a deep copy on the returned object. This
* task is out of the scope of this object and is left as an exercise for the caller.
*/
const char* const* getEnv()
{
m_args.clear();
for (auto& var : m_env)
m_args.format("%s=%s", var.first.c_str(), var.second.c_str());
return m_args.getArgs();
}
/** Retrieves the number of unique variables in the environment block.
*
* @returns The total number of unique variables in this environment block.
* @returns `0` if this environment block object is empty.
*/
size_t getCount() const
{
return m_env.size();
}
/** Copy assignment operator.
*
* @param[in] rhs The environment collector object to copy from. This object will receive
* a copy of all the variables currently listed in the @p rhs environment
* collector object. The @p rhs object will not be modified.
* @returns A reference to this object suitable for chaining other operators or calls.
*/
EnvCollector& operator=(const EnvCollector& rhs)
{
if (this == &rhs)
return *this;
clear();
if (rhs.m_env.size() == 0)
return *this;
m_env = rhs.m_env;
return *this;
}
/** Move assignment operator.
*
* @param[inout] rhs The argument collector object to move from. This object will
* steal all arguments from @p rhs and will clear out the other
* object before returning.
* @returns A reference to this object suitable for chaining other operators or calls.
*/
EnvCollector& operator=(EnvCollector&& rhs)
{
if (this == &rhs)
return *this;
clear();
m_env = std::move(rhs.m_env);
return *this;
}
/** Compare this object to another argument collector object for equality.
*
* @param[in] rhs The argument collector object to compare to this one.
* @returns `true` if the two objects contain the same list of arguments. Note that each
* object must contain the same arguments in the same order in order for them
* to match.
* @returns `false` if the argument lists in the two objects differ.
*/
bool operator==(const EnvCollector& rhs)
{
size_t count = m_env.size();
if (&rhs == this)
return true;
if (count != rhs.m_env.size())
return false;
for (auto var : m_env)
{
auto other = rhs.m_env.find(var.first);
if (other == rhs.m_env.end())
return false;
if (other->second != var.second)
return false;
}
return true;
}
/** Compare this object to another argument collector object for inequality.
*
* @param[in] rhs The argument collector object to compare to this one.
* @returns `true` if the two objects contain a different list of arguments. Note that each
* object must contain the same arguments in the same order in order for them
* to match. If either the argument count differs or the order of the arguments
* differs, this will succeed.
* @returns `false` if the argument lists in the two objects match.
*/
bool operator!=(const EnvCollector& rhs)
{
return !(*this == rhs);
}
/** Tests whether this argument collector is empty.
*
* @returns `true` if this argument collector object is empty.
* @returns `false` if argument collector has at least one argument in its list.
*/
bool operator!()
{
return m_env.size() == 0;
}
/** Tests whether this argument collector is non-empty.
*
* @returns `true` if argument collector has at least one argument in its list.
* @returns `false` if this argument collector object is empty.
*/
operator bool()
{
return !m_env.empty();
}
/** Adds a new environment variable by name and value.
*
* @param[in] name The name of the environment variable to add or replace. This may
* not be an empty string or `nullptr`, and should not contain an '='
* except as the first character.
* @param[in] value The value to assign to the variable @p name. This may be `nullptr`
* or an empty string to add a variable with no value.
* @returns A reference to this object suitable for chaining multiple calls.
*
* @remarks These functions allow various combinations of name and value types to be used
* to add new environment variables to this object. Values may be set as strings,
* integers, or floating point values.
*/
EnvCollector& add(const char* name, const char* value)
{
m_env[name] = value == nullptr ? "" : value;
return *this;
}
/** @copydoc add(const char*,const char*) */
EnvCollector& add(const std::string& name, const std::string& value)
{
m_env[name] = value;
return *this;
}
/** @copydoc add(const char*,const char*) */
EnvCollector& add(const std::string& name, const char* value)
{
m_env[name] = value == nullptr ? "" : value;
return *this;
}
/** @copydoc add(const char*,const char*) */
EnvCollector& add(const char* name, const std::string& value)
{
m_env[name] = value;
return *this;
}
#define ADD_PRIMITIVE_HANDLER(type, fmt) \
/** Adds a new name and primitive value to this environment collector object. \
@param[in] name The name of the new environment variable to be added. This may \
not be `nullptr` or an empty string. \
@param[in] value The primitive numerical value to set as the environment variable's \
value. This will be converted to a string before adding to the \
collector. \
@returns A reference to this environment collector object. \
*/ \
EnvCollector& add(const char* name, type value) \
{ \
char buffer[128]; \
carb::extras::formatString(buffer, CARB_COUNTOF(buffer), fmt, value); \
return add(name, buffer); \
} \
/** @copydoc add(const char*,type) */ \
EnvCollector& add(const std::string& name, type value) \
{ \
return add(name.c_str(), value); \
}
// unsigned integer handlers.
ADD_PRIMITIVE_HANDLER(uint8_t, "%" PRIu8)
ADD_PRIMITIVE_HANDLER(uint16_t, "%" PRIu16)
ADD_PRIMITIVE_HANDLER(uint32_t, "%" PRIu32)
ADD_PRIMITIVE_HANDLER(uint64_t, "%" PRIu64)
// signed integer handlers.
ADD_PRIMITIVE_HANDLER(int8_t, "%" PRId8)
ADD_PRIMITIVE_HANDLER(int16_t, "%" PRId16)
ADD_PRIMITIVE_HANDLER(int32_t, "%" PRId32)
ADD_PRIMITIVE_HANDLER(int64_t, "%" PRId64)
// other numerical handlers. Note that some of these can be trivially implicitly cast to
// other primitive types so we can't define them again. Specifically the size_t,
// intmax_t, and uintmax_t types often match other types with handlers defined above.
// Which handler each of these matches to will differ by platform however.
ADD_PRIMITIVE_HANDLER(float, "%.10f")
ADD_PRIMITIVE_HANDLER(double, "%.20f")
#undef ADD_PRIMITIVE_HANDLER
/** Adds or replaces a variable specified in a single string.
*
* @param[in] var The variable name and value to set. This may not be `nullptr` or an empty
* string. This must be in the format `<name>=<value>`. There should not
* be any spaces between the name, '=' and value portions of the string.
* If the '=' is missing or no value is given after the '=', the value of
* the named variable will be cleared out, but the variable will still
* remain valid.
* @returns A reference to this object suitable for chaining multiple calls.
*/
EnvCollector& add(const char* var)
{
const char* sep;
#if CARB_PLATFORM_WINDOWS
// Windows' environment sets variables such as "=C:=C:\". We need to handle this case.
// Here the variable's name is "=C:" and its value is "C:\". This similar behavior is
// not allowed on Linux however.
if (var[0] == '=')
sep = strchr(var + 1, '=');
else
#endif
sep = strchr(var, '=');
// no assignment in the string => clear out that variable.
if (sep == nullptr)
{
m_env[var] = "";
return *this;
}
m_env[std::string(var, sep - var)] = sep + 1;
return *this;
}
/** @copydoc add(const char*) */
EnvCollector& add(const std::string& var)
{
return add(var.c_str());
}
/** @copydoc add(const char*) */
EnvCollector& operator+=(const char* var)
{
return add(var);
}
/** @copydoc add(const char*) */
EnvCollector& operator+=(const std::string& var)
{
return add(var.c_str());
}
/** Adds a set of environment variables to this object.
*
* @param[in] vars The set of variables to add to this object. This may not be
* `nullptr`.
* The string table variant is intended to be a Unix style `nullptr`
* terminated string list. The other variants add the full contents
* of another environment collector object.
* @returns A reference to this object suitable for chaining multiple calls.
*/
EnvCollector& add(const char* const* vars)
{
for (const char* const* var = vars; var[0] != nullptr; var++)
add(var[0]);
return *this;
}
/** @copydoc add(const char* const*) */
EnvCollector& add(const std::vector<const char*>& vars)
{
for (auto& v : vars)
add(v);
return *this;
}
/** @copydoc add(const char* const*) */
EnvCollector& add(const std::vector<std::string>& vars)
{
for (auto& v : vars)
add(v);
return *this;
}
/** @copydoc add(const char* const*) */
EnvCollector& add(const EnvCollector& vars)
{
for (auto& var : vars.m_env)
m_env[var.first] = var.second;
return *this;
}
/** @copydoc add(const char* const*) */
EnvCollector& operator+=(const char* const* vars)
{
return add(vars);
}
/** @copydoc add(const char* const*) */
EnvCollector& operator+=(const std::vector<const char*>& vars)
{
return add(vars);
}
/** @copydoc add(const char* const*) */
EnvCollector& operator+=(const std::vector<std::string>& vars)
{
return add(vars);
}
/** @copydoc add(const char* const*) */
EnvCollector& operator+=(const EnvCollector& vars)
{
return add(vars);
}
/** Adds the environment variables from the calling process.
*
* @returns A reference to this object suitable for chaining multiple calls.
*
* @remarks This adds all of the current environment variables of the calling process to
* this environment block. Any variables with the same name that already existed
* in this object will be replaced. This is suitable for inheriting the calling
* process's current environment when launching a child process while still allowing
* changes or additions before launch.
*/
#if CARB_POSIX
EnvCollector& add()
{
# if CARB_PLATFORM_MACOS
char*** tmp = _NSGetEnviron(); // see man 7 environ
if (tmp == nullptr)
{
CARB_LOG_ERROR("_NSGetEnviron() returned nullptr");
return *this;
}
char** environ = *tmp;
# endif
for (char** env = environ; env[0] != nullptr; env++)
add(env[0]);
return *this;
}
#else
EnvCollector& add()
{
LPWCH origEnv = GetEnvironmentStringsW();
LPWCH env = origEnv;
std::string var;
size_t len;
// walk the environment strings table and add each variable to this object.
for (len = wcslen(env); env[0] != 0; env += len + 1, len = wcslen(env))
{
var = extras::convertWideToUtf8(env);
add(var);
}
FreeEnvironmentStringsW(origEnv);
return *this;
}
#endif
/** Removes a variable and its value from this object.
*
* @param[in] name The name of the variable to be removed. This may not be `nullptr` or
* an empty string. The named variable will no longer be present in
* this object upon return and its value will be lost.
* @returns A reference to this object suitable for chaining multiple calls.
*/
EnvCollector& remove(const char* name)
{
m_env.erase(name);
return *this;
}
/** @copydoc remove(const char*) */
EnvCollector& remove(const std::string& name)
{
return remove(name.c_str());
}
/** @copydoc remove(const char*) */
EnvCollector& operator-=(const char* name)
{
return remove(name);
}
/** @copydoc remove(const char*) */
EnvCollector& operator-=(const std::string& name)
{
return remove(name.c_str());
}
/** Retrieves the value for a named variable in this environment block object.
*
* @param[in] name The name of the variable to retrieve the value of. This may not be
* `nullptr` or an empty string. The value of the variable will not be
* modified by this lookup nor can its value be changed by assigning
* a new string to the returned string. To change the value, one of
* the add() functions or '+=()' operators should be used instead.
* @returns The value of the named variable if present in this environment block.
* @returns An empty string if the variable is not present in this environment block.
*/
const std::string& at(const char* name)
{
auto var = m_env.find(name);
if (var == m_env.end())
return m_empty;
return var->second;
}
/** @copydoc at(const char*) */
const std::string& at(const std::string& name)
{
return at(name.c_str());
}
/** @copydoc at(const char*) */
const std::string& operator[](const char* name)
{
return at(name);
}
/** @copydoc at(const char*) */
const std::string& operator[](const std::string& name)
{
return at(name.c_str());
}
private:
/** The table of argument names and values. This behaves differently in terms of case
* sensitivity depending on the platform. On Windows, environment variable names are
* treated as case insensitive to match local OS behavior. In contrast, on Linux
* environment variable names are treated as case sensitive.
*/
omni::extras::UnorderedPathMap<std::string> m_env;
/** The argument collector used to generate the environment block for getEnv(). */
ArgCollector m_args;
/** An empty string to return in case a variable is not found in the table. */
std::string m_empty;
};
} // namespace launcher
} // namespace carb
| 50,272 | C | 39.026274 | 120 | 0.571531 |
omniverse-code/kit/include/carb/cpp17/Tuple.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "Functional.h"
#include "../cpp/Tuple.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp17
{
using ::carb::cpp::apply;
}
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({ carb::cpp17::apply([](int) {}, std::make_tuple(5)); });
| 817 | C | 26.266666 | 85 | 0.747858 |
omniverse-code/kit/include/carb/cpp17/Utility.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "../cpp/Utility.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp17
{
using ::carb::cpp::in_place;
using ::carb::cpp::in_place_index;
using ::carb::cpp::in_place_index_t;
using ::carb::cpp::in_place_t;
using ::carb::cpp::in_place_type;
using ::carb::cpp::in_place_type_t;
} // namespace cpp17
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
static_assert(sizeof(carb::cpp17::in_place), "");
static_assert(sizeof(carb::cpp17::in_place_index<0>), "");
static_assert(sizeof(carb::cpp17::in_place_index_t<0>), "");
static_assert(sizeof(carb::cpp17::in_place_t), "");
static_assert(sizeof(carb::cpp17::in_place_type<int>), "");
static_assert(sizeof(carb::cpp17::in_place_type_t<int>), "");
});
| 1,306 | C | 30.878048 | 85 | 0.712098 |
omniverse-code/kit/include/carb/cpp17/StringView.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "../cpp20/TypeTraits.h"
#include "../cpp/StringView.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp17
{
using ::carb::cpp::basic_string_view;
using ::carb::cpp::string_view;
using ::carb::cpp::wstring_view;
#if CARB_HAS_CPP20
using ::carb::cpp::u8string_view;
#endif
using ::carb::cpp::u16string_view;
using ::carb::cpp::u32string_view;
using ::carb::cpp::operator""_sv;
} // namespace cpp17
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
static_assert(sizeof(carb::cpp17::basic_string_view<char>), "");
static_assert(sizeof(carb::cpp17::string_view), "");
static_assert(sizeof(carb::cpp17::wstring_view), "");
static_assert(sizeof(carb::cpp17::u16string_view), "");
static_assert(sizeof(carb::cpp17::u32string_view), "");
});
| 1,343 | C | 29.545454 | 85 | 0.726731 |
omniverse-code/kit/include/carb/cpp17/TypeTraits.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "../cpp/TypeTraits.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
//! (Deprecated) Namespace for C++17 features using C++14 semantics. Use \ref carb::cpp instead.
namespace cpp17
{
using ::carb::cpp::bool_constant;
using ::carb::cpp::conjunction;
using ::carb::cpp::disjunction;
using ::carb::cpp::invoke_result;
using ::carb::cpp::invoke_result_t;
using ::carb::cpp::is_convertible;
using ::carb::cpp::is_invocable;
using ::carb::cpp::is_invocable_r;
using ::carb::cpp::is_nothrow_invocable;
using ::carb::cpp::is_nothrow_invocable_r;
using ::carb::cpp::is_nothrow_swappable;
using ::carb::cpp::is_nothrow_swappable_with;
using ::carb::cpp::is_swappable;
using ::carb::cpp::is_swappable_with;
using ::carb::cpp::is_void;
using ::carb::cpp::negation;
using ::carb::cpp::void_t;
} // namespace cpp17
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
using True = carb::cpp17::bool_constant<true>;
using False = carb::cpp17::bool_constant<false>;
static_assert(carb::cpp17::conjunction<True, True>::value, "1");
static_assert(carb::cpp17::disjunction<True, False>::value, "2");
auto foo = []() noexcept { return true; };
static_assert(std::is_same<carb::cpp17::invoke_result<decltype(foo)>::type, bool>::value, "3");
static_assert(std::is_same<carb::cpp17::invoke_result_t<decltype(foo)>, bool>::value, "4");
static_assert(carb::cpp17::is_convertible<bool, int>::value, "5");
static_assert(carb::cpp17::is_invocable<decltype(foo)>::value, "6");
static_assert(carb::cpp17::is_invocable_r<bool, decltype(foo)>::value, "7");
static_assert(carb::cpp17::is_nothrow_invocable<decltype(foo)>::value, "9");
static_assert(carb::cpp17::is_nothrow_invocable_r<bool, decltype(foo)>::value, "10");
static_assert(std::is_class<carb::cpp17::is_nothrow_swappable<int>>::value, "11");
static_assert(std::is_class<carb::cpp17::is_nothrow_swappable_with<int, int>>::value, "12");
static_assert(std::is_class<carb::cpp17::is_swappable<int>>::value, "13");
static_assert(std::is_class<carb::cpp17::is_swappable_with<int, int>>::value, "14");
static_assert(carb::cpp17::is_void<void>::value, "15");
static_assert(carb::cpp17::negation<False>::value, "16");
});
| 2,789 | C | 41.923076 | 99 | 0.702044 |
omniverse-code/kit/include/carb/cpp17/Optional.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief Redirection for backwards compatibility
#pragma once
#include "Utility.h"
#include "../cpp/Optional.h"
CARB_FILE_DEPRECATED_MSG("Use carb/cpp include path and carb::cpp namespace instead")
namespace carb
{
namespace cpp17
{
using ::carb::cpp::bad_optional_access;
using ::carb::cpp::make_optional;
using ::carb::cpp::nullopt;
using ::carb::cpp::nullopt_t;
using ::carb::cpp::optional;
} // namespace cpp17
} // namespace carb
CARB_INCLUDE_PURIFY_TEST({
carb::cpp17::optional<int> opt{ carb::cpp17::nullopt };
carb::cpp17::optional<int> opt2 = carb::cpp17::make_optional<int>(5);
CARB_UNUSED(opt, opt2);
static_assert(sizeof(carb::cpp17::nullopt_t), "");
static_assert(sizeof(carb::cpp17::bad_optional_access), "");
});
| 1,201 | C | 29.049999 | 85 | 0.727727 |
omniverse-code/kit/include/carb/profiler/IProfileMonitor.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief Monitor interface for carb.profiler.
#pragma once
#include "../Defines.h"
#include "../Types.h"
namespace carb
{
namespace profiler
{
/**
* A struct describing a specific profiling event.
*/
struct ProfileEvent
{
//! A human-readable name for the event.
const char* eventName;
//! The thread ID that recorded this event. Comparable with `GetCurrentThreadID()` on Windows or `gettid()` on
//! Linux.
uint64_t threadId;
//! The start timestamp for this event. Based on 10 nanoseconds units since IProfiler::startup() was called.
uint64_t startTime;
//! The total time in milliseconds elapsed for this event.
float timeInMs;
//! The stack depth for this event.
uint16_t level;
};
//! An opaque pointer used by IProfileMonitor.
using ProfileEvents = struct ProfileEventsImpl*;
/**
* Defines an interface to monitor profiling events.
*/
struct IProfileMonitor
{
CARB_PLUGIN_INTERFACE("carb::profiler::IProfileMonitor", 1, 1)
/**
* Returns the profiled events for the previous frame (up to the previous \ref markFrameEnd() call).
*
* @returns an opaque pointer that refers to the previous frame's profiling information. This pointer must be
* released with releaseLastProfileEvents() when the caller is finished with it.
*/
ProfileEvents(CARB_ABI* getLastProfileEvents)();
/**
* Returns the number of profiling events for a ProfileEvents instance.
*
* @param events The ProfileEvents instance returned from getLastProfileEvents().
* @returns The number of profiling events in the array returned by getLastProfileEventsData().
*/
size_t(CARB_ABI* getLastProfileEventCount)(ProfileEvents events);
/**
* Returns an array of profiling events for a ProfileEvents instance.
*
* @param events The ProfileEvents instance returned from getLastProfileEvents().
* @returns An array of ProfileEvent objects. The size of the array is returned by getLastProfileEventCount().
*/
ProfileEvent*(CARB_ABI* getLastProfileEventsData)(ProfileEvents events);
/**
* Returns the number of thread IDs known to the ProfileEvents instance.
*
* @param events The ProfileEvents instance returned from getLastProfileEvents().
* @returns The number of thread IDs in the array returned by getProfileThreadIds().
*/
uint32_t(CARB_ABI* getProfileThreadCount)(ProfileEvents events);
/**
* Returns an array of thread IDs known to a ProfileEvents instance.
*
* @param events The ProfileEvents instance returned from getLastProfileEvents().
* @returns An array of thread IDs. The size of the array is returned by getProfileThreadCount(). The thread IDs
* are comparable with `GetCurrentThreadID()` on Windows and `gettid()` on Linux.
*/
uint64_t const*(CARB_ABI* getProfileThreadIds)(ProfileEvents events);
/**
* Destroys a ProfileEvents instance.
*
* The data returned getLastProfileEventsData() and getProfileThreadIds() must not be referenced after this function
* is called.
*
* @param events The ProfileEvents instance returned from getLastProfileEvents().
*/
void(CARB_ABI* releaseLastProfileEvents)(ProfileEvents events);
/**
* Returns the thread ID that called \ref markFrameEnd() event.
*
* @param events The ProfileEvents instance returned from getLastProfileEvents().
* @returns The thread ID that last called \ref markFrameEnd(). This thread ID is comparable with
* `GetCurrentThreadID()` on Windows and `gettid()` on Linux.
*/
uint64_t(CARB_ABI* getMainThreadId)(ProfileEvents events);
/**
* Marks the end of a frame's profile events.
*
* After this call, the previous frame's profile events are available via \ref getLastProfileEvents().
*/
void(CARB_ABI* markFrameEnd)();
};
} // namespace profiler
} // namespace carb
| 4,405 | C | 33.968254 | 120 | 0.708967 |
omniverse-code/kit/include/carb/profiler/ProfilerBindingsPython.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "../BindingsPythonUtils.h"
#include "../Framework.h"
#include "IProfileMonitor.h"
#include <memory>
#include <string>
#include <vector>
using namespace pybind11::literals;
namespace carb
{
namespace profiler
{
namespace
{
class ScopedProfileEvents
{
public:
ScopedProfileEvents(const IProfileMonitor* profileMonitor) : m_profileMonitor(profileMonitor)
{
m_profileEvents = m_profileMonitor->getLastProfileEvents();
}
ScopedProfileEvents(ScopedProfileEvents&& rhs)
: m_profileEvents(rhs.m_profileEvents), m_profileMonitor(rhs.m_profileMonitor)
{
rhs.m_profileEvents = nullptr;
}
~ScopedProfileEvents()
{
if (m_profileEvents)
m_profileMonitor->releaseLastProfileEvents(m_profileEvents);
}
ScopedProfileEvents& operator=(ScopedProfileEvents&& rhs)
{
std::swap(m_profileEvents, rhs.m_profileEvents);
std::swap(m_profileMonitor, rhs.m_profileMonitor);
return *this;
}
CARB_PREVENT_COPY(ScopedProfileEvents);
const IProfileMonitor* mon() const
{
return m_profileMonitor;
}
operator ProfileEvents() const
{
return m_profileEvents;
}
private:
ProfileEvents m_profileEvents;
const IProfileMonitor* m_profileMonitor;
};
inline void definePythonModule(py::module& m)
{
using namespace carb::profiler;
m.doc() = "pybind11 carb.profiler bindings";
py::enum_<InstantType>(m, "InstantType").value("THREAD", InstantType::Thread).value("PROCESS", InstantType::Process)
/**/;
py::enum_<FlowType>(m, "FlowType").value("BEGIN", FlowType::Begin).value("END", FlowType::End)
/**/;
m.def("is_profiler_active", []() -> bool { return (g_carbProfiler != nullptr); },
py::call_guard<py::gil_scoped_release>());
m.def("supports_dynamic_source_locations",
[]() -> bool { return (g_carbProfiler && g_carbProfiler->supportsDynamicSourceLocations()); },
py::call_guard<py::gil_scoped_release>());
// This is an extended helper with location, the shorter `begin` method is defined in __init__.py
m.def("begin_with_location",
[](uint64_t mask, std::string name, std::string functionStr, std::string filepathStr, uint32_t line) {
if (g_carbProfiler)
{
static carb::profiler::StaticStringType sfunction{ g_carbProfiler->registerStaticString("Py::func") };
static carb::profiler::StaticStringType sfilepath{ g_carbProfiler->registerStaticString("Py::code") };
auto function = sfunction, filepath = sfilepath;
if (g_carbProfiler->supportsDynamicSourceLocations())
{
if (!functionStr.empty())
{
function = carb::profiler::StaticStringType(functionStr.c_str());
}
if (!filepathStr.empty())
{
filepath = carb::profiler::StaticStringType(filepathStr.c_str());
}
}
uint32_t linenumber = line;
g_carbProfiler->beginDynamic(mask, function, filepath, linenumber, "%s", name.c_str());
}
},
py::arg("mask"), py::arg("name"), py::arg("function") = "", py::arg("filepath") = "", py::arg("lineno") = 0,
py::call_guard<py::gil_scoped_release>());
m.def("end",
[](uint64_t mask) {
if (g_carbProfiler)
{
g_carbProfiler->end(mask);
}
},
py::arg("mask"), py::call_guard<py::gil_scoped_release>());
defineInterfaceClass<IProfiler>(m, "IProfiler", "acquire_profiler_interface")
// .def("get_item", wrapInterfaceFunction(&IDictionary::getItem), py::arg("base_item"), py::arg("path") = "",
// py::return_value_policy::reference)
.def("startup", [](IProfiler* self) { self->startup(); }, py::call_guard<py::gil_scoped_release>())
.def("shutdown", [](IProfiler* self) { self->shutdown(); }, py::call_guard<py::gil_scoped_release>())
.def("set_capture_mask", [](IProfiler* self, uint64_t mask) { return self->setCaptureMask(mask); },
py::arg("mask"), py::call_guard<py::gil_scoped_release>())
.def("get_capture_mask", [](IProfiler* self) { return self->getCaptureMask(); },
py::call_guard<py::gil_scoped_release>())
.def("begin",
[](IProfiler* self, uint64_t mask, std::string name) {
static auto function = self->registerStaticString("pyfunc");
static auto file = self->registerStaticString("python");
self->beginDynamic(mask, function, file, 1, "%s", name.c_str());
},
py::arg("mask"), py::arg("name"), py::call_guard<py::gil_scoped_release>())
.def("frame", [](IProfiler* self, uint64_t mask, const char* name) { self->frameDynamic(mask, "%s", name); },
py::call_guard<py::gil_scoped_release>())
.def("end", [](IProfiler* self, uint64_t mask) { self->end(mask); }, py::arg("mask"),
py::call_guard<py::gil_scoped_release>())
.def("value_float",
[](IProfiler* self, uint64_t mask, float value, std::string name) {
self->valueFloatDynamic(mask, value, "%s", name.c_str());
},
py::arg("mask"), py::arg("value"), py::arg("name"), py::call_guard<py::gil_scoped_release>())
.def("value_int",
[](IProfiler* self, uint64_t mask, int32_t value, std::string name) {
self->valueIntDynamic(mask, value, "%s", name.c_str());
},
py::arg("mask"), py::arg("value"), py::arg("name"), py::call_guard<py::gil_scoped_release>())
.def("value_uint",
[](IProfiler* self, uint64_t mask, uint32_t value, std::string name) {
self->valueUIntDynamic(mask, value, "%s", name.c_str());
},
py::arg("mask"), py::arg("value"), py::arg("name"), py::call_guard<py::gil_scoped_release>())
.def("instant",
[](IProfiler* self, uint64_t mask, InstantType type, const char* name) {
static auto function = self->registerStaticString("pyfunc");
static auto file = self->registerStaticString("python");
self->emitInstantDynamic(mask, function, file, 1, type, "%s", name);
},
py::call_guard<py::gil_scoped_release>())
.def("flow",
[](IProfiler* self, uint64_t mask, FlowType type, uint64_t id, const char* name) {
static auto function = self->registerStaticString("pyfunc");
static auto file = self->registerStaticString("python");
self->emitFlowDynamic(mask, function, file, 1, type, id, "%s", name);
},
py::call_guard<py::gil_scoped_release>());
/**/;
py::class_<ScopedProfileEvents>(m, "ProfileEvents", R"(Profile Events holder)")
.def("get_main_thread_id",
[](const ScopedProfileEvents& events) { return events.mon()->getMainThreadId(events); },
py::call_guard<py::gil_scoped_release>())
.def("get_profile_thread_ids",
[](const ScopedProfileEvents& profileEvents) {
size_t threadCount;
const uint64_t* ids;
{
py::gil_scoped_release nogil;
const IProfileMonitor* monitor = profileEvents.mon();
threadCount = monitor->getProfileThreadCount(profileEvents);
ids = monitor->getProfileThreadIds(profileEvents);
}
py::tuple threadIds(threadCount);
for (size_t i = 0; i < threadCount; i++)
{
threadIds[i] = ids[i];
}
return threadIds;
})
.def("get_profile_events",
[](const ScopedProfileEvents& profileEvents, uint64_t threadId) {
size_t eventCount;
ProfileEvent* events;
uint32_t validEventCount{ 0 };
{
py::gil_scoped_release nogil;
const IProfileMonitor* monitor = profileEvents.mon();
eventCount = monitor->getLastProfileEventCount(profileEvents);
events = monitor->getLastProfileEventsData(profileEvents);
if (threadId == 0)
{
validEventCount = static_cast<uint32_t>(eventCount);
}
else
{
for (size_t i = 0; i < eventCount; i++)
{
if (events[i].threadId == threadId)
validEventCount++;
}
}
}
py::tuple nodeList(validEventCount);
validEventCount = 0;
for (size_t i = 0; i < eventCount; i++)
{
if (threadId != 0 && events[i].threadId != threadId)
continue;
nodeList[validEventCount++] =
py::dict("name"_a = events[i].eventName, "thread_id"_a = events[i].threadId,
"start_time"_a = events[i].startTime, "duration"_a = events[i].timeInMs,
"indent"_a = events[i].level);
}
return nodeList;
},
py::arg("thread_id") = 0)
/**/;
defineInterfaceClass<IProfileMonitor>(m, "IProfileMonitor", "acquire_profile_monitor_interface")
.def("get_last_profile_events", [](const IProfileMonitor* monitor) { return ScopedProfileEvents(monitor); },
py::call_guard<py::gil_scoped_release>())
.def("mark_frame_end", [](const IProfileMonitor* monitor) { return monitor->markFrameEnd(); },
py::call_guard<py::gil_scoped_release>())
/**/;
}
} // namespace
} // namespace profiler
} // namespace carb
| 10,771 | C | 42.967347 | 120 | 0.545075 |
omniverse-code/kit/include/carb/profiler/IProfiler.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief carb.profiler interface definition file.
#pragma once
#include "../Interface.h"
#include <atomic>
#include <cstdint>
namespace carb
{
//! Namespace for *carb.profiler* and related utilities.
namespace profiler
{
constexpr uint64_t kCaptureMaskNone = 0; ///< Captures no events, effectively disabling the profiler.
constexpr uint64_t kCaptureMaskAll = (uint64_t)-1; ///< Captures all events
constexpr uint64_t kCaptureMaskDefault = uint64_t(1); ///< If zero is provided to an event function, it becomes this.
constexpr uint64_t kCaptureMaskProfiler = uint64_t(1) << 63; ///< The mask used by the profiler for profiling itself.
/// A type representing a static string returned by IProfiler::registerStaticString().
using StaticStringType = size_t;
/// Returned as an error by IProfiler::registerStaticString() if the string could not be registered.
constexpr StaticStringType kInvalidStaticString = StaticStringType(0);
/// An opaque ID returned by IProfiler::beginStatic() / IProfiler::beginDynamic() that should be returned in
/// IProfiler::endEx() to validate that the zone was closed properly.
using ZoneId = size_t;
/// A marker that is returned IProfiler::beginStatic() / IProfiler::beginDynamic() on error and can be passed to
/// IProfiler::endEx() to prevent zone validation checking.
constexpr ZoneId kUnknownZoneId = 0;
/// A marker returned by IProfiler::beginStatic() / IProfiler::beginDynamic() to indicate that the zone
/// should be discarded, typically because it doesn't match the current capture mask.
constexpr ZoneId kNoZoneId = ZoneId(-1);
/// The type of flow event passed to IProfiler::emitFlowStatic() / IProfiler::emitFlowDynamic(). Typically used only by
/// profiler macros.
enum class FlowType : uint8_t
{
Begin, ///< A flow begin point.
End ///< A flow end point.
};
/// The type of instant event passed to IProfiler::emitInstantStatic() / IProfiler::emitInstantDynamic().
enum class InstantType : uint8_t
{
Thread, ///< Draws a vertical line through the entire process.
Process ///< Similar to a thread profile zone with zero duration.
};
/// ID for a GPU context created with IProfiler::createGpuContext
using GpuContextId = uint8_t;
/// Special value to indicate that a GPU context ID is invalid.
constexpr uint8_t kInvalidGpuContextId = (uint8_t)-1;
/// ID for a Lockable context created with IProfiler::createLockable
using LockableId = uint32_t;
/// Special value to indicate that a LockableId is invalid.
constexpr uint32_t kInvalidLockableId = (uint32_t)-1;
/// The type of lockable operation event
enum class LockableOperationType : uint8_t
{
BeforeLock, ///< This notes on the timeline immediately before locking a non shared lock
AfterLock, ///< This notes on the timeline immediately after locking a non shared lock
AfterUnlock, ///< This notes on the timeline immediately after unlocking a non shared lock
AfterSuccessfulTryLock, ///< This notes on the timeline immediately after successfully try locking a non shared lock
BeforeLockShared, ///< This notes on the timeline immediately before locking a shared lock
AfterLockShared, ///< This notes on the timeline immediately after locking a shared lock
AfterUnlockShared, ///< This notes on the timeline immediately after unlocking a shared lock
AfterSuccessfulTryLockShared, ///< This notes on the timeline immediately after successfully try locking a shared
///< lock
};
//! A callback used for \ref IProfiler::setMaskCallback(). Typically handled automatically by
//! \ref carb::profiler::registerProfilerForClient().
using MaskCallbackFn = void (*)(uint64_t);
/**
* Defines the profiler system that is associated with the Framework.
*
* It is not recommended to use this interface directly, rather use macros provided in Profile.h, such as
* @ref CARB_PROFILE_ZONE().
*
* Event names are specified as string which can have formatting, which provides string behavior hints, but whether
* to use those hints is up to the profiler backend implementation.
*/
struct IProfiler
{
CARB_PLUGIN_INTERFACE("carb::profiler::IProfiler", 1, 4)
/**
* Starts up the profiler for use.
*/
void(CARB_ABI* startup)();
/**
* Shuts down the profiler and cleans up resources.
*/
void(CARB_ABI* shutdown)();
/**
* Set capture mask. Capture mask provides a way to filter out certain profiling events.
* Condition (eventMask & captureMask) == eventMask is evaluated, and if true, event
* is recorded. The default capture mask is kCaptureMaskAll
*
* @note Calling from multiple threads is not recommended as threads will overwrite each values. Calls to this
* function should be serialized.
*
* @warning Changing the capture mask after the profiler has been started causes undefined behavior.
*
* @param mask Capture mask.
* @returns the previous Capture mask.
*/
uint64_t(CARB_ABI* setCaptureMask)(const uint64_t mask);
/**
* Gets the current capture mask
*
* @returns The current capture mask
*/
uint64_t(CARB_ABI* getCaptureMask)();
/**
* Starts the profiling event. This event could be a fiber-based event (i.e. could yield and resume on
* another thread) if tasking scheduler provides proper `startFiber`/`stopFiber` calls.
*
* @param mask Event capture mask.
* @param function Static string (see @ref registerStaticString()) of the function where the profile zone is located
* (usually `__func__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param file Static string (see @ref registerStaticString()) of the filename where the profile zone was started
* (usually `__FILE__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param line Line number in the file where the profile zone was started (usually __LINE__).
* @param nameFmt The event name format, followed by args. For beginStatic() this must be a \ref StaticStringType
* from registerStaticString().
* @returns An opaque ZoneId that should be passed to endEx().
*/
ZoneId(CARB_ABI* beginStatic)(
const uint64_t mask, StaticStringType function, StaticStringType file, int line, StaticStringType nameFmt);
//! @copydoc IProfiler::beginStatic()
ZoneId(CARB_ABI* beginDynamic)(
const uint64_t mask, StaticStringType function, StaticStringType file, int line, const char* nameFmt, ...)
CARB_PRINTF_FUNCTION(5, 6);
/**
* Stops the profiling event. This event could be a fiber-based event (i.e. could yield and resume on
* another thread) if tasking scheduler provides proper `startFiber`/`stopFiber` calls.
*
* @warning This call is deprecated. Please use endEx() instead. This function will not be removed
* but should also not be called in new code.
*
* @param mask Event capture mask.
*/
void(CARB_ABI* end)(const uint64_t mask);
/**
* Inserts a frame marker for the calling thread in the profiling output, for profilers that support frame markers.
*
* @note The name provided below must be the same for each set of frames, and called each time from the same thread.
* For example you might have main thread frames that all are named "frame" and GPU frames that are named "GPU
* frame". Some profilers (i.e. profiler-cpu to Tracy conversion) require that the name contain the word "frame."
*
* @param mask Deprecated and ignored for frame events.
* @param nameFmt The frame set name format, followed by args. For frameStatic() this must be a
* \ref StaticStringType from registerStaticString().
*/
void(CARB_ABI* frameStatic)(const uint64_t mask, StaticStringType nameFmt);
/// @copydoc frameStatic
void(CARB_ABI* frameDynamic)(const uint64_t mask, const char* nameFmt, ...) CARB_PRINTF_FUNCTION(2, 3);
/**
* Send floating point value to the profiler.
*
* @param mask Value capture mask.
* @param value Value.
* @param valueFmt The value name format, followed by args. For valueFloatStatic() this must be a
* \ref StaticStringType
* from registerStaticString().
*/
void(CARB_ABI* valueFloatStatic)(const uint64_t mask, float value, StaticStringType valueFmt);
/// @copydoc valueFloatStatic
void(CARB_ABI* valueFloatDynamic)(const uint64_t mask, float value, const char* valueFmt, ...)
CARB_PRINTF_FUNCTION(3, 4);
/**
* Send signed integer value to the profiler.
*
* @param mask Value capture mask.
* @param value Value.
* @param valueFmt The value name format, followed by args. For valueIntStatic() this must be a
* \ref StaticStringType from registerStaticString().
*/
void(CARB_ABI* valueIntStatic)(const uint64_t mask, int32_t value, StaticStringType valueFmt);
/// @copydoc valueIntStatic
void(CARB_ABI* valueIntDynamic)(const uint64_t mask, int32_t value, const char* valueFmt, ...)
CARB_PRINTF_FUNCTION(3, 4);
/**
* Send unsigned integer value to the profiler.
*
* @param mask Value capture mask.
* @param value Value.
* @param valueFmt The value name format, followed by args. For valueUIntStatic() this must be a \ref
* StaticStringType from registerStaticString().
*/
void(CARB_ABI* valueUIntStatic)(const uint64_t mask, uint32_t value, StaticStringType valueFmt);
/// @copydoc valueUIntStatic
void(CARB_ABI* valueUIntDynamic)(const uint64_t mask, uint32_t value, const char* valueFmt, ...)
CARB_PRINTF_FUNCTION(3, 4);
/**
* Sets a threads name.
*
* @param tidOrZero The thread ID to name, or 0 to name the current thread.
* @param nameFmt The thread name format, followed by args. For nameThreadStatic() this must be a
* \ref StaticStringType from registerStaticString().
*/
void(CARB_ABI* nameThreadStatic)(uint64_t tidOrZero, StaticStringType threadName);
/// @copydoc nameThreadStatic
void(CARB_ABI* nameThreadDynamic)(uint64_t tidOrZero, const char* threadName, ...) CARB_PRINTF_FUNCTION(2, 3);
/**
* Checks if the profiler supports dynamic source locations.
*
* Dynamic source locations allow the `file` and `func` parameters to functions such as beginStatic() and
* beginDynamic() to be a transient non-literal string on the heap or stack.
*
* @returns `true` if dynamic source locations are supported; `false` if they are not supported.
*/
bool(CARB_ABI* supportsDynamicSourceLocations)();
/**
* Helper functions to send a arbitrary type to the profiler.
*
* @tparam T The type of the parameter to send to the profiler.
* @param mask Value capture mask.
* @param value Value.
* @param valueFmt The value name format, followed by args. For valueStatic() this must be a \ref StaticStringType
* from registerStaticString().
*/
template <typename T>
void valueStatic(uint64_t mask, T value, StaticStringType valueFmt);
/// @copydoc valueStatic
/// @param args Additional arguments that correspond to printf-style format string @p valueFmt.
template <typename T, typename... Args>
void valueDynamic(uint64_t mask, T value, const char* valueFmt, Args&&... args);
/**
* Helper function for registering a static string.
*
* @note The profiler must copy all strings. By registering a static string, you are making a contract with the
* profiler that the string at the provided address will never change. This allows the string to be passed by
* pointer as an optimization without needing to copy the string.
*
* @note This function should be called only once per string. The return value should be captured in a variable and
* passed to the static function such as beginStatic(), frameStatic(), valueStatic(), etc.
*
* @param string The static string to register. This must be a string literal or otherwise a string whose address
* will never change.
* @returns A \ref StaticStringType that represents the registered static string. If the string could not be
* registered, kInvalidStaticString is returned.
*/
StaticStringType(CARB_ABI* registerStaticString)(const char* string);
/**
* Send memory allocation event to the profiler for custom pools.
*
* @param mask Value capture mask.
* @param ptr Memory address.
* @param size Amount of bytes allocated.
* @param name Static or formatted string which contains the name of the pool.
*/
void(CARB_ABI* allocNamedStatic)(const uint64_t mask, const void* ptr, uint64_t size, StaticStringType name);
/// @copydoc allocNamedStatic
void(CARB_ABI* allocNamedDynamic)(const uint64_t mask, const void* ptr, uint64_t size, const char* nameFmt, ...)
CARB_PRINTF_FUNCTION(4, 5);
/**
* Send memory free event to the profiler for custom pools.
*
* @param mask Value capture mask.
* @param ptr Memory address.
* @param name Static or formatted string which contains the name of the pool.
*/
void(CARB_ABI* freeNamedStatic)(const uint64_t mask, const void* ptr, StaticStringType valueFmt);
/// @copydoc freeNamedStatic
void(CARB_ABI* freeNamedDynamic)(const uint64_t mask, const void* ptr, const char* nameFmt, ...)
CARB_PRINTF_FUNCTION(3, 4);
/**
* Send memory allocation event to the profiler on the default pool.
*
* @param mask Value capture mask.
* @param ptr Memory address.
* @param size Amount of bytes allocated.
*/
void(CARB_ABI* allocStatic)(const uint64_t mask, const void* ptr, uint64_t size);
/**
* Send memory free event to the profiler on the default pool.
*
* @param mask Value capture mask.
* @param ptr Memory address.
*/
void(CARB_ABI* freeStatic)(const uint64_t mask, const void* ptr);
/**
* Stops the profiling event that was initiated by beginStatic() or beginDynamic().
*
* @param mask Event capture mask.
* @param zoneId The ZoneId returned from beginStatic() or beginDynamic().
*/
void(CARB_ABI* endEx)(const uint64_t mask, ZoneId zoneId);
/**
* Records an instant event on a thread's timeline at the current time. Generally not used directly; instead use the
* @ref CARB_PROFILE_EVENT() macro.
*
* @param mask Event capture mask.
* @param function Static string (see @ref registerStaticString()) of the name of the function containing this event
* (typically `__func__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param file Static string (see @ref registerStaticString()) of the name of the source file containing this event
* (typically `__FILE__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param line The line number in @p file containing this event (typically `__LINE__`).
* @param type The type of instant event.
* @param nameFmt The name for the event.
*/
void(CARB_ABI* emitInstantStatic)(const uint64_t mask,
StaticStringType function,
StaticStringType file,
int line,
InstantType type,
StaticStringType nameFmt);
/// @copydoc emitInstantStatic
/// @note This function is slower than using emitInstanceStatic().
/// @param ... `printf`-style varargs for @p nameFmt.
void(CARB_ABI* emitInstantDynamic)(const uint64_t mask,
StaticStringType function,
StaticStringType file,
int line,
InstantType type,
const char* nameFmt,
...) CARB_PRINTF_FUNCTION(6, 7);
/**
* Puts a flow event on the timeline at the current line. Generally not used directly; instead use the
* @ref CARB_PROFILE_FLOW_BEGIN() and @ref CARB_PROFILE_FLOW_END() macros.
*
* Flow events draw an arrow from one point (the @ref FlowType::Begin location) to another point (the @ref
* FlowType::End location). These two points can be in different threads but must have a matching @p id field. Only
* the @ref FlowType::Begin event must specify a @p name. The @p id field is meant to be unique across profiler
* runs, but may be reused as long as the @p name field matches across all @ref FlowType::Begin events and events
* occur on the global timeline as @ref FlowType::Begin followed by @ref FlowType::End.
*
* A call with @ref FlowType::Begin will automatically insert an instant event on the current thread's timeline.
*
* @param mask Event capture mask.
* @param function Static string (see @ref registerStaticString()) of the name of the function containing this
* event. If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref StaticStringType.
* @param file Static string (see @ref registerStaticString()) of the name of the source file containing this event
* (typically `__FILE__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param line The line number in @p file containing this event (typically `__LINE__`).
* @param type The type of flow marker.
* @param id A unique identifier to tie `Begin` and `End` events together.
* @param name The name for the flow event. Only required for @ref FlowType::Begin; if specified for
* @ref FlowType::End it must match exactly or be `nullptr`.
*/
void(CARB_ABI* emitFlowStatic)(const uint64_t mask,
StaticStringType function,
StaticStringType file,
int line,
FlowType type,
uint64_t id,
StaticStringType name);
/// @copydoc emitFlowStatic
/// @note This function is slower than using emitFlowStatic().
/// @param ... `printf`-style varargs for @p nameFmt.
void(CARB_ABI* emitFlowDynamic)(const uint64_t mask,
StaticStringType function,
StaticStringType file,
int line,
FlowType type,
uint64_t id,
const char* name,
...) CARB_PRINTF_FUNCTION(7, 8);
/**
* Create a new GPU profiling context that allows injecting timestamps coming from a GPU in a deferred manner
*
* @param name name of the context
* @param correlatedCpuTimestampNs correlated GPU clock timestamp (in nanoseconds)
* @param correlatedGpuTimestamp correlated GPU clock timestamp (raw value)
* @param gpuTimestampPeriodNs is the number of nanoseconds required for a GPU timestamp query to be incremented
* by 1.
* @param graphicApi string of graphic API used ['vulkan'/'d3d12']
* @returns a valid ID or kInvalidGpuContextId if creation fails
*/
GpuContextId(CARB_ABI* createGpuContext)(const char* name,
int64_t correlatedCpuTimestampNs,
int64_t correlatedGpuTimestamp,
float gpuTimestampPeriodNs,
const char* graphicApi);
/**
* Destroy a previously created GPU Context
*
* @param contextId id of the context, returned by createGpuContext
*/
void(CARB_ABI* destroyGpuContext)(GpuContextId contextId);
/**
* Submit context calibration information that allows correlating CPU and GPU clocks
*
* @param contextId id of the context, returned by createGpuContext
* @param correlatedCpuTimestampNs the new CPU timestamp at the time of correlation (in nanoseconds)
* @param previousCorrelatedCpuTimestamp the CPU timestamp at the time of previous correlation (in nanoseconds)
* @param correlatedGpuTimestamp the new raw GPU timestamp at the time of correlation
*/
bool(CARB_ABI* calibrateGpuContext)(GpuContextId contextId,
int64_t correlatedCpuTimestampNs,
int64_t previousCorrelatedCpuTimestampNs,
int64_t correlatedGpuTimestamp);
/**
* Record the beginning of a new GPU timestamp query
*
* @param mask Event capture mask.
* @param function Static string (see @ref registerStaticString()) of the name of the function containing this event
* (typically `__func__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param file Static string (see @ref registerStaticString()) of the name of the source file containing this event
* (typically `__FILE__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param line The line number in @p file containing this event (typically `__LINE__`).
* @param contextId the id of the context as returned by @ref createGpuContext
* @param queryId unique query id (for identification when passing to setGpuQueryValue)
* @param name The name for the event.
*/
void(CARB_ABI* beginGpuQueryStatic)(const uint64_t mask,
StaticStringType functionName,
StaticStringType fileName,
int line,
GpuContextId contextId,
uint32_t queryId,
StaticStringType name);
//! @copydoc IProfiler::beginGpuQueryStatic()
void(CARB_ABI* beginGpuQueryDynamic)(const uint64_t mask,
StaticStringType functionName,
StaticStringType fileName,
int line,
GpuContextId contextId,
uint32_t queryId,
const char* nameFmt,
...) CARB_PRINTF_FUNCTION(7, 8);
/**
* Record the end of a new GPU timestamp query
*
* @param mask Event capture mask.
* @param contextId the id of the context as returned by @ref createGpuContext
* @param queryId unique query id (for identification when passing to setGpuQueryValue)
*/
void(CARB_ABI* endGpuQuery)(const uint64_t mask, GpuContextId contextId, uint32_t queryId);
/**
* Set the value we've received from the GPU for a query (begin or end) we've issued in the past
*
* @param contextId the id of the context as returned by @ref createGpuContext
* @param queryId unique query id specified at begin/end time
* @param gpuTimestamp raw GPU timestamp value
*/
void(CARB_ABI* setGpuQueryValue)(const uint64_t mask, GpuContextId contextId, uint32_t queryId, int64_t gpuTimestamp);
/**
* Create a lockable context which we can use to tag lock operation
*
* @param mask Event capture mask. If the mask does not match the current capture mask, the lockable is not created
* and \ref kInvalidLockableId is returned.
* @param name context name
* @param isSharedLock if this shared for a shared lock
* @param functionName Static string (see @ref registerStaticString()) of the name of the function containing this
* event (typically `__func__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param fileName Static string (see @ref registerStaticString()) of the name of the source file containing this
* event (typically `__FILE__`). If supportsDynamicSourceLocations(), this may be a `const char*` cast to @ref
* StaticStringType.
* @param line The line number in @p file containing this event (typically `__LINE__`).
*/
LockableId(CARB_ABI* createLockable)(const uint64_t mask,
const char* name,
const bool isSharedLock,
StaticStringType functionName,
StaticStringType fileName,
int line);
/**
* Destroy a lockable context
*
* @param lockableId the id of the lockable as returned by @ref createLockable
*/
void(CARB_ABI* destroyLockable)(LockableId lockableId);
/**
* Record a lockable operation
*
* @param lockableId the id of the lockable as returned by @ref createLockable
* @param operation which lock operation to tag
*/
void(CARB_ABI* lockableOperation)(LockableId lockableId, LockableOperationType operation);
/**
* Used by \ref carb::profiler::registerProfilerForClient() and \ref carb::profiler::deregisterProfilerForClient()
* to register a callback for keeping the profiler mask up to date.
*
* @param func The callback function to register.
* @param enabled \c true to register the callback, \c false to unregister the callback.
* @returns The current profiler mask.
*/
uint64_t(CARB_ABI* setMaskCallback)(MaskCallbackFn func, bool enabled);
};
#ifndef DOXYGEN_BUILD
namespace detail
{
template <typename T>
class ValueInvoker;
template <>
class ValueInvoker<float>
{
public:
static void invokeStatic(IProfiler& profiler, uint64_t mask, float value, StaticStringType valueFmt)
{
profiler.valueFloatStatic(mask, value, valueFmt);
}
template <typename... Args>
static void invokeDynamic(IProfiler& profiler, uint64_t mask, float value, const char* valueFmt, Args&&... args)
{
profiler.valueFloatDynamic(mask, value, valueFmt, std::forward<Args>(args)...);
}
};
template <>
class ValueInvoker<int32_t>
{
public:
static void invokeStatic(IProfiler& profiler, uint64_t mask, int32_t value, StaticStringType valueFmt)
{
profiler.valueIntStatic(mask, value, valueFmt);
}
template <typename... Args>
static void invokeDynamic(IProfiler& profiler, uint64_t mask, int32_t value, const char* valueFmt, Args&&... args)
{
profiler.valueIntDynamic(mask, value, valueFmt, std::forward<Args>(args)...);
}
};
template <>
class ValueInvoker<uint32_t>
{
public:
static void invokeStatic(IProfiler& profiler, uint64_t mask, uint32_t value, StaticStringType valueFmt)
{
profiler.valueUIntStatic(mask, value, valueFmt);
}
template <typename... Args>
static void invokeDynamic(IProfiler& profiler, uint64_t mask, uint32_t value, const char* valueFmt, Args&&... args)
{
profiler.valueUIntDynamic(mask, value, valueFmt, std::forward<Args>(args)...);
}
};
} // namespace detail
#endif
template <typename T>
inline void IProfiler::valueStatic(uint64_t mask, T value, StaticStringType valueFmt)
{
using ValueInvoker = typename detail::ValueInvoker<T>;
ValueInvoker::invokeStatic(*this, mask, value, valueFmt);
}
template <typename T, typename... Args>
inline void IProfiler::valueDynamic(uint64_t mask, T value, const char* valueFmt, Args&&... args)
{
using ValueInvoker = typename detail::ValueInvoker<T>;
ValueInvoker::invokeDynamic(*this, mask, value, valueFmt, std::forward<Args>(args)...);
}
} // namespace profiler
} // namespace carb
/**
* Global pointer used to store the @ref carb::profiler::IProfiler interface.
*
* A copy of this pointer is stored in each Carbonite client (i.e. plugin/app). For applications, this pointer is
* declared by @ref OMNI_APP_GLOBALS. For plugins, this pointer is declared by @ref CARB_PROFILER_GLOBALS via @ref
* OMNI_MODULE_GLOBALS.
*
* This pointer is an implementation detail transparent to users. However, a linker error pointing to this variable
* usually indicates one of the `_GLOBALS` macros mentioned above were not called.
*/
CARB_WEAKLINK carb::profiler::IProfiler* g_carbProfiler;
/**
* A global variable used as a cache for the result of \ref carb::profiler::IProfiler::getCaptureMask().
*
* \ref carb::profiler::registerProfilerForClient() will register a callback function with the profiler (if supported)
* that will keep this variable updated. This variable can be checked inline before calling into the IProfiler
* interface.
*/
CARB_WEAKLINK std::atomic_uint64_t g_carbProfilerMask;
| 29,711 | C | 45.643642 | 122 | 0.661136 |
omniverse-code/kit/include/carb/profiler/ProfilerUtils.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief carb.profiler helper utilities.
#pragma once
#include "IProfiler.h"
#include "../cpp/Atomic.h"
#include "../settings/ISettings.h"
#include "../InterfaceUtils.h"
namespace carb
{
namespace profiler
{
//! \cond DEV
namespace detail
{
struct String2
{
carb::profiler::StaticStringType first;
carb::profiler::StaticStringType second;
constexpr String2(StaticStringType first, StaticStringType second) noexcept : first(first), second(second)
{
}
};
constexpr String2 makeString2(StaticStringType first, StaticStringType second) noexcept
{
return String2{ first, second };
}
struct String3
{
carb::profiler::StaticStringType first;
carb::profiler::StaticStringType second;
carb::profiler::StaticStringType third;
constexpr String3(StaticStringType first, StaticStringType second, StaticStringType third) noexcept
: first(first), second(second), third(third)
{
}
};
constexpr String3 makeString3(StaticStringType first, StaticStringType second, StaticStringType third) noexcept
{
return String3{ first, second, third };
}
} // namespace detail
//! \endcond
/**
* Profiler channel which can be configured via \ref carb::settings::ISettings.
*
* @warning Do not use this class directly. Instead, use \ref CARB_PROFILE_DECLARE_CHANNEL().
*/
class Channel final
{
uint64_t m_mask;
bool m_enabled;
const char* m_name;
Channel* m_next;
struct ModuleData
{
Channel* head{ nullptr };
LoadHookHandle onSettingsLoadHandle{ kInvalidLoadHook };
dictionary::SubscriptionId* changeSubscription{ nullptr };
#if CARB_ASSERT_ENABLED
~ModuleData()
{
// If these weren't unregistered we could crash later
CARB_ASSERT(onSettingsLoadHandle == kInvalidLoadHook);
CARB_ASSERT(changeSubscription == nullptr);
}
#endif
};
static ModuleData& moduleData()
{
static ModuleData s_moduleData;
return s_moduleData;
}
static void onSettingsLoad(const PluginDesc&, void*)
{
// DO NOT USE getCachedInterface here! This is called by a load hook, which can be triggered by
// getCachedInterface in this module. This means if we were to recursively call getCachedInterface() here, we
// could hang indefinitely as this thread is the thread responsible for loading the cached interface.
if (loadSettings(getFramework()->tryAcquireInterface<settings::ISettings>(), true))
{
g_carbFramework->removeLoadHook(moduleData().onSettingsLoadHandle);
moduleData().onSettingsLoadHandle = kInvalidLoadHook;
}
}
static void onSettingsUnload(void*, void*)
{
// Settings was unloaded. Make sure we no longer have a subscription callback.
moduleData().changeSubscription = nullptr;
}
static void onSettingsChange(const dictionary::Item*,
const dictionary::Item* changedItem,
dictionary::ChangeEventType eventType,
void*)
{
if (eventType == dictionary::ChangeEventType::eDestroyed)
return;
auto dict = getCachedInterface<dictionary::IDictionary>();
// Only care about elements that can change at runtime.
const char* name = dict->getItemName(changedItem);
if (strcmp(name, "enabled") != 0 && strcmp(name, "mask") != 0)
return;
loadSettings(
getCachedInterface<settings::ISettings>(), false, dict->getItemName(dict->getItemParent(changedItem)));
}
static bool loadSettings(settings::ISettings* settings, bool initial, const char* channelName = nullptr)
{
// Only proceed if settings is already initialized
if (!settings)
return false;
auto dict = carb::getCachedInterface<dictionary::IDictionary>();
if (!dict)
return false;
auto root = settings->getSettingsDictionary("/profiler/channels");
if (root)
{
for (Channel* c = moduleData().head; c; c = c->m_next)
{
if (channelName && strcmp(c->m_name, channelName) != 0)
continue;
auto channelRoot = dict->getItem(root, c->m_name);
if (!channelRoot)
continue;
auto enabled = dict->getItem(channelRoot, "enabled");
if (enabled)
{
c->setEnabled(dict->getAsBool(enabled));
}
auto mask = dict->getItem(channelRoot, "mask");
if (mask)
{
c->setMask(uint64_t(dict->getAsInt64(mask)));
}
}
}
// Register a change subscription on initial setup if we have any channels.
if (initial && !moduleData().changeSubscription && moduleData().head)
{
moduleData().changeSubscription =
settings->subscribeToTreeChangeEvents("/profiler/channels", onSettingsChange, nullptr);
::g_carbFramework->addReleaseHook(settings, onSettingsUnload, nullptr);
}
return true;
}
public:
/**
* Constructor
*
* @warning Do not call this directly. Instead use \ref CARB_PROFILE_DECLARE_CHANNEL().
*
* @warning Instances of this class must have static storage and module-lifetime, therefore they may only exist at
* file-level scope, class-level (static) scope, or namespace-level scope only. Anything else is undefined behavior.
*
* @param mask The default profiler mask for this channel.
* @param enabled Whether this channel is enabled by default.
* @param name A literal string that is used to look up settings keys.
*/
Channel(uint64_t mask, bool enabled, const char* name) : m_mask(mask), m_enabled(enabled), m_name(name)
{
// Add ourselves to the list of channels for this module
auto& head = moduleData().head;
m_next = head;
head = this;
}
/**
* Returns the name of this channel.
* @returns the channel name.
*/
const char* getName() const noexcept
{
return m_name;
}
/**
* Returns the current mask for this channel.
* @returns the current mask.
*/
uint64_t getMask() const noexcept
{
return m_mask;
}
/**
* Sets the mask value for *this.
* @param mask The new profiler mask value.
*/
void setMask(uint64_t mask) noexcept
{
cpp::atomic_ref<uint64_t>(m_mask).store(mask, std::memory_order_release);
}
/**
* Returns whether this channel is enabled.
* @returns \c true if this channel is enabled; \c false otherwise.
*/
bool isEnabled() const noexcept
{
return m_enabled;
}
/**
* Sets *this to enabled or disabled.
*
* @param enabled Whether to enable (\c true) or disable (\c false) the channel.
*/
void setEnabled(bool enabled) noexcept
{
cpp::atomic_ref<bool>(m_enabled).store(enabled, std::memory_order_release);
}
/**
* Called by profiler::registerProfilerForClient() to initialize all channels.
*
* If ISettings is available, it is queried for this module's channel's settings, and a subscription is installed to
* be notified when settings change. If ISettings is not available, a load hook is installed with the framework in
* order to be notified if and when ISettings becomes available.
*/
static void onProfilerRegistered()
{
// example-begin acquire-without-init
// Don't try to load settings, but if it's already available we will load settings from it.
auto settings = g_carbFramework->tryAcquireExistingInterface<settings::ISettings>();
// example-end acquire-without-init
if (!loadSettings(settings, true))
{
// If settings isn't available, wait for it to load.
moduleData().onSettingsLoadHandle =
g_carbFramework->addLoadHook<settings::ISettings>(nullptr, onSettingsLoad, nullptr);
}
}
/**
* Called by profiler::deregisterProfilerForClient() to uninitialize all channels.
*
* Any load hooks and subscriptions installed with ISettings are removed.
*/
static void onProfilerUnregistered()
{
if (moduleData().onSettingsLoadHandle != kInvalidLoadHook)
{
g_carbFramework->removeLoadHook(moduleData().onSettingsLoadHandle);
moduleData().onSettingsLoadHandle = kInvalidLoadHook;
}
if (moduleData().changeSubscription)
{
// Don't re-initialize settings if it's already been unloaded (though in this case we should've gotten a
// callback)
auto settings = g_carbFramework->tryAcquireExistingInterface<settings::ISettings>();
CARB_ASSERT(settings);
if (settings)
{
settings->unsubscribeToChangeEvents(moduleData().changeSubscription);
g_carbFramework->removeReleaseHook(settings, onSettingsUnload, nullptr);
}
moduleData().changeSubscription = nullptr;
}
}
};
/**
* Helper class that allows to automatically stop profiling upon leaving block.
* @note Typically this is not used by an application. It is generated automatically by the CARB_PROFILE_ZONE() macro.
*/
class ProfileZoneStatic final
{
const uint64_t m_mask;
ZoneId m_zoneId;
public:
/**
* Constructor.
*
* @param mask Profiling bitmask.
* @param tup A `String3` of registered static strings for `__func__`, `__FILE__` and event name.
* @param line Line number in the file where the profile zone was started (usually `__LINE__`).
*/
ProfileZoneStatic(const uint64_t mask, const ::carb::profiler::detail::String3& tup, int line) : m_mask(mask)
{
if (g_carbProfiler && ((mask ? mask : kCaptureMaskDefault) & g_carbProfilerMask.load(std::memory_order_acquire)))
m_zoneId = g_carbProfiler->beginStatic(m_mask, tup.first, tup.second, line, tup.third);
else
m_zoneId = kNoZoneId;
}
/**
* Constructor.
*
* @param channel A profiling channel.
* @param tup A `String3` of registered static strings for `__func__`, `__FILE__` and event name.
* @param line Line number in the file where the profile zone was started (usually `__LINE__`).
*/
ProfileZoneStatic(const Channel& channel, const ::carb::profiler::detail::String3& tup, int line)
: m_mask(channel.getMask())
{
if (g_carbProfiler && channel.isEnabled())
m_zoneId = g_carbProfiler->beginStatic(m_mask, tup.first, tup.second, line, tup.third);
else
m_zoneId = kNoZoneId;
}
/**
* Destructor.
*/
~ProfileZoneStatic()
{
if (g_carbProfiler && m_zoneId != kNoZoneId)
g_carbProfiler->endEx(m_mask, m_zoneId);
}
};
//! @copydoc ProfileZoneStatic
class ProfileZoneDynamic final
{
const uint64_t m_mask;
ZoneId m_zoneId;
public:
/**
* Constructor.
*
* @param mask Profiling bitmask.
* @param tup A `String2` of registered static strings for `__func__` and `__FILE__`.
* @param line Line number in the file where the profile zone was started (usually `__LINE__`).
* @param nameFmt Profile zone name with printf-style formatting followed by arguments
* @param args Printf-style arguments used with @p nameFmt.
*/
template <typename... Args>
ProfileZoneDynamic(
const uint64_t mask, const ::carb::profiler::detail::String2& tup, int line, const char* nameFmt, Args&&... args)
: m_mask(mask)
{
if (g_carbProfiler && ((mask ? mask : kCaptureMaskDefault) & g_carbProfilerMask.load(std::memory_order_acquire)))
m_zoneId =
g_carbProfiler->beginDynamic(m_mask, tup.first, tup.second, line, nameFmt, std::forward<Args>(args)...);
else
m_zoneId = kNoZoneId;
}
/**
* Constructor.
*
* @param channel A profiling channel.
* @param tup A `String2` of registered static strings for `__func__` and `__FILE__`.
* @param line Line number in the file where the profile zone was started (usually `__LINE__`).
* @param nameFmt Profile zone name with printf-style formatting followed by arguments
* @param args Printf-style arguments used with @p nameFmt.
*/
template <typename... Args>
ProfileZoneDynamic(const Channel& channel,
const ::carb::profiler::detail::String2& tup,
int line,
const char* nameFmt,
Args&&... args)
: m_mask(channel.getMask())
{
if (g_carbProfiler && channel.isEnabled())
m_zoneId =
g_carbProfiler->beginDynamic(m_mask, tup.first, tup.second, line, nameFmt, std::forward<Args>(args)...);
else
m_zoneId = kNoZoneId;
}
/**
* Destructor.
*/
~ProfileZoneDynamic()
{
if (g_carbProfiler && m_zoneId != kNoZoneId)
g_carbProfiler->endEx(m_mask, m_zoneId);
}
};
} // namespace profiler
} // namespace carb
| 13,862 | C | 32.648058 | 121 | 0.622421 |
omniverse-code/kit/include/carb/profiler/Profile.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! @file
//!
//! @brief carb.profiler macros and helpers
#pragma once
#include "../Defines.h"
#include "../Framework.h"
#include "../cpp/Atomic.h"
#include "IProfiler.h"
#include <cstdarg>
#include <cstdio>
#include "ProfilerUtils.h"
/**
* Declares a channel that can be used with the profiler.
*
* Channels can be used in place of a mask for macros such as \ref CARB_PROFILE_ZONE. Channels allow enabling and
* disabling at runtime, or based on a settings configuration.
*
* Channels must have static storage and module lifetime, therefore this macro should be used at file-level, class-level
* or namespace-level scope only. Any other use is undefined behavior.
*
* Channels must be declared in exactly one compilation unit for a given module. References to the channel can be
* accomplished with \ref CARB_PROFILE_EXTERN_CHANNEL for other compilation units that desire to reference the channel.
*
* Channel settings are located under `/profiler/channels/<name>` and may have the following values:
* - `enabled` - (bool) whether this channel is enabled (reports to the profiler) or not
* - `mask` - (uint64_t) the mask used with the profiler
*
* @param name_ A string name for this channel. This is used to look up settings keys for this channel.
* @param defaultMask_ The profiler works with the concept of masks. The profiler must have the capture mask enabled for
* this channel to report to the profiler. A typical value for this could be
* \ref carb::profiler::kCaptureMaskDefault.
* @param defaultEnabled_ Whether this channel is enabled to report to the profiler by default.
* @param symbol_ The symbol name that code would refer to this channel by.
*/
#define CARB_PROFILE_DECLARE_CHANNEL(name_, defaultMask_, defaultEnabled_, symbol_) \
::carb::profiler::Channel symbol_((defaultMask_), (defaultEnabled_), "" name_)
/**
* References a channel declared in another compilation unit.
*
* @param symbol_ The symbol name given to the \ref CARB_PROFILE_DECLARE_CHANNEL
*/
#define CARB_PROFILE_EXTERN_CHANNEL(symbol_) extern ::carb::profiler::Channel symbol_
#if CARB_PROFILING || defined(DOXYGEN_BUILD)
/**
* @defgroup Profiler Helper Macros
*
* All of the following macros do nothing if @ref g_carbProfiler is `nullptr` (i.e.
* carb::profiler::registerProfilerForClient() has not been called).
* @{
*/
# ifndef DOXYGEN_BUILD
// The following are helper macros for the profiler.
# define CARB_PROFILE_IF(cond, true_case, false_case) CARB_PROFILE_IF_HELPER(cond, true_case, false_case)
// Note: CARB_PROFILE_HAS_VARARGS only supports up to 10 args now. If more are desired, increase the sequences below
// and add test cases to TestProfiler.cpp
// This trick is from https://stackoverflow.com/a/36015150/1450686
# if CARB_COMPILER_MSC
# define CARB_PROFILE_HAS_VARARGS(x, ...) CARB_PROFILE_EXPAND_ARGS(CARB_PROFILE_AUGMENT_ARGS(__VA_ARGS__))
# elif CARB_COMPILER_GNUC
# define CARB_PROFILE_HAS_VARARGS(...) \
CARB_PROFILE_ARGCHK_PRIVATE2(0, ##__VA_ARGS__, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0)
# else
# error Unsupported Compiler!
# endif
// The following are implementation helpers not intended to be used
# define CARB_PROFILE_IF_HELPER(cond, true_case, false_case) \
CARB_JOIN(CARB_PROFILE_IF_HELPER_, cond)(true_case, false_case)
# define CARB_PROFILE_IF_HELPER_0(true_case, false_case) false_case
# define CARB_PROFILE_IF_HELPER_1(true_case, false_case) true_case
# define CARB_PROFILE_AUGMENT_ARGS(...) unused, __VA_ARGS__
# define CARB_PROFILE_EXPAND_ARGS(...) \
CARB_PROFILE_EXPAND(CARB_PROFILE_ARGCHK_PRIVATE(__VA_ARGS__, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0))
# define CARB_PROFILE_EXPAND(x) x
# define CARB_PROFILE_ARGCHK_PRIVATE(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, count, ...) count
# define CARB_PROFILE_ARGCHK_PRIVATE2(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, count, ...) count
# define CARB_PROFILE_UFUNCFILE(func) \
[](const char* pfunc) -> const auto& \
{ \
static auto tup = ::carb::profiler::detail::makeString2( \
::g_carbProfiler->registerStaticString(pfunc), ::g_carbProfiler->registerStaticString(__FILE__)); \
return tup; \
} \
(func)
# define CARB_PROFILE_UFUNCFILESTR(func, str) \
[](const char* pfunc, const char* pstr) -> const auto& \
{ \
static auto tup = ::carb::profiler::detail::makeString3( \
::g_carbProfiler->registerStaticString(pfunc), ::g_carbProfiler->registerStaticString(__FILE__), \
::g_carbProfiler->registerStaticString(pstr)); \
return tup; \
} \
(func, str)
# define CARB_PROFILE_FUNCFILE(func) \
[](const char* pfunc) -> const auto& \
{ \
if (::g_carbProfiler) \
{ \
static auto tup = \
::carb::profiler::detail::makeString2(::g_carbProfiler->registerStaticString(pfunc), \
::g_carbProfiler->registerStaticString(__FILE__)); \
return tup; \
} \
return ::carb::profiler::detail::emptyTuple2(); \
} \
(func)
# define CARB_PROFILE_FUNCFILESTR(func, str) \
[](const char* pfunc, const char* pstr) -> const auto& \
{ \
if (::g_carbProfiler) \
{ \
static auto tup = \
::carb::profiler::detail::makeString3(::g_carbProfiler->registerStaticString(pfunc), \
::g_carbProfiler->registerStaticString(__FILE__), \
::g_carbProfiler->registerStaticString(pstr)); \
return tup; \
} \
return ::carb::profiler::detail::emptyTuple3(); \
} \
(func, str)
# define CARB_PROFILE_CHECKMASK(mask) \
(((mask) ? (mask) : carb::profiler::kCaptureMaskDefault) & \
g_carbProfilerMask.load(std::memory_order_acquire))
namespace carb
{
namespace profiler
{
namespace detail
{
// Helper functions for begin that take the tuples created by CARB_PROFILE_UFUNCFILE and CARB_PROFILE_UFUNCFILESTR
template <class... Args>
carb::profiler::ZoneId beginDynamicHelper(
const uint64_t mask, const ::carb::profiler::detail::String2& tup, int line, const char* fmt, Args&&... args)
{
if (!CARB_PROFILE_CHECKMASK(mask))
return kNoZoneId;
return ::g_carbProfiler->beginDynamic(mask, tup.first, tup.second, line, fmt, std::forward<Args>(args)...);
}
template <class... Args>
carb::profiler::ZoneId beginDynamicHelper(const carb::profiler::Channel& channel,
const ::carb::profiler::detail::String2& tup,
int line,
const char* fmt,
Args&&... args)
{
if (!channel.isEnabled())
return kNoZoneId;
return ::g_carbProfiler->beginDynamic(
channel.getMask(), tup.first, tup.second, line, fmt, std::forward<Args>(args)...);
}
inline carb::profiler::ZoneId beginStaticHelper(const uint64_t mask, const ::carb::profiler::detail::String3& tup, int line)
{
if (!CARB_PROFILE_CHECKMASK(mask))
return kNoZoneId;
return ::g_carbProfiler->beginStatic(mask, tup.first, tup.second, line, tup.third);
}
inline carb::profiler::ZoneId beginStaticHelper(const carb::profiler::Channel& channel,
const ::carb::profiler::detail::String3& tup,
int line)
{
if (!channel.isEnabled())
return kNoZoneId;
return ::g_carbProfiler->beginStatic(channel.getMask(), tup.first, tup.second, line, tup.third);
}
inline uint64_t maskHelper(uint64_t mask)
{
return mask;
}
inline uint64_t maskHelper(const carb::profiler::Channel& channel)
{
return channel.getMask();
}
inline bool enabled(uint64_t mask)
{
return CARB_PROFILE_CHECKMASK(mask);
}
inline bool enabled(const carb::profiler::Channel& channel)
{
return channel.isEnabled();
}
inline const ::carb::profiler::detail::String2& emptyTuple2()
{
static constexpr auto tup = ::carb::profiler::detail::makeString2(kInvalidStaticString, kInvalidStaticString);
return tup;
}
inline const ::carb::profiler::detail::String3& emptyTuple3()
{
static constexpr auto tup =
::carb::profiler::detail::makeString3(kInvalidStaticString, kInvalidStaticString, kInvalidStaticString);
return tup;
}
} // namespace detail
} // namespace profiler
} // namespace carb
# endif
/**
* Starts the profiler that has been registered with carb::profiler::registerProfilerForClient().
*
* When finished with the profiler it should be stopped with CARB_PROFILE_SHUTDOWN().
*
* @note This is typically done immediately after carb::profiler::registerProfilerForClient().
*/
# define CARB_PROFILE_STARTUP() \
do \
{ \
if (::g_carbProfiler) \
{ \
::g_carbProfiler->startup(); \
} \
} while (0)
/**
* Shuts down the profiler that has been registered with carb::profiler::registerProfilerForClient() and previously
* started with CARB_PROFILE_STARTUP().
*
* @note This is typically done immediately before carb::profiler::deregisterProfilerForClient().
*/
# define CARB_PROFILE_SHUTDOWN() \
do \
{ \
if (::g_carbProfiler) \
{ \
::g_carbProfiler->shutdown(); \
} \
} while (0)
/**
* Registers a static string for use with the profiler.
*
* The profiler works by capturing events very quickly in the thread of execution that they happen in, and then
* processing them later in a background thread. Since static/literal strings are contained in memory that may be
* invalid once the module unloads, these static/literal strings are registered and copied by the profiler and this
* macro returns a handle to the string that can be passed to the "static" function such as
* @ref carb::profiler::IProfiler::beginStatic().
*
* @note This macro is used by other helper macros and is typically not used by applications.
*
* @warning Undefined behavior occurs if the given string is not a literal or static string.
*
* @returns A handle to the static string registered with the profiler. There is no need to unregister this string.
*/
# define CARB_PROFILE_REGISTER_STRING(str) \
[](const char* pstr) { \
if (::g_carbProfiler) \
{ \
static ::carb::profiler::StaticStringType p = ::g_carbProfiler->registerStaticString(pstr); \
return p; \
} \
return ::carb::profiler::kInvalidStaticString; \
}(str)
/**
* A helper to set the capture mask.
*
* The capture mask is a set of 64 bits. Each profiling zone is *bitwise-and*'d with the capture mask. If the operation
* matches the profiling zone mask then the event is included in the profiling output. Otherwise, the event is ignored.
*
* The default capture mask is profiler-specific, but typically has all bits set (i.e. includes everything).
* @see carb::profiler::IProfiler::setCaptureMask()
*
* @warning Changing the capture mask after the profiler has been started causes undefined behavior.
*/
# define CARB_PROFILE_SET_CAPTURE_MASK(mask) \
do \
{ \
if (::g_carbProfiler) \
{ \
::g_carbProfiler->setCaptureMask(mask); \
} \
} while (0)
/**
* Marks the beginning of a profiling zone.
*
* To end the profiling zone, use CARB_PROFILE_END().
*
* @warning Consider using CARB_PROFILE_ZONE() to automatically profile a scope. Manual begin and end sections can cause
* programming errors and confuse the profiler if an end is skipped.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a channel symbol name.
* @param eventName The name of the profiling zone. This must be either a literal string or a printf-style format
* string. Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p eventName.
* @returns A carb::profiler::ZoneId that is unique to this zone and should be passed to CARB_PROFILE_END().
*/
# define CARB_PROFILE_BEGIN(maskOrChannel, eventName, ...) \
::g_carbProfiler ? \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(eventName, ##__VA_ARGS__), \
::carb::profiler::detail::beginDynamicHelper( \
maskOrChannel, CARB_PROFILE_UFUNCFILE(__func__), __LINE__, eventName, ##__VA_ARGS__), \
::carb::profiler::detail::beginStaticHelper( \
maskOrChannel, CARB_PROFILE_UFUNCFILESTR(__func__, eventName), __LINE__)) : \
(0 ? /*compiler validate*/ printf(eventName, ##__VA_ARGS__) : 0)
/**
* Marks the end of a profiling zone previously started with CARB_PROFILE_BEGIN().
*
* @warning Consider using CARB_PROFILE_ZONE() to automatically profile a scope. Manual begin and end sections can cause
* programming errors and confuse the profiler if an end is skipped.
*
* @param maskOrChannel The event mask or a channel symbol. This should match the value passed to CARB_PROFILE_BEGIN().
* @param ... The carb::profiler::ZoneId returned from CARB_PROFILE_BEGIN(), if known. This will help the profiler to
* validate that the proper zone was ended.
*/
# define CARB_PROFILE_END(maskOrChannel, ...) \
do \
{ \
if (::g_carbProfiler) \
{ \
::g_carbProfiler->CARB_PROFILE_IF( \
CARB_PROFILE_HAS_VARARGS(maskOrChannel, ##__VA_ARGS__), \
endEx(::carb::profiler::detail::maskHelper(maskOrChannel), ##__VA_ARGS__), \
end(::carb::profiler::detail::maskHelper(maskOrChannel))); \
} \
} while (0)
/**
* Inserts a frame marker for the calling thread in the profiling output, for profilers that support frame markers.
*
* @note The name provided below must be the same for each set of frames, and called each time from the same thread.
* For example you might have main thread frames that all are named "frame" and GPU frames that are named "GPU
* frame". Some profilers (i.e. profiler-cpu to Tracy conversion) require that the name contain the word "frame."
*
* @param mask Deprecated and ignored for frame events.
* @param frameName A name for the frame. This must either be a literal string or a printf-style format string. Literal
* strings are far more efficient. See the note above about frame names.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p frameName.
*/
# define CARB_PROFILE_FRAME(mask, frameName, ...) \
do \
{ \
/* Use printf to validate the format string */ \
if (0) \
{ \
printf(frameName, ##__VA_ARGS__); \
} \
if (::g_carbProfiler) \
{ \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(frameName, ##__VA_ARGS__), \
::g_carbProfiler->frameDynamic(mask, frameName, ##__VA_ARGS__), \
::g_carbProfiler->frameStatic(mask, []() { \
static ::carb::profiler::StaticStringType p = \
::g_carbProfiler->registerStaticString("" frameName); \
return p; \
}())); \
} \
} while (0)
/**
* Creates a profiling zone over a scope.
*
* This macro creates a temporary object on the stack that automatically begins a profiling zone at the point where this
* macro is used, and automatically ends the profiling zone when it goes out of scope.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a channel symbol.
* @param zoneName The name of the profiling zone. This must be either a literal string or a printf-style format string.
* Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p zoneName.
*/
# define CARB_PROFILE_ZONE(maskOrChannel, zoneName, ...) \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(zoneName, ##__VA_ARGS__), \
::carb::profiler::ProfileZoneDynamic CARB_JOIN(_carbZone, __LINE__)( \
(maskOrChannel), CARB_PROFILE_FUNCFILE(__func__), __LINE__, zoneName, ##__VA_ARGS__), \
::carb::profiler::ProfileZoneStatic CARB_JOIN(_carbZone, __LINE__)( \
(maskOrChannel), CARB_PROFILE_FUNCFILESTR(__func__, zoneName), __LINE__))
/**
* A helper for CARB_PROFILE_ZONE() that automatically uses the function name as from `CARB_PRETTY_FUNCTION`.
*
* Equivalent, but faster than: `CARB_PROFILE_ZONE(mask, "%s", CARB_PRETTY_FUNCTION)`.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
*/
# define CARB_PROFILE_FUNCTION(maskOrChannel) \
::carb::profiler::ProfileZoneStatic CARB_JOIN(_carbZoneFunction, __LINE__)( \
(maskOrChannel), CARB_PROFILE_FUNCFILESTR(__func__, CARB_PRETTY_FUNCTION), __LINE__)
/**
* Writes a named numeric value to the profiling output for profilers that support them.
*
* @note Supported types for @p value are `float`, `uint32_t` and `int32_t`.
*
* @param value The value to record.
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
* @param valueName The name of the value. This must be either a literal string or a printf-style format string. Literal
* strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p valueName.
*/
# define CARB_PROFILE_VALUE(value, maskOrChannel, valueName, ...) \
do \
{ \
/* Use printf to validate the format string */ \
if (0) \
{ \
printf(valueName, ##__VA_ARGS__); \
} \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
CARB_PROFILE_IF( \
CARB_PROFILE_HAS_VARARGS(valueName, ##__VA_ARGS__), \
::g_carbProfiler->valueDynamic( \
::carb::profiler::detail::maskHelper(maskOrChannel), value, valueName, ##__VA_ARGS__), \
::g_carbProfiler->valueStatic(::carb::profiler::detail::maskHelper(maskOrChannel), value, []() { \
static ::carb::profiler::StaticStringType p = \
::g_carbProfiler->registerStaticString("" valueName); \
return p; \
}())); \
} \
} while (0)
/**
* Records an allocation event for a named memory pool for profilers that support them.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
* @param ptr The memory address that was allocated.
* @param size The size of the memory region beginning at @p ptr.
* @param poolName The name of the memory pool. This must be either a literal string or a printf-style format string.
* Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p poolName.
*/
# define CARB_PROFILE_ALLOC_NAMED(maskOrChannel, ptr, size, poolName, ...) \
do \
{ \
/* Use printf to validate the format string */ \
if (0) \
{ \
printf(poolName, ##__VA_ARGS__); \
} \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(poolName, ##__VA_ARGS__), \
::g_carbProfiler->allocNamedDynamic(::carb::profiler::detail::maskHelper(maskOrChannel), \
ptr, size, poolName, ##__VA_ARGS__), \
::g_carbProfiler->allocNamedStatic( \
::carb::profiler::detail::maskHelper(maskOrChannel), ptr, size, []() { \
static ::carb::profiler::StaticStringType p = \
::g_carbProfiler->registerStaticString("" poolName); \
return p; \
}())); \
} \
} while (0)
/**
* Records a free event for a named memory pool for profilers that support them.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel. This should match
* the value passed to CARB_PROFILE_ALLOC_NAMED() for the same allocation.
* @param ptr The memory address that was freed.
* @param poolName The name of the memory pool. This must be either a literal string or a printf-style format string.
* Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p poolName.
*/
# define CARB_PROFILE_FREE_NAMED(maskOrChannel, ptr, poolName, ...) \
do \
{ \
/* Use printf to validate the format string */ \
if (0) \
{ \
printf(poolName, ##__VA_ARGS__); \
} \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
CARB_PROFILE_IF( \
CARB_PROFILE_HAS_VARARGS(poolName, ##__VA_ARGS__), \
::g_carbProfiler->freeNamedDynamic( \
::carb::profiler::detail::maskHelper(maskOrChannel), ptr, poolName, ##__VA_ARGS__), \
::g_carbProfiler->freeNamedStatic(::carb::profiler::detail::maskHelper(maskOrChannel), ptr, []() { \
static ::carb::profiler::StaticStringType p = \
::g_carbProfiler->registerStaticString("" poolName); \
return p; \
}())); \
} \
} while (0)
/**
* Records an allocation event for profilers that support them.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
* @param ptr The memory address that was allocated.
* @param size The size of the memory region beginning at @p ptr.
*/
# define CARB_PROFILE_ALLOC(maskOrChannel, ptr, size) \
do \
{ \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
::g_carbProfiler->allocStatic(::carb::profiler::detail::maskHelper(maskOrChannel), ptr, size); \
} \
} while (0)
/**
* Records a free event for profilers that support them.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
* @param ptr The memory address that was freed.
*/
# define CARB_PROFILE_FREE(maskOrChannel, ptr) \
do \
{ \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
::g_carbProfiler->freeStatic(::carb::profiler::detail::maskHelper(maskOrChannel), ptr); \
} \
} while (0)
/**
* Records the name of a thread.
*
* @param tidOrZero The thread ID that is being named. A value of `0` indicates the current thread. Not all profilers
* support values other than `0`.
* @param threadName The name of the thread. This must be either a literal string or a printf-style format string.
* Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p threadName.
*/
# define CARB_NAME_THREAD(tidOrZero, threadName, ...) \
do \
{ \
/* Use printf to validate the format string */ \
if (0) \
{ \
printf((threadName), ##__VA_ARGS__); \
} \
if (::g_carbProfiler) \
{ \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(threadName, ##__VA_ARGS__), \
::g_carbProfiler->nameThreadDynamic((tidOrZero), (threadName), ##__VA_ARGS__), \
::g_carbProfiler->nameThreadStatic((tidOrZero), []() { \
static ::carb::profiler::StaticStringType p = \
::g_carbProfiler->registerStaticString("" threadName); \
return p; \
}())); \
} \
} while (0)
/**
* Records an instant event on a thread's timeline at the current time.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
* @param type The type of the instant event that will be passed to carb::profiler::emitInstantStatic() or
* carb::profiler::emitInstantDynamic().
* @param name The name of the event. This must either be a literal string or a printf-style format string with variadic
* arguments. Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p name.
*/
# define CARB_PROFILE_EVENT(maskOrChannel, type, name, ...) \
do \
{ \
if (0) \
printf((name), ##__VA_ARGS__); \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
CARB_PROFILE_IF( \
CARB_PROFILE_HAS_VARARGS(name, ##__VA_ARGS__), \
static auto tup = ::carb::profiler::detail::makeString2( \
::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__)); \
::g_carbProfiler->emitInstantDynamic(::carb::profiler::detail::maskHelper(maskOrChannel), tup.first, \
tup.second, __LINE__, (type), (name), ##__VA_ARGS__), \
static auto tup = ::carb::profiler::detail::makeString3( \
::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__), ::g_carbProfiler->registerStaticString(name)); \
::g_carbProfiler->emitInstantStatic(::carb::profiler::detail::maskHelper(maskOrChannel), \
tup.first, tup.second, __LINE__, (type), tup.third)); \
} \
} while (0)
/**
* Records the beginning of a flow event on the timeline at the current time for the current thread.
*
* Flow events draw an arrow from one point (the `BEGIN` location) to another point (the `END` location).
* These two points can be in different threads but must have a matching @p id field. The @p id field is meant to be
* unique across profiler runs, but may be reused as long as the @p name field matches across all `BEGIN` events and
* events occur on the global timeline as `BEGIN` followed by `END`.
*
* This macro will automatically insert an instant event on the current thread's timeline.
*
* @param maskOrChannel The event mask (see carb::profiler::setCaptureMask()) or a profiling channel.
* @param id A unique identifier that must also be passed to CARB_PROFILE_FLOW_END().
* @param name The name of the event. This must either be a literal string or a printf-style format string with variadic
* arguments. Literal strings are far more efficient.
* @param ... Optional printf-style variadic arguments corresponding to format specifiers in @p name.
*/
# define CARB_PROFILE_FLOW_BEGIN(maskOrChannel, id, name, ...) \
do \
{ \
if (0) \
printf((name), ##__VA_ARGS__); \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(name, ##__VA_ARGS__), \
static auto tup = ::carb::profiler::detail::makeString2( \
::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__)); \
::g_carbProfiler->emitFlowDynamic( \
::carb::profiler::detail::maskHelper(maskOrChannel), tup.first, tup.second, \
__LINE__, ::carb::profiler::FlowType::Begin, (id), (name), ##__VA_ARGS__), \
static auto tup = ::carb::profiler::detail::makeString3( \
::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__), \
::g_carbProfiler->registerStaticString("" name)); \
::g_carbProfiler->emitFlowStatic(::carb::profiler::detail::maskHelper(maskOrChannel), \
tup.first, tup.second, __LINE__, \
::carb::profiler::FlowType::Begin, (id), tup.third)); \
} \
} while (0)
/**
* Records the end of a flow event on the timeline at the current time for the current thread.
*
* @see CARB_PROFILE_FLOW_BEGIN()
*
* @param maskOrChannel The event mask or profiling channel. Must match the value given to CARB_PROFILE_FLOW_BEGIN().
* @param id Th unique identifier passed to CARB_PROFILE_FLOW_BEGIN().
*/
# define CARB_PROFILE_FLOW_END(maskOrChannel, id) \
do \
{ \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
static auto tup = \
::carb::profiler::detail::makeString2(::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__)); \
::g_carbProfiler->emitFlowStatic(::carb::profiler::detail::maskHelper(maskOrChannel), tup.first, \
tup.second, __LINE__, ::carb::profiler::FlowType::End, (id), \
::carb::profiler::kInvalidStaticString); \
} \
} while (0)
/**
* Create a new GPU profiling context that allows injecting timestamps coming from a GPU in a deferred manner
*
* @param name name of the context
* @param correlatedCpuTimestampNs correlated GPU clock timestamp (in nanoseconds)
* @param correlatedGpuTimestamp correlated GPU clock timestamp (raw value)
* @param gpuTimestampPeriodNs is the number of nanoseconds required for a GPU timestamp query to be incremented
* by 1.
* @param graphicApi string of graphic API used ['vulkan'/'d3d12']
* @returns a valid ID or kInvalidGpuContextId if creation fails
*/
# define CARB_PROFILE_CREATE_GPU_CONTEXT( \
name, correlatedCpuTimestampNs, correlatedGpuTimestamp, gpuTimestampPeriodNs, graphicApi) \
(::g_carbProfiler ? ::g_carbProfiler->createGpuContext(name, correlatedCpuTimestampNs, correlatedGpuTimestamp, \
gpuTimestampPeriodNs, graphicApi) : \
carb::profiler::kInvalidGpuContextId)
/**
* Destroy a previously created GPU Context
*
* @param contextId ID of the context, returned by createGpuContext
*/
# define CARB_PROFILE_DESTROY_GPU_CONTEXT(contextId) \
do \
{ \
if (::g_carbProfiler) \
{ \
::g_carbProfiler->destroyGpuContext(contextId); \
} \
} while (0)
/**
* Submit context calibration information that allows correlating CPU and GPU clocks
*
* @param contextId ID of the context, returned by @ref carb::profiler::IProfiler::createGpuContext()
* @param correlatedCpuTimestampNs The new CPU timestamp at the time of correlation (in nanoseconds)
* @param previousCorrelatedCpuTimestampNs The CPU timestamp at the time of previous correlation (in nanoseconds)
* @param correlatedGpuTimestamp The new raw GPU timestamp at the time of correlation
*/
# define CARB_PROFILE_CALIBRATE_GPU_CONTEXT( \
contextId, correlatedCpuTimestampNs, previousCorrelatedCpuTimestampNs, correlatedGpuTimestamp) \
((::g_carbProfiler) ? \
(::g_carbProfiler->calibrateGpuContext( \
contextId, correlatedCpuTimestampNs, previousCorrelatedCpuTimestampNs, correlatedGpuTimestamp)) : \
false)
/**
* Record the beginning of a new GPU timestamp query
*
* @param maskOrChannel Event capture mask or profiling channel.
* @param contextId The id of the context as returned by @ref carb::profiler::IProfiler::createGpuContext()
* @param queryId Unique query id (for identification when passing to @ref
* carb::profiler::IProfiler::setGpuQueryValue())
* @param eventName The name for the event.
*/
# define CARB_PROFILE_GPU_QUERY_BEGIN(maskOrChannel, contextId, queryId, eventName, ...) \
do \
{ \
if (0) \
printf((eventName), ##__VA_ARGS__); \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
CARB_PROFILE_IF(CARB_PROFILE_HAS_VARARGS(eventName, ##__VA_ARGS__), \
static auto tup = ::carb::profiler::detail::makeString2( \
::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__)); \
::g_carbProfiler->beginGpuQueryDynamic( \
::carb::profiler::detail::maskHelper(maskOrChannel), tup.first, tup.second, \
__LINE__, contextId, queryId, eventName, ##__VA_ARGS__), \
static auto tup = ::carb::profiler::detail::makeString3( \
::g_carbProfiler->registerStaticString(CARB_PRETTY_FUNCTION), \
::g_carbProfiler->registerStaticString(__FILE__), \
::g_carbProfiler->registerStaticString("" eventName)); \
::g_carbProfiler->beginGpuQueryStatic( \
::carb::profiler::detail::maskHelper(maskOrChannel), tup.first, tup.second, \
__LINE__, contextId, queryId, tup.third)); \
} \
} while (0)
/**
* Record the end of a new GPU timestamp query
*
* @param maskOrChannel Event capture mask or profiling channel.
* @param contextId The id of the context as returned by @ref carb::profiler::IProfiler::createGpuContext()
* @param queryId Unique query id (for identification when passing to @ref
* carb::profiler::IProfiler::setGpuQueryValue())
*/
# define CARB_PROFILE_GPU_QUERY_END(maskOrChannel, contextId, queryId) \
do \
{ \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
::g_carbProfiler->endGpuQuery(::carb::profiler::detail::maskHelper(maskOrChannel), contextId, queryId); \
} \
} while (0)
/**
* Set the value we've received from the GPU for a query (begin or end) we've issued in the past
*
* @param maskOrChannel Event capture mask or profiling channel
* @param contextId The id of the context as returned by @ref carb::profiler::IProfiler::createGpuContext()
* @param queryId Unique query id specified at begin/end time
* @param gpuTimestamp Raw GPU timestamp value
*/
# define CARB_PROFILE_GPU_SET_QUERY_VALUE(maskOrChannel, contextId, queryId, gpuTimestamp) \
do \
{ \
if (::g_carbProfiler && ::carb::profiler::detail::enabled(maskOrChannel)) \
{ \
::g_carbProfiler->setGpuQueryValue( \
::carb::profiler::detail::maskHelper(maskOrChannel), contextId, queryId, gpuTimestamp); \
} \
} while (0)
/**
* Create a lockable context which we can use to tag lock operation
* @note Do not use this macro directly. Use \ref carb::profiler::ProfiledMutex or
* \ref carb::profiler::ProfiledSharedMutex instead.
* @param maskOrChannel Event capture mask or profiling channel
* @param isSharedLock If this shared for a shared lock
* @param name The lockable context name
*/
# define CARB_PROFILE_LOCKABLE_CREATE(maskOrChannel, isSharedLock, name) \
[](bool enabled, const uint64_t maskParam, const bool isSharedLockParam, const char* nameParam, \
const char* function) { \
if (::g_carbProfiler && enabled) \
{ \
static auto tup = ::carb::profiler::detail::makeString2( \
::g_carbProfiler->registerStaticString(function), ::g_carbProfiler->registerStaticString(__FILE__)); \
return ::g_carbProfiler->createLockable( \
maskParam, nameParam, isSharedLockParam, tup.first, tup.second, __LINE__); \
} \
return ::carb::profiler::kInvalidLockableId; \
}(::carb::profiler::detail::enabled(maskOrChannel), ::carb::profiler::detail::maskHelper(maskOrChannel), \
(isSharedLock), (name), CARB_PRETTY_FUNCTION)
/**
* Destroy a lockable context
* @note Do not use this macro directly. Use \ref carb::profiler::ProfiledMutex or
* \ref carb::profiler::ProfiledSharedMutex instead.
* @param lockableId the id of the lockable as returned by @ref carb::profiler::IProfiler::createLockable()
*/
# define CARB_PROFILE_LOCKABLE_DESTROY(lockableId) \
do \
{ \
if (::g_carbProfiler && lockableId != carb::profiler::kInvalidLockableId) \
{ \
::g_carbProfiler->destroyLockable((lockableId)); \
} \
} while (0)
/**
* Records a lockable operation on a thread's timeline at the current time.
* @note Do not use this macro directly. Use \ref carb::profiler::ProfiledMutex or
* \ref carb::profiler::ProfiledSharedMutex instead.
* @param lockableId the id of the lockable as returned by @ref carb::profiler::IProfiler::createLockable()
* @param operation which lock operation to tag
*/
# define CARB_PROFILE_LOCKABLE_OPERATION(lockableId, operation) \
do \
{ \
if (::g_carbProfiler && lockableId != carb::profiler::kInvalidLockableId) \
{ \
::g_carbProfiler->lockableOperation((lockableId), (operation)); \
} \
} while (0)
/// @}
#else
# define CARB_PROFILE_STARTUP() (void(0))
# define CARB_PROFILE_SHUTDOWN() (void(0))
# define CARB_PROFILE_REGISTER_STRING(str) (CARB_UNUSED(str), ::carb::profiler::kInvalidStaticString)
# define CARB_PROFILE_SET_CAPTURE_MASK(mask) CARB_UNUSED(mask)
# define CARB_PROFILE_BEGIN(maskOrChannel, eventName, ...) \
(CARB_UNUSED((maskOrChannel), (eventName), ##__VA_ARGS__), ::carb::profiler::kNoZoneId)
# define CARB_PROFILE_END(maskOrChannel, ...) CARB_UNUSED((maskOrChannel), ##__VA_ARGS__)
# define CARB_PROFILE_FRAME(mask, frameName, ...) CARB_UNUSED((mask), (frameName), ##__VA_ARGS__)
# define CARB_PROFILE_ZONE(maskOrChannel, zoneName, ...) CARB_UNUSED((maskOrChannel), (zoneName), ##__VA_ARGS__)
# define CARB_PROFILE_FUNCTION(maskOrChannel) CARB_UNUSED(maskOrChannel)
# define CARB_PROFILE_VALUE(value, maskOrChannel, valueName, ...) \
CARB_UNUSED((value), (maskOrChannel), (valueName), ##__VA_ARGS__)
# define CARB_PROFILE_ALLOC_NAMED(maskOrChannel, ptr, size, poolName, ...) \
CARB_UNUSED((maskOrChannel), (ptr), (size), (poolName), ##__VA_ARGS__)
# define CARB_PROFILE_FREE_NAMED(maskOrChannel, ptr, poolName, ...) \
CARB_UNUSED((maskOrChannel), (ptr), (poolName), ##__VA_ARGS__)
# define CARB_PROFILE_ALLOC(maskOrChannel, ptr, size) CARB_UNUSED((maskOrChannel), (ptr), (size))
# define CARB_PROFILE_FREE(maskOrChannel, ptr) CARB_UNUSED((maskOrChannel), (ptr))
# define CARB_NAME_THREAD(tidOrZero, threadName, ...) CARB_UNUSED((tidOrZero), (threadName), ##__VA_ARGS__)
# define CARB_PROFILE_EVENT(maskOrChannel, type, name, ...) \
CARB_UNUSED((maskOrChannel), (type), (name), ##__VA_ARGS__)
# define CARB_PROFILE_FLOW_BEGIN(maskOrChannel, id, name, ...) \
CARB_UNUSED((maskOrChannel), (id), (name), ##__VA_ARGS__)
# define CARB_PROFILE_FLOW_END(maskOrChannel, id) CARB_UNUSED((maskOrChannel), (id))
# define CARB_PROFILE_CREATE_GPU_CONTEXT( \
name, correlatedCpuTimestampNs, correlatedGpuTimestamp, gpuTimestampPeriodNs, graphicApi) \
(CARB_UNUSED( \
(name), (correlatedCpuTimestampNs), (correlatedGpuTimestamp), (gpuTimestampPeriodNs), (graphicsApi)), \
carb::profiler::kInvalidGpuContextId)
# define CARB_PROFILE_DESTROY_GPU_CONTEXT(contextId) CARB_UNUSED(contextId)
# define CARB_PROFILE_CALIBRATE_GPU_CONTEXT( \
contextId, correlatedCpuTimestampNs, previousCorrelatedCpuTimestampNs, correlatedGpuTimestamp) \
CARB_UNUSED( \
(contextId), (correlatedCpuTimestampNs), (previousCorrelatedCpuTimestampNs), (correlatedGpuTimestamp))
# define CARB_PROFILE_GPU_QUERY_BEGIN(maskOrChannel, contextId, queryId, eventName, ...) \
CARB_UNUSED((maskOrChannel), (contextId), (queryId), (eventName), ##__VA_ARGS__)
# define CARB_PROFILE_GPU_QUERY_END(maskOrChannel, contextId, queryId) \
(CARB_UNUSED((maskOrChannel), (contextId), (queryId)))
# define CARB_PROFILE_GPU_SET_QUERY_VALUE(maskOrChannel, contextId, queryId, gpuTimestamp) \
CARB_UNUSED((maskOrChannel), (contextId), (queryId), (gpuTimestamp))
# define CARB_PROFILE_LOCKABLE_CREATE(maskOrChannel, isSharedLock, name) \
(CARB_UNUSED((maskOrChannel), (isSharedLock), (name)), ::carb::profiler::kInvalidLockableId)
# define CARB_PROFILE_LOCKABLE_DESTROY(lockableId) CARB_UNUSED(lockableId)
# define CARB_PROFILE_LOCKABLE_OPERATION(lockableId, operation) CARB_UNUSED((lockableId), (operation))
#endif
/**
* Placeholder macro for any work that needs to be done at the global scope for the profiler.
* @note This is typically not used as it is included in the @ref CARB_GLOBALS_EX macro.
*/
#define CARB_PROFILER_GLOBALS()
namespace carb
{
namespace profiler
{
/**
* Wrapper to add automatic profiling to a mutex
*/
template <class Mutex>
class ProfiledMutex
{
public:
/**
* Constructor.
* @param profileMask The mask used to determine if events from this mutex are captured.
* @param name The name of the mutex
*/
ProfiledMutex(const uint64_t profileMask, const char* name) : ProfiledMutex(profileMask, false, name)
{
}
/**
* Constructor.
* @param channel The profiling channel used to determine if events from this mutex are captured.
* @param name The name of the mutex
*/
ProfiledMutex(const carb::profiler::Channel& channel, const char* name) : ProfiledMutex(channel, false, name)
{
}
/**
* Destructor.
*/
~ProfiledMutex()
{
CARB_PROFILE_LOCKABLE_DESTROY(m_lockableId);
}
/**
* Locks the underlying mutex and reports the event to the profiler.
*/
void lock()
{
CARB_PROFILE_LOCKABLE_OPERATION(m_lockableId, LockableOperationType::BeforeLock);
m_mutex.lock();
CARB_PROFILE_LOCKABLE_OPERATION(m_lockableId, LockableOperationType::AfterLock);
}
/**
* Attempts a lock on the underlying mutex and reports the event to the profiler if successful.
* @returns \c true if successfully locked; \c false otherwise.
*/
bool try_lock()
{
bool acquired = m_mutex.try_lock();
if (acquired)
{
CARB_PROFILE_LOCKABLE_OPERATION(m_lockableId, LockableOperationType::AfterSuccessfulTryLock);
}
return acquired;
}
/**
* Unlocks the underlying mutex and reports the event to the profiler.
*/
void unlock()
{
m_mutex.unlock();
CARB_PROFILE_LOCKABLE_OPERATION(m_lockableId, LockableOperationType::AfterUnlock);
}
/**
* Returns a reference to the underlying mutex.
* @returns a reference to the underlying mutex.
*/
Mutex& getMutex()
{
return m_mutex;
}
/**
* Returns a reference to the underlying mutex.
* @returns a reference to the underlying mutex.
*/
const Mutex& getMutex() const
{
return m_mutex;
}
protected:
/**
* Protected Constructor.
* @param profileMask The mask used to determine if events from this mutex are captured.
* @param isSharedMutex A boolean representing whether `*this` represents a shared mutex.
* @param name The name of the mutex
*/
ProfiledMutex(const uint64_t profileMask, bool isSharedMutex, const char* name)
{
m_lockableId = CARB_PROFILE_LOCKABLE_CREATE(profileMask, isSharedMutex, name);
}
/**
* Protected Constructor.
* @param channel The channel used to determine if events from this mutex are captured.
* @param isSharedMutex A boolean representing whether `*this` represents a shared mutex.
* @param name The name of the mutex
*/
ProfiledMutex(const carb::profiler::Channel& channel, bool isSharedMutex, const char* name)
{
m_lockableId = CARB_PROFILE_LOCKABLE_CREATE(channel, isSharedMutex, name);
}
//! The underlying mutex instance
Mutex m_mutex;
//! The lockable ID as returned by \ref carb::profiler::IProfiler::createLockable()
LockableId m_lockableId;
};
/**
* Wrapper to add automatic profiling to a shared mutex
*/
template <class Mutex>
class ProfiledSharedMutex : public ProfiledMutex<Mutex>
{
using Base = ProfiledMutex<Mutex>;
public:
/**
* Constructor.
* @param profileMask The mask used to determine if events from this mutex are captured.
* @param name The name of the mutex
*/
ProfiledSharedMutex(const uint64_t profileMask, const char* name) : Base(profileMask, true, name)
{
}
/**
* Constructor.
* @param channel The profiling channel used to determine if events from this mutex are captured.
* @param name The name of the mutex
*/
ProfiledSharedMutex(const carb::profiler::Channel& channel, const char* name) : Base(channel, true, name)
{
}
/**
* Destructor.
*/
~ProfiledSharedMutex()
{
}
/**
* Locks the underlying mutex (shared) and reports the event to the profiler.
*/
void lock_shared()
{
CARB_PROFILE_LOCKABLE_OPERATION(this->m_lockableId, LockableOperationType::BeforeLockShared);
this->m_mutex.lock_shared();
CARB_PROFILE_LOCKABLE_OPERATION(this->m_lockableId, LockableOperationType::AfterLockShared);
}
/**
* Attempts a shared lock on the underlying mutex and reports the event to the profiler if successful.
* @returns \c true if successfully locked; \c false otherwise.
*/
bool try_lock_shared()
{
bool acquired = this->m_mutex.try_lock_shared();
if (acquired)
{
CARB_PROFILE_LOCKABLE_OPERATION(this->m_lockableId, LockableOperationType::AfterSuccessfulTryLockShared);
}
return acquired;
}
/**
* Unlocks (shared) the underlying mutex and reports the event to the profiler.
*/
void unlock_shared()
{
this->m_mutex.unlock_shared();
CARB_PROFILE_LOCKABLE_OPERATION(this->m_lockableId, LockableOperationType::AfterUnlockShared);
}
};
void deregisterProfilerForClient() noexcept;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
inline void updateMask(uint64_t mask)
{
g_carbProfilerMask.store(mask, std::memory_order_release);
}
inline void releaseHook(void* iface, void*)
{
cpp::atomic_ref<IProfiler*>(g_carbProfiler).store(nullptr); // sequentially consistent
getFramework()->removeReleaseHook(iface, &releaseHook, nullptr);
}
inline void frameworkReleaseHook(void*, void*)
{
// Framework is going away, so make sure we get fully deregistered.
deregisterProfilerForClient();
}
inline void loadHook(const PluginDesc&, void*)
{
if (!g_carbProfiler)
{
IProfiler* profiler = getFramework()->tryAcquireInterface<IProfiler>();
if (profiler)
{
if (profiler->setMaskCallback)
{
// Relaxed semantics since we will shortly be synchronizing on g_carbProfiler.
g_carbProfilerMask.store(profiler->setMaskCallback(updateMask, true), std::memory_order_relaxed);
}
else
{
g_carbProfilerMask.store(uint64_t(-1), std::memory_order_relaxed); // not supported; let everything
// through
}
getFramework()->addReleaseHook(profiler, &detail::releaseHook, nullptr);
cpp::atomic_ref<IProfiler*>(g_carbProfiler).store(profiler, std::memory_order_seq_cst); // sequentially
// consistent
}
}
}
inline bool& registered()
{
static bool r{ false };
return r;
}
inline LoadHookHandle& loadHookHandle()
{
static carb::LoadHookHandle handle{};
return handle;
}
} // namespace detail
#endif
/**
* Allows access to the @ref g_carbProfiler global variable previously registered with @ref registerProfilerForClient().
* @returns The value of @ref g_carbProfiler.
*/
inline IProfiler* getProfiler()
{
return g_carbProfiler;
}
/**
* Clears the @ref g_carbProfiler global variable and unregisters load and release hooks with the \ref Framework.
*/
inline void deregisterProfilerForClient() noexcept
{
if (std::exchange(detail::registered(), false))
{
auto fw = getFramework();
auto handle = std::exchange(detail::loadHookHandle(), kInvalidLoadHook);
IProfiler* profiler = cpp::atomic_ref<IProfiler*>(g_carbProfiler).exchange(nullptr, std::memory_order_seq_cst);
if (fw)
{
if (profiler && fw->verifyInterface(profiler) && profiler->setMaskCallback)
{
profiler->setMaskCallback(detail::updateMask, false);
}
if (handle)
{
fw->removeLoadHook(handle);
}
fw->removeReleaseHook(nullptr, &detail::frameworkReleaseHook, nullptr);
if (profiler)
{
fw->removeReleaseHook(profiler, &detail::releaseHook, nullptr);
}
// Unregister channels
Channel::onProfilerUnregistered();
}
}
}
/**
* Acquires the default IProfiler interface and assigns it to the @ref g_carbProfiler global variable.
*
* If a profiler is not yet loaded, a load hook is registered with the \ref Framework and when the profiler is loaded,
* \ref g_carbProfiler will be automatically set for this module. If the profiler is unloaded, \ref g_carbProfiler will
* be automatically set to `nullptr`.
*/
inline void registerProfilerForClient() noexcept
{
if (!std::exchange(detail::registered(), true))
{
auto fw = getFramework();
fw->addReleaseHook(nullptr, &detail::frameworkReleaseHook, nullptr);
IProfiler* profiler = fw->tryAcquireInterface<IProfiler>();
if (profiler)
{
if (profiler->setMaskCallback)
{
// Relaxed semantics since we will shortly be synchronizing on g_carbProfiler.
g_carbProfilerMask.store(profiler->setMaskCallback(detail::updateMask, true), std::memory_order_relaxed);
}
else
{
g_carbProfilerMask.store(uint64_t(-1), std::memory_order_relaxed); // let everything through
}
bool b = fw->addReleaseHook(profiler, &detail::releaseHook, nullptr);
CARB_ASSERT(b);
CARB_UNUSED(b);
}
cpp::atomic_ref<IProfiler*>(g_carbProfiler).store(profiler, std::memory_order_seq_cst); // sequentially
// consistent
detail::loadHookHandle() = fw->addLoadHook<IProfiler>(nullptr, &detail::loadHook, nullptr);
// Register channels
Channel::onProfilerRegistered();
// Make sure this only happens once even if re-registered.
static bool ensureDeregister = (atexit(&deregisterProfilerForClient), true);
CARB_UNUSED(ensureDeregister);
}
}
} // namespace profiler
} // namespace carb
| 77,631 | C | 62.528642 | 124 | 0.427239 |
omniverse-code/kit/include/carb/cpp/Tuple.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<tuple>` library.
#pragma once
#include <tuple>
#include "Functional.h"
namespace carb
{
namespace cpp
{
namespace detail
{
template <class F, class Tuple, size_t... I>
constexpr decltype(auto) applyImpl(F&& f, Tuple&& t, std::index_sequence<I...>)
{
return carb::cpp::invoke(std::forward<F>(f), std::get<I>(std::forward<Tuple>(t))...);
}
} // namespace detail
template <class F, class Tuple>
constexpr decltype(auto) apply(F&& f, Tuple&& t)
{
return detail::applyImpl(std::forward<F>(f), std::forward<Tuple>(t),
std::make_index_sequence<std::tuple_size<std::remove_reference_t<Tuple>>::value>{});
}
} // namespace cpp
} // namespace carb
| 1,210 | C | 27.833333 | 113 | 0.703306 |
omniverse-code/kit/include/carb/cpp/Semaphore.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<semaphore>` library.
#pragma once
#include "Atomic.h"
#include "../thread/Futex.h"
#include <algorithm>
#include <thread>
namespace carb
{
namespace cpp
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace detail
{
# if CARB_PLATFORM_WINDOWS
constexpr ptrdiff_t kSemaphoreValueMax = LONG_MAX;
# else
constexpr ptrdiff_t kSemaphoreValueMax = INT_MAX;
# endif
} // namespace detail
#endif
// Handle case where Windows.h may have defined 'max'
#pragma push_macro("max")
#undef max
/**
* C++20-compatible counting semaphore class.
*
* A counting_semaphore is a lightweight synchronization primitive that can control access to a shared resource. Unlike
* a mutex, a counting_semaphore allows more than one concurrent access to the same resource, for at least
* `least_max_value` concurrent accessors. The program is ill-formed if `least_max_value` is negative.
*
* This is a C++14-compatible implementation of std::counting_semaphore from C++20 draft spec dated 11/13/2019.
*
* @note `sizeof(counting_semaphore)` is 8 bytes for `least_max_value > 1`. A specialization exists for
* `least_max_value == 1` where the size is only 1 byte, also known as @ref binary_semaphore.
*
* @tparam least_max_value The maximum count value that this semaphore can reach. This
* indicates the number of threads or callers that can simultaneously
* successfully acquire this semaphore. May not be less than or equal to zero.
*
* @thread_safety This class is thread-safe. However, attempting to destruct before all threads have returned from any
* function (especially the wait functions) is malformed and will lead to undefined behavior.
*/
template <ptrdiff_t least_max_value = detail::kSemaphoreValueMax>
class CARB_VIZ counting_semaphore
{
CARB_PREVENT_COPY_AND_MOVE(counting_semaphore);
public:
/** Constructor: initializes a new semaphore object with a given count.
*
* @param[in] desired The initial count value for the semaphore. This must be a positive
* value or zero. If set to zero, the semaphore will be 'unowned' on
* creation. If set to any other value, the semaphore will only be able
* to be acquired by at most @a least_max_value minus @p desired other
* threads or callers until it is released @p desired times.
*/
constexpr explicit counting_semaphore(ptrdiff_t desired) noexcept
: m_data(::carb_min(::carb_max(ptrdiff_t(0), desired), least_max_value))
{
static_assert(least_max_value >= 1, "semaphore needs a count of at least 1");
static_assert(least_max_value <= detail::kSemaphoreValueMax, "semaphore count too high");
}
/**
* Destructor
*
* On Linux, performs a `CARB_CHECK` to verify that no waiters are present when `*this` is destroyed.
*
* @note On Windows, `ExitProcess()` (or returning from `main()`) causes all threads to be terminated before
* `atexit()` registered functions are called (and static objects are cleaned up). This has the unpleasant side
* effect of potentially terminating threads that are waiting on a semaphore and will never get the chance to clean
* up their waiting count. Therefore, this check is linux only.
*/
~counting_semaphore() noexcept
{
#if CARB_PLATFORM_LINUX
// Make sure we don't have any waiters when we are destroyed
CARB_CHECK((m_data.load(std::memory_order_acquire) >> kWaitersShift) == 0, "Semaphore destroyed with waiters");
#endif
}
/** Retrieves the maximum count value this semaphore can reach.
*
* @returns The maximum count value for this semaphore. This will never be zero.
*
* @thread_safety This call is thread safe.
*/
static constexpr ptrdiff_t max() noexcept
{
return least_max_value;
}
/** Releases references on this semaphore and potentially wakes another waiting thread.
*
* @param[in] update The number of references to atomically increment this semaphore's
* counter by. This number of waiting threads will be woken as a
* result.
* @return No return value.
*
* @remarks This releases zero or more references on this semaphore. If a reference is
* released, another waiting thread could potentially be woken and acquire this
* semaphore again.
*
* @thread_safety This call is thread safe.
*/
void release(ptrdiff_t update = 1) noexcept
{
CARB_ASSERT(update >= 0);
uint64_t d = m_data.load(std::memory_order_relaxed), u;
for (;;)
{
// The standard is somewhat unclear here. Preconditions are that update >= 0 is true and update <= max() -
// counter is true. And it throws system_error when an exception is required. So I supposed that it's likely
// that violating the precondition would cause a system_error exception which doesn't completely make sense
// (I would think runtime_error would make more sense). However, throwing at all is inconvenient, as is
// asserting/crashing/etc. Therefore, we clamp the update value here.
u = ::carb_min(update, max() - ptrdiff_t(d & kValueMask));
if (CARB_LIKELY(m_data.compare_exchange_weak(d, d + u, std::memory_order_release, std::memory_order_relaxed)))
break;
}
// At this point, the Semaphore could be destroyed by another thread. Therefore, we shouldn't access any other
// members (taking the address of m_data below is okay because that would not actually read any memory that
// may be destroyed)
// waiters with a value have been notified already by whatever thread added the value. Only wake threads that
// haven't been woken yet.
ptrdiff_t waiters = ptrdiff_t(d >> kWaitersShift);
ptrdiff_t value = ptrdiff_t(d & kValueMask);
ptrdiff_t wake = ::carb_min(ptrdiff_t(u), waiters - value);
if (wake > 0)
{
// cpp::atomic only has notify_one() and notify_all(). Call the futex system directly to wake N.
thread::futex::notify(m_data, unsigned(size_t(wake)), unsigned(size_t(waiters)));
}
}
/** Acquires a reference to this semaphore.
*
* @returns No return value.
*
* @remarks This blocks until a reference to this semaphore can be successfully acquired.
* This is done by atomically decrementing the semaphore's counter if it is greater
* than zero. If the counter is zero, this will block until the counter is greater
* than zero. The counter is incremented by calling release().
*
* @thread_safety This call is thread safe.
*/
void acquire() noexcept
{
if (CARB_LIKELY(fast_acquire(false)))
return;
// Register as a waiter
uint64_t d =
m_data.fetch_add(uint64_t(1) << kWaitersShift, std::memory_order_relaxed) + (uint64_t(1) << kWaitersShift);
for (;;)
{
if ((d & kValueMask) == 0)
{
// Need to wait
m_data.wait(d, std::memory_order_relaxed);
// Reload
d = m_data.load(std::memory_order_relaxed);
}
else
{
// Try to unregister as a waiter and grab a token at the same time
if (CARB_LIKELY(m_data.compare_exchange_weak(d, d - 1 - (uint64_t(1) << kWaitersShift),
std::memory_order_acquire, std::memory_order_relaxed)))
return;
}
}
}
/** Attempts to acquire a reference to this semaphore.
*
* @returns `true` if the semaphore's counter was greater than zero and it was successfully
* atomically decremented. Returns `false` if the counter was zero and the
* semaphore could not be acquired. This will never block even if the semaphore
* could not be acquired.
*
* @thread_safety This call is thread safe.
*/
bool try_acquire() noexcept
{
return fast_acquire(true);
}
/** Attempts to acquire a reference to this semaphore for a specified relative time.
*
* @tparam Rep The representation primitive type for the duration value.
* @tparam Period The duration's time scale value (ie: milliseconds, seconds, etc).
* @param[in] duration The amount of time to try to acquire this semaphore for. This is
* specified as a duration relative to the call time.
* @returns `true` if the semaphore's counter was greater than zero and it was successfully
* atomically decremented within the specified time limit. Returns `false` if the
* counter was zero and the semaphore could not be acquired within the time limit.
* This will only block for up to approximately the specified time limit.
*
* @thread_safety This call is thread safe.
*/
template <class Rep, class Period>
bool try_acquire_for(const std::chrono::duration<Rep, Period>& duration) noexcept
{
if (CARB_LIKELY(fast_acquire(false)))
return true;
if (duration.count() <= 0)
return false;
// Register as a waiter
uint64_t d =
m_data.fetch_add(uint64_t(1) << kWaitersShift, std::memory_order_relaxed) + (uint64_t(1) << kWaitersShift);
while ((d & kValueMask) != 0)
{
// Try to unregister as a waiter and grab a token at the same time
if (CARB_LIKELY(m_data.compare_exchange_weak(
d, d - 1 - (uint64_t(1) << kWaitersShift), std::memory_order_acquire, std::memory_order_relaxed)))
return true;
}
// Now we need to wait, but do it with absolute time so that we properly handle spurious futex wakeups
auto time_point = std::chrono::steady_clock::now() + thread::detail::clampDuration(duration);
for (;;)
{
if (!m_data.wait_until(d, time_point, std::memory_order_relaxed))
{
// Timed out. Unregister as a waiter
m_data.fetch_sub(uint64_t(1) << kWaitersShift, std::memory_order_relaxed);
return false;
}
// Reload after wait
d = m_data.load(std::memory_order_relaxed);
if ((d & kValueMask) != 0)
{
// Try to unreference as a waiter and grab a token at the same time
if (CARB_LIKELY(m_data.compare_exchange_weak(d, d - 1 - (uint64_t(1) << kWaitersShift),
std::memory_order_acquire, std::memory_order_relaxed)))
return true;
}
}
}
/** Attempts to acquire a reference to this semaphore until a specified absolute time.
*
* @tparam Clock The clock to use as a time source to compare the time limit to.
* @tparam Duration The duration type associated with the specified clock.
* @param[in] time_point The absolute time to try to acquire this semaphore for. This is
* specified as a time point from the given clock @a Clock.
* @returns `true` if the semaphore's counter was greater than zero and it was successfully
* atomically decremented before the specified time limit. Returns `false` if the
* counter was zero and the semaphore could not be acquired before the time limit.
* This will only block up until approximately the specified time limit.
*
* @thread_safety This call is thread safe.
*/
template <class Clock, class Duration>
bool try_acquire_until(const std::chrono::time_point<Clock, Duration>& time_point) noexcept
{
if (CARB_LIKELY(fast_acquire(false)))
return true;
// Register as a waiter
uint64_t d =
m_data.fetch_add(uint64_t(1) << kWaitersShift, std::memory_order_relaxed) + (uint64_t(1) << kWaitersShift);
for (;;)
{
if ((d & kValueMask) == 0)
{
// Need to wait
if (!m_data.wait_until(d, time_point, std::memory_order_relaxed))
{
// Timed out. Unregister as a waiter
m_data.fetch_sub(uint64_t(1) << kWaitersShift, std::memory_order_relaxed);
return false;
}
// Reload after wait
d = m_data.load(std::memory_order_relaxed);
}
else
{
// Try to unregister as a waiter and grab a token at the same time
if (CARB_LIKELY(m_data.compare_exchange_weak(d, d - 1 - (uint64_t(1) << kWaitersShift),
std::memory_order_acquire, std::memory_order_relaxed)))
return true;
}
}
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
// The 32 most significant bits are the waiters; the lower 32 bits is the value of the semaphore
CARB_VIZ cpp::atomic_uint64_t m_data;
constexpr static int kWaitersShift = 32;
constexpr static unsigned kValueMask = 0xffffffff;
CARB_ALWAYS_INLINE bool fast_acquire(bool needResolution) noexcept
{
uint64_t d = m_data.load(needResolution ? std::memory_order_acquire : std::memory_order_relaxed);
for (;;)
{
if (uint32_t(d & kValueMask) == 0)
return false;
if (CARB_LIKELY(m_data.compare_exchange_weak(d, d - 1, std::memory_order_acquire, std::memory_order_relaxed)))
return true;
if (!needResolution)
return false;
}
}
#endif
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Specialization for the case of a semaphore with a maximum count of 1. This is treated as
* a binary semaphore - it can only be acquired by one caller at a time.
*/
template <>
class CARB_VIZ counting_semaphore<1>
{
CARB_PREVENT_COPY_AND_MOVE(counting_semaphore);
public:
static constexpr ptrdiff_t max() noexcept
{
return 1;
}
constexpr explicit counting_semaphore(ptrdiff_t desired) noexcept
: m_val(uint8_t(size_t(::carb_min(::carb_max(ptrdiff_t(0), desired), max()))))
{
}
void release(ptrdiff_t update = 1) noexcept
{
if (CARB_UNLIKELY(update <= 0))
return;
CARB_ASSERT(update == 1); // precondition failure
if (!m_val.exchange(1, std::memory_order_release))
m_val.notify_one();
}
void acquire() noexcept
{
for (;;)
{
uint8_t old = m_val.exchange(0, std::memory_order_acquire);
if (CARB_LIKELY(old == 1))
break;
CARB_ASSERT(old == 0); // m_val can only be 0 or 1
m_val.wait(0, std::memory_order_relaxed);
}
}
bool try_acquire() noexcept
{
uint8_t old = m_val.exchange(0, std::memory_order_acquire);
CARB_ASSERT(old <= 1); // m_val can only be 0 or 1
return old == 1;
}
template <class Rep, class Period>
bool try_acquire_for(const std::chrono::duration<Rep, Period>& duration) noexcept
{
return try_acquire_until(std::chrono::steady_clock::now() + thread::detail::clampDuration(duration));
}
template <class Clock, class Duration>
bool try_acquire_until(const std::chrono::time_point<Clock, Duration>& time_point) noexcept
{
for (;;)
{
uint8_t old = m_val.exchange(0, std::memory_order_acquire);
if (CARB_LIKELY(old == 1))
return true;
CARB_ASSERT(old == 0); // m_val can only be 0 or 1
if (!m_val.wait_until(0, time_point, std::memory_order_relaxed))
return false;
}
}
protected:
CARB_VIZ cpp::atomic_uint8_t m_val;
};
#endif
/** Alias for a counting semaphore that can only be acquired by one caller at a time. */
using binary_semaphore = counting_semaphore<1>;
#pragma pop_macro("max")
} // namespace cpp
} // namespace carb
| 17,044 | C | 39.680191 | 122 | 0.606724 |
omniverse-code/kit/include/carb/cpp/Functional.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<functional>` library.
#pragma once
#include "TypeTraits.h"
#include "detail/ImplInvoke.h"
#include "../detail/NoexceptType.h"
namespace carb
{
namespace cpp
{
CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE()
//! Invoke the function \a f with the given \a args pack.
//!
//! This is equivalent to the C++20 \c std::invoke function. It was originally added in C++17, but is marked as
//! \c constexpr per the C++20 Standard.
template <typename Func, typename... TArgs>
constexpr invoke_result_t<Func, TArgs...> invoke(Func&& f,
TArgs&&... args) noexcept(is_nothrow_invocable<Func, TArgs...>::value)
{
return detail::invoke_impl<std::decay_t<Func>>::eval(std::forward<Func>(f), std::forward<TArgs>(args)...);
}
//! \cond DEV
namespace detail
{
// This is needed to handle calling a function which returns a non-void when `R` is void. The only difference is the
// lack of a return statement.
template <typename R, typename Func, typename... TArgs>
constexpr std::enable_if_t<is_void<R>::value> invoke_r_impl(Func&& f, TArgs&&... args) noexcept(
is_nothrow_invocable_r<R, Func, TArgs...>::value)
{
detail::invoke_impl<std::decay_t<Func>>::eval(std::forward<Func>(f), std::forward<TArgs>(args)...);
}
template <typename R, typename Func, typename... TArgs>
constexpr std::enable_if_t<!is_void<R>::value, R> invoke_r_impl(Func&& f, TArgs&&... args) noexcept(
is_nothrow_invocable_r<R, Func, TArgs...>::value)
{
return detail::invoke_impl<std::decay_t<Func>>::eval(std::forward<Func>(f), std::forward<TArgs>(args)...);
}
} // namespace detail
//! \endcond
//! Invoke the function with the given arguments with the explicit return type \c R. This follows the same rules as
//! \ref carb::cpp::invoke().
//!
//! This is equivalent to the C++23 \c std::invoke_r function. It lives here because people would expect an \c invoke_r
//! function to live next to an \c invoke function.
template <typename R, typename Func, typename... TArgs>
constexpr R invoke_r(Func&& f, TArgs&&... args) noexcept(is_nothrow_invocable_r<R, Func, TArgs...>::value)
{
return detail::invoke_r_impl<R>(std::forward<Func>(f), std::forward<TArgs>(args)...);
}
CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE()
} // namespace cpp
} // namespace carb
| 2,806 | C | 36.426666 | 119 | 0.694227 |
omniverse-code/kit/include/carb/cpp/Utility.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<utility>` library.
#pragma once
#include "../Defines.h"
#include <utility>
namespace carb
{
namespace cpp
{
#if !CARB_HAS_CPP17
struct in_place_t
{
explicit in_place_t() = default;
};
static constexpr in_place_t in_place{};
template <class>
struct in_place_type_t
{
explicit in_place_type_t() = default;
};
template <class T>
static constexpr in_place_type_t<T> in_place_type{};
template <std::size_t I>
struct in_place_index_t
{
explicit in_place_index_t() = default;
};
template <std::size_t I>
static constexpr in_place_index_t<I> in_place_index{};
#else
using std::in_place;
using std::in_place_index;
using std::in_place_index_t;
using std::in_place_t;
using std::in_place_type;
using std::in_place_type_t;
#endif
} // namespace cpp
} // namespace carb
| 1,312 | C | 19.84127 | 96 | 0.723323 |
omniverse-code/kit/include/carb/cpp/StringView.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<string_view>` library.
#pragma once
#include "../Defines.h"
#include "../../omni/detail/PointerIterator.h"
#include "TypeTraits.h"
#include <algorithm>
#include <string>
#include <typeindex> // for std::hash
#include <utility>
namespace carb
{
namespace cpp
{
template <class CharT, class Traits>
class basic_string_view;
//! \cond DEV
namespace detail
{
template <class T>
struct IsBasicStringView : public std::false_type
{
};
template <class T, class Traits>
struct IsBasicStringView<basic_string_view<T, Traits>> : public std::true_type
{
};
template <class T, class OpType, class = void>
struct HasOperator : public std::false_type
{
};
template <class T, class OpType>
struct HasOperator<T, OpType, void_t<decltype(std::declval<T>().operator OpType())>> : public std::true_type
{
};
template <class CharT, class T>
struct IsCharArrayLiteral : public std::false_type
{
};
template <class CharT, size_t N>
struct IsCharArrayLiteral<CharT, const CharT (&)[N]> : public std::true_type
{
};
// GCC instantiates some functions always so they cannot use static_assert, but throwing an exception is allowed from a
// constexpr function (which will act as a compile failure if constexpr) so fall back to that.
#if CARB_EXCEPTIONS_ENABLED
# define CARB_ALWAYS_FAIL(msg) throw std::out_of_range(msg)
# define CARB_THROW_OR_CHECK(check, msg) \
if (!CARB_LIKELY(check)) \
throw std::out_of_range(msg)
#else
# define CARB_THROW_OR_CHECK(check, msg) CARB_CHECK((check), msg)
# if CARB_COMPILER_MSC
# define CARB_ALWAYS_FAIL(msg) static_assert(false, msg)
# else
# define CARB_ALWAYS_FAIL(msg) CARB_FATAL_UNLESS(false, msg)
# endif
#endif
} // namespace detail
//! \endcond DEV
/**
* The class template basic_string_view describes an object that can refer to a constant contiguous sequence of elements
* with the first element of the sequence at position zero.
*
* This implementation of \c string_view is a guaranteed @rstref{ABI- and interop-safe <abi-compatibility>} type.
*
* @see https://en.cppreference.com/w/cpp/string/basic_string_view
* @tparam CharT character type
* @tparam Traits A traits class specifying the operations on the character type. Like for `std::basic_string`,
* `Traits::char_type` must name the same type as `CharT` or the program is ill-formed.
*/
template <class CharT, class Traits = std::char_traits<CharT>>
class CARB_VIZ basic_string_view
{
public:
//! `Traits`
using traits_type = Traits;
//! `CharT`
using value_type = CharT;
//! `CharT*`
using pointer = CharT*;
//! `const CharT*`
using const_pointer = const CharT*;
//! `CharT&`
using reference = CharT&;
//! `const CharT&`
using const_reference = const CharT&;
//! implementation defined constant LegacyRandomAccessIterator and LegacyContiguousIterator whose value_type
//! is CharT.
using const_iterator = omni::detail::PointerIterator<const_pointer, basic_string_view>;
//! `const_iterator`
//! \note `iterator` and `const_iterator` are the same type because string views are views into constant character
//! sequences.
using iterator = const_iterator;
//! `std::reverse_iterator<const_iterator>`
using const_reverse_iterator = std::reverse_iterator<const_iterator>;
//! `const_reverse_iterator`
using reverse_iterator = const_reverse_iterator;
//! `std::size_t`
using size_type = std::size_t;
//! `std::ptrdiff_t`
using difference_type = std::ptrdiff_t;
//! Special value. The exact meaning depends on the context.
static constexpr size_type npos = size_type(-1);
//! Constructs a basic_string_view.
//! \details Constructs an empty basic_string_view. After construction, \ref data() is equal to `nullptr` and
//! \ref size() is equal to `0`.
constexpr basic_string_view() noexcept = default;
//! Constructs a basic_string_view.
//! \details Constructs a view of the same content as \p other. After construction, \ref data() is equal to
//! `other.data()` and \ref size() is equal to `other.size()`.
//! @param other The string view to copy.
constexpr basic_string_view(const basic_string_view& other) noexcept = default;
//! Constructs a basic_string_view.
//! \details Constructs a view of the first count characters of the character array starting with the element
//! pointed by \p s. \p s can contain null characters. The behavior is undefined if `[s, s + count)` is not a valid
//! range (even though the constructor may not access any of the elements of this range). After construction,
//! \ref data() is equal to \p s, and \ref size() is equal to \p count.
//! @param s The character array to view.
//! @param count The number of characters in \p s to view.
constexpr basic_string_view(const CharT* s, size_type count) : m_data(s), m_count(count)
{
}
//! Constructs a basic_string_view.
//! \details Constructs a view of the null-terminated character string pointed to by \p s, not including the
//! terminating null character. The length of the view is determined as if by `Traits::length(s)`. The behavior is
//! undefined if `[s, s + Traits::length(s))` is not a valid range. After construction, \ref data() is equal to
//! \p s, and \ref size() is equal to `Traits::length(s)`.
//! \note As a Carbonite extension, this constructor will not participate in overload resolution if \p s is a
//! literal `CharT` array. Instead, see \ref basic_string_view(const CharT(&literal)[N]).
//! @param s The null-terminated character string to view.
#ifdef DOXYGEN_BUILD
constexpr basic_string_view(const CharT* s) : m_data(s), m_count(traits_type::length(s))
#else
template <class T,
std::enable_if_t<!detail::IsCharArrayLiteral<CharT, T>::value && std::is_convertible<T, const_pointer>::value,
bool> = false>
constexpr basic_string_view(T&& s) : m_data(s), m_count(traits_type::length(s))
#endif
{
}
//! Constructs a basic_string_view.
//! \details Constructs a view of the literal string \p literal, not including the terminating null character. The
//! length of the view is determined by `N - 1` as literal strings will have a terminating null character. After
//! construction, \ref data() is equal to \p literal, and \ref size() is equal to `N - 1`.
//! \note This constructor is a Carbonite extension and provided as an optimization. For `std::basic_string_view`,
//! the \ref basic_string_view(const CharT*) constructor would be invoked instead. This allows string views to be
//! constructed as a constant expression from string literals without using the `_sv` literal extension.
//! @param literal A string literal to view.
template <size_t N>
constexpr basic_string_view(const CharT (&literal)[N]) noexcept : m_data(literal), m_count(N - 1)
{
}
//! Constructs a basic_string_view.
//! \details Constructs a basic_string_view over the range `[first, last)`. The behavior is undefined if
//! `[first, last)` is not a valid range or if `It` is not a random-access iterator. This function differs
//! significantly from the C++20 definition since the concepts of `contiguous_iterator` and `sized_sentinel_for` are
//! not available. Since these concepts are not available until C++20, instead this function does not participate in
//! overload resolution unless
//! `std::iterator_traits<It>::iterator_category == std::random_access_iterator_tag`. Also \p first and \p last must
//! be a matching iterator type. After construction, \ref data() is equal to `std::to_address(first)`, and
//! \ref size() is equal to `last - first`.
//! @param first Iterator to the beginning of the view.
//! @param last Iterator to the end of the view (non-inclusive).
template <class It CARB_NO_DOC(
,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false)>
constexpr basic_string_view(It first, It last) : m_data(std::addressof(*first)), m_count(std::distance(first, last))
{
}
//! Constructs a basic_string_view.
//! \details Constructs a basic_string_view over the "range" \p r. After construction \ref data() is equal to
//! `r.data()` and \ref size() is equal to `r.size()`.
//! @tparam R A range type. Since this implementation is for pre-C++20 and ranges are not available, this is an
//! approximation of a `range`: This type must have `data()` and `size()` member functions that must be
//! convertible to \ref const_pointer and \ref size_type respectively. (e.g. a `std::vector`).
//! @param r The range to view. Behavior is undefined if `[range.data(), range.size())` is not a contiguous range or
//! cannot be borrowed (i.e. it is a temporary that will expire leaving a dangling pointer).
template <class R CARB_NO_DOC(,
std::enable_if_t<cpp::detail::IsConvertibleRange<cpp::remove_cvref_t<R>, const_pointer>::value &&
!detail::IsBasicStringView<cpp::remove_cvref_t<R>>::value &&
!std::is_convertible<R, const char*>::value &&
!detail::HasOperator<cpp::remove_cvref_t<R>, basic_string_view>::value,
bool> = false)>
constexpr explicit basic_string_view(R&& r) : m_data(r.data()), m_count(r.size())
{
}
//! Implicit conversion from `std::basic_string` to basic_string_view.
//!
//! \details Construct a basic_string_view from a `std::basic_string`. The construction is implicit to mimic the
//! behavior of <a
//! href="https://en.cppreference.com/w/cpp/string/basic_string/operator_basic_string_view">std::basic_string<CharT,Traits,Allocator>::operator
//! basic_string_view</a>.
//!
//! @tparam S An instance of `std::basic_string`.
template <class S,
class Allocator = typename S::allocator_type,
std::enable_if_t<std::is_same<std::basic_string<CharT, Traits, Allocator>, std::decay_t<S>>::value, bool> = false>
constexpr basic_string_view(const S& s) : m_data(s.data()), m_count(s.size())
{
}
//! basic_string_view cannot be constructed from nullptr.
constexpr basic_string_view(std::nullptr_t) = delete;
//! Assigns a view.
//! @param view The view to replace `*this` with.
//! @returns `*this`
constexpr basic_string_view& operator=(const basic_string_view& view) noexcept = default;
//! Returns an iterator to the beginning.
//! @returns A \ref const_iterator to the first character of the view.
constexpr const_iterator begin() const noexcept
{
return const_iterator(m_data);
}
//! Returns an iterator to the beginning.
//! @returns A \ref const_iterator to the first character of the view.
constexpr const_iterator cbegin() const noexcept
{
return const_iterator(m_data);
}
//! Returns an iterator to the end.
//! @returns A \ref const_iterator to the character following the last character of the view. This character acts as
//! a placeholder, attempting to access it results in undefined behavior.
constexpr const_iterator end() const noexcept
{
return const_iterator(m_data + m_count);
}
//! Returns an iterator to the end.
//! @returns A \ref const_iterator to the character following the last character of the view. This character acts as
//! a placeholder, attempting to access it results in undefined behavior.
constexpr const_iterator cend() const noexcept
{
return const_iterator(m_data + m_count);
}
//! Returns a reverse iterator to the beginning.
//! @returns A \ref const_reverse_iterator to the first character of the reversed view. It corresponds to the last
//! character of the non-reversed view.
constexpr const_reverse_iterator rbegin() const noexcept
{
return const_reverse_iterator(end());
}
//! Returns a reverse iterator to the beginning.
//! @returns A \ref const_reverse_iterator to the first character of the reversed view. It corresponds to the last
//! character of the non-reversed view.
constexpr const_reverse_iterator crbegin() const noexcept
{
return const_reverse_iterator(cend());
}
//! Returns a reverse iterator to the end.
//! @returns a \ref const_reverse_iterator to the character following the last character of the reversed view. It
//! corresponds to the character preceding the first character of the non-reversed view. This character acts as a
//! placeholder, attempting to access it results in undefined behavior.
constexpr const_reverse_iterator rend() const noexcept
{
return const_reverse_iterator(begin());
}
//! Returns a reverse iterator to the end.
//! @returns a \ref const_reverse_iterator to the character following the last character of the reversed view. It
//! corresponds to the character preceding the first character of the non-reversed view. This character acts as a
//! placeholder, attempting to access it results in undefined behavior.
constexpr const_reverse_iterator crend() const noexcept
{
return const_reverse_iterator(cbegin());
}
//! Accesses the specified character.
//! \details Returns a const reference to the character at the specified position. No bounds checking is performed:
//! the behavior is undefined if `pos >= size()`.
//! @param pos The position of the character to return.
//! @returns A \ref const_reference to the requested character.
constexpr const_reference operator[](size_type pos) const noexcept /*strengthened*/
{
// Though the standard says no bounds checking we do assert
CARB_ASSERT(pos < m_count);
return m_data[pos];
}
//! Accesses the specified character with bounds checking.
//! \details Returns a const reference to the character at the specified position. Bounds checking is performed.
//! \throws std::out_of_range Invalid access: \p pos is at or after \ref size().
//! @param pos The position of the character to return.
//! @returns A \ref const_reference to the requested character
constexpr const_reference at(size_type pos) const
{
CARB_THROW_OR_CHECK(pos < m_count, "pos >= size()");
return m_data[pos];
}
//! Accesses the first character.
//! @returns A \ref const_reference to the first character in the view. The behavior is undefined if empty() is
//! `true`.
constexpr const_reference front() const noexcept /*strengthened*/
{
CARB_ASSERT(!empty(), "Undefined since empty()");
return *m_data;
}
//! Accesses the last character.
//! @returns A \ref const_reference to the last character in the view. The behavior is undefined if empty() is
//! `true`.
constexpr const_reference back() const noexcept /*strengthened*/
{
CARB_ASSERT(!empty(), "Undefined since empty()");
return m_data[m_count - 1];
}
//! Returns a pointer to the first character of a view.
//! \details Returns a pointer to the underlying character array. The pointer is such that the range
//! `[data(), data() + size())` is valid and the values in it correspond to the values of the view.
//! \note Unlike `std::basic_string::data()` and string literals, this function returns a pointer to a buffer that
//! is not necessarily null-terminated, for example a substring view (e.g. from \ref remove_suffix()). Therefore,
//! it is typically a mistake to pass `data()` to a routine that takes just a `const CharT*` and expects a null-
//! terminated string.
//! @returns A \ref const_pointer to the underlying character array.
constexpr const_pointer data() const noexcept
{
return m_data;
}
//! Returns the number of characters.
//! \details Returns the number of `CharT` characters in the view, i.e. `std::distance(begin(), end())`.
//! @returns The number of `CharT` elements in the view.
constexpr size_type size() const noexcept
{
return m_count;
}
//! Returns the number of characters.
//! \details Returns the number of `CharT` characters in the view, i.e. `std::distance(begin(), end())`.
//! @returns The number of `CharT` elements in the view.
constexpr size_type length() const noexcept
{
return m_count;
}
//! Returns the maximum number of characters.
//! \details The largest possible number of char-like objects that can be referred to by a basic_string_view.
//! @returns Maximum number of characters.
constexpr size_type max_size() const noexcept
{
return npos - 1;
}
//! Checks whether the view is empty.
//! \details Checks if the view has no characters, i.e. whether \ref size() is `0`.
//! @returns `true` if the view is empty, `false` otherwise.
CARB_NODISCARD constexpr bool empty() const noexcept
{
return m_count == 0;
}
//! Shrinks the view by moving its start forward.
//! \details Moves the start of the view forward by \p n characters. The behavior is undefined if `n > size()`.
//! @param n Number of characters to remove from the start of the view.
constexpr void remove_prefix(size_type n) noexcept /*strengthened*/
{
CARB_ASSERT(n <= size(), "Undefined since n > size()");
m_data += n;
m_count -= n;
}
//! Shrinks the view by moving its end backward.
//! \details Moves the end of the view back by \p n characters. The behavior is undefined if `n > size()`.
//! @param n Number of characters to remove from the end of the view.
constexpr void remove_suffix(size_type n) noexcept /*strengthened*/
{
CARB_ASSERT(n <= size(), "Undefined since n > size()");
m_count = m_count - n;
}
//! Swaps the contents.
//! \details Exchanges the view with that of \p v.
//! @param v View to swap with.
constexpr void swap(basic_string_view& v) noexcept
{
std::swap(m_data, v.m_data);
std::swap(m_count, v.m_count);
}
//! Copies characters.
//! \details Copies the substring `[pos, pos + rcount)` to the character array pointed to by \p dest, where `rcount`
//! is the smaller of \p count and `size() - pos`. Equivalent to `Traits::copy(dest, data() + pos, rcount)`.
//! \throws std::out_of_range if `pos > size()`.
//! @param dest Pointer to the destination character string.
//! @param count Requested substring length.
//! @param pos Position of first character.
//! @returns Number of characters copied.
constexpr size_type copy(CharT* dest, size_type count, size_type pos = 0) const
{
CARB_THROW_OR_CHECK(pos <= size(), "pos > size()");
size_type rcount = ::carb_min(count, size() - pos);
Traits::copy(dest, m_data + pos, rcount);
return rcount;
}
//! Returns a substring.
//! \details Returns a view of the substring `[pos, pos + rcount)`, where `rcount` is the smaller of \p count and
//! `size() - pos.`
//! \throws std::out_of_range if `pos > size()`.
//! @param pos Position of the first character.
//! @param count Requested length.
//! @returns View of the substring `[pos, pos + count)`.
constexpr basic_string_view substr(size_t pos, size_t count = npos) const
{
CARB_THROW_OR_CHECK(pos <= size(), "pos > size()");
size_t rcount = ::carb_min(count, size() - pos);
return { m_data + pos, rcount };
}
//! Compares two views.
//! \details The length rlen of the sequences to compare is the smaller of \ref size() and `v.size()`. The function
//! compares the two views by calling `traits::compare(data(), v.data(), rlen)`, and returns as follows:
//! * A value less than zero (`<0`) if:
//! * `Traits::compare(data(), v.data(), rlen) < 0`, or
//! * `Traits::compare(data(), v.data(), rlen) == 0` and `size() < v.size()`.
//! * A value of zero (`0`) if:
//! * `Traits::compare(data(), v.data(), rlen) == 0` and `size() == v.size()`.
//! * A value greater than zero (`>0`) if:
//! * `Traits::compare(data(), v.data(), rlen) > 0`, or
//! * `Traits::compare(data(), v.data(), rlen) == 0` and `size() > v.size()`.
//! @param v View to compare
//! @returns A negative value if `*this` is less than the other character sequence, `0` if both character sequences
//! are equal, positive value if `*this` is greater than the other character sequence. See above.
constexpr int compare(basic_string_view v) const noexcept
{
size_type rlen = ::carb_min(size(), v.size());
int result = traits_type::compare(data(), v.data(), rlen);
if (result != 0 || size() == v.size())
return result;
return (size() < v.size()) ? -1 : 1;
}
//! Compares two views.
//! \details Equivalent to `substr(pos1, count1).compare(v)`.
//! \see compare(basic_string_view) const noexcept, substr()
//! \throws std::out_of_range if `pos1 > size()`.
//! @param pos1 Position of the first character in this view to compare.
//! @param count1 Number of characters of this view to compare.
//! @param v View to compare.
//! @returns see \ref compare(basic_string_view) const noexcept
constexpr int compare(size_type pos1, size_type count1, basic_string_view v) const
{
return substr(pos1, count1).compare(v);
}
//! Compares two views.
//! \details Equivalent to `substr(pos1, count1).compare(v.substr(pos2, count2))`.
//! \see compare(basic_string_view) const noexcept, substr()
//! \throws std::out_of_range if `pos1 > size()` or if `pos2 > v.size()`.
//! @param pos1 Position of the first character in this view to compare.
//! @param count1 Number of characters of this view to compare.
//! @param v View to compare.
//! @param pos2 Position of the first character of the given view to compare.
//! @param count2 Number of characters of the given view to compare.
//! @returns see \ref compare(basic_string_view) const noexcept
constexpr int compare(size_type pos1, size_type count1, basic_string_view v, size_type pos2, size_type count2) const
{
return substr(pos1, count1).compare(v.substr(pos2, count2));
}
//! Compares two views.
//! \details Equivalent to `compare(basic_string_view(s))`.
//! \see compare(basic_string_view) const noexcept
//! @param s Pointer to the null-terminated character string to compare to.
//! @returns see \ref compare(basic_string_view) const noexcept
constexpr int compare(const CharT* s) const
{
return compare(basic_string_view(s));
}
//! Compares two views.
//! \details Equivalent to `substr(pos1, count1).compare(basic_string_view(s))`.
//! \see compare(basic_string_view) const noexcept, substr()
//! \throws std::out_of_range if `pos1 > size()`.
//! @param pos1 Position of the first character in this view to compare.
//! @param count1 Number of characters of this view to compare.
//! @param s Pointer to the null-terminated character string to compare to.
//! @returns see \ref compare(basic_string_view) const noexcept
constexpr int compare(size_type pos1, size_type count1, const CharT* s) const
{
return substr(pos1, count1).compare(basic_string_view(s));
}
//! Compares two views.
//! \details Equivalent to `substr(pos1, count1).compare(basic_string_view(s, count2))`. Behavior is undefined if
//! `[s, s+count2)` is not a valid contiguous range.
//! \see compare(basic_string_view) const noexcept, substr()
//! \throws std::out_of_range if `pos1 > size()`.
//! @param pos1 Position of the first character in this view to compare.
//! @param count1 Number of characters of this view to compare.
//! @param s Pointer to the character string to compare to.
//! @param count2 Number of characters of \p s to compare.
//! @returns see \ref compare(basic_string_view) const noexcept
constexpr int compare(size_type pos1, size_type count1, const CharT* s, size_type count2) const
{
return substr(pos1, count1).compare(basic_string_view(s, count2));
}
//! Checks if the string view starts with the given prefix.
//! \details Effectively returns `substr(0, sv.size()) == sv`.
//! @param sv A string view which may be a result of implicit conversion from `std::basic_string`.
//! @returns `true` if the string view begins with the provided prefix, `false` otherwise.
constexpr bool starts_with(basic_string_view sv) const noexcept
{
return substr(0, sv.size()) == sv;
}
//! Checks if the string view starts with the given prefix.
//! \details Effectively returns `!empty() && Traits::eq(front(), ch)`.
//! @param ch A single character.
//! @returns `true` if the string view begins with the provided prefix, `false` otherwise.
constexpr bool starts_with(CharT ch) const noexcept
{
return !empty() && traits_type::eq(front(), ch);
}
//! Checks if the string view starts with the given prefix.
//! \details Effectively returns `starts_with(basic_string_view(s))`.
//! @param s A null-terminated character string.
//! @returns `true` if the string view begins with the provided prefix, `false` otherwise.
constexpr bool starts_with(const CharT* s) const
{
return starts_with(basic_string_view(s));
}
//! Checks if the string view ends with the given suffix.
//! \details Effectively returns `size() >= sv.size() && compare(size() - sv.size(), npos, sv) == 0`.
//! @param sv A string view which may be a result of implicit conversion from `std::basic_string`.
//! @returns `true` if the string view ends with the provided suffix, `false` otherwise.
constexpr bool ends_with(basic_string_view sv) const noexcept
{
return size() >= sv.size() && compare(size() - sv.size(), npos, sv) == 0;
}
//! Checks if the string view ends with the given suffix.
//! \details Effectively returns `!empty() && Traits::eq(back(), ch)`.
//! @param ch A single character.
//! @returns `true` if the string view ends with the provided suffix, `false` otherwise.
constexpr bool ends_with(CharT ch) const noexcept
{
return !empty() && traits_type::eq(back(), ch);
}
//! Checks if the string view ends with the given suffix.
//! \details Effectively returns `ends_with(basic_string_view(s))`.
//! @param s A null-terminated character string.
//! @returns `true` if the string view ends with the provided suffix, `false` otherwise.
constexpr bool ends_with(const CharT* s) const
{
return ends_with(basic_string_view(s));
}
//! Checks if the string view contains the given substring or character.
//! \details Effectively `find(sv) != npos`.
//! @param sv A string view.
//! @returns `true` if the string view contains the provided substring, `false` otherwise.
constexpr bool contains(basic_string_view sv) const noexcept
{
return find(sv) != npos;
}
//! Checks if the string view contains the given substring or character.
//! \details Effectively `find(c) != npos`.
//! @param c A single character.
//! @returns `true` if the string view contains the provided substring, `false` otherwise.
constexpr bool contains(CharT c) const noexcept
{
return find(c) != npos;
}
//! Checks if the string view contains the given substring or character.
//! \details Effectively `find(s) != npos`.
//! @param s A null-terminated character string.
//! @returns `true` if the string view contains the provided substring, `false` otherwise.
constexpr bool contains(const CharT* s) const
{
return find(s) != npos;
}
//! Find characters in the view.
//! \details Finds the first substring equal to the given character sequence. Complexity is `O(size() * v.size())`
//! at worst.
//! @param v View to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type find(basic_string_view v, size_type pos = 0) const noexcept
{
// [strings.view.find] in the Standard.
size_type xpos = pos;
while (xpos + v.size() <= size())
{
if (traits_type::compare(v.data(), data() + xpos, v.size()) == 0)
{
return xpos;
}
xpos++;
}
return npos;
}
//! Find characters in the view.
//! \details Finds the first substring equal to the given character sequence. Equivalent to
//! `find(basic_string_view(std::addressof(ch), 1))`. Complexity is `O(size())` at worst.
//! @param ch Character to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type find(CharT ch, size_type pos = 0) const noexcept
{
size_type xpos = pos;
while (xpos < size())
{
if (traits_type::eq(data()[xpos], ch))
{
return xpos;
}
xpos++;
}
return npos;
}
//! Find characters in the view.
//! \details Finds the first substring equal to the given character sequence. Equivalent to
//! `find(basic_string_view(s, count), pos)`. Complexity is `O(size() * count)` at worst.
//! @param s Pointer to a character string to search for.
//! @param pos Position at which to start the search.
//! @param count Length of substring to search for.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type find(const CharT* s, size_type pos, size_type count) const
{
return find(basic_string_view(s, count), pos);
}
//! Find characters in the view.
//! \details Finds the first substring equal to the given character sequence. Equivalent to
//! `find(basic_string_view(s), pos)`. Complexity is `O(size() * Traits::length(s))` at worst.
//! @param s Pointer to a character string to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type find(const CharT* s, size_type pos = 0) const
{
return find(basic_string_view(s), pos);
}
//! Find the last occurrence of a substring.
//! \details Finds the last substring equal to the given character sequence. Search begins at \p pos, i.e. the found
//! substring must not being is a position following \p pos. If \ref npos or any value not smaller than `size()-1`
//! is passed as pos, the whole string will be searched. Complexity is `O(size() * v.size())` at worst.
//! @param v View to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type rfind(basic_string_view v, size_type pos = npos) const noexcept
{
if (v.size() > size())
{
return npos;
}
// Clip the position to our string length.
for (size_type xpos = ::carb_min(pos, size() - v.size());; xpos--)
{
if (traits_type::compare(v.data(), data() + xpos, v.size()) == 0)
{
return xpos;
}
if (xpos == 0)
{
break;
}
}
return npos;
}
//! Find the last occurrence of a substring.
//! \details Finds the last substring equal to the given character sequence. Search begins at \p pos, i.e. the found
//! substring must not being is a position following \p pos. If \ref npos or any value not smaller than `size()-1`
//! is passed as pos, the whole string will be searched. Equivalent to
//! `rfind(basic_string_view(std::addressof(ch), 1), pos)`. Complexity is `O(size())` at worst.
//! @param ch Character to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type rfind(CharT ch, size_type pos = npos) const noexcept
{
if (empty())
{
return npos;
}
// Clip the position to our string length.
for (size_type xpos = ::carb_min(pos, size() - 1);; xpos--)
{
if (traits_type::eq(ch, data()[xpos]))
{
return xpos;
}
if (xpos == 0)
{
break;
}
}
return npos;
}
//! Find the last occurrence of a substring.
//! \details Finds the last substring equal to the given character sequence. Search begins at \p pos, i.e. the found
//! substring must not being is a position following \p pos. If \ref npos or any value not smaller than `size()-1`
//! is passed as pos, the whole string will be searched. Equivalent to `rfind(basic_string_view(s, count), pos)`.
//! Complexity is `O(size() * count)` at worst.
//! @param s Pointer to a character string to search for.
//! @param pos Position at which to start the search.
//! @param count Length of substring to search for.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type rfind(const CharT* s, size_type pos, size_type count) const
{
return rfind(basic_string_view(s, count), pos);
}
//! Find the last occurrence of a substring.
//! \details Finds the last substring equal to the given character sequence. Search begins at \p pos, i.e. the found
//! substring must not being is a position following \p pos. If \ref npos or any value not smaller than `size()-1`
//! is passed as pos, the whole string will be searched. Equivalent to `rfind(basic_string_view(s), pos)`.
//! Complexity is `O(size() * Traits::length(s))` at worst.
//! @param s Pointer to a null-terminated character string to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character of the found substring, or \ref npos if no such substring is found.
constexpr size_type rfind(const CharT* s, size_type pos = npos) const
{
return rfind(basic_string_view(s), pos);
}
//! Find first occurrence of characters.
//! \details Finds the first occurrence of any of the characters of \p v in this view, starting as position \p pos.
//! Complexity is `O(size() * v.size())` at worst.
//! @param v View to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_first_of(basic_string_view v, size_type pos = 0) const noexcept
{
if (v.empty())
{
return npos;
}
size_type xpos = pos;
while (xpos < size())
{
if (v.find(m_data[xpos]) != npos)
{
return xpos;
}
xpos++;
}
return npos;
}
//! Find first occurrence of characters.
//! \details Equivalent to `find_first_of(basic_string_view(std::addressof(ch), 1), pos)`.
//! Complexity is `O(size())` at worst.
//! \see find_first_of(basic_string_view,size_type) const noexcept
//! @param ch Character to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_first_of(CharT ch, size_type pos = 0) const noexcept
{
return find(ch, pos);
}
//! Find first occurrence of characters.
//! \details Equivalent to `find_first_of(basic_string_view(s, count), pos)`. Complexity is `O(size() * count)` at
//! worst.
//! \see find_first_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a string of characters to search for.
//! @param pos Position at which to start the search.
//! @param count Length of the string of characters to search for.
//! @returns Position of the first occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_first_of(const CharT* s, size_type pos, size_type count) const
{
return find_first_of(basic_string_view(s, count), pos);
}
//! Find first occurrence of characters.
//! \details Equivalent to `find_first_of(basic_string_view(s, Traits::length(s)), pos)`. Complexity is
//! `O(size() * count)` at worst.
//! \see find_first_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a null-terminated string of characters to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_first_of(const CharT* s, size_type pos = 0) const
{
return find_first_of(basic_string_view(s), pos);
}
//! Find last occurrence of characters.
//! \details Finds the last character equal to one of characters in the given character sequence. Exact search
//! algorithm is not specified. The search considers only the interval `[0, pos]`. If the character is not present
//! in the interval, \ref npos will be returned. Complexity is `O(size() * v.size())` at worst.
//! @param v View to search for.
//! @param pos Position at which the search is to finish.
//! @returns Position of the last occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_last_of(basic_string_view v, size_type pos = npos) const noexcept
{
if (v.empty() || empty())
{
return npos;
}
// Clip the position to our string length.
for (size_type xpos = ::carb_min(pos, size() - 1);; xpos--)
{
if (v.find(data()[xpos]) != npos)
{
return xpos;
}
if (xpos == 0)
{
break;
}
}
return npos;
}
//! Find last occurrence of characters.
//! \details Finds the last character equal to one of characters in the given character sequence. Exact search
//! algorithm is not specified. The search considers only the interval `[0, pos]`. If the character is not present
//! in the interval, \ref npos will be returned. Equivalent to
//! `find_last_of(basic_string_view(std::addressof(ch), 1), pos)`. Complexity is `O(size())` at worst.
//! \see find_last_of(basic_string_view,size_type) const noexcept
//! @param ch Character to search for.
//! @param pos Position at which the search is to finish.
//! @returns Position of the last occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_last_of(CharT ch, size_type pos = npos) const noexcept
{
return rfind(ch, pos);
}
//! Find last occurrence of characters.
//! \details Finds the last character equal to one of characters in the given character sequence. Exact search
//! algorithm is not specified. The search considers only the interval `[0, pos]`. If the character is not present
//! in the interval, \ref npos will be returned. Equivalent to
//! `find_last_of(basic_string_view(s, count), pos)`. Complexity is `O(size() * count)` at worst.
//! \see find_last_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a string of characters to search for.
//! @param pos Position at which the search is to finish.
//! @param count Length of the string of characters to search for.
//! @returns Position of the last occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_last_of(const CharT* s, size_type pos, size_type count) const
{
return find_last_of(basic_string_view(s, count), pos);
}
//! Find last occurrence of characters.
//! \details Finds the last character equal to one of characters in the given character sequence. Exact search
//! algorithm is not specified. The search considers only the interval `[0, pos]`. If the character is not present
//! in the interval, \ref npos will be returned. Equivalent to
//! `find_last_of(basic_string_view(s), pos)`. Complexity is `O(size() * Traits::length(s))` at worst.
//! \see find_last_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a null-terminated string of characters to search for.
//! @param pos Position at which the search is to finish.
//! @returns Position of the last occurrence of any character of the substring, or \ref npos if no such character
//! is found.
constexpr size_type find_last_of(const CharT* s, size_type pos = npos) const
{
return find_last_of(basic_string_view(s), pos);
}
//! Find first absence of characters.
//! \details Finds the first character not equal to any of the characters in the given character sequence.
//! Complexity is `O(size() * v.size())` at worst.
//! @param v View to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_first_not_of(basic_string_view v, size_type pos = 0) const noexcept
{
size_type xpos = pos;
while (xpos < size())
{
if (v.find(data()[xpos]) == npos)
{
return xpos;
}
xpos++;
}
return npos;
}
//! Find first absence of characters.
//! \details Finds the first character not equal to any of the characters in the given character sequence.
//! Equivalent to `find_first_not_of(basic_string_view(std::addressof(ch), 1), pos)`. Complexity is `O(size())` at
//! worst.
//! \see find_first_not_of(basic_string_view,size_type) const noexcept
//! @param ch Character to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_first_not_of(CharT ch, size_type pos = 0) const noexcept
{
size_type xpos = pos;
while (xpos < size())
{
if (!traits_type::eq(ch, m_data[xpos]))
{
return xpos;
}
xpos++;
}
return npos;
}
//! Find first absence of characters.
//! \details Finds the first character not equal to any of the characters in the given character sequence.
//! Equivalent to `find_first_not_of(basic_string_view(s, count), pos)`. Complexity is `O(size() * count)` at worst.
//! \see find_first_not_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a string of characters to search for.
//! @param pos Position at which to start the search.
//! @param count Length of the string of characters to compare.
//! @returns Position of the first character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_first_not_of(const CharT* s, size_type pos, size_type count) const
{
return find_first_not_of(basic_string_view(s, count), pos);
}
//! Find first absence of characters.
//! \details Finds the first character not equal to any of the characters in the given character sequence.
//! Equivalent to `find_first_not_of(basic_string_view(s), pos)`. Complexity is `O(size() * Traits::length(s))` at
//! worst.
//! \see find_first_not_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a null-terminated string of characters to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the first character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_first_not_of(const CharT* s, size_type pos = 0) const
{
return find_first_not_of(basic_string_view(s), pos);
}
//! Find last absence of characters.
//! \details Finds the last character not equal to any of the characters in the given character sequence. The search
//! considers only the interval `[0, pos]`. Complexity is `O(size() * v.size())` at worst.
//! @param v View to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the last character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_last_not_of(basic_string_view v, size_type pos = 0) const noexcept
{
if (empty())
{
return npos;
}
// Clip the position to our string length.
for (size_type xpos = ::carb_min(pos, size() - 1);; xpos--)
{
if (v.find(data()[xpos]) == npos)
{
return xpos;
}
if (xpos == 0)
{
break;
}
}
return npos;
}
//! Find last absence of characters.
//! \details Finds the last character not equal to any of the characters in the given character sequence. The search
//! considers only the interval `[0, pos]`. Equivalent to
//! `find_last_not_of(basic_string_view(std::addressof(ch), 1), pos)`, Complexity is `O(size())` at worst.
//! \see find_last_not_of(basic_string_view,size_type) const noexcept
//! @param ch Character to search for.
//! @param pos Position at which to start the search.
//! @returns Position of the last character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_last_not_of(CharT ch, size_type pos = 0) const noexcept
{
if (empty())
{
return npos;
}
// Clip the position to our string length.
for (size_type xpos = ::carb_min(pos, size() - 1);; xpos--)
{
if (!traits_type::eq(data()[xpos], ch))
{
return xpos;
}
if (xpos == 0)
{
break;
}
}
return npos;
}
//! Find last absence of characters.
//! \details Finds the last character not equal to any of the characters in the given character sequence. The search
//! considers only the interval `[0, pos]`. Equivalent to
//! `find_last_not_of(basic_string_view(s, count), pos)`, Complexity is `O(size() * count)` at worst.
//! \see find_last_not_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a string of characters to compare.
//! @param pos Position at which to start the search.
//! @param count Length of the string of characters to compare.
//! @returns Position of the last character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_last_not_of(const CharT* s, size_type pos, size_type count) const
{
return find_last_not_of(basic_string_view(s, count), pos);
}
//! Find last absence of characters.
//! \details Finds the last character not equal to any of the characters in the given character sequence. The search
//! considers only the interval `[0, pos]`. Equivalent to
//! `find_last_not_of(basic_string_view(s), pos)`, Complexity is `O(size() * Traits::length(s))` at worst.
//! \see find_last_not_of(basic_string_view,size_type) const noexcept
//! @param s Pointer to a null-terminated string of characters to compare.
//! @param pos Position at which to start the search.
//! @returns Position of the last character not equal to any of the characters in the given string, or \ref npos if
//! no such character is found.
constexpr size_type find_last_not_of(const CharT* s, size_type pos = 0) const
{
return find_last_not_of(basic_string_view(s), pos);
}
private:
CARB_VIZ const_pointer m_data = nullptr;
CARB_VIZ size_type m_count = 0;
};
//! basic_string_view<char>
//! @see basic_string_view
using string_view = basic_string_view<char>;
//! basic_string_view<wchar_t>
//! @see basic_string_view
using wstring_view = basic_string_view<wchar_t>;
#if CARB_HAS_CPP20
//! basic_string_view<char8_t>
//! @see basic_string_view
using u8string_view = basic_string_view<char8_t>;
#endif
//! basic_string_view<char16_t>
//! @see basic_string_view
using u16string_view = basic_string_view<char16_t>;
//! basic_string_view<char32_t>
//! @see basic_string_view
using u32string_view = basic_string_view<char32_t>;
// Ensure these for ABI safety
//! \cond SKIP
#define CARB_IMPL_ENSURE_ABI(cls) \
static_assert(std::is_standard_layout<cls>::value, #cls " must be standard layout"); \
static_assert(std::is_trivially_copyable<cls>::value, #cls " must be trivially copyable"); /* C++23 requirement */ \
static_assert(sizeof(cls) == (2 * sizeof(size_t)), #cls "ABI change violation")
CARB_IMPL_ENSURE_ABI(string_view);
CARB_IMPL_ENSURE_ABI(wstring_view);
CARB_IMPL_ENSURE_ABI(u16string_view);
CARB_IMPL_ENSURE_ABI(u32string_view);
#undef CARB_IMPL_ENSURE_ABI
//! \endcond SKIP
//! @defgroup string_view_compare Lexicographically compare two string views.
//! \details. All comparisons are done via the \ref basic_string_view::compare() member function (which itself is
//! defined in terms of `Traits::compare()`):
//! * Two views are equal if both the size of \p a and \p b are equal and each character in \p a has an equivalent
//! character in \p b at the same position.
//! * The ordering comparisons are done lexicographically -- the comparison is performed by a function equivalent to
//! `std::lexicographical_compare`.
//! Complexity is linear in the size of the views.
//! @{
//! Lexicographically compare two string views.
template <class CharT, class Traits = std::char_traits<CharT>>
bool operator==(const basic_string_view<CharT, Traits>& a, const basic_string_view<CharT, Traits>& b)
{
return a.compare(b) == 0;
}
//! Lexicographically compare two string views.
template <class CharT, class Traits = std::char_traits<CharT>>
bool operator!=(const basic_string_view<CharT, Traits>& a, const basic_string_view<CharT, Traits>& b)
{
return a.compare(b) != 0;
}
//! Lexicographically compare two string views.
template <class CharT, class Traits = std::char_traits<CharT>>
bool operator<(const basic_string_view<CharT, Traits>& a, const basic_string_view<CharT, Traits>& b)
{
return a.compare(b) < 0;
}
//! Lexicographically compare two string views.
template <class CharT, class Traits = std::char_traits<CharT>>
bool operator<=(const basic_string_view<CharT, Traits>& a, const basic_string_view<CharT, Traits>& b)
{
return a.compare(b) <= 0;
}
//! Lexicographically compare two string views.
template <class CharT, class Traits = std::char_traits<CharT>>
bool operator>(const basic_string_view<CharT, Traits>& a, const basic_string_view<CharT, Traits>& b)
{
return a.compare(b) > 0;
}
//! Lexicographically compare two string views.
template <class CharT, class Traits = std::char_traits<CharT>>
bool operator>=(const basic_string_view<CharT, Traits>& a, const basic_string_view<CharT, Traits>& b)
{
return a.compare(b) >= 0;
}
// [string.view.comparison]
//! Lexicographically compare two string views.
inline bool operator==(const char* t, string_view sv)
{
return string_view(t) == sv;
}
//! Lexicographically compare two string views.
inline bool operator==(string_view sv, const char* t)
{
return sv == string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator!=(const char* t, string_view sv)
{
return string_view(t) != sv;
}
//! Lexicographically compare two string views.
inline bool operator!=(string_view sv, const char* t)
{
return sv != string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<(const char* t, string_view sv)
{
return string_view(t) < sv;
}
//! Lexicographically compare two string views.
inline bool operator<(string_view sv, const char* t)
{
return sv < string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<=(const char* t, string_view sv)
{
return string_view(t) <= sv;
}
//! Lexicographically compare two string views.
inline bool operator<=(string_view sv, const char* t)
{
return sv <= string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>(const char* t, string_view sv)
{
return string_view(t) > sv;
}
//! Lexicographically compare two string views.
inline bool operator>(string_view sv, const char* t)
{
return sv > string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>=(const char* t, string_view sv)
{
return string_view(t) >= sv;
}
//! Lexicographically compare two string views.
inline bool operator>=(string_view sv, const char* t)
{
return sv >= string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator==(const wchar_t* t, wstring_view sv)
{
return wstring_view(t) == sv;
}
//! Lexicographically compare two string views.
inline bool operator==(wstring_view sv, const wchar_t* t)
{
return sv == wstring_view(t);
}
//! Lexicographically compare two string views.
inline bool operator!=(const wchar_t* t, wstring_view sv)
{
return wstring_view(t) != sv;
}
//! Lexicographically compare two string views.
inline bool operator!=(wstring_view sv, const wchar_t* t)
{
return sv != wstring_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<(const wchar_t* t, wstring_view sv)
{
return wstring_view(t) < sv;
}
//! Lexicographically compare two string views.
inline bool operator<(wstring_view sv, const wchar_t* t)
{
return sv < wstring_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<=(const wchar_t* t, wstring_view sv)
{
return wstring_view(t) <= sv;
}
//! Lexicographically compare two string views.
inline bool operator<=(wstring_view sv, const wchar_t* t)
{
return sv <= wstring_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>(const wchar_t* t, wstring_view sv)
{
return wstring_view(t) > sv;
}
//! Lexicographically compare two string views.
inline bool operator>(wstring_view sv, const wchar_t* t)
{
return sv > wstring_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>=(const wchar_t* t, wstring_view sv)
{
return wstring_view(t) >= sv;
}
//! Lexicographically compare two string views.
inline bool operator>=(wstring_view sv, const wchar_t* t)
{
return sv >= wstring_view(t);
}
//! Lexicographically compare two string views.
inline bool operator==(const char16_t* t, u16string_view sv)
{
return u16string_view(t) == sv;
}
//! Lexicographically compare two string views.
inline bool operator==(u16string_view sv, const char16_t* t)
{
return sv == u16string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator!=(const char16_t* t, u16string_view sv)
{
return u16string_view(t) != sv;
}
//! Lexicographically compare two string views.
inline bool operator!=(u16string_view sv, const char16_t* t)
{
return sv != u16string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<(const char16_t* t, u16string_view sv)
{
return u16string_view(t) < sv;
}
//! Lexicographically compare two string views.
inline bool operator<(u16string_view sv, const char16_t* t)
{
return sv < u16string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<=(const char16_t* t, u16string_view sv)
{
return u16string_view(t) <= sv;
}
//! Lexicographically compare two string views.
inline bool operator<=(u16string_view sv, const char16_t* t)
{
return sv <= u16string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>(const char16_t* t, u16string_view sv)
{
return u16string_view(t) > sv;
}
//! Lexicographically compare two string views.
inline bool operator>(u16string_view sv, const char16_t* t)
{
return sv > u16string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>=(const char16_t* t, u16string_view sv)
{
return u16string_view(t) >= sv;
}
//! Lexicographically compare two string views.
inline bool operator>=(u16string_view sv, const char16_t* t)
{
return sv >= u16string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator==(const char32_t* t, u32string_view sv)
{
return u32string_view(t) == sv;
}
//! Lexicographically compare two string views.
inline bool operator==(u32string_view sv, const char32_t* t)
{
return sv == u32string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator!=(const char32_t* t, u32string_view sv)
{
return u32string_view(t) != sv;
}
//! Lexicographically compare two string views.
inline bool operator!=(u32string_view sv, const char32_t* t)
{
return sv != u32string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<(const char32_t* t, u32string_view sv)
{
return u32string_view(t) < sv;
}
//! Lexicographically compare two string views.
inline bool operator<(u32string_view sv, const char32_t* t)
{
return sv < u32string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator<=(const char32_t* t, u32string_view sv)
{
return u32string_view(t) <= sv;
}
//! Lexicographically compare two string views.
inline bool operator<=(u32string_view sv, const char32_t* t)
{
return sv <= u32string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>(const char32_t* t, u32string_view sv)
{
return u32string_view(t) > sv;
}
//! Lexicographically compare two string views.
inline bool operator>(u32string_view sv, const char32_t* t)
{
return sv > u32string_view(t);
}
//! Lexicographically compare two string views.
inline bool operator>=(const char32_t* t, u32string_view sv)
{
return u32string_view(t) >= sv;
}
//! Lexicographically compare two string views.
inline bool operator>=(u32string_view sv, const char32_t* t)
{
return sv >= u32string_view(t);
}
//! @}
// Note that literal suffixes that don't start with _ are reserved, in addition we probably don't want to compete with
// the C++17 suffix either.
//! Creates a string view of a character array literal.
//! \note The literal suffix operator `sv` is reserved by C++, so this is `_sv`.
//! @param str Pointer to the beginning of the raw character array literal.
//! @param len Length of the raw character array literal.
//! @returns The \ref basic_string_view literal.
constexpr string_view operator""_sv(const char* str, std::size_t len) noexcept
{
return string_view(str, len);
}
// C++ 20 and above have char8_t.
#if CARB_HAS_CPP20
//! \copydoc operator""_sv(const char*,std::size_t) noexcept
constexpr u8string_view operator""_sv(const char8_t* str, std::size_t len) noexcept
{
return u8string_view(str, len);
}
#endif
//! \copydoc operator""_sv(const char*,std::size_t) noexcept
constexpr u16string_view operator""_sv(const char16_t* str, std::size_t len) noexcept
{
return u16string_view(str, len);
}
//! \copydoc operator""_sv(const char*,std::size_t) noexcept
constexpr u32string_view operator""_sv(const char32_t* str, std::size_t len) noexcept
{
return u32string_view(str, len);
}
//! \copydoc operator""_sv(const char*,std::size_t) noexcept
constexpr wstring_view operator""_sv(const wchar_t* str, std::size_t len) noexcept
{
return wstring_view(str, len);
}
// Non-standard function?
//! Swaps two string views.
//! @param a String view to swap.
//! @param b String view to swap.
template <class CharT, class Traits>
constexpr void swap(carb::cpp::basic_string_view<CharT, Traits>& a, carb::cpp::basic_string_view<CharT, Traits>& b) noexcept
{
a.swap(b);
};
} // namespace cpp
} // namespace carb
//! Hash support for string views.
template <class CharT, class Traits>
struct std::hash<carb::cpp::basic_string_view<CharT, Traits>>
{
//! @private
size_t operator()(const carb::cpp::basic_string_view<CharT, Traits>& v) const
{
return carb::hashBuffer(v.data(), (uintptr_t)(v.data() + v.size()) - (uintptr_t)(v.data()));
}
};
#undef CARB_ALWAYS_FAIL
#undef CARB_THROW_OR_CHECK
| 62,925 | C | 40.208906 | 147 | 0.65122 |
omniverse-code/kit/include/carb/cpp/Memory.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<memory>` library.
#pragma once
#include "../Defines.h"
#include <memory>
#include <type_traits>
namespace carb
{
namespace cpp
{
#if !CARB_HAS_CPP17 || defined DOXYGEN_BUILD
//! Get the address of \a arg, even if \c operator& is overloaded. This is generally only useful in memory management
//! functions -- \c to_address is almost always preferable.
//!
//! \note
//! This function is \c constexpr even in C++14 mode.
template <typename T>
constexpr T* addressof(T& arg) noexcept
{
return __builtin_addressof(arg);
}
//! Taking the address of a \c const rvalue is never correct.
template <typename T>
T const* addressof(T const&&) = delete;
#else
using std::addressof;
#endif
//! Call the destructor of \a p.
template <typename T>
constexpr std::enable_if_t<!std::is_array<T>::value> destroy_at(T* const p) noexcept(std::is_nothrow_destructible<T>::value)
{
p->~T();
}
//! Call the destructor of all \a array elements.
//!
//! \tparam T The element type of the array must have a \c noexcept destructor. There no mechanism to safely use this
//! function if an element throws. This is a departure from the C++20, wherein an exception thrown from a
//! destructor will result in either \c std::terminate or an "implementation defined manner." Instead, we force
//! you to handle potential exceptions by disallowing it.
template <typename T, std::size_t N>
constexpr void destroy_at(T (*array)[N]) noexcept
{
static_assert(noexcept(carb::cpp::destroy_at(array[0])),
"destroy_at for array requires elements to have noexcept destructor");
for (T& elem : *array)
{
carb::cpp::destroy_at(carb::cpp::addressof(elem));
}
}
#if !CARB_HAS_CPP20 || defined DOXYGEN_BUILD
//! Construct a \c T in \a place using the provided \a args.
//!
//! \note
//! This differs from the C++20 definition by not being \c constexpr, since placement new is not \c constexpr before
//! C++20. When C++20 is enabled, this function disappears in favor of \c std::construct_at.
template <typename T, typename... TArgs>
T* construct_at(T* place, TArgs&&... args) noexcept
CARB_NO_DOC((noexcept(::new (static_cast<void*>(place)) T(std::forward<TArgs>(args)...))))
{
return ::new (static_cast<void*>(place)) T(std::forward<TArgs>(args)...);
}
#else
using std::construct_at;
#endif
} // namespace cpp
} // namespace carb
| 2,908 | C | 29.946808 | 124 | 0.698418 |
omniverse-code/kit/include/carb/cpp/TypeTraits.h | // Copyright (c) 2022-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<type_traits>` library.
#pragma once
#include "../Defines.h"
#include "../detail/NoexceptType.h"
#include "detail/ImplInvoke.h"
#include <functional>
#include <type_traits>
namespace carb
{
namespace cpp
{
CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE()
//! An integral constant with \c bool type and value \c B.
template <bool B>
using bool_constant = std::integral_constant<bool, B>;
//! \cond DEV
namespace detail
{
template <typename... B>
struct conjunction_impl;
template <>
struct conjunction_impl<> : std::true_type
{
};
template <typename B>
struct conjunction_impl<B> : B
{
};
template <typename BHead, typename... BRest>
struct conjunction_impl<BHead, BRest...> : std::conditional_t<bool(BHead::value), conjunction_impl<BRest...>, BHead>
{
};
} // namespace detail
//! \endcond
//! A conjunction is the logical \e and of all \c B traits.
//!
//! An empty list results in a \c true value. This meta-function is short-circuiting.
//!
//! \tparam B The series of traits to evaluate the \c value member of. Each \c B must have a member constant \c value
//! which is convertible to \c bool. Use of carb::cpp::bool_constant is helpful here.
template <typename... B>
struct conjunction : detail::conjunction_impl<B...>
{
};
//! \cond DEV
namespace detail
{
template <typename... B>
struct disjunction_impl;
template <>
struct disjunction_impl<> : std::false_type
{
};
template <typename B>
struct disjunction_impl<B> : B
{
};
template <typename BHead, typename... BRest>
struct disjunction_impl<BHead, BRest...> : std::conditional_t<bool(BHead::value), BHead, disjunction_impl<BRest...>>
{
};
} // namespace detail
//! \endcond
//! A disjunction is the logical \e or of all \c B traits.
//!
//! An empty list results in a \c false value. This metafunction is short-circuiting.
//!
//! \tparam B The series of traits to evaluate the \c value member of. Each \c B must have a member constant \c value
//! which is convertible to \c bool. Use of \ref cpp::bool_constant is helpful here.
template <typename... B>
struct disjunction : detail::disjunction_impl<B...>
{
};
//! A logical \e not of \c B trait.
//!
//! \tparam B The trait to evaluate the \c value member of. This must have a member constant \c value which is
//! convertible to \c bool. Use of \ref cpp::bool_constant is helpful here.
template <typename B>
struct negation : bool_constant<!bool(B::value)>
{
};
//! Void type
template <class...>
using void_t = void;
using std::is_convertible;
using std::is_void;
//! \cond DEV
namespace detail
{
// Base case matches where either `To` or `From` is void or if `is_convertible<From, To>` is false. The conversion in
// this case is only non-throwing if both `From` and `To` are `void`.
template <typename From, typename To, typename = void>
struct is_nothrow_convertible_impl : conjunction<is_void<From>, is_void<To>>
{
};
// If neither `From` nor `To` are void and `From` is convertible to `To`, then we test that such a conversion is
// non-throwing.
template <typename From, typename To>
struct is_nothrow_convertible_impl<
From,
To,
std::enable_if_t<conjunction<negation<is_void<From>>, negation<is_void<To>>, is_convertible<From, To>>::value>>
{
static void test(To) noexcept;
static constexpr bool value = noexcept(test(std::declval<From>()));
};
} // namespace detail
//! \endcond
//! Determine if \c From can be implicitly-converted to \c To without throwing an exception.
//!
//! This is equivalent to the C++20 \c std::is_nothrow_convertible meta query. While added in C++20, it is required for
//! the C++17 \ref is_nothrow_invocable_r meta query.
template <typename From, typename To>
struct is_nothrow_convertible : bool_constant<detail::is_nothrow_convertible_impl<From, To>::value>
{
};
//! \cond DEV
namespace detail
{
template <class T>
struct IsSwappable;
template <class T>
struct IsNothrowSwappable;
template <class T, class U, class = void>
struct SwappableWithHelper : std::false_type
{
};
template <class T, class U>
struct SwappableWithHelper<T, U, void_t<decltype(swap(std::declval<T>(), std::declval<U>()))>> : std::true_type
{
};
template <class T, class U>
struct IsSwappableWith : bool_constant<conjunction<SwappableWithHelper<T, U>, SwappableWithHelper<U, T>>::value>
{
};
template <class T>
struct IsSwappable : IsSwappableWith<std::add_lvalue_reference_t<T>, std::add_lvalue_reference_t<T>>::type
{
};
using std::swap; // enable ADL
template <class T, class U>
struct SwapCannotThrow : bool_constant<noexcept(swap(std::declval<T>(), std::declval<U>()))&& noexcept(
swap(std::declval<U>(), std::declval<T>()))>
{
};
template <class T, class U>
struct IsNothrowSwappableWith : bool_constant<conjunction<IsSwappableWith<T, U>, SwapCannotThrow<T, U>>::value>
{
};
template <class T>
struct IsNothrowSwappable : IsNothrowSwappableWith<std::add_lvalue_reference_t<T>, std::add_lvalue_reference_t<T>>::type
{
};
} // namespace detail
//! \endcond
template <class T, class U>
struct is_swappable_with : detail::IsSwappableWith<T, U>::type
{
};
template <class T>
struct is_swappable : detail::IsSwappable<T>::type
{
};
template <class T, class U>
struct is_nothrow_swappable_with : detail::IsNothrowSwappableWith<T, U>::type
{
};
template <class T>
struct is_nothrow_swappable : detail::IsNothrowSwappable<T>::type
{
};
//! \cond DEV
namespace detail
{
// The base case is matched in cases where `invoke_uneval` is an invalid expression. The `Qualify` is always set to void
// by users.
template <typename Qualify, typename Func, typename... TArgs>
struct invoke_result_impl
{
};
template <typename Func, typename... TArgs>
struct invoke_result_impl<decltype(void(invoke_uneval(std::declval<Func>(), std::declval<TArgs>()...))), Func, TArgs...>
{
using type = decltype(invoke_uneval(std::declval<Func>(), std::declval<TArgs>()...));
};
template <typename Qualify, typename Func, typename... TArgs>
struct is_invocable_impl : std::false_type
{
};
template <typename Func, typename... TArgs>
struct is_invocable_impl<void_t<typename invoke_result_impl<void, Func, TArgs...>::type>, Func, TArgs...> : std::true_type
{
};
template <typename Qualify, typename Func, typename... TArgs>
struct is_nothrow_invocable_impl : std::false_type
{
};
template <typename Func, typename... TArgs>
struct is_nothrow_invocable_impl<void_t<typename invoke_result_impl<void, Func, TArgs...>::type>, Func, TArgs...>
: bool_constant<noexcept(invoke_uneval(std::declval<Func>(), std::declval<TArgs>()...))>
{
};
} // namespace detail
//! \endcond
//! Get the result type of calling \c Func with the \c TArgs pack.
//!
//! If \c Func is callable with the given \c TArgs pack, then this structure has a member typedef named \c type with the
//! return of that call. If \c Func is not callable, then the member typedef does not exist.
//!
//! \code
//! static_assert(std::is_same<int, typename invoke_result<int(*)(char), char>::type>::value);
//! \endcode
//!
//! This is equivalent to the C++17 \c std::invoke_result meta transformation.
//!
//! \see carb::cpp::invoke_result_t
template <typename Func, typename... TArgs>
struct invoke_result : detail::invoke_result_impl<void, Func, TArgs...>
{
};
//! Helper for \ref carb::cpp::invoke_result which accesses the \c type member.
//!
//! \code
//! // Get the proper return type and SFINAE-safe disqualify `foo` when `f(10)` is not valid.
//! template <typename Func>
//! invoke_result_t<Func, int> foo(Func&& f)
//! {
//! return invoke(std::forward<Func>(f), 10);
//! }
//! \endcode
//!
//! This is equivalent to the C++ \c std::invoke_result_t helper typedef.
template <typename Func, typename... TArgs>
using invoke_result_t = typename invoke_result<Func, TArgs...>::type;
//! Check if the \c Func is invocable with the \c TArgs pack.
//!
//! If \c Func is callable with the given \c TArgs pack, then this structure will derive from \c true_type; otherwise,
//! it will be \c false_type. If \c value is \c true, then `invoke(func, args...)` is a valid expression.
//!
//! \code
//! static_assert(is_invocable<void(*)()>::value);
//! static_assert(!is_invocable<void(*)(int)>::value);
//! static_assert(is_invocable<void(*)(int), int>::value);
//! static_assert(is_invocable<void(*)(long), int>::value);
//! \endcode
//!
//! This is equivalent to the C++20 \c std::is_invocable meta query. The query was added in C++17, but this additionally
//! supports invoking a pointer to a `const&` member function on an rvalue reference.
template <typename Func, typename... TArgs>
struct is_invocable : detail::is_invocable_impl<void, Func, TArgs...>
{
};
//! Check if invoking \c Func with the \c TArgs pack will not throw.
//!
//! If \c Func called with the given \c TArgs pack is callable and marked \c noexcept, then this structure will derive
//! from \c true_type; otherwise, it will be \c false_type. If \c Func is not callable at all, then this will also be
//! \c false_type.
//!
//! This is equivalent to the C++17 \c is_nothrow_invocable meta query.
template <typename Func, typename... TArgs>
struct is_nothrow_invocable : detail::is_nothrow_invocable_impl<void, Func, TArgs...>
{
};
//! \cond DEV
namespace detail
{
template <typename Qualify, typename R, typename Func, typename... TArgs>
struct invocable_r_impl
{
using invocable_t = std::false_type;
using invocable_nothrow_t = std::false_type;
};
template <typename Func, typename... TArgs>
struct invocable_r_impl<std::enable_if_t<is_invocable<Func, TArgs...>::value>, void, Func, TArgs...>
{
using invocable_t = std::true_type;
using invocable_nothrow_t = is_nothrow_invocable<Func, TArgs...>;
};
// The is_void as part of the qualifier is to workaround an MSVC issue where it thinks this partial specialization and
// the one which explicitly lists `R` as void are equally-qualified.
template <typename R, typename Func, typename... TArgs>
struct invocable_r_impl<std::enable_if_t<is_invocable<Func, TArgs...>::value && !is_void<R>::value>, R, Func, TArgs...>
{
private:
// Can't use declval for conversion checks, as it adds an rvalue ref to the type. We want to make sure the result of
// a returned function can be converted.
static invoke_result_t<Func, TArgs...> get_val() noexcept;
template <typename Target>
static void convert_to(Target) noexcept;
template <typename TR, typename = decltype(convert_to<TR>(get_val()))>
static std::true_type test(int) noexcept;
template <typename TR>
static std::false_type test(...) noexcept;
template <typename TR, typename = decltype(convert_to<TR>(get_val()))>
static bool_constant<noexcept(convert_to<TR>(get_val()))> test_nothrow(int) noexcept;
template <typename TR>
static std::false_type test_nothrow(...) noexcept;
public:
using invocable_t = decltype(test<R>(0));
using invocable_nothrow_t = decltype(test_nothrow<R>(0));
};
} // namespace detail
//! \endcond
//! Check if invoking \c Func with the \c TArgs pack will return \c R.
//!
//! Similar to \ref is_invocable, but additionally checks that the result type is convertible to \c R and that the
//! conversion does not bind a reference to a temporary object. If \c R is \c void, the result can be any type (as any
//! type can be converted to \c void by discarding it). If \c value is \c true, then `invoke_r<R>(func, args...)` is a
//! valid expression.
//!
//! This is equivalent to the C++23 definition of \c is_invocable_r. The function was originally added in C++17, but the
//! specification was altered in C++23 to avoid undefined behavior.
template <typename R, typename Func, typename... TArgs>
struct is_invocable_r : detail::invocable_r_impl<void, R, Func, TArgs...>::invocable_t
{
};
//! Check that invoking \c Func with the \c TArgs pack and converting it to \c R will not throw.
//!
//! This is equivalent to the C++23 definition of \c is_nothrow_invocable_r. The function was originally added in C++17,
//! but the specification was altered in C++23 to avoid undefined behavior.
template <typename R, typename Func, typename... TArgs>
struct is_nothrow_invocable_r : detail::invocable_r_impl<void, R, Func, TArgs...>::invocable_nothrow_t
{
};
CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE()
//! Provides the member typedef type that names T (i.e. the identity transformation).
//! This can be used to establish non-deduced contexts in template argument deduction.
template <class T>
struct type_identity
{
//! The identity transformation.
using type = T;
};
//! Helper type for \ref type_identity
template <class T>
using type_identity_t = typename type_identity<T>::type;
//! If the type T is a reference type, provides the member typedef type which is the type referred to by T with its
//! topmost cv-qualifiers removed. Otherwise type is T with its topmost cv-qualifiers removed.
template <class T>
struct remove_cvref
{
//! The type `T` or referred to by `T` (in the case of a reference) with topmost cv-qualifiers removed.
using type = std::remove_cv_t<std::remove_reference_t<T>>;
};
//! Helper type for \ref remove_cvref
template <class T>
using remove_cvref_t = typename remove_cvref<T>::type;
//! \cond DEV
namespace detail
{
template <class T, class P, class = void>
struct IsConvertibleRange : public std::false_type
{
};
template <class T, class P>
struct IsConvertibleRange<T,
P,
cpp::void_t<decltype(std::declval<T>().size()),
std::enable_if_t<std::is_convertible<decltype(std::declval<T>().data()), P>::value>>>
: public std::true_type
{
};
} // namespace detail
//! \endcond DEV
} // namespace cpp
} // namespace carb
| 14,234 | C | 30.91704 | 123 | 0.69615 |
omniverse-code/kit/include/carb/cpp/Barrier.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<barrier>` library.
#pragma once
#include "Atomic.h"
#include "Bit.h"
#include <utility>
namespace carb
{
//! Namespace for C++ standard library types after C++14 implemented and usable by C++14 compilers.
namespace cpp
{
//! \cond DEV
namespace detail
{
constexpr uint32_t kInvalidPhase = 0;
struct NullFunction
{
constexpr NullFunction() noexcept = default;
constexpr void operator()() noexcept
{
}
};
} // namespace detail
//! \endcond
// Handle case where Windows.h may have defined 'max'
#pragma push_macro("max")
#undef max
/**
* Implements a C++20 barrier in C++14 semantics.
*
* A barrier is a thread coordination mechanism whose lifetime consists of a sequence of barrier phases, where
* each phase allows at most an expected number of threads to block until the expected number of threads
* arrive at the barrier. A barrier is useful for managing repeated tasks that are handled by multiple
* threads.
*
* @see https://en.cppreference.com/w/cpp/thread/barrier
* @tparam CompletionFunction A function object type that must meet the requirements of MoveConstructible and
* Destructible. `std::is_nothrow_invocable_v<CompletionFunction&>` must be `true`. The default template argument is an
* unspecified function object type that additionally meets the requirements of DefaultConstructible. Calling an lvalue
* of it with no arguments has no effects. Every barrier behaves as if it holds an exposition-only non-static data
* member `completion_` of type `CompletionFunction` and calls it by `completion_()` on every phase completion step.
*/
template <class CompletionFunction = detail::NullFunction>
class barrier
{
CARB_PREVENT_COPY_AND_MOVE(barrier);
public:
/**
* Returns the maximum value of expected count supported by the implementation.
* @returns the maximum value of expected count supported by the implementation.
*/
static constexpr ptrdiff_t max() noexcept
{
return ptrdiff_t(INT_MAX);
}
/**
* Constructor
*
* Sets both the initial expected count for each phase and the current expected count for the first phase to
* @p expected, initializes the completion function object with `std::move(f)`, and then starts the first phase. The
* behavior is undefined if @p expected is negative or greater than @ref max().
*
* @param expected Initial value of the expected count.
* @param f Completion function object to be called on phase completion step.
* @throws std::exception Any exception thrown by CompletionFunction's move constructor.
*/
constexpr explicit barrier(ptrdiff_t expected, CompletionFunction f = CompletionFunction{})
: m_emo(InitBoth{}, std::move(f), (uint64_t(1) << kPhaseBitShift) + uint32_t(::carb_min(expected, max()))),
m_expected(uint32_t(::carb_min(expected, max())))
{
CARB_ASSERT(expected >= 0 && expected <= max());
}
/**
* Destructor
*
* The behavior is undefined if any thread is concurrently calling a member function of the barrier.
*
* @note This implementation waits until all waiting threads have woken, but this is a stronger guarantee than the
* standard.
*/
~barrier()
{
// Wait for destruction until all waiters are clear
while (m_waiters.load(std::memory_order_acquire) != 0)
std::this_thread::yield();
}
/**
* An object type meeting requirements of MoveConstructible, MoveAssignable and Destructible.
* @see arrive() wait()
*/
class arrival_token
{
CARB_PREVENT_COPY(arrival_token);
friend class barrier;
uint32_t m_token{ detail::kInvalidPhase };
arrival_token(uint32_t token) : m_token(token)
{
}
public:
//! Constructor
arrival_token() = default;
//! Move constructor
//! @param rhs Other @c arrival_token to move from. @c rhs is left in a valid but empty state.
arrival_token(arrival_token&& rhs) : m_token(std::exchange(rhs.m_token, detail::kInvalidPhase))
{
}
//! Move-assign operator
//! @param rhs Other @c arrival_token to move from. @c rhs is left in a valid but empty state.
//! @returns @c *this
arrival_token& operator=(arrival_token&& rhs)
{
m_token = std::exchange(rhs.m_token, detail::kInvalidPhase);
return *this;
}
};
/**
* Arrives at barrier and decrements the expected count
*
* Constructs an @ref arrival_token object associated with the phase synchronization point for the current phase.
* Then, decrements the expected count by @p update.
*
* This function executes atomically. The call to this function strongly happens-before the start of the phase
* completion step for the current phase.
*
* The behavior is undefined if @p update is less than or equal zero or greater than the expected count for the
* current barrier phase.
*
* @param update The value by which the expected count is decreased.
* @returns The constructed @ref arrival_token object.
* @throws std::system_error According to the standard, but this implementation does not throw. Instead an assertion
* occurs.
* @see wait()
*/
CARB_NODISCARD arrival_token arrive(ptrdiff_t update = 1)
{
return arrival_token(uint32_t(_arrive(update).first >> kPhaseBitShift));
}
/**
* Blocks at the phase synchronization point until its phase completion step is run.
*
* If @p arrival is associated with the phase synchronization point for the current phase of @c *this, blocks at the
* synchronization point associated with @p arrival until the phase completion step of the synchronization point's
* phase is run.
*
* Otherwise if @p arrival is associated with the phase synchronization point for the immediately preceding phase of
* @c *this, returns immediately.
*
* Otherwise, i.e. if @p arrival is associated with the phase synchronization point for an earlier phase of @c *this
* or any phase of a barrier object other than @c *this, the behavior is undefined.
*
* @param arrival An @ref arrival_token obtained by a previous call to @ref arrive() on the same barrier.
* @throws std::system_error According to the standard, but this implementation does not throw. Instead an assertion
* occurs.
*/
void wait(arrival_token&& arrival) const
{
// Precondition: arrival is associated with the phase synchronization point for the current phase or the
// immediately preceding phase.
CARB_CHECK(arrival.m_token != 0); // No invalid tokens
uint64_t data = m_emo.second.load(std::memory_order_acquire);
uint32_t phase = uint32_t(data >> kPhaseBitShift);
CARB_CHECK((phase - arrival.m_token) <= 1, "arrival %u is not the previous or current phase %u",
arrival.m_token, phase);
if (phase != arrival.m_token)
return;
// Register as a waiter
m_waiters.fetch_add(1, std::memory_order_relaxed);
do
{
// Wait for the phase to change
m_emo.second.wait(data, std::memory_order_relaxed);
// Reload after waiting
data = m_emo.second.load(std::memory_order_acquire);
phase = uint32_t(data >> kPhaseBitShift);
} while (phase == arrival.m_token);
// Unregister as a waiter
m_waiters.fetch_sub(1, std::memory_order_release);
}
/**
* Arrives at barrier and decrements the expected count by one, then blocks until the current phase completes.
*
* Atomically decrements the expected count by one, then blocks at the synchronization point for the current phase
* until the phase completion step of the current phase is run. Equivalent to `wait(arrive())`.
*
* The behavior is undefined if the expected count for the current phase is zero.
*
* @note If the current expected count is decremented to zero in the call to this function, the phase completion
* step is run and this function does not block. If the current expected count is zero before calling this function,
* the initial expected count for all subsequent phases is also zero, which means the barrier cannot be reused.
*
* @throws std::system_error According to the standard, but this implementation does not throw. Instead an assertion
* occurs.
*/
void arrive_and_wait()
{
// Two main differences over just doing arrive(wait()):
// - We return immediately if _arrive() did the phase shift
// - We don't CARB_CHECK that the phase is the current or preceding one since it is guaranteed
auto result = _arrive(1);
if (result.second)
return;
// Register as a waiter
m_waiters.fetch_add(1, std::memory_order_relaxed);
uint64_t data = result.first;
uint32_t origPhase = uint32_t(data >> kPhaseBitShift), phase;
do
{
// Wait for the phase to change
m_emo.second.wait(data, std::memory_order_relaxed);
// Reload after waiting
data = m_emo.second.load(std::memory_order_acquire);
phase = uint32_t(data >> kPhaseBitShift);
} while (phase == origPhase);
// Unregister as a waiter
m_waiters.fetch_sub(1, std::memory_order_release);
}
/**
* Decrements both the initial expected count for subsequent phases and the expected count for current phase by one.
*
* This function is executed atomically. The call to this function strongly happens-before the start of the phase
* completion step for the current phase.
*
* The behavior is undefined if the expected count for the current phase is zero.
*
* @note This function can cause the completion step for the current phase to start. If the current expected count
* is zero before calling this function, the initial expected count for all subsequent phases is also zero, which
* means the barrier cannot be reused.
*
* @throws std::system_error According to the standard, but this implementation does not throw. Instead an assertion
* occurs.
*/
void arrive_and_drop()
{
uint32_t prev = m_expected.fetch_sub(1, std::memory_order_relaxed);
CARB_CHECK(prev != 0); // Precondition failure: expected count for the current barrier phase must be greater
// than zero.
_arrive(1);
}
private:
constexpr static int kPhaseBitShift = 32;
constexpr static uint64_t kCounterMask = 0xffffffffull;
CARB_ALWAYS_INLINE std::pair<uint64_t, bool> _arrive(ptrdiff_t update)
{
CARB_CHECK(update > 0 && update <= max());
uint64_t pre = m_emo.second.fetch_sub(uint32_t(update), std::memory_order_acq_rel);
CARB_CHECK(ptrdiff_t(int32_t(uint32_t(pre & kCounterMask))) >= update); // Precondition check
bool completed = false;
if (uint32_t(pre & kCounterMask) == uint32_t(update))
{
// Phase is now complete
std::atomic_thread_fence(std::memory_order_acquire);
_completePhase(pre - uint32_t(update));
completed = true;
}
return std::make_pair(pre - uint32_t(update), completed);
}
void _completePhase(uint64_t data)
{
uint32_t expected = m_expected.load(std::memory_order_relaxed);
// Run the completion routine before releasing threads
m_emo.first()();
// Increment the phase and don't allow the invalid phase
uint32_t phase = uint32_t(data >> kPhaseBitShift);
if (++phase == detail::kInvalidPhase)
++phase;
#if CARB_ASSERT_ENABLED
// Should not have changed during completion function.
uint64_t old = m_emo.second.exchange((uint64_t(phase) << kPhaseBitShift) + expected, std::memory_order_release);
CARB_ASSERT(old == data);
#else
m_emo.second.store((uint64_t(phase) << kPhaseBitShift) + expected, std::memory_order_release);
#endif
// Release all waiting threads
m_emo.second.notify_all();
}
// The MSB 32 bits of the atomic_uint64_t are the Phase; the other bits are the Counter
EmptyMemberPair<CompletionFunction, atomic_uint64_t> m_emo;
std::atomic_uint32_t m_expected;
mutable std::atomic_uint32_t m_waiters{ 0 };
};
#pragma pop_macro("max")
} // namespace cpp
} // namespace carb
| 13,176 | C | 38.452096 | 120 | 0.662417 |
omniverse-code/kit/include/carb/cpp/Optional.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
// Implements std::optional from C++17 using C++14 paradigms.
// Heavily borrowed from MS STL: https://github.com/microsoft/STL/blob/master/stl/inc/optional
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<optional>` library.
#pragma once
#include "../Defines.h"
#include "Utility.h"
#define CARB_IMPLOPTIONAL
#include "detail/ImplOptional.h"
#undef CARB_IMPLOPTIONAL
namespace carb
{
namespace cpp
{
struct nullopt_t
{
struct Tag
{
};
explicit constexpr nullopt_t(Tag)
{
}
};
static constexpr nullopt_t nullopt{ nullopt_t::Tag{} };
class bad_optional_access final : public std::exception
{
public:
bad_optional_access() noexcept = default;
bad_optional_access(const bad_optional_access&) noexcept = default;
bad_optional_access& operator=(const bad_optional_access&) noexcept = default;
virtual const char* what() const noexcept override
{
return "bad optional access";
}
};
template <class T>
class CARB_VIZ optional : private detail::SelectHierarchy<detail::OptionalConstructor<T>, T>
{
using BaseClass = detail::SelectHierarchy<detail::OptionalConstructor<T>, T>;
static_assert(!std::is_same<std::remove_cv_t<T>, nullopt_t>::value &&
!std::is_same<std::remove_cv_t<T>, in_place_t>::value,
"T may not be nullopt_t or inplace_t");
static_assert(std::is_object<T>::value && std::is_destructible<T>::value && !std::is_array<T>::value,
"T does not meet Cpp17Destructible requirements");
// Essentially: !is_same(U, optional) && !is_same(U, in_place_t) && is_constructible(T from U)
template <class U>
using AllowDirectConversion = bool_constant<
conjunction<negation<std::is_same<typename std::remove_reference_t<typename std::remove_cv_t<U>>, optional>>,
negation<std::is_same<typename std::remove_reference_t<typename std::remove_cv_t<U>>, in_place_t>>,
std::is_constructible<T, U>>::value>;
// Essentially: !(is_same(T, U) || is_constructible(T from optional<U>) || is_convertible(optional<U> to T))
template <class U>
struct AllowUnwrapping : bool_constant<!disjunction<std::is_same<T, U>,
std::is_constructible<T, optional<U>&>,
std::is_constructible<T, const optional<U>&>,
std::is_constructible<T, const optional<U>>,
std::is_constructible<T, optional<U>>,
std::is_convertible<optional<U>&, T>,
std::is_convertible<const optional<U>&, T>,
std::is_convertible<const optional<U>, T>,
std::is_convertible<optional<U>, T>>::value>
{
};
// Essentially: !(is_same(T, U) || is_assignable(T& from optional<U>))
template <class U>
struct AllowUnwrappingAssignment : bool_constant<!disjunction<std::is_same<T, U>,
std::is_assignable<T&, optional<U>&>,
std::is_assignable<T&, const optional<U>&>,
std::is_assignable<T&, const optional<U>>,
std::is_assignable<T&, optional<U>>>::value>
{
};
[[noreturn]] static void onBadAccess()
{
#if CARB_EXCEPTIONS_ENABLED
throw bad_optional_access();
#else
CARB_FATAL_UNLESS(0, "bad optional access");
#endif
}
public:
using value_type = T;
constexpr optional() noexcept
{
}
constexpr optional(nullopt_t) noexcept
{
}
optional(const optional& other) : BaseClass(static_cast<const BaseClass&>(other))
{
}
optional(optional&& other) noexcept(std::is_nothrow_move_constructible<T>::value)
: BaseClass(static_cast<BaseClass&&>(std::move(other)))
{
}
optional& operator=(const optional& other)
{
if (other)
this->assign(*other);
else
reset();
return *this;
}
optional& operator=(optional&& other) noexcept(
std::is_nothrow_move_assignable<T>::value&& std::is_nothrow_move_constructible<T>::value)
{
if (other)
this->assign(std::move(*other));
else
reset();
return *this;
}
// The spec states that this is conditionally-explicit, which is a C++20 feature, so we have to work around it by
// having two functions with SFINAE
template <class U,
typename std::enable_if_t<
conjunction<AllowUnwrapping<U>, std::is_constructible<T, const U&>, std::is_convertible<const U&, T>>::value,
int> = 0>
optional(const optional<U>& other)
{
if (other)
this->construct(*other);
}
template <
class U,
typename std::enable_if_t<
conjunction<AllowUnwrapping<U>, std::is_constructible<T, const U&>, negation<std::is_convertible<const U&, T>>>::value,
int> = 0>
explicit optional(const optional<U>& other)
{
if (other)
this->construct(*other);
}
// The spec states that this is conditionally-explicit, which is a C++20 feature, so we have to work around it by
// having two functions with SFINAE
template <
class U,
typename std::enable_if_t<conjunction<AllowUnwrapping<U>, std::is_constructible<T, U>, std::is_convertible<U, T>>::value,
int> = 0>
optional(optional<U>&& other)
{
if (other)
this->construct(std::move(*other));
}
template <class U,
typename std::enable_if_t<
conjunction<AllowUnwrapping<U>, std::is_constructible<T, U>, negation<std::is_convertible<U, T>>>::value,
int> = 0>
explicit optional(optional<U>&& other)
{
if (other)
this->construct(std::move(*other));
}
template <class... Args, typename std::enable_if_t<std::is_constructible<T, Args...>::value, int> = 0>
optional(in_place_t, Args&&... args) : BaseClass(in_place, std::forward<Args>(args)...)
{
}
template <class U,
class... Args,
typename std::enable_if_t<std::is_constructible<T, std::initializer_list<U>&, Args...>::value, int> = 0>
optional(in_place_t, std::initializer_list<U> ilist, Args&&... args)
: BaseClass(in_place, ilist, std::forward<Args>(args)...)
{
}
// The spec states that this is conditionally-explicit, which is a C++20 feature, so we have to work around it by
// having two functions with SFINAE
template <class U = value_type,
typename std::enable_if_t<conjunction<AllowDirectConversion<U>, std::is_convertible<U, T>>::value, int> = 0>
constexpr optional(U&& value) : BaseClass(in_place, std::forward<U>(value))
{
}
template <class U = value_type,
typename std::enable_if_t<conjunction<AllowDirectConversion<U>, negation<std::is_convertible<U, T>>>::value, int> = 0>
constexpr explicit optional(U&& value) : BaseClass(in_place, std::forward<U>(value))
{
}
~optional() = default;
optional& operator=(nullopt_t) noexcept
{
reset();
return *this;
}
template <class U = T,
typename std::enable_if_t<
conjunction<negation<std::is_same<optional, typename std::remove_cv_t<typename std::remove_reference_t<U>>>>,
negation<conjunction<std::is_scalar<T>, std::is_same<T, typename std::decay_t<U>>>>,
std::is_constructible<T, U>,
std::is_assignable<T&, U>>::value,
int> = 0>
optional& operator=(U&& value)
{
this->assign(std::forward<U>(value));
return *this;
}
template <
class U,
typename std::enable_if_t<
conjunction<AllowUnwrappingAssignment<U>, std::is_constructible<T, const U&>, std::is_assignable<T&, const U&>>::value,
int> = 0>
optional& operator=(const optional<U>& other)
{
if (other)
this->assign(*other);
else
reset();
return *this;
}
template <class U,
typename std::enable_if_t<
conjunction<AllowUnwrappingAssignment<U>, std::is_constructible<T, U>, std::is_assignable<T&, U>>::value,
int> = 0>
optional& operator=(optional<U>&& other)
{
if (other)
this->assign(std::move(*other));
else
reset();
return *this;
}
constexpr const T* operator->() const
{
return std::addressof(this->val());
}
constexpr T* operator->()
{
return std::addressof(this->val());
}
constexpr const T& operator*() const&
{
return this->val();
}
constexpr T& operator*() &
{
return this->val();
}
constexpr const T&& operator*() const&&
{
return std::move(this->val());
}
constexpr T&& operator*() &&
{
return std::move(this->val());
}
constexpr explicit operator bool() const noexcept
{
return this->hasValue;
}
constexpr bool has_value() const noexcept
{
return this->hasValue;
}
constexpr const T& value() const&
{
if (!this->hasValue)
onBadAccess();
return this->val();
}
constexpr T& value() &
{
if (!this->hasValue)
onBadAccess();
return this->val();
}
constexpr const T&& value() const&&
{
if (!this->hasValue)
onBadAccess();
return std::move(this->val());
}
constexpr T&& value() &&
{
if (!this->hasValue)
onBadAccess();
return std::move(this->val());
}
template <class U>
constexpr typename std::remove_cv_t<T> value_or(U&& default_value) const&
{
static_assert(
std::is_convertible<const T&, typename std::remove_cv_t<T>>::value,
"The const overload of optional<T>::value_or() requires const T& to be convertible to std::remove_cv_t<T>");
static_assert(std::is_convertible<U, T>::value, "optional<T>::value_or() requires U to be convertible to T");
if (this->hasValue)
return this->val();
return static_cast<typename std::remove_cv_t<T>>(std::forward<U>(default_value));
}
template <class U>
constexpr typename std::remove_cv_t<T> value_or(U&& default_value) &&
{
static_assert(
std::is_convertible<T, typename std::remove_cv_t<T>>::value,
"The rvalue overload of optional<T>::value_or() requires T to be convertible to std::remove_cv_t<T>");
static_assert(std::is_convertible<U, T>::value, "optional<T>::value_or() requires U to be convertible to T");
if (this->hasValue)
return this->val();
return static_cast<typename std::remove_cv_t<T>>(std::forward<U>(default_value));
}
void swap(optional& other) noexcept(std::is_nothrow_move_constructible<T>::value&& is_nothrow_swappable<T>::value)
{
static_assert(std::is_move_constructible<T>::value, "T must be move constructible");
static_assert(!std::is_move_constructible<T>::value || is_swappable<T>::value, "T must be swappable");
const bool engaged = this->hasValue;
if (engaged == other.hasValue)
{
if (engaged)
{
using std::swap; // Enable ADL
swap(**this, *other);
}
}
else
{
optional& source = engaged ? *this : other;
optional& target = engaged ? other : *this;
target.construct(std::move(*source));
source.reset();
}
}
using BaseClass::reset;
template <class... Args>
T& emplace(Args&&... args)
{
reset();
return this->construct(std::forward<Args>(args)...);
}
template <class U,
class... Args,
typename std::enable_if_t<std::is_constructible<T, std::initializer_list<U>&, Args...>::value, int> = 0>
T& emplace(std::initializer_list<U> ilist, Args&&... args)
{
reset();
return this->construct(ilist, std::forward<Args>(args)...);
}
};
template <class T, class U>
constexpr bool operator==(const optional<T>& lhs, const optional<U>& rhs)
{
const bool lhv = lhs.has_value();
return lhv == rhs.has_value() && (!lhv || *lhs == *rhs);
}
template <class T, class U>
constexpr bool operator!=(const optional<T>& lhs, const optional<U>& rhs)
{
const bool lhv = lhs.has_value();
return lhv != rhs.has_value() || (lhv && *lhs != *rhs);
}
template <class T, class U>
constexpr bool operator<(const optional<T>& lhs, const optional<U>& rhs)
{
return rhs.has_value() && (!lhs.has_value() || *lhs < *rhs);
}
template <class T, class U>
constexpr bool operator<=(const optional<T>& lhs, const optional<U>& rhs)
{
return !lhs.has_value() || (rhs.has_value() && *lhs <= *rhs);
}
template <class T, class U>
constexpr bool operator>(const optional<T>& lhs, const optional<U>& rhs)
{
return lhs.has_value() && (!rhs.has_value() || *lhs > *rhs);
}
template <class T, class U>
constexpr bool operator>=(const optional<T>& lhs, const optional<U>& rhs)
{
return !rhs.has_value() || (lhs.has_value() && *lhs >= *rhs);
}
template <class T>
constexpr bool operator==(const optional<T>& opt, nullopt_t) noexcept
{
return !opt.has_value();
}
template <class T>
constexpr bool operator==(nullopt_t, const optional<T>& opt) noexcept
{
return !opt.has_value();
}
template <class T>
constexpr bool operator!=(const optional<T>& opt, nullopt_t) noexcept
{
return opt.has_value();
}
template <class T>
constexpr bool operator!=(nullopt_t, const optional<T>& opt) noexcept
{
return opt.has_value();
}
template <class T>
constexpr bool operator<(const optional<T>& opt, nullopt_t) noexcept
{
CARB_UNUSED(opt);
return false;
}
template <class T>
constexpr bool operator<(nullopt_t, const optional<T>& opt) noexcept
{
return opt.has_value();
}
template <class T>
constexpr bool operator<=(const optional<T>& opt, nullopt_t) noexcept
{
return !opt.has_value();
}
template <class T>
constexpr bool operator<=(nullopt_t, const optional<T>& opt) noexcept
{
CARB_UNUSED(opt);
return true;
}
template <class T>
constexpr bool operator>(const optional<T>& opt, nullopt_t) noexcept
{
return opt.has_value();
}
template <class T>
constexpr bool operator>(nullopt_t, const optional<T>& opt) noexcept
{
CARB_UNUSED(opt);
return false;
}
template <class T>
constexpr bool operator>=(const optional<T>& opt, nullopt_t) noexcept
{
CARB_UNUSED(opt);
return true;
}
template <class T>
constexpr bool operator>=(nullopt_t, const optional<T>& opt) noexcept
{
return !opt.has_value();
}
template <class T, class U, detail::EnableIfComparableWithEqual<T, U> = 0>
constexpr bool operator==(const optional<T>& opt, const U& value)
{
return opt ? *opt == value : false;
}
template <class T, class U, detail::EnableIfComparableWithEqual<T, U> = 0>
constexpr bool operator==(const T& value, const optional<U>& opt)
{
return opt ? *opt == value : false;
}
template <class T, class U, detail::EnableIfComparableWithNotEqual<T, U> = 0>
constexpr bool operator!=(const optional<T>& opt, const U& value)
{
return opt ? *opt != value : true;
}
template <class T, class U, detail::EnableIfComparableWithNotEqual<T, U> = 0>
constexpr bool operator!=(const T& value, const optional<U>& opt)
{
return opt ? *opt != value : true;
}
template <class T, class U, detail::EnableIfComparableWithLess<T, U> = 0>
constexpr bool operator<(const optional<T>& opt, const U& value)
{
return opt ? *opt < value : true;
}
template <class T, class U, detail::EnableIfComparableWithLess<T, U> = 0>
constexpr bool operator<(const T& value, const optional<U>& opt)
{
return opt ? value < *opt : false;
}
template <class T, class U, detail::EnableIfComparableWithLessEqual<T, U> = 0>
constexpr bool operator<=(const optional<T>& opt, const U& value)
{
return opt ? *opt <= value : true;
}
template <class T, class U, detail::EnableIfComparableWithLessEqual<T, U> = 0>
constexpr bool operator<=(const T& value, const optional<U>& opt)
{
return opt ? value <= *opt : false;
}
template <class T, class U, detail::EnableIfComparableWithGreater<T, U> = 0>
constexpr bool operator>(const optional<T>& opt, const U& value)
{
return opt ? *opt > value : false;
}
template <class T, class U, detail::EnableIfComparableWithGreater<T, U> = 0>
constexpr bool operator>(const T& value, const optional<U>& opt)
{
return opt ? value > *opt : true;
}
template <class T, class U, detail::EnableIfComparableWithGreaterEqual<T, U> = 0>
constexpr bool operator>=(const optional<T>& opt, const U& value)
{
return opt ? *opt >= value : false;
}
template <class T, class U, detail::EnableIfComparableWithGreaterEqual<T, U> = 0>
constexpr bool operator>=(const T& value, const optional<U>& opt)
{
return opt ? value >= *opt : true;
}
template <class T, typename std::enable_if_t<std::is_move_constructible<T>::value && is_swappable<T>::value, int> = 0>
void swap(optional<T>& lhs, optional<T>& rhs) noexcept(noexcept(lhs.swap(rhs)))
{
lhs.swap(rhs);
}
template <class T>
constexpr optional<typename std::decay_t<T>> make_optional(T&& value)
{
return optional<typename std::decay_t<T>>{ std::forward<T>(value) };
}
template <class T, class... Args>
constexpr optional<T> make_optional(Args&&... args)
{
return optional<T>{ in_place, std::forward<Args>(args)... };
}
template <class T, class U, class... Args>
constexpr optional<T> make_optional(std::initializer_list<U> il, Args&&... args)
{
return optional<T>{ in_place, il, std::forward<Args>(args)... };
}
} // namespace cpp
} // namespace carb
| 18,873 | C | 31.824348 | 132 | 0.592169 |
omniverse-code/kit/include/carb/cpp/Variant.h | // Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<variant>` library.
#pragma once
#include "../Defines.h"
#include "TypeTraits.h"
#include "Utility.h"
#include <cstdint>
#include <exception>
#include <new>
#include <tuple>
#include <utility>
// This class is a not quite standards conformant implementation of std::variant. Where it doesn't comply it is
// in the sense that it doesn't support everything. Such as all constexpr usages. Part of this is because it
// isn't possible on a C++14 compiler, the other part is full coverage of this class is difficult. Feel free
// to expand this class and make it more conforming to all use cases the standard version can given it will
// still compile on C++14. The long term intention is we will move to a C++17 compiler, and import the std
// version of this class, removing this code from our codebase. Therefore it is very important that this class
// doesn't do anything that the std can't, though the opposite is permissible.
namespace carb
{
namespace cpp
{
static constexpr std::size_t variant_npos = (std::size_t)-1;
// Forward define.
template <typename... Types>
class variant;
template <std::size_t I, typename T>
struct variant_alternative;
class bad_variant_access final : public std::exception
{
public:
bad_variant_access() noexcept = default;
bad_variant_access(const bad_variant_access&) noexcept = default;
bad_variant_access& operator=(const bad_variant_access&) noexcept = default;
virtual const char* what() const noexcept override
{
return "bad variant access";
}
};
namespace detail
{
// Common pathway for bad_variant_access.
[[noreturn]] inline void on_bad_variant_access()
{
#if CARB_EXCEPTIONS_ENABLED
throw bad_variant_access();
#else
std::terminate();
#endif
}
template <bool IsTriviallyDesctructable, typename... Types>
class VariantHold;
template <bool IsTriviallyDesctructable>
class VariantHold<IsTriviallyDesctructable>
{
static constexpr size_t size = 0;
};
template <typename T, typename... Types>
class VariantHold<true, T, Types...>
{
public:
static constexpr size_t size = 1 + sizeof...(Types);
using Next = VariantHold<true, Types...>;
union
{
CARB_VIZ std::remove_const_t<T> m_value;
CARB_VIZ Next m_next;
};
constexpr VariantHold() noexcept
{
}
template <class... Args>
constexpr VariantHold(in_place_index_t<0>, Args&&... args) noexcept : m_value(std::forward<Args>(args)...)
{
}
template <size_t I, class... Args>
constexpr VariantHold(in_place_index_t<I>, Args&&... args) noexcept
: m_next(in_place_index<I - 1>, std::forward<Args>(args)...)
{
}
constexpr T& get() & noexcept
{
return m_value;
}
constexpr const T& get() const& noexcept
{
return m_value;
}
constexpr T&& get() && noexcept
{
return std::move(m_value);
}
constexpr const T&& get() const&& noexcept
{
return std::move(m_value);
}
};
template <typename T, typename... Types>
class VariantHold<false, T, Types...>
{
public:
static constexpr size_t size = 1 + sizeof...(Types);
using Next = VariantHold<false, Types...>;
union
{
CARB_VIZ std::remove_const_t<T> m_value;
CARB_VIZ Next m_next;
};
constexpr VariantHold() noexcept
{
}
template <class... Args>
constexpr VariantHold(in_place_index_t<0>, Args&&... args) noexcept : m_value(std::forward<Args>(args)...)
{
}
template <size_t I, class... Args>
constexpr VariantHold(in_place_index_t<I>, Args&&... args) noexcept
: m_next(in_place_index<I - 1>, std::forward<Args>(args)...)
{
}
~VariantHold()
{
}
constexpr T& get() & noexcept
{
return m_value;
}
constexpr const T& get() const& noexcept
{
return m_value;
}
constexpr T&& get() && noexcept
{
return std::move(m_value);
}
constexpr const T&& get() const&& noexcept
{
return std::move(m_value);
}
};
template <size_t I>
struct VariantGetFromHold
{
template <class Hold>
static decltype(auto) get(Hold&& hold)
{
return VariantGetFromHold<I - 1>::get(hold.m_next);
}
};
template <>
struct VariantGetFromHold<0>
{
template <class Hold>
static decltype(auto) get(Hold&& hold)
{
return hold.get();
}
};
template <size_t I, typename Hold>
constexpr decltype(auto) variant_get_from_hold(Hold&& hold)
{
constexpr size_t size = std::remove_reference_t<Hold>::size;
return VariantGetFromHold < I < size ? I : size - 1 > ::get(hold);
}
// Visitor with index feedback.
template <size_t I, typename Functor, typename Hold>
static decltype(auto) visitWithIndex(Functor&& functor, Hold&& hold)
{
return std::forward<Functor>(functor)(I, VariantGetFromHold<I>::get(static_cast<Hold&&>(hold)));
}
template <int I>
struct VisitWithIndexHelper;
template <typename Functor, typename Hold, typename Ids = std::make_index_sequence<std::remove_reference<Hold>::type::size>>
struct VisitWithIndexTable;
template <typename Functor, typename Hold, size_t... Ids>
struct VisitWithIndexTable<Functor, Hold, std::index_sequence<Ids...>>
{
using return_type = decltype(std::declval<Functor>()(VariantGetFromHold<0>::get(std::declval<Hold>())));
using f_table_type = return_type (*)(Functor&&, Hold&&);
static f_table_type& table(size_t id)
{
static f_table_type tbl[] = { &visitWithIndex<Ids, Functor, Hold>... };
return tbl[id];
}
};
template <>
struct VisitWithIndexHelper<-1>
{
template <typename Functor, typename Hold>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold&& hold)
{
auto& entry = VisitWithIndexTable<Functor, Hold>::table(index);
return entry(std::forward<Functor>(functor), std::forward<Hold>(hold));
}
};
#define VISIT_WITH_INDEX_1(n) \
case (n): \
return std::forward<Functor>(functor)( \
n, VariantGetFromHold < n < size ? n : size - 1 > ::get(static_cast<Hold&&>(hold)));
#define VISIT_WITH_INDEX_2(n) \
VISIT_WITH_INDEX_1(n) \
VISIT_WITH_INDEX_1(n + 1)
#define VISIT_WITH_INDEX_4(n) \
VISIT_WITH_INDEX_2(n) \
VISIT_WITH_INDEX_2(n + 2)
#define VISIT_WITH_INDEX_8(n) \
VISIT_WITH_INDEX_4(n) \
VISIT_WITH_INDEX_4(n + 4)
#define VISIT_WITH_INDEX_16(n) \
VISIT_WITH_INDEX_8(n) \
VISIT_WITH_INDEX_8(n + 8)
template <>
struct VisitWithIndexHelper<0>
{
template <typename Functor, typename Hold>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold&& hold)
{
constexpr size_t size = std::remove_reference_t<Hold>::size;
switch (index)
{
default:
VISIT_WITH_INDEX_1(0);
}
}
};
template <>
struct VisitWithIndexHelper<1>
{
template <typename Functor, typename Hold>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold&& hold)
{
constexpr size_t size = std::remove_reference_t<Hold>::size;
switch (index)
{
default:
VISIT_WITH_INDEX_2(0);
}
}
};
template <>
struct VisitWithIndexHelper<2>
{
template <typename Functor, typename Hold>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold&& hold)
{
constexpr size_t size = std::remove_reference_t<Hold>::size;
switch (index)
{
default:
VISIT_WITH_INDEX_4(0);
}
}
};
template <>
struct VisitWithIndexHelper<3>
{
template <typename Functor, typename Hold>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold&& hold)
{
constexpr size_t size = std::remove_reference_t<Hold>::size;
switch (index)
{
default:
VISIT_WITH_INDEX_8(0);
}
}
};
template <>
struct VisitWithIndexHelper<4>
{
template <typename Functor, typename Hold>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold&& hold)
{
constexpr size_t size = std::remove_reference_t<Hold>::size;
switch (index)
{
default:
VISIT_WITH_INDEX_16(0);
}
}
};
#undef VISIT_WITH_INDEX_1
#undef VISIT_WITH_INDEX_2
#undef VISIT_WITH_INDEX_4
#undef VISIT_WITH_INDEX_8
#undef VISIT_WITH_INDEX_16
// Use this as the definition so that the template parameters can auto-deduce.
template <typename Functor, typename Hold>
decltype(auto) visitorWithIndex(Functor&& functor, size_t typeIndex, Hold&& hold)
{
constexpr int size = std::remove_reference<Hold>::type::size;
constexpr int version = size <= 1 ? 0 : size <= 2 ? 1 : size <= 4 ? 2 : size <= 8 ? 3 : size <= 16 ? 4 : -1;
return VisitWithIndexHelper<version>::issue(std::forward<Functor>(functor), typeIndex, std::forward<Hold>(hold));
}
// Visitor without index feedback.
template <size_t I>
struct Dispatcher;
template <>
struct Dispatcher<1>
{
template <typename Functor, typename Impl>
using return_type = decltype(std::declval<Functor>()(VariantGetFromHold<0>::get(std::declval<Impl>())));
template <size_t I, typename Functor, typename Impl>
static decltype(auto) issue(Functor&& functor, Impl&& impl)
{
return std::forward<Functor>(functor)(variant_get_from_hold<I>(std::forward<Impl>(impl)));
}
};
template <>
struct Dispatcher<2>
{
template <typename Functor, typename Impl1, typename Impl2>
using return_type = decltype(std::declval<Functor>()(
VariantGetFromHold<0>::get(std::declval<Impl1>()), VariantGetFromHold<0>::get(std::declval<Impl2>())));
template <size_t I, typename Functor, typename Impl1, typename Impl2>
static decltype(auto) issue(Functor&& functor, Impl1&& impl1, Impl2&& impl2)
{
constexpr size_t size1 = std::remove_reference<Impl1>::type::size;
constexpr size_t I1 = I % size1;
constexpr size_t I2 = I / size1;
return functor(variant_get_from_hold<I1>(std::forward<Impl1>(impl1)),
variant_get_from_hold<I2>(std::forward<Impl2>(impl2)));
}
};
template <typename... Impl>
struct TotalStates;
template <typename Impl>
struct TotalStates<Impl>
{
static constexpr size_t value = std::remove_reference<Impl>::type::size;
};
template <typename Impl, typename... Rem>
struct TotalStates<Impl, Rem...>
{
static constexpr size_t value = std::remove_reference<Impl>::type::size * TotalStates<Rem...>::value;
};
template <typename... Ts>
struct Package
{
};
template <typename Functor, typename... Impl>
struct VisitHelperTable
{
template <typename Ids>
struct Instance;
};
template <typename Functor, typename... Impl>
template <size_t... Ids>
struct VisitHelperTable<Functor, Impl...>::Instance<std::index_sequence<Ids...>>
{
using dispatcher = Dispatcher<sizeof...(Impl)>;
using return_type = typename dispatcher::template return_type<Functor, Impl...>;
using f_table_type = return_type (*)(Functor&&, Impl&&...);
static f_table_type& table(size_t id)
{
static f_table_type tbl[] = { &Dispatcher<sizeof...(Impl)>::template issue<Ids, Functor>... };
return tbl[id];
}
};
inline size_t computeIndex()
{
return 0;
}
template <class Impl, class... Impls>
constexpr size_t computeIndex(Impl&& impl, Impls&&... impls)
{
if (impl.index() != variant_npos)
{
constexpr size_t size = std::remove_reference<Impl>::type::size;
return impl.index() + size * computeIndex(impls...);
}
on_bad_variant_access();
}
template <int I>
struct VisitHelper;
template <>
struct VisitHelper<-1>
{
template <typename Functor, typename... Impl>
static constexpr decltype(auto) issue(Functor&& functor, Impl&&... impl)
{
constexpr size_t size = TotalStates<Impl...>::value;
size_t index = computeIndex(impl...);
auto& entry = VisitHelperTable<Functor, Impl...>::template Instance<std::make_index_sequence<size>>::table(index);
return entry(std::forward<Functor>(functor), std::forward<Impl>(impl)...);
}
};
#define VISIT_1(n) \
case (n): \
return dispatcher::template issue<n, Functor>(std::forward<Functor>(functor), std::forward<Impl>(impl)...);
#define VISIT_2(n) \
VISIT_1(n) \
VISIT_1(n + 1)
#define VISIT_4(n) \
VISIT_2(n) \
VISIT_2(n + 2)
#define VISIT_8(n) \
VISIT_4(n) \
VISIT_4(n + 4)
#define VISIT_16(n) \
VISIT_8(n) \
VISIT_8(n + 8)
template <>
struct VisitHelper<0>
{
template <typename Functor, typename... Impl>
static constexpr decltype(auto) issue(Functor&& functor, Impl&&... impl)
{
size_t index = computeIndex(impl...);
using dispatcher = Dispatcher<sizeof...(Impl)>;
switch (index)
{
default:
VISIT_1(0);
}
}
};
template <>
struct VisitHelper<1>
{
template <typename Functor, typename... Impl>
static constexpr decltype(auto) issue(Functor&& functor, Impl&&... impl)
{
size_t index = computeIndex(impl...);
using dispatcher = Dispatcher<sizeof...(Impl)>;
switch (index)
{
default:
VISIT_2(0);
}
}
};
template <>
struct VisitHelper<2>
{
template <typename Functor, typename... Impl>
static constexpr decltype(auto) issue(Functor&& functor, Impl&&... impl)
{
size_t index = computeIndex(impl...);
using dispatcher = Dispatcher<sizeof...(Impl)>;
switch (index)
{
default:
VISIT_4(0);
}
}
};
template <>
struct VisitHelper<3>
{
template <typename Functor, typename... Impl>
static constexpr decltype(auto) issue(Functor&& functor, Impl&&... impl)
{
size_t index = computeIndex(impl...);
using dispatcher = Dispatcher<sizeof...(Impl)>;
switch (index)
{
default:
VISIT_8(0);
}
}
};
template <>
struct VisitHelper<4>
{
template <typename Functor, typename... Impl>
static constexpr decltype(auto) issue(Functor&& functor, Impl&&... impl)
{
size_t index = computeIndex(impl...);
using dispatcher = Dispatcher<sizeof...(Impl)>;
switch (index)
{
default:
VISIT_16(0);
}
}
};
#undef VISIT_1
#undef VISIT_2
#undef VISIT_4
#undef VISIT_8
#undef VISIT_16
// Use this as the definition so that the template parameters can auto-deduce.
template <typename Functor, typename... Impl>
decltype(auto) visitor(Functor&& functor, Impl&&... impl)
{
constexpr size_t size = TotalStates<Impl...>::value;
constexpr int version = size <= 1 ? 0 : size <= 2 ? 1 : size <= 4 ? 2 : size <= 8 ? 3 : size <= 16 ? 4 : -1;
return VisitHelper<version>::issue(std::forward<Functor>(functor), std::forward<Impl>(impl)...);
}
// Internal helper that generates smaller code when scanning two variants.
template <size_t I, typename Functor, typename Hold1, typename Hold2>
decltype(auto) visitSameOnce(Functor&& functor, Hold1&& hold1, Hold2&& hold2)
{
return std::forward<Functor>(functor)(
variant_get_from_hold<I>(std::forward<Hold1>(hold1)), variant_get_from_hold<I>(std::forward<Hold2>(hold2)));
}
template <typename Functor,
typename Hold1,
typename Hold2,
typename Ids = std::make_index_sequence<std::remove_reference<Hold1>::type::size>>
struct VisitSameHelperTable;
template <typename Functor, typename Hold1, typename Hold2, size_t... Ids>
struct VisitSameHelperTable<Functor, Hold1, Hold2, std::index_sequence<Ids...>>
{
using return_type = decltype(std::declval<Functor>()(
VariantGetFromHold<0>::get(std::declval<Hold1>()), VariantGetFromHold<0>::get(std::declval<Hold2>())));
using f_table_type = return_type (*)(Functor&&, Hold1&&, Hold2&&);
static f_table_type& table(size_t id)
{
static f_table_type tbl[] = { &visitSameOnce<Ids, Functor, Hold1, Hold2>... };
return tbl[id];
}
};
template <int I>
struct VisitSameHelper;
template <>
struct VisitSameHelper<-1>
{
template <typename Functor, typename Hold1, typename Hold2>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold1&& hold1, Hold2&& hold2)
{
constexpr auto& entry = VisitSameHelperTable<Functor, Hold1, Hold2>::table(index);
return entry(std::forward<Functor>(functor), std::forward<Hold1>(hold1), std::forward<Hold2>(hold2));
}
};
#define VISIT_SAME_1(n) \
case (n): \
return functor(variant_get_from_hold<n>(std::forward<Hold1>(hold1)), \
variant_get_from_hold<n>(std::forward<Hold2>(hold2)));
#define VISIT_SAME_2(n) \
VISIT_SAME_1(n) \
VISIT_SAME_1(n + 1)
#define VISIT_SAME_4(n) \
VISIT_SAME_2(n) \
VISIT_SAME_2(n + 2)
#define VISIT_SAME_8(n) \
VISIT_SAME_4(n) \
VISIT_SAME_4(n + 4)
#define VISIT_SAME_16(n) \
VISIT_SAME_8(n) \
VISIT_SAME_8(n + 8)
template <>
struct VisitSameHelper<0>
{
template <typename Functor, typename Hold1, typename Hold2>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold1&& hold1, Hold2&& hold2)
{
switch (index)
{
default:
VISIT_SAME_1(0);
}
}
};
template <>
struct VisitSameHelper<1>
{
template <typename Functor, typename Hold1, typename Hold2>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold1&& hold1, Hold2&& hold2)
{
switch (index)
{
default:
VISIT_SAME_2(0);
}
}
};
template <>
struct VisitSameHelper<2>
{
template <typename Functor, typename Hold1, typename Hold2>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold1&& hold1, Hold2&& hold2)
{
switch (index)
{
default:
VISIT_SAME_4(0);
}
}
};
template <>
struct VisitSameHelper<3>
{
template <typename Functor, typename Hold1, typename Hold2>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold1&& hold1, Hold2&& hold2)
{
switch (index)
{
default:
VISIT_SAME_8(0);
}
}
};
template <>
struct VisitSameHelper<4>
{
template <typename Functor, typename Hold1, typename Hold2>
static constexpr decltype(auto) issue(Functor&& functor, size_t index, Hold1&& hold1, Hold2&& hold2)
{
switch (index)
{
default:
VISIT_SAME_16(0);
}
}
};
#undef VISIT_SAME_1
#undef VISIT_SAME_2
#undef VISIT_SAME_4
#undef VISIT_SAME_8
#undef VISIT_SAME_16
// Use this as the definition so that the template parameters can auto-deduce.
template <typename Functor, typename Hold1, typename Hold2>
decltype(auto) visitor_same(Functor&& functor, size_t typeIndex, Hold1&& hold1, Hold2&& hold2)
{
constexpr int size = std::remove_reference<Hold1>::type::size;
constexpr int version = size <= 1 ? 0 : size <= 2 ? 1 : size <= 4 ? 2 : size <= 8 ? 3 : size <= 16 ? 4 : -1;
return VisitSameHelper<version>::issue(
std::forward<Functor>(functor), typeIndex, std::forward<Hold1>(hold1), std::forward<Hold2>(hold2));
}
template <std::size_t I, typename T, typename... Candiates>
struct GetIndexOfHelper;
template <std::size_t I, typename T, typename Candiate>
struct GetIndexOfHelper<I, T, Candiate>
{
static constexpr size_t value = I;
};
template <std::size_t I, typename T, typename FirstCandiate, typename... Candiates>
struct GetIndexOfHelper<I, T, FirstCandiate, Candiates...>
{
static constexpr size_t value =
std::is_same<T, FirstCandiate>::value ? I : GetIndexOfHelper<I + 1, T, Candiates...>::value;
};
template <typename T, typename... Candiates>
static constexpr size_t index_of_v = GetIndexOfHelper<0, T, Candiates...>::value;
template <typename T, typename... Candiates>
static constexpr size_t index_of_init_v =
GetIndexOfHelper<0, std::remove_const_t<std::remove_reference_t<T>>, std::remove_const_t<Candiates>...>::value;
template <bool IsTriviallyDesctructable, typename... Types>
class VariantBaseImpl;
template <typename... Types>
class VariantBaseImpl<true, Types...> : public VariantHold<true, Types...>
{
public:
using hold = VariantHold<true, Types...>;
static constexpr size_t size = VariantHold<false, Types...>::size;
CARB_VIZ size_t m_index;
constexpr VariantBaseImpl() noexcept : hold{}, m_index(variant_npos)
{
}
template <size_t I, class... Args>
constexpr VariantBaseImpl(in_place_index_t<I>, Args&&... args) noexcept
: hold{ in_place_index<I>, std::forward<Args>(args)... }, m_index(I)
{
}
constexpr size_t index() const
{
return m_index;
}
void destroy()
{
m_index = variant_npos;
}
};
template <typename... Types>
class VariantBaseImpl<false, Types...> : public VariantHold<false, Types...>
{
public:
static constexpr size_t size = VariantHold<false, Types...>::size;
using hold = VariantHold<false, Types...>;
CARB_VIZ size_t m_index;
constexpr VariantBaseImpl() noexcept : hold{}, m_index(variant_npos)
{
}
template <size_t I, class... Args>
constexpr VariantBaseImpl(in_place_index_t<I>, Args&&... args) noexcept
: hold{ in_place_index<I>, std::forward<Args>(args)... }, m_index(I)
{
}
constexpr size_t index() const
{
return m_index;
}
void destroy()
{
if (m_index != variant_npos)
{
detail::visitor(
[](auto& obj) {
using type = typename std::remove_reference<decltype(obj)>::type;
obj.~type();
},
*this);
}
m_index = variant_npos;
}
~VariantBaseImpl()
{
destroy();
}
};
template <typename... Types>
using VariantBase = VariantBaseImpl<conjunction<std::is_trivially_destructible<Types>...>::value, Types...>;
} // namespace detail
struct monostate
{
constexpr monostate()
{
}
};
constexpr bool operator==(monostate, monostate) noexcept
{
return true;
}
constexpr bool operator!=(monostate, monostate) noexcept
{
return false;
}
constexpr bool operator<(monostate, monostate) noexcept
{
return false;
}
constexpr bool operator>(monostate, monostate) noexcept
{
return false;
}
constexpr bool operator<=(monostate, monostate) noexcept
{
return true;
}
constexpr bool operator>=(monostate, monostate) noexcept
{
return true;
}
template <typename Type>
struct variant_alternative<0, variant<Type>>
{
using type = Type;
};
template <typename Type, typename... OtherTypes>
struct variant_alternative<0, variant<Type, OtherTypes...>>
{
using type = Type;
};
template <size_t I, typename Type, typename... OtherTypes>
struct variant_alternative<I, variant<Type, OtherTypes...>>
{
using type = typename variant_alternative<I - 1, variant<OtherTypes...>>::type;
};
template <std::size_t I, typename T>
using variant_alternative_t = typename variant_alternative<I, T>::type;
template <typename... Types>
class CARB_VIZ variant : public detail::VariantBase<Types...>
{
private:
using base = detail::VariantBase<Types...>;
using hold = typename base::hold;
using self_type = variant<Types...>;
public:
constexpr variant() noexcept : base(in_place_index_t<0>())
{
}
constexpr variant(const variant& other) noexcept
{
base::m_index = other.index();
if (base::m_index != variant_npos)
{
detail::visitor_same(
[](auto& dest, auto& src) {
using type = typename std::remove_reference<decltype(src)>::type;
new (&dest) type(src);
},
other.index(), *this, other);
base::m_index = other.index();
}
}
constexpr variant(variant&& other) noexcept
{
base::m_index = other.index();
if (base::m_index != variant_npos)
{
CARB_ASSERT(base::m_index < sizeof...(Types));
detail::visitor_same(
[](auto& dest, auto&& src) {
using type = typename std::remove_reference<decltype(src)>::type;
new (&dest) type(std::move(src));
},
other.index(), *this, other);
other.base::m_index = variant_npos;
}
}
template <class T>
constexpr variant(const T& value) noexcept : base{ in_place_index_t<detail::index_of_init_v<T, Types...>>(), value }
{
}
template <class T,
typename std::enable_if<!std::is_same<variant, std::remove_reference_t<std::remove_const_t<T>>>::value,
bool>::type = true>
constexpr variant(T&& value) noexcept
: base{ in_place_index_t<detail::index_of_init_v<T, Types...>>(), std::move(value) }
{
}
template <class T, class... Args>
constexpr explicit variant(in_place_type_t<T>, Args&&... args)
: base{ in_place_index_t<detail::index_of_init_v<T, Types...>>(), std::forward<Args>(args)... }
{
}
template <std::size_t I, class... Args>
constexpr explicit variant(in_place_index_t<I>, Args&&... args)
: base{ in_place_index_t<I>(), std::forward<Args>(args)... }
{
}
constexpr variant& operator=(const variant& rhs)
{
if (this != &rhs)
{
if (base::m_index != variant_npos)
{
base::destroy();
}
if (rhs.base::m_index != variant_npos)
{
detail::visitor_same(
[](auto& dest, auto& src) {
using type = typename std::remove_reference<decltype(src)>::type;
new (&dest) type(src);
},
rhs.index(), *this, rhs);
base::m_index = rhs.base::m_index;
}
}
return *this;
}
constexpr variant& operator=(variant&& rhs)
{
if (this == &rhs)
return *this;
if (base::m_index != variant_npos)
{
base::destroy();
}
base::m_index = rhs.base::m_index;
if (base::m_index != variant_npos)
{
CARB_ASSERT(base::m_index < sizeof...(Types));
detail::visitor_same(
[](auto& dest, auto&& src) {
using type = typename std::remove_reference<decltype(src)>::type;
new (&dest) type(std::move(src));
},
rhs.index(), *this, rhs);
rhs.base::m_index = variant_npos;
}
return *this;
}
template <class T,
typename std::enable_if<!std::is_same<variant, std::remove_reference_t<std::remove_const_t<T>>>::value,
bool>::type = true>
variant& operator=(T&& t) noexcept
{
constexpr size_t I = detail::index_of_init_v<T, Types...>;
using type = variant_alternative_t<I, self_type>;
type& v = detail::variant_get_from_hold<I>(*static_cast<hold*>(this));
if (index() == I)
{
v = std::move(t);
}
else
{
base::destroy();
new (&v) type(std::move(t));
base::m_index = I;
}
return *this;
}
constexpr bool valueless_by_exception() const noexcept
{
return base::m_index == variant_npos;
}
template <class T, class... Args>
auto emplace(Args&&... args) -> std::remove_const_t<std::remove_reference_t<T>>&
{
base::destroy();
using place_type = std::remove_const_t<std::remove_reference_t<T>>;
base::m_index = detail::index_of_v<place_type, Types...>;
return *(new (&detail::variant_get_from_hold<detail::index_of_v<T, Types...>>(static_cast<hold&>(*this)))
place_type(std::forward<Args>(args)...));
}
constexpr std::size_t index() const noexcept
{
return base::m_index;
}
};
template <class T, class... Types>
constexpr bool holds_alternative(const variant<Types...>& v) noexcept
{
return v.index() == detail::index_of_v<T, Types...>;
}
template <std::size_t I, class... Types>
constexpr std::add_pointer_t<variant_alternative_t<I, variant<Types...>>> get_if(variant<Types...>* pv) noexcept
{
return (pv && I == pv->index()) ? &detail::variant_get_from_hold<I>(*pv) : nullptr;
}
template <std::size_t I, class... Types>
constexpr std::add_pointer_t<const variant_alternative_t<I, variant<Types...>>> get_if(const variant<Types...>* pv) noexcept
{
return (pv && I == pv->index()) ? &detail::variant_get_from_hold<I>(*pv) : nullptr;
}
template <class T, class... Types>
constexpr std::add_pointer_t<T> get_if(variant<Types...>* pv) noexcept
{
return get_if<detail::index_of_v<T, Types...>>(pv);
}
template <class T, class... Types>
constexpr std::add_pointer_t<const T> get_if(const variant<Types...>* pv) noexcept
{
return get_if<detail::index_of_v<T, Types...>>(pv);
}
// Don't support moves yet...
template <std::size_t I, class... Types>
constexpr variant_alternative_t<I, variant<Types...>>& get(variant<Types...>& v)
{
auto o = get_if<I>(&v);
if (o)
{
return *o;
}
detail::on_bad_variant_access();
}
template <std::size_t I, class... Types>
constexpr const variant_alternative_t<I, variant<Types...>>& get(const variant<Types...>& v)
{
auto o = get_if<I>(&v);
if (o)
{
return *o;
}
detail::on_bad_variant_access();
}
template <class T, class... Types>
constexpr T& get(variant<Types...>& v)
{
auto o = get_if<T>(&v);
if (o)
{
return *o;
}
detail::on_bad_variant_access();
}
template <class T, class... Types>
constexpr const T& get(const variant<Types...>& v)
{
auto o = get_if<T>(&v);
if (o)
{
return *o;
}
detail::on_bad_variant_access();
}
// Comparison
template <class... Types>
constexpr bool operator==(const variant<Types...>& v, const variant<Types...>& w)
{
return v.index() == w.index() &&
detail::visitor_same([](const auto& a, const auto& b) { return a == b; }, v.index(), v, w);
}
template <class... Types>
constexpr bool operator!=(const variant<Types...>& v, const variant<Types...>& w)
{
return v.index() != w.index() ||
detail::visitor_same([](const auto& a, const auto& b) { return a != b; }, v.index(), v, w);
}
template <class... Types>
constexpr bool operator<(const variant<Types...>& v, const variant<Types...>& w)
{
// If w.valueless_by_exception(), false; otherwise if v.valueless_by_exception(), true
if (w.valueless_by_exception())
return false;
if (v.valueless_by_exception())
return true;
return v.index() < w.index() ||
(v.index() == w.index() &&
detail::visitor_same([](const auto& a, const auto& b) { return a < b; }, v.index(), v, w));
}
template <class... Types>
constexpr bool operator>(const variant<Types...>& v, const variant<Types...>& w)
{
// If v.valueless_by_exception(), false; otherwise if w.valueless_by_exception(), true
if (v.valueless_by_exception())
return false;
if (w.valueless_by_exception())
return true;
return v.index() > w.index() ||
(v.index() == w.index() &&
detail::visitor_same([](const auto& a, const auto& b) { return a > b; }, v.index(), v, w));
}
template <class... Types>
constexpr bool operator<=(const variant<Types...>& v, const variant<Types...>& w)
{
// If v.valueless_by_exception(), true; otherwise if w.valueless_by_exception(), false
if (v.valueless_by_exception())
return true;
if (w.valueless_by_exception())
return false;
return v.index() < w.index() ||
(v.index() == w.index() &&
detail::visitor_same([](const auto& a, const auto& b) { return a <= b; }, v.index(), v, w));
}
template <class... Types>
constexpr bool operator>=(const variant<Types...>& v, const variant<Types...>& w)
{
// If w.valueless_by_exception(), true; otherwise if v.valueless_by_exception(), false
if (w.valueless_by_exception())
return true;
if (v.valueless_by_exception())
return false;
return v.index() > w.index() ||
(v.index() == w.index() &&
detail::visitor_same([](const auto& a, const auto& b) { return a >= b; }, v.index(), v, w));
}
// Currently we only support one Variant and not a list.
template <class Visitor, class... Variants>
constexpr decltype(auto) visit(Visitor&& vis, Variants&&... variants)
{
return detail::visitor(std::forward<Visitor>(vis), std::forward<Variants>(variants)...);
}
} // namespace cpp
} // namespace carb
namespace std
{
template <>
struct hash<carb::cpp::monostate>
{
CARB_NODISCARD size_t operator()(const carb::cpp::monostate&) const
{
// Just return something reasonable, there is not state with monostate.
// This is just a random hex value.
return 0x5f631327531c2962ull;
}
};
template <typename... Types>
struct hash<carb::cpp::variant<Types...>>
{
CARB_NODISCARD size_t operator()(const carb::cpp::variant<Types...>& vis) const
{
// Valueless
if (vis.index() == carb::cpp::variant_npos)
{
return 0;
}
return carb::hashCombine(std::hash<size_t>{}(vis.index()), carb::cpp::visit(
// Invoking dohash directly is a compile
// error.
[](const auto& s) { return dohash(s); }, vis));
}
private:
// This is a simple way to remove the C-Ref qualifiers.
template <class T>
static size_t dohash(const T& t)
{
return std::hash<T>{}(t);
}
};
} // namespace std
| 37,739 | C | 30.45 | 124 | 0.556321 |
omniverse-code/kit/include/carb/cpp/Latch.h | // Copyright (c) 2019-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<latch>` library.
#pragma once
#include "Atomic.h"
#include <algorithm>
#include <thread>
namespace carb
{
namespace cpp
{
// Handle case where Windows.h may have defined 'max'
#pragma push_macro("max")
#undef max
/**
* Implements a C++20 latch in C++14 semantics.
*
* The latch class is a downward counter of type @c std::ptrdiff_t which can be used to synchronize threads. The value
* of the counter is initialized on creation. Threads may block on the latch until the counter is decremented to zero.
* There is no possibility to increase or reset the counter, which makes the latch a single-use @ref barrier.
*
* @thread_safety Concurrent invocations of the member functions of @c latch, except for the destructor, do not
* introduce data races.
*
* Unlike @ref barrier, @c latch can be decremented by a participating thread more than once.
*/
class latch
{
CARB_PREVENT_COPY_AND_MOVE(latch);
public:
/**
* The maximum value of counter supported by the implementation
* @returns The maximum value of counter supported by the implementation.
*/
static constexpr ptrdiff_t max() noexcept
{
return ptrdiff_t(UINT_MAX);
}
/**
* Constructor
*
* Constructs a latch and initializes its internal counter. The behavior is undefined if @p expected is negative or
* greater than @ref max().
* @param expected The initial value of the internal counter.
*/
constexpr explicit latch(ptrdiff_t expected) noexcept : m_counter(uint32_t(::carb_min(max(), expected)))
{
CARB_ASSERT(expected >= 0 && expected <= max());
}
/**
* Destructor
*
* The behavior is undefined if any thread is concurrently calling a member function of the latch.
*
* @note This implementation waits until all waiting threads have woken, but this is a stronger guarantee than the
* standard.
*/
~latch() noexcept
{
// Wait until we have no waiters
while (m_waiters.load(std::memory_order_acquire) != 0)
std::this_thread::yield();
}
/**
* Decrements the counter in a non-blocking manner
*
* Atomically decrements the internal counter by @p update without blocking the caller. If the count reaches zero,
* all blocked threads are unblocked.
*
* If @p update is greater than the value of the internal counter or is negative, the behavior is undefined.
*
* This operation strongly happens-before all calls that are unblocked on this latch.
*
* @param update The value by which the internal counter is decreased.
* @throws std::system_error According to the standard, but this implementation does not throw. Instead an assertion
* occurs.
*/
void count_down(ptrdiff_t update = 1) noexcept
{
CARB_ASSERT(update >= 0);
// `fetch_sub` returns value before operation
uint32_t count = m_counter.fetch_sub(uint32_t(update), std::memory_order_release);
CARB_CHECK((count - uint32_t(update)) <= count); // Malformed if we go below zero or overflow
if ((count - uint32_t(update)) == 0)
{
// Wake all waiters
m_counter.notify_all();
}
}
// Returns whether the latch has completed. Allowed to return spuriously false with very low probability.
/**
* Tests if the internal counter equals zero
*
* Returns @c true only if the internal counter has reached zero. This function may spuriously return @c false with
* very low probability even if the internal counter has reached zero.
*
* @note The reason why a spurious result is permitted is to allow implementations to use a memory order more
* relaxed than @c std::memory_order_seq_cst.
*
* @return With very low probability @c false, otherwise `cnt == 0` where `cnt` is the value of the internal
* counter.
*/
bool try_wait() const noexcept
{
return m_counter.load(std::memory_order_acquire) == 0;
}
/**
* Blocks until the counter reaches zero
*
* Blocks the calling thread until the internal counter reaches zero. If it is zero already, returns immediately.
* @throws std::system_error According to the standard, but this implementation does not throw.
*/
void wait() const noexcept
{
uint32_t count = m_counter.load(std::memory_order_acquire);
if (count != 0)
{
// Register as a waiter
m_waiters.fetch_add(1, std::memory_order_relaxed);
_wait(count);
}
}
/**
* Decrements the counter and blocks until it reaches zero
*
* Atomically decrements the internal counter by @p update and (if necessary) blocks the calling thread until the
* counter reaches zero. Equivalent to `count_down(update); wait();`.
*
* If @p update is greater than the value of the internal counter or is negative, the behavior is undefined.
*
* @param update The value by which the internal counter is decreased.
* @throws std::system_error According to the standard, but this implementation does not throw. Instead an assertion
* occurs.
*/
void arrive_and_wait(ptrdiff_t update = 1) noexcept
{
uint32_t original = m_counter.load(std::memory_order_acquire);
if (original == uint32_t(update))
{
// We're the last and won't be waiting.
#if CARB_ASSERT_ENABLED
uint32_t updated = m_counter.exchange(0, std::memory_order_release);
CARB_ASSERT(updated == original);
#else
m_counter.store(0, std::memory_order_release);
#endif
// Wake all waiters
m_counter.notify_all();
return;
}
// Speculatively register as a waiter
m_waiters.fetch_add(1, std::memory_order_relaxed);
original = m_counter.fetch_sub(uint32_t(update), std::memory_order_release);
if (CARB_UNLIKELY(original == uint32_t(update)))
{
// Wake all waiters and unregister as a waiter
m_counter.notify_all();
m_waiters.fetch_sub(1, std::memory_order_release);
}
else
{
CARB_CHECK(original >= uint32_t(update)); // Malformed if we underflow
_wait(original - uint32_t(update));
}
}
private:
mutable atomic_uint32_t m_counter;
mutable atomic_uint32_t m_waiters{ 0 };
CARB_ALWAYS_INLINE void _wait(uint32_t count) const noexcept
{
CARB_ASSERT(count != 0);
do
{
m_counter.wait(count, std::memory_order_relaxed);
count = m_counter.load(std::memory_order_acquire);
} while (count != 0);
// Done waiting
m_waiters.fetch_sub(1, std::memory_order_release);
}
};
#pragma pop_macro("max")
} // namespace cpp
} // namespace carb
| 7,433 | C | 33.901408 | 120 | 0.64698 |
omniverse-code/kit/include/carb/cpp/StdDef.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<cstddef>` library.
#pragma once
#include "TypeTraits.h"
namespace carb
{
namespace cpp
{
//! A byte is a distinct type that implements the concept of byte as specified in the C++ language definition.
//! Like `char` and `unsigned char`, it can be used to access raw memory occupied by other objects, but unlike those
//! types it is not a character type and is not an arithmetic type. A byte is only a collection of bits, and only
//! bitwise operators are defined for it.
enum class byte : unsigned char
{
};
#ifndef DOXYGEN_BUILD
template <class IntegerType, std::enable_if_t<std::is_integral<IntegerType>::value, bool> = false>
constexpr IntegerType to_integer(byte b) noexcept
{
return static_cast<IntegerType>(b);
}
constexpr byte operator|(byte l, byte r) noexcept
{
return byte(static_cast<unsigned char>(l) | static_cast<unsigned char>(r));
}
constexpr byte operator&(byte l, byte r) noexcept
{
return byte(static_cast<unsigned char>(l) & static_cast<unsigned char>(r));
}
constexpr byte operator^(byte l, byte r) noexcept
{
return byte(static_cast<unsigned char>(l) ^ static_cast<unsigned char>(r));
}
constexpr byte operator~(byte b) noexcept
{
return byte(~static_cast<unsigned char>(b));
}
template <class IntegerType, std::enable_if_t<std::is_integral<IntegerType>::value, bool> = false>
constexpr byte operator<<(byte b, IntegerType shift) noexcept
{
return byte(static_cast<unsigned char>(b) << shift);
}
template <class IntegerType, std::enable_if_t<std::is_integral<IntegerType>::value, bool> = false>
constexpr byte operator>>(byte b, IntegerType shift) noexcept
{
return byte(static_cast<unsigned char>(b) >> shift);
}
template <class IntegerType, std::enable_if_t<std::is_integral<IntegerType>::value, bool> = false>
constexpr byte& operator<<=(byte& b, IntegerType shift) noexcept
{
b = b << shift;
return b;
}
template <class IntegerType, std::enable_if_t<std::is_integral<IntegerType>::value, bool> = false>
constexpr byte& operator>>=(byte& b, IntegerType shift) noexcept
{
b = b >> shift;
return b;
}
constexpr byte& operator|=(byte& l, byte r) noexcept
{
l = l | r;
return l;
}
constexpr byte& operator&=(byte& l, byte r) noexcept
{
l = l & r;
return l;
}
constexpr byte& operator^=(byte& l, byte r) noexcept
{
l = l ^ r;
return l;
}
#endif
} // namespace cpp
} // namespace carb
| 2,914 | C | 27.028846 | 116 | 0.713452 |
omniverse-code/kit/include/carb/cpp/Exception.h | // Copyright (c) 2021-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<exception>` library.
#pragma once
#include "../Defines.h"
#include <exception>
#if CARB_PLATFORM_LINUX
# include <cxxabi.h>
# include <cstring>
#elif CARB_PLATFORM_WINDOWS
# include <cstring>
extern "C"
{
void* __cdecl _getptd(void);
}
#endif
// __cpp_lib_uncaught_exceptions -> https://en.cppreference.com/w/User:D41D8CD98F/feature_testing_macros
// Visual Studio 14.0+ supports N4152 std::uncaught_exceptions() but doesn't define __cpp_lib_uncaught_exceptions
#if (defined(__cpp_lib_uncaught_exceptions) && __cpp_lib_uncaught_exceptions >= 201411) || \
(defined(_MSC_VER) && _MSC_VER >= 1900)
# define CARB_HAS_UNCAUGHT_EXCEPTIONS 1
#else
# define CARB_HAS_UNCAUGHT_EXCEPTIONS 0
#endif
namespace carb
{
namespace cpp
{
//
// various ways to backport this, mainly come from accessing the systems thread local data and knowing
// the exact offset the exception count is stored in.
//
// * https://beta.boost.org/doc/libs/develop/boost/core/uncaught_exceptions.hpp
// * https://github.com/facebook/folly/blob/master/folly/lang/UncaughtExceptions.h
// * https://github.com/bitwizeshift/BackportCpp/blob/master/include/bpstd/exception.hpp
//
inline int uncaught_exceptions() noexcept
{
#if CARB_HAS_UNCAUGHT_EXCEPTIONS
return static_cast<int>(std::uncaught_exceptions());
#elif CARB_PLATFORM_LINUX
using byte = unsigned char;
int count{};
// __cxa_eh_globals::uncaughtExceptions, x32 offset - 0x4, x64 - 0x8
const auto* ptr = reinterpret_cast<const byte*>(::abi::__cxa_get_globals()) + sizeof(void*);
std::memcpy(&count, ptr, sizeof(count));
return count;
#elif CARB_PLATFORM_WINDOWS
using byte = unsigned char;
int count{};
const auto offset = (sizeof(void*) == 8u ? 0x100 : 0x90);
const auto* ptr = static_cast<const byte*>(::_getptd()) + offset;
// _tiddata::_ProcessingThrow, x32 offset - 0x90, x64 - 0x100
std::memcpy(&count, ptr, sizeof(count));
return count;
#else
// return C++11/14 uncaught_exception() is basically broken for any nested exceptions
// as only going from 0 exceptions to 1 exception will be detected
return static_cast<int>(std::uncaught_exception());
#endif
}
} // namespace cpp
} // namespace carb
| 2,777 | C | 33.725 | 120 | 0.707238 |
omniverse-code/kit/include/carb/cpp/Span.h | // Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
//! \file
//! \brief C++14-compatible implementation of select functionality from C++ `<span>` library.
#pragma once
#include "../Defines.h"
#include "TypeTraits.h"
#include "detail/ImplData.h"
#include "StdDef.h"
#include "../../omni/detail/PointerIterator.h"
#include <array>
namespace carb
{
namespace cpp
{
//! A constant of type size_t that is used to differentiate carb::cpp::span of static and dynamic extent
//! @see span
constexpr size_t dynamic_extent = size_t(-1);
template <class T, size_t Extent>
class span;
//! \cond DEV
namespace detail
{
template <class T>
constexpr T* to_address(T* p) noexcept
{
static_assert(!std::is_function<T>::value, "Ill-formed if T is function type");
return p;
}
template <class Ptr, std::enable_if_t<std::is_pointer<decltype(std::declval<Ptr>().operator->())>::value, bool> = false>
constexpr auto to_address(const Ptr& p) noexcept
{
return to_address(p.operator->());
}
template <size_t Extent, size_t Offset, size_t Count>
struct DetermineSubspanExtent
{
constexpr static size_t value = Count;
};
template <size_t Extent, size_t Offset>
struct DetermineSubspanExtent<Extent, Offset, dynamic_extent>
{
constexpr static size_t value = Extent - Offset;
};
template <size_t Offset>
struct DetermineSubspanExtent<dynamic_extent, Offset, dynamic_extent>
{
constexpr static size_t value = dynamic_extent;
};
template <class T>
struct IsStdArray : public std::false_type
{
};
template <class T, size_t N>
struct IsStdArray<std::array<T, N>> : public std::true_type
{
};
template <class T>
struct IsSpan : public std::false_type
{
};
template <class T, size_t N>
struct IsSpan<span<T, N>> : public std::true_type
{
};
// GCC instantiates some functions always so they cannot use static_assert, but throwing an exception is allowed from a
// constexpr function (which will act as a compile failure if constexpr) so fall back to that.
#if CARB_EXCEPTIONS_ENABLED
# define CARB_ALWAYS_FAIL(msg) throw std::out_of_range(msg)
# define CARB_THROW_OR_CHECK(check, msg) \
if (!CARB_LIKELY(check)) \
throw std::out_of_range(msg)
#else
# define CARB_THROW_OR_CHECK(check, msg) CARB_CHECK((check), msg)
# if CARB_COMPILER_MSC
# define CARB_ALWAYS_FAIL(msg) static_assert(false, msg)
# else
# define CARB_ALWAYS_FAIL(msg) CARB_FATAL_UNLESS(false, msg)
# endif
#endif
} // namespace detail
//! \endcond
/**
* An object that refers to a contiguous sequence of objects.
*
* The class template span describes an object that can refer to a contiguous sequence of objects with the first element
* of the sequence at position zero. A span can either have a \a static extent, in which case the number of elements in
* the sequence is known at compile-time and encoded in the type, or a \a dynamic extent.
*
* If a span has \a dynamic extent, this implementation holds two members: a pointer to T and a size. A span with
* \a static extent has only one member: a pointer to T.
*
* Every specialization of \c span is a \a TriviallyCopyable type.
*
* This implementation of \c span is a C++14-compatible implementation of the
* [C++20 std::span](https://en.cppreference.com/w/cpp/container/span), as such certain constructors that involve
* `ranges` or `concepts` are either not implemented or are implemented using C++14 paradigms.
*
* This implementation of \c span is a guaranteed @rstref{ABI- and interop-safe <abi-compatibility>} type.
*
* @note For function definitions below the following definitions are used: An ill-formed program will generate a
* compiler error via `static_assert`. Undefined behavior is typically signaled by throwing a `std::out_of_range`
* exception as this is allowed for `constexpr` functions to cause a compiler error, however, if exceptions are
* disabled a \ref CARB_CHECK will occur (this also disables `constexpr` as \ref CARB_CHECK is not `constexpr`).
* @tparam T Element type; must be a complete object type that is not an abstract class type
* @tparam Extent The number of elements in the sequence, or \ref dynamic_extent if dynamic
*/
template <class T, size_t Extent = dynamic_extent>
class span
{
// NOTE: This implementation is used for Extent != 0 && Extent != dynamic_extent, both of which have specializations
public:
using element_type = T; //!< The element type `T`
using value_type = std::remove_cv_t<T>; //!< The value type; const/volatile is removed from `T`
using size_type = std::size_t; //!< The size type `size_t`
using difference_type = std::ptrdiff_t; //!< The difference type `ptrdiff_t`
using pointer = T*; //!< The pointer type `T*`
using const_pointer = const T*; //!< The const pointer type `const T*`
using reference = T&; //!< The reference type `T&`
using const_reference = const T&; //!< The const reference type `const T&`
//! The iterator type \ref omni::detail::PointerIterator
using iterator = omni::detail::PointerIterator<pointer, span>;
//! The reverse iterator type `std::reverse_iterator<iterator>`
using reverse_iterator = std::reverse_iterator<iterator>;
//! The number of elements in the sequence, or \ref dynamic_extent if dynamic
constexpr static std::size_t extent = Extent;
#ifdef DOXYGEN_BUILD
//! Default constructor
//!
//! Constructs an empty span whose \ref data() is `nullptr` and \ref size() is `0`. This constructor participates in
//! overload resolution only if `extent == 0 || extent == dynamic_extent`.
constexpr span() noexcept
{
}
#endif
//! Constructs a \ref span that is a view over the range `[first, first + count)`.
//!
//! Behavior is undefined if `count != extent` (for static extent) or \p first does not model `contiguous_iterator`.
//! However, since `contiguous_iterator` is not available until C++20, instead this function does not participate in
//! overload resolution unless `std::iterator_traits<It>::iterator_category == std::random_access_iterator_tag`.
//! @param first An iterator or pointer type that models C++20 `contiguous_iterator`
//! @param count The number of elements from \p first to include in the span. If `extent != dynamic_extent` then
//! this must match \ref extent.
template <class It CARB_NO_DOC(
,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false)>
constexpr explicit span(It first, size_type count)
{
CARB_THROW_OR_CHECK(extent == count, "Behavior is undefined if count != extent");
m_p = detail::to_address(first);
}
//! Constructs a \ref span that is a view over the range `[first, last)`.
//!
//! Behavior is undefined if `(last - first) != extent` (for static extent) or if `[first, last)` does not represent
//! a contiguous range. This function differs significantly from the C++20 definition since the concepts of
//! `contiguous_iterator` and `sized_sentinel_for` are not available. Since these concepts are not available until
//! C++20, instead this function does not participate in overload resolution unless
//! `std::iterator_traits<It>::iterator_category == std::random_access_iterator_tag`. Also \p first and \p last must
//! be a matching iterator type.
//! @param first An iterator or pointer type that represents the first element in the span.
//! @param last An iterator or pointer type that represents the past-the-end element in the span.
template <class It CARB_NO_DOC(
,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false)>
constexpr explicit span(It first, It last)
{
CARB_THROW_OR_CHECK((last - first) == extent, "Behavior is undefined if (last - first) != extent");
m_p = detail::to_address(first);
}
//! Constructs a span that is a view over an array.
//!
//! Behavior is undefined if `extent != dynamic_extent && N != extent`.
//! @param arr The array to view
template <std::size_t N>
constexpr span(type_identity_t<element_type> (&arr)[N]) noexcept
{
static_assert(N == extent, "Undefined if N != extent");
m_p = cpp::data(arr);
}
//! Constructs a span that is a view over an array.
//!
//! Behavior is undefined if `extent != dynamic_extent && N != extent`.
//! @param arr The array to view
template <class U, std::size_t N CARB_NO_DOC(, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false)>
constexpr span(std::array<U, N>& arr) noexcept
{
static_assert(N == extent, "Undefined if N != extent");
m_p = cpp::data(arr);
}
//! Constructs a span that is a view over an array.
//!
//! Behavior is undefined if `extent != dynamic_extent && N != extent`.
//! @param arr The array to view
template <class U, std::size_t N CARB_NO_DOC(, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false)>
constexpr span(const std::array<U, N>& arr) noexcept
{
static_assert(N == extent, "Undefined if N != extent");
m_p = cpp::data(arr);
}
// template< class R >
// explicit(extent != dynamic_extent)
// constexpr span( R&& range );
// (Constructor not available without ranges, but approximate constructor follows)
//! Constructs a span that is a view over a range.
//!
//! The behavior is undefined if any of the following are true:
//! * `R` does not actually model `contiguous_range` and `sized_range`
//! * if `R` does not model `borrowed_range` while `element_type` is non-const
//! * `extent` is not `dynamic_extent` and the size of the range != `extent`
//!
//! @tparam R A range type. Since this implementation is for pre-C++20 and ranges are not available, this is an
//! approximation of a `range`: This type must have `data()` and `size()` member functions that must be
//! convertible to the \ref pointer and \ref size_type types respectively.
//! @param range The range to view. Behavior is undefined if `[range.data(), range.data() + range.size())` is not a
//! contiguous range or cannot be borrowed (i.e. it is a temporary that will expire leaving a danging pointer).
template <class R CARB_NO_DOC(
,
std::enable_if_t<detail::IsConvertibleRange<cpp::remove_cvref_t<R>, pointer>::value &&
// These types have a separate constructor
!detail::IsStdArray<cpp::remove_cvref_t<R>>::value &&
!detail::IsSpan<cpp::remove_cvref_t<R>>::value && !std::is_array<cpp::remove_cvref_t<R>>::value,
bool> = false)>
constexpr explicit span(R&& range)
{
CARB_THROW_OR_CHECK(range.size() == extent, "Behavior is undefined if R.size() != extent");
m_p = range.data();
}
#ifndef DOXYGEN_BUILD
template <class U,
std::size_t N,
std::enable_if_t<N == dynamic_extent && std::is_convertible<U, element_type>::value, bool> = false>
constexpr explicit span(const span<U, N>& source) noexcept : m_p(source.data())
{
CARB_CHECK(source.size() == extent); // specified as `noexcept` so we cannot throw
}
template <class U,
std::size_t N,
std::enable_if_t<N != dynamic_extent && std::is_convertible<U, element_type>::value, bool> = false>
#else
//! Converting constructor from another span.
//!
//! Behavior is undefined if `extent != dynamic_extent && source.size() != extent`.
//! @tparam U `element_type` of \p source; must be convertible to `element_type`
//! @tparam N `extent` of \p source
//! @param source The span to convert from
template <class U, std::size_t N>
#endif
constexpr span(const span<U, N>& source) noexcept : m_p(source.data())
{
static_assert(N == extent, "Undefined if N != extent");
}
//! Copy constructor
//! @param other A span to copy from
constexpr span(const span& other) noexcept = default;
//! Assignment operator
//!
//! @param other A span to copy from
//! @returns *this
constexpr span& operator=(const span& other) noexcept = default;
//! Returns an iterator to the first element of the span.
//!
//! If the span is empty, the returned iterator will be equal to \ref end().
//! @returns an \ref iterator to the first element of the span
constexpr iterator begin() const noexcept
{
return iterator(m_p);
}
//! Returns an iterator to the element following the last element of the span.
//!
//! This element acts as a placeholder; attempting to access it results in undefined behavior.
//! @returns an \ref iterator to the element following the last element of the span
constexpr iterator end() const noexcept
{
return iterator(m_p + extent);
}
//! Returns a reverse iterator to the first element of the reversed span.
//!
//! It corresponds to the last element of the non-reversed span. If the span is empty, the returned iterator is
//! equal to \ref rend().
//! @returns a \ref reverse_iterator to the first element of the reversed span
constexpr reverse_iterator rbegin() const noexcept
{
return reverse_iterator(end());
}
//! Reverse a reverse iterator to the element following the last element of the reversed span.
//!
//! It corresponds to the element preceding the first element of the non-reversed span. This element acts as a
//! placeholder, attempting to access it results in undefined behavior.
//! @returns a \ref reverse_iterator to the element following the last element of the reversed span
constexpr reverse_iterator rend() const noexcept
{
return reverse_iterator(begin());
}
//! Returns a reference to the first element in the span.
//!
//! Calling this on an empty span results in undefined behavior.
//! @returns a reference to the first element
constexpr reference front() const
{
return *m_p;
}
//! Returns a reference to the last element in a span.
//!
//! Calling this on an empty span results in undefined behavior.
//! @returns a reference to the last element
constexpr reference back() const
{
return m_p[extent - 1];
}
//! Returns a reference to the element in the span at the given index.
//!
//! The behavior is undefined if \p index is out of range (i.e. if it is greater than or equal to \ref size() or
//! the span is \ref empty()).
//! @param index The index of the element to access
//! @returns a reference to the element at position \p index
constexpr reference operator[](size_type index) const
{
CARB_THROW_OR_CHECK(index < extent, "Behavior is undefined when index exceeds size()");
return m_p[index];
}
//! Returns a pointer to the beginning of the sequence.
//! @returns a pointer to the beginning of the sequence
constexpr pointer data() const noexcept
{
return m_p;
}
//! Returns the number of elements in the span.
//! @returns the number of elements in the span
constexpr size_type size() const noexcept
{
return extent;
}
//! Returns the size of the sequence in bytes.
//! @returns the size of the sequence in bytes
constexpr size_type size_bytes() const noexcept
{
return sizeof(element_type) * extent;
}
//! Checks if the span is empty.
//! @returns \c true if the span is empty (i.e. \ref size() == 0); \c false otherwise
CARB_NODISCARD constexpr bool empty() const noexcept
{
return false;
}
//! Obtains a subspan consisting of the first N elements of the sequence.
//!
//! The program is ill-formed if `Count > extent`. The behavior is undefined if `Count > size()`.
//! @tparam Count the number of elements of the subspan
//! @returns a span that is a view over the first `Count` elements of `*this`
template <std::size_t Count>
constexpr span<element_type, Count> first() const
{
static_assert(Count <= extent, "Program ill-formed if Count > extent");
return span<element_type, Count>{ m_p, Count };
}
//! Obtains a subspan consisting of the first N elements of the sequence.
//!
//! The program is ill-formed if `Count > extent`. The behavior is undefined if `Count > size()`.
//! @param Count the number of elements of the subspan
//! @returns a span of dynamic extent that is a view over the first `Count` elements of `*this`
constexpr span<element_type, dynamic_extent> first(size_type Count) const
{
CARB_THROW_OR_CHECK(Count <= extent, "Program ill-formed if Count > extent");
return span<element_type, dynamic_extent>{ m_p, Count };
}
//! Obtains a subspan consisting of the last N elements of the sequence.
//!
//! The program is ill-formed if `Count > Extent`. The behavior is undefined if `Count > size()`.
//! @tparam Count the number of elements of the subspan
//! @returns a span that is a view over the last `Count` elements of `*this`
template <std::size_t Count>
constexpr span<element_type, Count> last() const
{
static_assert(Count <= extent, "Program ill-formed if Count > extent");
return span<element_type, Count>{ m_p + (extent - Count), Count };
}
//! Obtains a subspan consisting of the last N elements of the sequence.
//!
//! The program is ill-formed if `Count > extent`. The behavior is undefined if `Count > size()`.
//! @param Count the number of elements of the subspan
//! @returns a span of dynamic extent that is a view over the last `Count` elements of `*this`
constexpr span<element_type, dynamic_extent> last(size_type Count) const
{
CARB_THROW_OR_CHECK(Count <= extent, "Program ill-formed if Count > extent");
return span<element_type, dynamic_extent>{ m_p + (extent - Count), Count };
}
//! Obtains a subspan that is a view over Count elements of this span starting at Offset.
//!
//! If `Count` is \ref dynamic_extent, the number of elements in the subspan is \ref size() - `Offset` (i.e. it ends
//! at the end of `*this`).
//! Ill-formed if `Offset` is greater than \ref extent, or `Count` is not \ref dynamic_extent and `Count` is greater
//! than \ref extent - `Offset`.
//! Behavior is undefined if either `Offset` or `Count` is out of range. This happens if `Offset` is greater than
//! \ref size(), or `Count` is not \ref dynamic_extent and `Count` is greater than \ref size() - `Offset`.
//! The \ref extent of the returned span is determined as follows: if `Count` is not \ref dynamic_extent, `Count`;
//! otherwise, if `Extent` is not \ref dynamic_extent, `Extent - Offset`; otherwise \ref dynamic_extent.
//! @tparam Offset The offset within `*this` to start the subspan
//! @tparam Count The length of the subspan, or \ref dynamic_extent to indicate the rest of the span.
//! @returns A subspan of the given range
template <std::size_t Offset, std::size_t Count = dynamic_extent>
constexpr span<element_type, detail::DetermineSubspanExtent<extent, Offset, Count>::value> subspan() const
{
static_assert(Offset <= extent, "Ill-formed");
static_assert(Count == dynamic_extent || (Offset + Count) <= extent, "Ill-formed");
return span<element_type, detail::DetermineSubspanExtent<extent, Offset, Count>::value>{
data() + Offset, carb_min(size() - Offset, Count)
};
}
//! Obtains a subspan that is a view over Count elements of this span starting at Offset.
//!
//! If \p Count is \ref dynamic_extent, the number of elements in the subspan is \ref size() - `Offset` (i.e. it
//! ends at the end of `*this`).
//! Behavior is undefined if either \p Offset or \p Count is out of range. This happens if \p Offset is greater than
//! \ref size(), or \p Count is not \ref dynamic_extent and \p Count is greater than \ref size() - \p Offset.
//! The extent of the returned span is always \ref dynamic_extent.
//! @param Offset The offset within `*this` to start the subspan
//! @param Count The length of the subspan, or \ref dynamic_extent to indicate the rest of the span.
//! @returns A subspan of the given range
constexpr span<element_type, dynamic_extent> subspan(size_type Offset, size_type Count = dynamic_extent) const
{
CARB_THROW_OR_CHECK(Offset <= extent, "Program ill-formed if Offset > extent");
CARB_THROW_OR_CHECK(Count == dynamic_extent || (Offset + Count) <= extent,
"Program ill-formed if Count is not dynamic_extent and is greater than Extent - Offset");
return { data() + Offset, carb_min(size() - Offset, Count) };
}
private:
pointer m_p;
};
CARB_ASSERT_INTEROP_SAFE(span<int, 1>);
// Doxygen can ignore the specializations
#ifndef DOXYGEN_BUILD
// Specialization for dynamic_extent
template <class T>
class span<T, dynamic_extent>
{
// NOTE: This specialization is for Extent == dynamic_extent
public:
using element_type = T;
using value_type = std::remove_cv_t<T>;
using size_type = std::size_t;
using difference_type = std::ptrdiff_t;
using pointer = T*;
using const_pointer = const T*;
using reference = T&;
using const_reference = const T&;
using iterator = omni::detail::PointerIterator<pointer, span>;
using reverse_iterator = std::reverse_iterator<iterator>;
constexpr static std::size_t extent = dynamic_extent;
constexpr span() noexcept : m_p(nullptr), m_size(0)
{
}
template <class It,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false>
constexpr span(It first, size_type count)
{
m_p = detail::to_address(first);
m_size = count;
}
template <class It,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false>
constexpr span(It first, It last)
{
m_p = detail::to_address(first);
m_size = last - first;
}
template <std::size_t N>
constexpr span(type_identity_t<element_type> (&arr)[N]) noexcept
{
m_p = cpp::data(arr);
m_size = N;
}
template <class U, std::size_t N, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false>
constexpr span(std::array<U, N>& arr) noexcept
{
m_p = cpp::data(arr);
m_size = N;
}
template <class U, std::size_t N, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false>
constexpr span(const std::array<U, N>& arr) noexcept
{
m_p = cpp::data(arr);
m_size = N;
}
// template< class R >
// explicit(extent != dynamic_extent)
// constexpr span( R&& range );
// (Constructor not available without ranges, but approximate constructor follows)
template <class R,
std::enable_if_t<detail::IsConvertibleRange<cpp::remove_cvref_t<R>, pointer>::value &&
!detail::IsStdArray<cpp::remove_cvref_t<R>>::value && // has separate constructor
!detail::IsSpan<cpp::remove_cvref_t<R>>::value && // has separate constructor
!std::is_array<cpp::remove_cvref_t<R>>::value, // has separate constructor
bool> = false>
constexpr span(R&& range)
{
m_p = range.data();
m_size = range.size();
}
template <class U, std::size_t N, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false>
constexpr span(const span<U, N>& source) noexcept
{
m_p = source.data();
m_size = source.size();
}
constexpr span(const span& other) noexcept = default;
constexpr span& operator=(const span& other) noexcept = default;
constexpr iterator begin() const noexcept
{
return iterator(m_p);
}
constexpr iterator end() const noexcept
{
return iterator(m_p + m_size);
}
constexpr reverse_iterator rbegin() const noexcept
{
return reverse_iterator(end());
}
constexpr reverse_iterator rend() const noexcept
{
return reverse_iterator(begin());
}
constexpr reference front() const
{
CARB_THROW_OR_CHECK(!empty(), "Behavior is undefined when calling front() on an empty span");
return *m_p;
}
constexpr reference back() const
{
CARB_THROW_OR_CHECK(!empty(), "Behavior is undefined when calling back() on an empty span");
return m_p[m_size - 1];
}
constexpr reference operator[](size_type index) const
{
CARB_THROW_OR_CHECK(index < m_size, "Behavior is undefined when index exceeds size()");
return m_p[index];
}
constexpr pointer data() const noexcept
{
return m_p;
}
constexpr size_type size() const noexcept
{
return m_size;
}
constexpr size_type size_bytes() const noexcept
{
return sizeof(element_type) * m_size;
}
CARB_NODISCARD constexpr bool empty() const noexcept
{
return m_size == 0;
}
template <std::size_t Count>
constexpr span<element_type, Count> first() const
{
CARB_THROW_OR_CHECK(Count <= m_size, "Behavior is undefined when Count > size()");
return span<element_type, Count>{ m_p, Count };
}
constexpr span<element_type, dynamic_extent> first(size_type Count) const
{
CARB_THROW_OR_CHECK(Count <= m_size, "Behavior is undefined when Count > size()");
return span<element_type, dynamic_extent>{ m_p, Count };
}
template <std::size_t Count>
constexpr span<element_type, Count> last() const
{
CARB_THROW_OR_CHECK(Count <= m_size, "Behavior is undefined when Count > size()");
return span<element_type, Count>{ m_p + (m_size - Count), Count };
}
constexpr span<element_type, dynamic_extent> last(size_type Count) const
{
CARB_THROW_OR_CHECK(Count <= m_size, "Behavior is undefined when Count > size()");
return span<element_type, dynamic_extent>{ m_p + (m_size - Count), Count };
}
template <std::size_t Offset, std::size_t Count = dynamic_extent>
constexpr span<element_type, detail::DetermineSubspanExtent<extent, Offset, Count>::value> subspan() const
{
CARB_THROW_OR_CHECK(Offset <= m_size, "Behavior is undefined when Offset > size()");
CARB_THROW_OR_CHECK(Count == dynamic_extent || (Offset + Count) <= m_size,
"Behavior is undefined when Count != dynamic_extent and (Offset + Count) > size()");
return span<element_type, detail::DetermineSubspanExtent<extent, Offset, Count>::value>{
data() + Offset, carb_min(size() - Offset, Count)
};
}
constexpr span<element_type, dynamic_extent> subspan(size_type Offset, size_type Count = dynamic_extent) const
{
CARB_THROW_OR_CHECK(Offset <= m_size, "Behavior is undefined when Offset > size()");
CARB_THROW_OR_CHECK(Count == dynamic_extent || (Offset + Count) <= m_size,
"Behavior is undefined when Count != dynamic_extent and (Offset + Count) > size()");
return { data() + Offset, carb_min(size() - Offset, Count) };
}
private:
pointer m_p;
size_type m_size;
};
// Specialization for zero
template <class T>
class span<T, 0>
{
// NOTE: This specialization is for Extent == 0
public:
using element_type = T;
using value_type = std::remove_cv_t<T>;
using size_type = std::size_t;
using difference_type = std::ptrdiff_t;
using pointer = T*;
using const_pointer = const T*;
using reference = T&;
using const_reference = const T&;
using iterator = omni::detail::PointerIterator<pointer, span>;
using reverse_iterator = std::reverse_iterator<iterator>;
constexpr static std::size_t extent = 0;
constexpr span() noexcept = default;
template <class It,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false>
constexpr explicit span(It first, size_type count)
{
CARB_UNUSED(first, count);
CARB_THROW_OR_CHECK(count == 0, "Behavior is undefined if count != extent");
}
template <class It,
std::enable_if_t<std::is_same<typename std::iterator_traits<It>::iterator_category, std::random_access_iterator_tag>::value,
bool> = false>
constexpr explicit span(It first, It last)
{
CARB_UNUSED(first, last);
CARB_THROW_OR_CHECK(first == last, "Behavior is undefined if (last - first) != extent");
}
template <std::size_t N>
constexpr span(type_identity_t<element_type> (&arr)[N]) noexcept
{
CARB_UNUSED(arr);
static_assert(N == extent, "Undefined if N != extent");
}
template <class U, std::size_t N, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false>
constexpr span(std::array<U, N>& arr) noexcept
{
CARB_UNUSED(arr);
static_assert(N == extent, "Undefined if N != extent");
}
template <class U, std::size_t N, std::enable_if_t<std::is_convertible<U, element_type>::value, bool> = false>
constexpr span(const std::array<U, N>& arr) noexcept
{
CARB_UNUSED(arr);
static_assert(N == extent, "Undefined if N != extent");
}
// template< class R >
// explicit(extent != dynamic_extent)
// constexpr span( R&& range );
// (Constructor not available without ranges, but approximate constructor follows)
template <class R,
std::enable_if_t<detail::IsConvertibleRange<cpp::remove_cvref_t<R>, pointer>::value &&
!detail::IsStdArray<cpp::remove_cvref_t<R>>::value && // has separate constructor
!detail::IsSpan<cpp::remove_cvref_t<R>>::value && // has separate constructor
!std::is_array<cpp::remove_cvref_t<R>>::value, // has separate constructor
bool> = false>
constexpr explicit span(R&& range)
{
CARB_THROW_OR_CHECK(range.size() == extent, "Behavior is undefined if R.size() != extent");
}
template <class U,
std::size_t N,
std::enable_if_t<N == dynamic_extent && std::is_convertible<U, element_type>::value, bool> = false>
constexpr explicit span(const span<U, N>& source) noexcept
{
CARB_UNUSED(source);
CARB_THROW_OR_CHECK(N == extent, "Behavior is undefined if N != extent");
}
template <class U,
std::size_t N,
std::enable_if_t<N != dynamic_extent && std::is_convertible<U, element_type>::value, bool> = false>
constexpr explicit span(const span<U, N>& source) noexcept
{
CARB_UNUSED(source);
CARB_THROW_OR_CHECK(N == extent, "Behavior is undefined if N != extent");
}
constexpr span(const span& other) noexcept = default;
constexpr span& operator=(const span& other) noexcept = default;
constexpr iterator begin() const noexcept
{
return end();
}
constexpr iterator end() const noexcept
{
return iterator(nullptr);
}
constexpr reverse_iterator rbegin() const noexcept
{
return rend();
}
constexpr reverse_iterator rend() const noexcept
{
return reverse_iterator(begin());
}
constexpr reference front() const
{
CARB_ALWAYS_FAIL("Behavior is undefined if front() is called on an empty span");
}
constexpr reference back() const
{
CARB_ALWAYS_FAIL("Behavior is undefined if back() is called on an empty span");
}
constexpr reference operator[](size_type index) const
{
CARB_UNUSED(index);
CARB_ALWAYS_FAIL("Behavior is undefined if index >= size()");
}
constexpr pointer data() const noexcept
{
return nullptr;
}
constexpr size_type size() const noexcept
{
return 0;
}
constexpr size_type size_bytes() const noexcept
{
return 0;
}
CARB_NODISCARD constexpr bool empty() const noexcept
{
return true;
}
template <std::size_t Count>
constexpr span<element_type, Count> first() const
{
static_assert(Count <= extent, "Program ill-formed if Count > extent");
return span<element_type, Count>{};
}
constexpr span<element_type, dynamic_extent> first(size_type Count) const
{
CARB_UNUSED(Count);
CARB_THROW_OR_CHECK(Count == 0, "Behavior is undefined if Count > extent");
return span<element_type, dynamic_extent>{};
}
template <std::size_t Count>
constexpr span<element_type, Count> last() const
{
CARB_THROW_OR_CHECK(Count == 0, "Behavior is undefined if Count > extent");
return span<element_type, Count>{};
}
constexpr span<element_type, dynamic_extent> last(size_type Count) const
{
CARB_UNUSED(Count);
CARB_THROW_OR_CHECK(Count == 0, "Behavior is undefined if Count > extent");
return span<element_type, dynamic_extent>{};
}
template <std::size_t Offset, std::size_t Count = dynamic_extent>
constexpr span<element_type, detail::DetermineSubspanExtent<extent, Offset, Count>::value> subspan() const
{
static_assert(Offset <= extent, "Ill-formed");
static_assert(Count == dynamic_extent || (Offset + Count) <= extent, "Ill-formed");
return {};
}
constexpr span<element_type, dynamic_extent> subspan(size_type Offset, size_type Count = dynamic_extent) const
{
CARB_UNUSED(Offset, Count);
CARB_THROW_OR_CHECK(Offset <= extent, "Behavior is undefined if Offset > extent");
CARB_THROW_OR_CHECK(Count == dynamic_extent || (Offset + Count) <= extent,
"Behavior is undefined if Count != dynamic_extent and (Offset + Count) > extent");
return {};
}
};
CARB_ASSERT_INTEROP_SAFE(span<int, 0>);
CARB_ASSERT_INTEROP_SAFE(span<int, dynamic_extent>);
#endif
#ifndef DOXYGEN_BUILD
template <class T, std::size_t N, std::enable_if_t<N == dynamic_extent, bool> = false>
span<const cpp::byte, dynamic_extent> as_bytes(span<T, N> s) noexcept
{
return { reinterpret_cast<const cpp::byte*>(s.data()), s.size_bytes() };
}
template <class T, std::size_t N, std::enable_if_t<N != dynamic_extent, bool> = false>
span<const cpp::byte, sizeof(T) * N> as_bytes(span<T, N> s) noexcept
#else
//! Obtains a view ot the object representation of the elements of the given span
//! @tparam T the `element_type` of the span
//! @tparam N the `extent` of the span
//! @param s The span
//! @returns A \ref span of type `span<const cpp::byte, E>` where `E` is \ref dynamic_extent if `N` is also
//! \ref dynamic_extent, otherwise `E` is `sizeof(T) * N`.
template <class T, std::size_t N>
auto as_bytes(span<T, N> s) noexcept
#endif
{
return span<const cpp::byte, sizeof(T) * N>{ reinterpret_cast<const cpp::byte*>(s.data()), s.size_bytes() };
}
#ifndef DOXYGEN_BUILD
template <class T, std::size_t N, std::enable_if_t<N == dynamic_extent, bool> = false>
span<cpp::byte, dynamic_extent> as_writable_bytes(span<T, N> s) noexcept
{
return { reinterpret_cast<cpp::byte*>(s.data()), s.size_bytes() };
}
template <class T, std::size_t N, std::enable_if_t<N != dynamic_extent, bool> = false>
span<cpp::byte, sizeof(T) * N> as_writable_bytes(span<T, N> s) noexcept
#else
//! Obtains a writable view to the object representation of the elements of the given span
//! @tparam T the `element_type` of the span
//! @tparam N the `extent` of the span
//! @param s The span
//! @returns A \ref span of type `span<cpp::byte, E>` where `E` is \ref dynamic_extent if `N` is also
//! \ref dynamic_extent, otherwise `E` is `sizeof(T) * N`.
template <class T, std::size_t N>
auto as_writable_bytes(span<T, N> s) noexcept
#endif
{
return span<cpp::byte, sizeof(T) * N>{ reinterpret_cast<cpp::byte*>(s.data()), s.size_bytes() };
}
#undef CARB_ALWAYS_FAIL
#undef CARB_THROW_OR_CHECK
} // namespace cpp
} // namespace carb
| 37,511 | C | 38.653277 | 138 | 0.636507 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.