timeutils.h File Reference

This module defines storage classes for timestamps and operations on time values. More...

#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	TimestampU
	Timestamp (unsigned) More...
struct	TimestampI
	Timestamp (signed) More...

Macros
#define	NANO_PREFIX   (1000000000)
	Integer nano prefix.
#define	NANO_PREFIX_F   (1000000000.0f)
	Float nanno prefix.
#define	T_SEC_PER_MINUTE   (60)
	seconds per minute
#define	T_SEC_PER_HOUR   (60 * T_SEC_PER_MINUTE)
	seconds per hour
#define	T_SEC_PER_DAY   (24 * T_SEC_PER_HOUR)
	seconds per day
#define	T_SEC_PER_YEAR   (365 * T_SEC_PER_DAY)
	seconds per year
#define	T_SEC_PER_LEAPYEAR   (366 * T_SEC_PER_DAY)
	seconds per leapyear
#define	T_SEC_PER_FOURYEAR   (3 * T_SEC_PER_YEAR + T_SEC_PER_LEAPYEAR)
	seconds per four years

Functions
TimestampI *	tsUToI (TimestampI *ti, const TimestampU *tu)
TimestampU *	tsIToU (TimestampU *tu, const TimestampI *ti)
TimestampI *	addTime (TimestampI *r, const TimestampI *a, const TimestampI *b)
TimestampI *	subTime (TimestampI *r, const TimestampI *a, const TimestampI *b)
TimestampI *	divTime (TimestampI *r, const TimestampI *a, int divisor)
uint64_t	nsU (const TimestampU *t)
int64_t	nsI (const TimestampI *t)
void	normTime (TimestampI *t)
int64_t	tsToTick (const TimestampI *ts, uint32_t tps)
TimestampI *	nsToTsI (TimestampI *r, int64_t ns)
bool	nonZeroI (const TimestampI *a)
void	tsPrint (char *str, const TimestampI *ts)

Detailed Description

This module defines storage classes for timestamps and operations on time values.

Copyright

András Wiesner, 2019-2025

Definition in file timeutils.h.

Macro Definition Documentation

NANO_PREFIX

#define NANO_PREFIX   (1000000000)

Integer nano prefix.

Definition at line 38 of file timeutils.h.

NANO_PREFIX_F

#define NANO_PREFIX_F   (1000000000.0f)

Float nanno prefix.

Definition at line 39 of file timeutils.h.

T_SEC_PER_DAY

#define T_SEC_PER_DAY   (24 * T_SEC_PER_HOUR)

seconds per day

Definition at line 43 of file timeutils.h.

T_SEC_PER_FOURYEAR

#define T_SEC_PER_FOURYEAR   (3 * T_SEC_PER_YEAR + T_SEC_PER_LEAPYEAR)

seconds per four years

Definition at line 46 of file timeutils.h.

T_SEC_PER_HOUR

#define T_SEC_PER_HOUR   (60 * T_SEC_PER_MINUTE)

seconds per hour

Definition at line 42 of file timeutils.h.

T_SEC_PER_LEAPYEAR

#define T_SEC_PER_LEAPYEAR   (366 * T_SEC_PER_DAY)

seconds per leapyear

Definition at line 45 of file timeutils.h.

T_SEC_PER_MINUTE

#define T_SEC_PER_MINUTE   (60)

seconds per minute

Definition at line 41 of file timeutils.h.

T_SEC_PER_YEAR

#define T_SEC_PER_YEAR   (365 * T_SEC_PER_DAY)

seconds per year

Definition at line 44 of file timeutils.h.

Function Documentation

addTime()

TimestampI * addTime	(	TimestampI *	r,
		const TimestampI *	a,
		const TimestampI *	b
	)

Add up timestamps. r = a + b;

Parameters

r	result
a	first operand
b	second operand

Returns

r

Definition at line 24 of file timeutils.c.

divTime()

TimestampI * divTime	(	TimestampI *	r,
		const TimestampI *	a,
		int	divisor
	)

Divide (inversely scale) a time value by an integer.

Parameters

r	pointer to the result field
a	dividend
divisor	divisor

Returns

r

Definition at line 39 of file timeutils.c.

nonZeroI()

bool nonZeroI

(

const TimestampI *

a

)

Does the timestamp differ from zero?

Parameters

a

timestamp

Returns

a != 0

Definition at line 75 of file timeutils.c.

normTime()

void normTime

(

TimestampI *

t

)

Normalize time. Move whole seconds from the nanoseconds field to the seconds.

Parameters

t	Time. It will be overwritten.

Definition at line 57 of file timeutils.c.

nsI()

int64_t nsI

(

const TimestampI *

t

)

Convert signed time into nanoseconds.

Parameters

t

time

Returns

time in nanoseconds

Definition at line 52 of file timeutils.c.

nsToTsI()

TimestampI * nsToTsI	(	TimestampI *	r,
		int64_t	ns
	)

Convert nanoseconds to time.

Parameters

r	results
ns	time in nanoseconds

Returns

r

Definition at line 69 of file timeutils.c.

nsU()

uint64_t nsU

(

const TimestampU *

t

)

Convert unsigned time into nanoseconds.

Parameters

t

time

Returns

time in nanoseconds

Definition at line 47 of file timeutils.c.

subTime()

TimestampI * subTime	(	TimestampI *	r,
		const TimestampI *	a,
		const TimestampI *	b
	)

Substract timestamps. r = a - b;

Parameters

r	result
a	first operand
b	second operand

Returns

r

Definition at line 32 of file timeutils.c.

tsIToU()

TimestampU * tsIToU	(	TimestampU *	tu,
		const TimestampI *	ti
	)

Convert signed timestamp to unsigned.

Parameters

tu	destination (signed) timestamp
ti	source (unsigned) timestamp

Definition at line 15 of file timeutils.c.

tsPrint()

void tsPrint	(	char *	str,
		const TimestampI *	ts
	)

Print datetime to string.

Parameters

str	destination area, must provide at least 20 consecutive bytes!
ts	pointer to timestamp object holding the time value

Definition at line 81 of file timeutils.c.

tsToTick()

int64_t tsToTick	(	const TimestampI *	ts,
		uint32_t	tps
	)

Convert duration (~time value) to hardware ticks.

Parameters

ts	time
tps	ticks per second

Returns

duration in ticks (rounded to floor during division)

Definition at line 63 of file timeutils.c.

tsUToI()

TimestampI * tsUToI	(	TimestampI *	ti,
		const TimestampU *	tu
	)

Convert unsigned timestamp to signed.

Parameters

ti	destination (signed) timestamp
tu	source (unsigned) timestamp

Definition at line 8 of file timeutils.c.