From 1c18c451f3a48507e876cfdb03c0a6f2187f62cb Mon Sep 17 00:00:00 2001 From: Daniel Scally Date: Wed, 30 Nov 2022 13:31:08 +0000 Subject: lib/timer: Add timer infrastructure Some sources simply fill the buffers passed by the USB subsystem and return them as quickly as possible. Particularly with compressed formats operating at superspeed this rapidly results in unrealistic frame rates. Add infrastructure that allows us to define a specific framerate and introduce blocking calls that constrain those sources to the framerates expected by the host. Reviewed-by: Kieran Bingham Signed-off-by: Daniel Scally --- include/uvcgadget/timer.h | 59 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 include/uvcgadget/timer.h (limited to 'include/uvcgadget/timer.h') diff --git a/include/uvcgadget/timer.h b/include/uvcgadget/timer.h new file mode 100644 index 0000000..de93287 --- /dev/null +++ b/include/uvcgadget/timer.h @@ -0,0 +1,59 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * libuvcgadget timer utils + * + * Copyright (C) 2022 Daniel Scally + * + * Contact: Daniel Scally + */ + +struct timer; + +/* + * timer_new - Create a new timer + * + * Allocates and returns a new struct timer. This must be configured with + * timer_set_fps() and then armed with timer_arm(), following which calls to + * timer_wait() will block until the expiration of a period as defined by + * timer_set_fps(). + * + * Timers allocated with this function should be removed with timer_destroy() + */ +struct timer *timer_new(void); + +/* + * timer_set_fps - Configure the timer's wait period + * + * Configure the timer to wait for a period of time such that expirations per + * second matches @fps + */ +void timer_set_fps(struct timer *timer, int fps); + +/* + * timer_arm + * + * Arms the timer such that calls to timer_wait() become blocking until the + * expiration of a period. + */ +int timer_arm(struct timer *timer); + +/* + * timer_disarm + * + * Disarms the timer such that calls to timer_wait() return without blocking. + */ +int timer_disarm(struct timer *timer); + +/* + * timer_wait + * + * If the timer is armed, block until the expiration of a period + */ +void timer_wait(struct timer *timer); + +/* + * timer_destroy + * + * Close the timer's file descriptor and free the memory + */ +void timer_destroy(struct timer *timer); -- cgit v1.2.3