Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages | Examples

timer.h

00001 
00028 #ifndef __ALSA_TIMER_H
00029 #define __ALSA_TIMER_H
00030 
00031 #ifdef __cplusplus
00032 extern "C" {
00033 #endif
00034 
00042 #define SND_TIMER_DLSYM_VERSION         _dlsym_timer_001
00043 
00044 #define SND_TIMER_QUERY_DLSYM_VERSION   _dlsym_timer_query_001
00045 
00047 typedef struct _snd_timer_id snd_timer_id_t;
00049 typedef struct _snd_timer_ginfo snd_timer_ginfo_t;
00051 typedef struct _snd_timer_gparams snd_timer_gparams_t;
00053 typedef struct _snd_timer_gstatus snd_timer_gstatus_t;
00055 typedef struct _snd_timer_info snd_timer_info_t;
00057 typedef struct _snd_timer_params snd_timer_params_t;
00059 typedef struct _snd_timer_status snd_timer_status_t;
00061 typedef enum _snd_timer_class {
00062         SND_TIMER_CLASS_NONE = -1,      
00063         SND_TIMER_CLASS_SLAVE = 0,      
00064         SND_TIMER_CLASS_GLOBAL,         
00065         SND_TIMER_CLASS_CARD,           
00066         SND_TIMER_CLASS_PCM,            
00067         SND_TIMER_CLASS_LAST = SND_TIMER_CLASS_PCM      
00068 } snd_timer_class_t;
00069 
00071 typedef enum _snd_timer_slave_class {
00072         SND_TIMER_SCLASS_NONE = 0,              
00073         SND_TIMER_SCLASS_APPLICATION,           
00074         SND_TIMER_SCLASS_SEQUENCER,             
00075         SND_TIMER_SCLASS_OSS_SEQUENCER,         
00076         SND_TIMER_SCLASS_LAST = SND_TIMER_SCLASS_OSS_SEQUENCER  
00077 } snd_timer_slave_class_t;
00078 
00080 typedef enum _snd_timer_event {
00081         SND_TIMER_EVENT_RESOLUTION = 0, /* val = resolution in ns */
00082         SND_TIMER_EVENT_TICK,           /* val = ticks */
00083         SND_TIMER_EVENT_START,          /* val = resolution in ns */
00084         SND_TIMER_EVENT_STOP,           /* val = 0 */
00085         SND_TIMER_EVENT_CONTINUE,       /* val = resolution in ns */
00086         SND_TIMER_EVENT_PAUSE,          /* val = 0 */
00087         /* master timer events for slave timer instances */
00088         SND_TIMER_EVENT_MSTART = SND_TIMER_EVENT_START + 10,
00089         SND_TIMER_EVENT_MSTOP = SND_TIMER_EVENT_STOP + 10,
00090         SND_TIMER_EVENT_MCONTINUE = SND_TIMER_EVENT_CONTINUE + 10,
00091         SND_TIMER_EVENT_MPAUSE = SND_TIMER_EVENT_PAUSE + 10,
00092 } snd_timer_event_t;
00093 
00095 typedef struct _snd_timer_read {
00096         unsigned int resolution;        
00097         unsigned int ticks;             
00098 } snd_timer_read_t;
00099 
00101 typedef struct _snd_timer_tread {
00102         snd_timer_event_t event;
00103         snd_htimestamp_t tstamp;
00104         unsigned int val;
00105 } snd_timer_tread_t;
00106 
00108 #define SND_TIMER_GLOBAL_SYSTEM 0
00109 
00110 #define SND_TIMER_GLOBAL_RTC    1
00111 
00113 #define SND_TIMER_OPEN_NONBLOCK         (1<<0)
00114 
00115 #define SND_TIMER_OPEN_TREAD            (1<<1)
00116 
00118 typedef enum _snd_timer_type {
00120         SND_TIMER_TYPE_HW = 0,
00122         SND_TIMER_TYPE_SHM,
00124         SND_TIMER_TYPE_INET
00125 } snd_timer_type_t;
00126 
00128 typedef struct _snd_timer_query snd_timer_query_t;
00130 typedef struct _snd_timer snd_timer_t;
00131 
00132 
00133 int snd_timer_query_open(snd_timer_query_t **handle, const char *name, int mode);
00134 int snd_timer_query_open_lconf(snd_timer_query_t **handle, const char *name, int mode, snd_config_t *lconf);
00135 int snd_timer_query_close(snd_timer_query_t *handle);
00136 int snd_timer_query_next_device(snd_timer_query_t *handle, snd_timer_id_t *tid);
00137 int snd_timer_query_info(snd_timer_query_t *handle, snd_timer_ginfo_t *info);
00138 int snd_timer_query_params(snd_timer_query_t *handle, snd_timer_gparams_t *params);
00139 int snd_timer_query_status(snd_timer_query_t *handle, snd_timer_gstatus_t *status);
00140 
00141 int snd_timer_open(snd_timer_t **handle, const char *name, int mode);
00142 int snd_timer_open_lconf(snd_timer_t **handle, const char *name, int mode, snd_config_t *lconf);
00143 int snd_timer_close(snd_timer_t *handle);
00144 int snd_timer_poll_descriptors_count(snd_timer_t *handle);
00145 int snd_timer_poll_descriptors(snd_timer_t *handle, struct pollfd *pfds, unsigned int space);
00146 int snd_timer_poll_descriptors_revents(snd_timer_t *timer, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
00147 int snd_timer_info(snd_timer_t *handle, snd_timer_info_t *timer);
00148 int snd_timer_params(snd_timer_t *handle, snd_timer_params_t *params);
00149 int snd_timer_status(snd_timer_t *handle, snd_timer_status_t *status);
00150 int snd_timer_start(snd_timer_t *handle);
00151 int snd_timer_stop(snd_timer_t *handle);
00152 int snd_timer_continue(snd_timer_t *handle);
00153 ssize_t snd_timer_read(snd_timer_t *handle, void *buffer, size_t size);
00154 
00155 size_t snd_timer_id_sizeof(void);
00157 #define snd_timer_id_alloca(ptr) do { assert(ptr); *ptr = (snd_timer_id_t *) alloca(snd_timer_id_sizeof()); memset(*ptr, 0, snd_timer_id_sizeof()); } while (0)
00158 int snd_timer_id_malloc(snd_timer_id_t **ptr);
00159 void snd_timer_id_free(snd_timer_id_t *obj);
00160 void snd_timer_id_copy(snd_timer_id_t *dst, const snd_timer_id_t *src);
00161 
00162 void snd_timer_id_set_class(snd_timer_id_t *id, int dev_class);
00163 int snd_timer_id_get_class(snd_timer_id_t *id);
00164 void snd_timer_id_set_sclass(snd_timer_id_t *id, int dev_sclass);
00165 int snd_timer_id_get_sclass(snd_timer_id_t *id);
00166 void snd_timer_id_set_card(snd_timer_id_t *id, int card);
00167 int snd_timer_id_get_card(snd_timer_id_t *id);
00168 void snd_timer_id_set_device(snd_timer_id_t *id, int device);
00169 int snd_timer_id_get_device(snd_timer_id_t *id);
00170 void snd_timer_id_set_subdevice(snd_timer_id_t *id, int subdevice);
00171 int snd_timer_id_get_subdevice(snd_timer_id_t *id);
00172 
00173 size_t snd_timer_info_sizeof(void);
00175 #define snd_timer_info_alloca(ptr) do { assert(ptr); *ptr = (snd_timer_info_t *) alloca(snd_timer_info_sizeof()); memset(*ptr, 0, snd_timer_info_sizeof()); } while (0)
00176 int snd_timer_info_malloc(snd_timer_info_t **ptr);
00177 void snd_timer_info_free(snd_timer_info_t *obj);
00178 void snd_timer_info_copy(snd_timer_info_t *dst, const snd_timer_info_t *src);
00179 
00180 int snd_timer_info_is_slave(snd_timer_info_t * info);
00181 int snd_timer_info_get_card(snd_timer_info_t * info);
00182 const char *snd_timer_info_get_id(snd_timer_info_t * info);
00183 const char *snd_timer_info_get_name(snd_timer_info_t * info);
00184 long snd_timer_info_get_resolution(snd_timer_info_t * info);
00185 
00186 size_t snd_timer_params_sizeof(void);
00188 #define snd_timer_params_alloca(ptr) do { assert(ptr); *ptr = (snd_timer_params_t *) alloca(snd_timer_params_sizeof()); memset(*ptr, 0, snd_timer_params_sizeof()); } while (0)
00189 int snd_timer_params_malloc(snd_timer_params_t **ptr);
00190 void snd_timer_params_free(snd_timer_params_t *obj);
00191 void snd_timer_params_copy(snd_timer_params_t *dst, const snd_timer_params_t *src);
00192 
00193 void snd_timer_params_set_auto_start(snd_timer_params_t * params, int auto_start);
00194 int snd_timer_params_get_auto_start(snd_timer_params_t * params);
00195 void snd_timer_params_set_exclusive(snd_timer_params_t * params, int exclusive);
00196 int snd_timer_params_get_exclusive(snd_timer_params_t * params);
00197 void snd_timer_params_set_ticks(snd_timer_params_t * params, long ticks);
00198 long snd_timer_params_get_ticks(snd_timer_params_t * params);
00199 void snd_timer_params_set_queue_size(snd_timer_params_t * params, long queue_size);
00200 long snd_timer_params_get_queue_size(snd_timer_params_t * params);
00201 void snd_timer_params_set_filter(snd_timer_params_t * params, unsigned int filter);
00202 unsigned int snd_timer_params_get_filter(snd_timer_params_t * params);
00203 
00204 size_t snd_timer_status_sizeof(void);
00206 #define snd_timer_status_alloca(ptr) do { assert(ptr); *ptr = (snd_timer_status_t *) alloca(snd_timer_status_sizeof()); memset(*ptr, 0, snd_timer_status_sizeof()); } while (0)
00207 int snd_timer_status_malloc(snd_timer_status_t **ptr);
00208 void snd_timer_status_free(snd_timer_status_t *obj);
00209 void snd_timer_status_copy(snd_timer_status_t *dst, const snd_timer_status_t *src);
00210 
00211 snd_htimestamp_t snd_timer_status_get_timestamp(snd_timer_status_t * status);
00212 long snd_timer_status_get_resolution(snd_timer_status_t * status);
00213 long snd_timer_status_get_lost(snd_timer_status_t * status);
00214 long snd_timer_status_get_overrun(snd_timer_status_t * status);
00215 long snd_timer_status_get_queue(snd_timer_status_t * status);
00216 
00217 /* deprecated functions, for compatibility */
00218 long snd_timer_info_get_ticks(snd_timer_info_t * info);
00219 
00222 #ifdef __cplusplus
00223 }
00224 #endif
00225 
00226 #endif 

Generated on Mon May 3 16:15:22 2004 for ALSA project - the C library reference by doxygen 1.3.6