ALSA project - the C library reference
timer.h
Go to the documentation of this file.
1 
11 /*
12  * This library is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU Lesser General Public License as
14  * published by the Free Software Foundation; either version 2.1 of
15  * the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25  *
26  */
27 
28 #ifndef __ALSA_TIMER_H
29 #define __ALSA_TIMER_H
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
42 #define SND_TIMER_DLSYM_VERSION _dlsym_timer_001
43 
44 #define SND_TIMER_QUERY_DLSYM_VERSION _dlsym_timer_query_001
45 
47 typedef struct _snd_timer_id snd_timer_id_t;
49 typedef struct _snd_timer_ginfo snd_timer_ginfo_t;
51 typedef struct _snd_timer_gparams snd_timer_gparams_t;
53 typedef struct _snd_timer_gstatus snd_timer_gstatus_t;
55 typedef struct _snd_timer_info snd_timer_info_t;
57 typedef struct _snd_timer_params snd_timer_params_t;
59 typedef struct _snd_timer_status snd_timer_status_t;
61 typedef enum _snd_timer_class {
69 
71 typedef enum _snd_timer_slave_class {
78 
80 typedef enum _snd_timer_event {
81  SND_TIMER_EVENT_RESOLUTION = 0, /* val = resolution in ns */
82  SND_TIMER_EVENT_TICK, /* val = ticks */
83  SND_TIMER_EVENT_START, /* val = resolution in ns */
84  SND_TIMER_EVENT_STOP, /* val = 0 */
85  SND_TIMER_EVENT_CONTINUE, /* val = resolution in ns */
86  SND_TIMER_EVENT_PAUSE, /* val = 0 */
87  SND_TIMER_EVENT_EARLY, /* val = 0 */
88  SND_TIMER_EVENT_SUSPEND, /* val = 0 */
89  SND_TIMER_EVENT_RESUME, /* val = resolution in ns */
90  /* master timer events for slave timer instances */
91  SND_TIMER_EVENT_MSTART = SND_TIMER_EVENT_START + 10,
92  SND_TIMER_EVENT_MSTOP = SND_TIMER_EVENT_STOP + 10,
93  SND_TIMER_EVENT_MCONTINUE = SND_TIMER_EVENT_CONTINUE + 10,
94  SND_TIMER_EVENT_MPAUSE = SND_TIMER_EVENT_PAUSE + 10,
95  SND_TIMER_EVENT_MSUSPEND = SND_TIMER_EVENT_SUSPEND + 10,
96  SND_TIMER_EVENT_MRESUME = SND_TIMER_EVENT_RESUME + 10
98 
100 typedef struct _snd_timer_read {
101  unsigned int resolution;
102  unsigned int ticks;
104 
106 typedef struct _snd_timer_tread {
109  unsigned int val;
111 
113 #define SND_TIMER_GLOBAL_SYSTEM 0
114 
115 #define SND_TIMER_GLOBAL_RTC 1 /* Obsoleted, due to enough legacy. */
116 
117 #define SND_TIMER_GLOBAL_HPET 2
118 
119 #define SND_TIMER_GLOBAL_HRTIMER 3
120 
122 #define SND_TIMER_OPEN_NONBLOCK (1<<0)
123 
124 #define SND_TIMER_OPEN_TREAD (1<<1)
125 
127 typedef enum _snd_timer_type {
135 
137 typedef struct _snd_timer_query snd_timer_query_t;
139 typedef struct _snd_timer snd_timer_t;
140 
141 
142 int snd_timer_query_open(snd_timer_query_t **handle, const char *name, int mode);
143 int snd_timer_query_open_lconf(snd_timer_query_t **handle, const char *name, int mode, snd_config_t *lconf);
149 
150 int snd_timer_open(snd_timer_t **handle, const char *name, int mode);
151 int snd_timer_open_lconf(snd_timer_t **handle, const char *name, int mode, snd_config_t *lconf);
152 int snd_timer_close(snd_timer_t *handle);
154  snd_async_callback_t callback, void *private_data);
157 int snd_timer_poll_descriptors(snd_timer_t *handle, struct pollfd *pfds, unsigned int space);
158 int snd_timer_poll_descriptors_revents(snd_timer_t *timer, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
159 int snd_timer_info(snd_timer_t *handle, snd_timer_info_t *timer);
160 int snd_timer_params(snd_timer_t *handle, snd_timer_params_t *params);
161 int snd_timer_status(snd_timer_t *handle, snd_timer_status_t *status);
162 int snd_timer_start(snd_timer_t *handle);
163 int snd_timer_stop(snd_timer_t *handle);
164 int snd_timer_continue(snd_timer_t *handle);
165 ssize_t snd_timer_read(snd_timer_t *handle, void *buffer, size_t size);
166 
167 size_t snd_timer_id_sizeof(void);
169 #define snd_timer_id_alloca(ptr) __snd_alloca(ptr, snd_timer_id)
172 void snd_timer_id_copy(snd_timer_id_t *dst, const snd_timer_id_t *src);
173 
174 void snd_timer_id_set_class(snd_timer_id_t *id, int dev_class);
176 void snd_timer_id_set_sclass(snd_timer_id_t *id, int dev_sclass);
178 void snd_timer_id_set_card(snd_timer_id_t *id, int card);
180 void snd_timer_id_set_device(snd_timer_id_t *id, int device);
182 void snd_timer_id_set_subdevice(snd_timer_id_t *id, int subdevice);
184 
185 size_t snd_timer_ginfo_sizeof(void);
187 #define snd_timer_ginfo_alloca(ptr) __snd_alloca(ptr, snd_timer_ginfo)
191 
202 
203 size_t snd_timer_info_sizeof(void);
205 #define snd_timer_info_alloca(ptr) __snd_alloca(ptr, snd_timer_info)
209 
212 const char *snd_timer_info_get_id(snd_timer_info_t * info);
213 const char *snd_timer_info_get_name(snd_timer_info_t * info);
215 
216 size_t snd_timer_params_sizeof(void);
218 #define snd_timer_params_alloca(ptr) __snd_alloca(ptr, snd_timer_params)
222 
223 int snd_timer_params_set_auto_start(snd_timer_params_t * params, int auto_start);
225 int snd_timer_params_set_exclusive(snd_timer_params_t * params, int exclusive);
227 int snd_timer_params_set_early_event(snd_timer_params_t * params, int early_event);
229 void snd_timer_params_set_ticks(snd_timer_params_t * params, long ticks);
231 void snd_timer_params_set_queue_size(snd_timer_params_t * params, long queue_size);
233 void snd_timer_params_set_filter(snd_timer_params_t * params, unsigned int filter);
234 unsigned int snd_timer_params_get_filter(snd_timer_params_t * params);
235 
236 size_t snd_timer_status_sizeof(void);
238 #define snd_timer_status_alloca(ptr) __snd_alloca(ptr, snd_timer_status)
242 
248 
249 /* deprecated functions, for compatibility */
251 
254 #ifdef __cplusplus
255 }
256 #endif
257 
258 #endif
void snd_timer_id_copy(snd_timer_id_t *dst, const snd_timer_id_t *src)
copy one snd_timer_id_t structure to another
Definition: timer_query.c:478
struct _snd_timer_ginfo snd_timer_ginfo_t
Definition: timer.h:49
unsigned int val
Definition: timer.h:109
snd_htimestamp_t snd_timer_status_get_timestamp(snd_timer_status_t *status)
get timestamp
Definition: timer.c:842
int snd_timer_query_next_device(snd_timer_query_t *handle, snd_timer_id_t *tid)
obtain the next timer identification
Definition: timer_query.c:221
Definition: timer.h:76
struct _snd_timer_gstatus snd_timer_gstatus_t
Definition: timer.h:53
struct _snd_timer_id snd_timer_id_t
Definition: timer.h:47
Definition: timer.h:73
Definition: timer.h:100
int snd_timer_id_get_sclass(snd_timer_id_t *id)
get timer sub-class
Definition: timer_query.c:522
snd_timer_t * snd_async_handler_get_timer(snd_async_handler_t *handler)
Return timer handle related to an async handler.
Definition: timer.c:331
int snd_timer_close(snd_timer_t *handle)
close timer handle
Definition: timer.c:248
snd_timer_event_t
Definition: timer.h:80
long snd_timer_params_get_ticks(snd_timer_params_t *params)
get timer ticks
Definition: timer.c:712
size_t snd_timer_params_sizeof(void)
get size of the snd_timer_params_t structure in bytes
Definition: timer.c:562
long snd_timer_status_get_lost(snd_timer_status_t *status)
get master tick lost count
Definition: timer.c:864
void snd_timer_status_copy(snd_timer_status_t *dst, const snd_timer_status_t *src)
copy one snd_timer_status_t structure to another
Definition: timer.c:829
Definition: timer.h:66
ssize_t snd_timer_read(snd_timer_t *handle, void *buffer, size_t size)
read bytes using timer handle
Definition: timer.c:944
int snd_timer_status(snd_timer_t *handle, snd_timer_status_t *status)
get status from timer handle
Definition: timer.c:898
size_t snd_timer_info_sizeof(void)
get size of the snd_timer_info_t structure in bytes
Definition: timer.c:443
long snd_timer_info_get_resolution(snd_timer_info_t *info)
get timer resolution in us
Definition: timer.c:539
struct _snd_timer_query snd_timer_query_t
Definition: timer.h:137
void(* snd_async_callback_t)(snd_async_handler_t *handler)
Async notification callback.
Definition: global.h:122
int snd_timer_open(snd_timer_t **handle, const char *name, int mode)
Opens a new connection to the timer interface.
Definition: timer.c:202
int snd_timer_poll_descriptors(snd_timer_t *handle, struct pollfd *pfds, unsigned int space)
get poll descriptors
Definition: timer.c:358
const char * snd_timer_info_get_name(snd_timer_info_t *info)
get timer name
Definition: timer.c:527
Definition: timer.h:129
int snd_timer_open_lconf(snd_timer_t **handle, const char *name, int mode, snd_config_t *lconf)
Opens a new connection to the timer interface using local configuration.
Definition: timer.c:233
int snd_timer_info_malloc(snd_timer_info_t **ptr)
allocate a new snd_timer_info_t structure
Definition: timer.c:456
int snd_timer_params_set_exclusive(snd_timer_params_t *params, int exclusive)
set timer exclusive use
Definition: timer.c:642
int snd_timer_query_status(snd_timer_query_t *handle, snd_timer_gstatus_t *status)
get the timer global status
Definition: timer_query.c:425
struct _snd_timer_params snd_timer_params_t
Definition: timer.h:57
void snd_timer_params_set_queue_size(snd_timer_params_t *params, long queue_size)
set timer queue size (32-1024)
Definition: timer.c:723
char * snd_timer_ginfo_get_id(snd_timer_ginfo_t *obj)
get timer identification
Definition: timer_query.c:325
snd_timer_event_t event
Definition: timer.h:107
Definition: timer.h:67
struct _snd_timer snd_timer_t
Definition: timer.h:139
Definition: timer.h:133
void snd_timer_ginfo_copy(snd_timer_ginfo_t *dst, const snd_timer_ginfo_t *src)
copy one snd_timer_info_t structure to another
Definition: timer_query.c:272
unsigned long snd_timer_ginfo_get_resolution_min(snd_timer_ginfo_t *obj)
get timer minimal resolution in ns
Definition: timer_query.c:355
int snd_timer_info_is_slave(snd_timer_info_t *info)
determine, if timer is slave
Definition: timer.c:494
unsigned int ticks
Definition: timer.h:102
struct _snd_timer_status snd_timer_status_t
Definition: timer.h:59
int snd_timer_params_set_auto_start(snd_timer_params_t *params, int auto_start)
set timer auto start
Definition: timer.c:613
int snd_timer_poll_descriptors_revents(snd_timer_t *timer, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
get returned events from poll descriptors
Definition: timer.c:389
size_t snd_timer_status_sizeof(void)
get size of the snd_timer_status_t structure in bytes
Definition: timer.c:789
long snd_timer_status_get_resolution(snd_timer_status_t *status)
get resolution in us
Definition: timer.c:853
int snd_timer_params_malloc(snd_timer_params_t **ptr)
allocate a new snd_timer_params_t structure
Definition: timer.c:575
struct timespec snd_htimestamp_t
Definition: global.h:154
Definition: timer.h:131
int snd_timer_stop(snd_timer_t *handle)
stop the timer
Definition: timer.c:921
int snd_timer_query_params(snd_timer_query_t *handle, snd_timer_gparams_t *params)
set the timer global parameters
Definition: timer_query.c:407
struct _snd_timer_gparams snd_timer_gparams_t
Definition: timer.h:51
int snd_timer_params_get_early_event(snd_timer_params_t *params)
determine if timer has early event flag
Definition: timer.c:690
long snd_timer_status_get_overrun(snd_timer_status_t *status)
get overrun count
Definition: timer.c:875
void snd_timer_info_free(snd_timer_info_t *obj)
frees the snd_timer_info_t structure
Definition: timer.c:472
int snd_timer_params_set_early_event(snd_timer_params_t *params, int early_event)
set timer early event
Definition: timer.c:675
unsigned int snd_timer_params_get_filter(snd_timer_params_t *params)
get timer event filter
Definition: timer.c:764
void snd_timer_id_free(snd_timer_id_t *obj)
frees the snd_timer_id_t structure
Definition: timer_query.c:467
void snd_timer_info_copy(snd_timer_info_t *dst, const snd_timer_info_t *src)
copy one snd_timer_info_t structure to another
Definition: timer.c:483
snd_timer_slave_class_t
Definition: timer.h:71
Definition: timer.h:72
int snd_timer_ginfo_set_tid(snd_timer_ginfo_t *obj, snd_timer_id_t *tid)
set timer identification
Definition: timer_query.c:284
unsigned int resolution
Definition: timer.h:101
int snd_timer_ginfo_get_card(snd_timer_ginfo_t *obj)
get associated card with timer
Definition: timer_query.c:315
Definition: timer.h:64
void snd_timer_params_free(snd_timer_params_t *obj)
frees the snd_timer_params_t structure
Definition: timer.c:591
int snd_timer_id_get_device(snd_timer_id_t *id)
get timer device
Definition: timer_query.c:566
int snd_timer_id_get_subdevice(snd_timer_id_t *id)
get timer subdevice
Definition: timer_query.c:588
Definition: timer.h:75
int snd_timer_status_malloc(snd_timer_status_t **ptr)
allocate a new snd_timer_status_t structure
Definition: timer.c:802
int snd_timer_id_get_class(snd_timer_id_t *id)
get timer class
Definition: timer_query.c:500
int snd_timer_id_malloc(snd_timer_id_t **ptr)
allocate a new snd_timer_id_t structure
Definition: timer_query.c:451
size_t snd_timer_id_sizeof(void)
get size of the snd_timer_id_t structure in bytes
Definition: timer_query.c:438
int snd_timer_query_open_lconf(snd_timer_query_t **handle, const char *name, int mode, snd_config_t *lconf)
Opens a new connection to the timer query interface using local configuration.
Definition: timer_query.c:185
struct _snd_async_handler snd_async_handler_t
Internal structure for an async notification client handler.
Definition: global.h:115
Definition: timer.h:63
void snd_timer_params_set_filter(snd_timer_params_t *params, unsigned int filter)
set timer event filter
Definition: timer.c:748
int snd_timer_poll_descriptors_count(snd_timer_t *handle)
get count of poll descriptors for timer handle
Definition: timer.c:345
void snd_timer_params_set_ticks(snd_timer_params_t *params, long ticks)
set timer ticks
Definition: timer.c:701
void snd_timer_id_set_class(snd_timer_id_t *id, int dev_class)
set timer class
Definition: timer_query.c:489
long snd_timer_status_get_queue(snd_timer_status_t *status)
get count of used queue elements
Definition: timer.c:886
char * snd_timer_ginfo_get_name(snd_timer_ginfo_t *obj)
get timer name
Definition: timer_query.c:335
int snd_timer_start(snd_timer_t *handle)
start the timer
Definition: timer.c:910
int snd_timer_query_close(snd_timer_query_t *handle)
close timer query handle
Definition: timer_query.c:200
int snd_timer_params_get_exclusive(snd_timer_params_t *params)
determine if timer has exclusive flag
Definition: timer.c:662
int snd_timer_params(snd_timer_t *handle, snd_timer_params_t *params)
set parameters for timer handle
Definition: timer.c:778
unsigned int snd_timer_ginfo_get_flags(snd_timer_ginfo_t *obj)
get timer flags
Definition: timer_query.c:305
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:69
int snd_timer_info_get_card(snd_timer_info_t *info)
get timer card
Definition: timer.c:505
snd_timer_id_t * snd_timer_ginfo_get_tid(snd_timer_ginfo_t *obj)
get timer identification
Definition: timer_query.c:295
Definition: timer.h:62
struct _snd_timer_info snd_timer_info_t
Definition: timer.h:55
Definition: timer.h:65
int snd_timer_id_get_card(snd_timer_id_t *id)
get timer card
Definition: timer_query.c:544
void snd_timer_id_set_device(snd_timer_id_t *id, int device)
set timer device
Definition: timer_query.c:555
Definition: timer.h:106
int snd_timer_continue(snd_timer_t *handle)
continue the timer
Definition: timer.c:932
void snd_timer_status_free(snd_timer_status_t *obj)
frees the snd_timer_status_t structure
Definition: timer.c:818
void snd_timer_id_set_sclass(snd_timer_id_t *id, int dev_sclass)
set timer sub-class
Definition: timer_query.c:511
int snd_timer_query_info(snd_timer_query_t *handle, snd_timer_ginfo_t *info)
obtain the timer global information
Definition: timer_query.c:389
void snd_timer_id_set_subdevice(snd_timer_id_t *id, int subdevice)
set timer subdevice
Definition: timer_query.c:577
long snd_timer_params_get_queue_size(snd_timer_params_t *params)
get queue size
Definition: timer.c:734
unsigned long snd_timer_ginfo_get_resolution(snd_timer_ginfo_t *obj)
get timer resolution in ns
Definition: timer_query.c:345
Definition: timer.h:74
void snd_timer_ginfo_free(snd_timer_ginfo_t *obj)
frees the snd_timer_ginfo_t structure
Definition: timer_query.c:261
int snd_async_add_timer_handler(snd_async_handler_t **handler, snd_timer_t *timer, snd_async_callback_t callback, void *private_data)
Add an async handler for a timer.
Definition: timer.c:301
int snd_timer_params_get_auto_start(snd_timer_params_t *params)
determine if timer has auto start flag
Definition: timer.c:628
unsigned long snd_timer_ginfo_get_resolution_max(snd_timer_ginfo_t *obj)
get timer maximal resolution in ns
Definition: timer_query.c:365
void * ptr
Definition: seq_event.h:199
const char * snd_timer_info_get_id(snd_timer_info_t *info)
get timer id
Definition: timer.c:516
size_t snd_timer_ginfo_sizeof(void)
get size of the snd_timer_ginfo_t structure in bytes
Definition: timer_query.c:232
snd_htimestamp_t tstamp
Definition: timer.h:108
unsigned int snd_timer_ginfo_get_clients(snd_timer_ginfo_t *obj)
get current timer clients
Definition: timer_query.c:375
long snd_timer_info_get_ticks(snd_timer_info_t *info)
(DEPRECATED) get maximum timer ticks
Definition: timer.c:957
snd_timer_type_t
Definition: timer.h:127
int snd_timer_query_open(snd_timer_query_t **handle, const char *name, int mode)
Opens a new connection to the timer query interface.
Definition: timer_query.c:160
void snd_timer_id_set_card(snd_timer_id_t *id, int card)
set timer card
Definition: timer_query.c:533
int snd_timer_ginfo_malloc(snd_timer_ginfo_t **ptr)
allocate a new snd_timer_ginfo_t structure
Definition: timer_query.c:245
int snd_timer_info(snd_timer_t *handle, snd_timer_info_t *timer)
get information about timer handle
Definition: timer.c:551
snd_timer_class_t
Definition: timer.h:61
void snd_timer_params_copy(snd_timer_params_t *dst, const snd_timer_params_t *src)
copy one snd_timer_params_t structure to another
Definition: timer.c:602