7#ifndef __LIBCAMERA_BASE_UTILS_H__
8#define __LIBCAMERA_BASE_UTILS_H__
23#include <libcamera/base/private.h>
29#define O_TMPFILE (020000000 | O_DIRECTORY)
38const char *
basename(
const char *path);
41std::string
dirname(
const std::string &path);
44std::vector<typename T::key_type>
map_keys(
const T &map)
46 std::vector<typename T::key_type> keys;
47 std::transform(map.begin(), map.end(), std::back_inserter(keys),
48 [](
const auto &value) { return value.first; });
52template<
class InputIt1,
class InputIt2>
54 InputIt2 first2, InputIt2 last2)
56 unsigned int count = 0;
58 while (first1 != last1 && first2 != last2) {
59 if (*first1 < *first2) {
62 if (!(*first2 < *first1))
71using clock = std::chrono::steady_clock;
72using duration = std::chrono::steady_clock::duration;
84std::basic_ostream<char, std::char_traits<char>> &
85operator<<(std::basic_ostream<
char, std::char_traits<char>> &stream,
const _hex &h);
89 std::enable_if_t<std::is_integral<T>::value> * =
nullptr>
90_hex
hex(T value,
unsigned int width = 0);
94inline _hex hex<int32_t>(int32_t value,
unsigned int width)
96 return {
static_cast<uint64_t
>(value), width ? width : 8 };
100inline _hex hex<uint32_t>(uint32_t value,
unsigned int width)
102 return {
static_cast<uint64_t
>(value), width ? width : 8 };
106inline _hex hex<int64_t>(int64_t value,
unsigned int width)
108 return {
static_cast<uint64_t
>(value), width ? width : 16 };
112inline _hex hex<uint64_t>(uint64_t value,
unsigned int width)
114 return {
static_cast<uint64_t
>(value), width ? width : 16 };
118size_t strlcpy(
char *dst,
const char *src,
size_t size);
121template<
typename Container,
typename UnaryOp>
122std::string
join(
const Container &items,
const std::string &sep, UnaryOp op)
124 std::ostringstream ss;
127 for (
typename Container::const_iterator it = std::begin(items);
128 it != std::end(items); ++it) {
140template<
typename Container>
141std::string
join(
const Container &items,
const std::string &sep)
143 std::ostringstream ss;
146 for (
typename Container::const_iterator it = std::begin(items);
147 it != std::end(items); ++it) {
159template<
typename Container,
typename UnaryOp>
160std::string
join(
const Container &items,
const std::string &sep, UnaryOp op =
nullptr);
168 StringSplitter(
const std::string &str,
const std::string &delim);
173 iterator(
const StringSplitter *ss, std::string::size_type pos);
175 iterator &operator++();
177 bool operator!=(
const iterator &other)
const;
180 const StringSplitter *ss_;
181 std::string::size_type pos_;
182 std::string::size_type next_;
185 iterator begin()
const;
186 iterator end()
const;
195details::StringSplitter
split(
const std::string &str,
const std::string &delim);
197std::string
toAscii(
const std::string &str);
202constexpr unsigned int alignDown(
unsigned int value,
unsigned int alignment)
204 return value / alignment * alignment;
207constexpr unsigned int alignUp(
unsigned int value,
unsigned int alignment)
209 return (value + alignment - 1) / alignment * alignment;
215struct reverse_adapter {
220auto begin(reverse_adapter<T> r)
222 return std::rbegin(r.iterable);
226auto end(reverse_adapter<T> r)
228 return std::rend(r.iterable);
234details::reverse_adapter<T>
reverse(T &&iterable)
241template<
typename Base>
242class enumerate_iterator
245 using base_reference =
typename std::iterator_traits<Base>::reference;
248 using difference_type =
typename std::iterator_traits<Base>::difference_type;
249 using value_type = std::pair<const std::size_t, base_reference>;
250 using pointer = value_type *;
251 using reference = value_type &;
252 using iterator_category = std::input_iterator_tag;
254 explicit enumerate_iterator(Base iter)
255 : current_(iter), pos_(0)
259 enumerate_iterator &operator++()
266 bool operator!=(
const enumerate_iterator &other)
const
268 return current_ != other.current_;
273 return { pos_, *current_ };
281template<
typename Base>
282class enumerate_adapter
285 using iterator = enumerate_iterator<Base>;
287 enumerate_adapter(Base begin, Base end)
288 : begin_(begin), end_(end)
292 iterator begin()
const
294 return iterator{ begin_ };
299 return iterator{ end_ };
310auto enumerate(T &iterable) -> details::enumerate_adapter<
decltype(iterable.begin())>
312 return { std::begin(iterable), std::end(iterable) };
316template<
typename T,
size_t N>
317auto enumerate(T (&iterable)[N]) -> details::enumerate_adapter<T *>
319 return { std::begin(iterable), std::end(iterable) };
323class Duration :
public std::chrono::duration<double, std::nano>
325 using BaseDuration = std::chrono::duration<double, std::nano>;
330 template<
typename Rep,
typename Period>
331 constexpr Duration(
const std::chrono::duration<Rep, Period> &d)
336 template<
typename Period>
339 auto const c = std::chrono::duration_cast<std::chrono::duration<double, Period>>(*this);
343 explicit constexpr operator bool()
const
345 return *
this != BaseDuration::zero();
352template<
class CharT,
class Traits>
353std::basic_ostream<CharT, Traits> &operator<<(std::basic_ostream<CharT, Traits> &os,
354 const utils::Duration &d);
Helper class from std::chrono::duration that represents a time duration in nanoseconds with double pr...
Definition: utils.h:324
double get() const
Retrieve the tick count, converted to the timebase provided by the template argument Period of type s...
Definition: utils.h:337
constexpr Duration(const std::chrono::duration< Rep, Period > &d)
Construct a Duration by converting an arbitrary std::chrono::duration.
Definition: utils.h:331
Top-level libcamera namespace.
Definition: backtrace.h:17
Transform operator*(Transform t0, Transform t1)
Compose two transforms together.
Definition: transform.cpp:207
const char * basename(const char *path)
Strip the directory prefix from the path.
Definition: utils.cpp:36
details::StringSplitter split(const std::string &str, const std::string &delim)
Split a string based on a delimiter.
Definition: utils.cpp:322
std::string time_point_to_string(const time_point &time)
Convert a time point to a string representation.
Definition: utils.cpp:174
constexpr unsigned int alignDown(unsigned int value, unsigned int alignment)
Align value down to alignment.
Definition: utils.h:202
std::string libcameraSourcePath()
Retrieve the path to the source directory.
Definition: source_paths.cpp:114
std::string toAscii(const std::string &str)
Remove any non-ASCII characters from a string.
Definition: utils.cpp:336
size_t strlcpy(char *dst, const char *src, size_t size)
Copy a string with a size limit.
Definition: utils.cpp:239
char * secure_getenv(const char *name)
Get an environment variable.
Definition: utils.cpp:60
std::chrono::steady_clock clock
The libcamera clock (monotonic)
Definition: utils.h:71
std::chrono::steady_clock::time_point time_point
The libcamera time point related to libcamera::utils::clock.
Definition: utils.h:73
unsigned int set_overlap(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2)
Count the number of elements in the intersection of two ranges.
Definition: utils.h:53
std::vector< typename T::key_type > map_keys(const T &map)
Retrieve the keys of a std::map<>
Definition: utils.h:44
constexpr unsigned int alignUp(unsigned int value, unsigned int alignment)
Align value up to alignment.
Definition: utils.h:207
std::string libcameraBuildPath()
Retrieve the path to the build directory.
Definition: source_paths.cpp:74
struct timespec duration_to_timespec(const duration &value)
Convert a duration to a timespec.
Definition: utils.cpp:160
auto enumerate(T &iterable) -> details::enumerate_adapter< decltype(iterable.begin())>
Wrap an iterable to enumerate index and value in a range-based loop.
Definition: utils.h:310
std::string join(const Container &items, const std::string &sep, UnaryOp op=nullptr)
Join elements of a container in a string with a separator.
std::chrono::steady_clock::duration duration
The libcamera duration related to libcamera::utils::clock.
Definition: utils.h:72
details::reverse_adapter< T > reverse(T &&iterable)
Wrap an iterable to reverse iteration in a range-based loop.
Definition: utils.h:234
_hex hex(T value, unsigned int width=0)
Write an hexadecimal value to an output string.
std::string dirname(const std::string &path)
Identify the dirname portion of a path.
Definition: utils.cpp:82