ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
seq.h
Go to the documentation of this file.
1 
9 /*
10  * Application interface library for the ALSA driver
11  *
12  *
13  * This library is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU Lesser General Public License as
15  * published by the Free Software Foundation; either version 2.1 of
16  * the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU Lesser General Public License for more details.
22  *
23  * You should have received a copy of the GNU Lesser General Public
24  * License along with this library; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26  *
27  */
28 
29 #ifndef __ALSA_SEQ_H
30 #define __ALSA_SEQ_H
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
44 #define SND_SEQ_DLSYM_VERSION _dlsym_seq_001
45 
47 typedef struct _snd_seq snd_seq_t;
48 
52 #define SND_SEQ_OPEN_OUTPUT 1
53 #define SND_SEQ_OPEN_INPUT 2
54 #define SND_SEQ_OPEN_DUPLEX (SND_SEQ_OPEN_OUTPUT|SND_SEQ_OPEN_INPUT)
59 #define SND_SEQ_NONBLOCK 0x0001
62 typedef enum _snd_seq_type {
67 
69 #define SND_SEQ_ADDRESS_UNKNOWN 253
70 #define SND_SEQ_ADDRESS_SUBSCRIBERS 254
71 #define SND_SEQ_ADDRESS_BROADCAST 255
74 #define SND_SEQ_CLIENT_SYSTEM 0
76 /*
77  */
78 int snd_seq_open(snd_seq_t **handle, const char *name, int streams, int mode);
79 int snd_seq_open_lconf(snd_seq_t **handle, const char *name, int streams, int mode, snd_config_t *lconf);
80 const char *snd_seq_name(snd_seq_t *seq);
82 int snd_seq_close(snd_seq_t *handle);
83 int snd_seq_poll_descriptors_count(snd_seq_t *handle, short events);
84 int snd_seq_poll_descriptors(snd_seq_t *handle, struct pollfd *pfds, unsigned int space, short events);
85 int snd_seq_poll_descriptors_revents(snd_seq_t *seq, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
86 int snd_seq_nonblock(snd_seq_t *handle, int nonblock);
87 int snd_seq_client_id(snd_seq_t *handle);
88 
91 int snd_seq_set_output_buffer_size(snd_seq_t *handle, size_t size);
92 int snd_seq_set_input_buffer_size(snd_seq_t *handle, size_t size);
93 
95 typedef struct _snd_seq_system_info snd_seq_system_info_t;
96 
97 size_t snd_seq_system_info_sizeof(void);
99 #define snd_seq_system_info_alloca(ptr) \
100  __snd_alloca(ptr, snd_seq_system_info)
104 
111 
113 
125 typedef struct _snd_seq_client_info snd_seq_client_info_t;
126 
128 typedef enum snd_seq_client_type {
132 
133 size_t snd_seq_client_info_sizeof(void);
135 #define snd_seq_client_info_alloca(ptr) \
136  __snd_alloca(ptr, snd_seq_client_info)
140 
148 const unsigned char *snd_seq_client_info_get_event_filter(const snd_seq_client_info_t *info);
151 
153 void snd_seq_client_info_set_name(snd_seq_client_info_t *info, const char *name);
156 void snd_seq_client_info_set_event_filter(snd_seq_client_info_t *info, unsigned char *filter);
157 
162 
164 int snd_seq_get_any_client_info(snd_seq_t *handle, int client, snd_seq_client_info_t *info);
167 
168 /*
169  */
170 
172 typedef struct _snd_seq_client_pool snd_seq_client_pool_t;
173 
174 size_t snd_seq_client_pool_sizeof(void);
176 #define snd_seq_client_pool_alloca(ptr) \
177  __snd_alloca(ptr, snd_seq_client_pool)
181 
191 
194 
195 
207 typedef struct _snd_seq_port_info snd_seq_port_info_t;
208 
210 #define SND_SEQ_PORT_SYSTEM_TIMER 0
211 #define SND_SEQ_PORT_SYSTEM_ANNOUNCE 1
214 #define SND_SEQ_PORT_CAP_READ (1<<0)
215 #define SND_SEQ_PORT_CAP_WRITE (1<<1)
217 #define SND_SEQ_PORT_CAP_SYNC_READ (1<<2)
218 #define SND_SEQ_PORT_CAP_SYNC_WRITE (1<<3)
220 #define SND_SEQ_PORT_CAP_DUPLEX (1<<4)
222 #define SND_SEQ_PORT_CAP_SUBS_READ (1<<5)
223 #define SND_SEQ_PORT_CAP_SUBS_WRITE (1<<6)
224 #define SND_SEQ_PORT_CAP_NO_EXPORT (1<<7)
226 /* port type */
227 
228 #define SND_SEQ_PORT_TYPE_SPECIFIC (1<<0)
229 
230 #define SND_SEQ_PORT_TYPE_MIDI_GENERIC (1<<1)
231 
232 #define SND_SEQ_PORT_TYPE_MIDI_GM (1<<2)
233 
234 #define SND_SEQ_PORT_TYPE_MIDI_GS (1<<3)
235 
236 #define SND_SEQ_PORT_TYPE_MIDI_XG (1<<4)
237 
238 #define SND_SEQ_PORT_TYPE_MIDI_MT32 (1<<5)
239 
240 #define SND_SEQ_PORT_TYPE_MIDI_GM2 (1<<6)
241 
243 #define SND_SEQ_PORT_TYPE_SYNTH (1<<10)
244 
246 #define SND_SEQ_PORT_TYPE_DIRECT_SAMPLE (1<<11)
247 
249 #define SND_SEQ_PORT_TYPE_SAMPLE (1<<12)
250 
251 #define SND_SEQ_PORT_TYPE_HARDWARE (1<<16)
252 
253 #define SND_SEQ_PORT_TYPE_SOFTWARE (1<<17)
254 
255 #define SND_SEQ_PORT_TYPE_SYNTHESIZER (1<<18)
256 
258 #define SND_SEQ_PORT_TYPE_PORT (1<<19)
259 
260 #define SND_SEQ_PORT_TYPE_APPLICATION (1<<20)
261 
262 
263 size_t snd_seq_port_info_sizeof(void);
265 #define snd_seq_port_info_alloca(ptr) \
266  __snd_alloca(ptr, snd_seq_port_info)
270 
274 const char *snd_seq_port_info_get_name(const snd_seq_port_info_t *info);
275 unsigned int snd_seq_port_info_get_capability(const snd_seq_port_info_t *info);
276 unsigned int snd_seq_port_info_get_type(const snd_seq_port_info_t *info);
286 
287 void snd_seq_port_info_set_client(snd_seq_port_info_t *info, int client);
288 void snd_seq_port_info_set_port(snd_seq_port_info_t *info, int port);
290 void snd_seq_port_info_set_name(snd_seq_port_info_t *info, const char *name);
291 void snd_seq_port_info_set_capability(snd_seq_port_info_t *info, unsigned int capability);
292 void snd_seq_port_info_set_type(snd_seq_port_info_t *info, unsigned int type);
300 
302 int snd_seq_delete_port(snd_seq_t *handle, int port);
303 int snd_seq_get_port_info(snd_seq_t *handle, int port, snd_seq_port_info_t *info);
304 int snd_seq_get_any_port_info(snd_seq_t *handle, int client, int port, snd_seq_port_info_t *info);
305 int snd_seq_set_port_info(snd_seq_t *handle, int port, snd_seq_port_info_t *info);
307 
319 typedef struct _snd_seq_port_subscribe snd_seq_port_subscribe_t;
320 
321 size_t snd_seq_port_subscribe_sizeof(void);
323 #define snd_seq_port_subscribe_alloca(ptr) \
324  __snd_alloca(ptr, snd_seq_port_subscribe)
328 
335 
342 
346 
347 /*
348  */
349 
351 typedef struct _snd_seq_query_subscribe snd_seq_query_subscribe_t;
352 
354 typedef enum {
358 
359 size_t snd_seq_query_subscribe_sizeof(void);
361 #define snd_seq_query_subscribe_alloca(ptr) \
362  __snd_alloca(ptr, snd_seq_query_subscribe)
366 
378 
384 
386 
398 typedef struct _snd_seq_queue_info snd_seq_queue_info_t;
400 typedef struct _snd_seq_queue_status snd_seq_queue_status_t;
402 typedef struct _snd_seq_queue_tempo snd_seq_queue_tempo_t;
404 typedef struct _snd_seq_queue_timer snd_seq_queue_timer_t;
405 
407 #define SND_SEQ_QUEUE_DIRECT 253
409 size_t snd_seq_queue_info_sizeof(void);
410 
411 #define snd_seq_queue_info_alloca(ptr) \
412  __snd_alloca(ptr, snd_seq_queue_info)
416 
418 const char *snd_seq_queue_info_get_name(const snd_seq_queue_info_t *info);
421 unsigned int snd_seq_queue_info_get_flags(const snd_seq_queue_info_t *info);
422 
423 void snd_seq_queue_info_set_name(snd_seq_queue_info_t *info, const char *name);
426 void snd_seq_queue_info_set_flags(snd_seq_queue_info_t *info, unsigned int flags);
427 
429 int snd_seq_alloc_named_queue(snd_seq_t *seq, const char *name);
430 int snd_seq_alloc_queue(snd_seq_t *handle);
431 int snd_seq_free_queue(snd_seq_t *handle, int q);
434 int snd_seq_query_named_queue(snd_seq_t *seq, const char *name);
435 
436 int snd_seq_get_queue_usage(snd_seq_t *handle, int q);
437 int snd_seq_set_queue_usage(snd_seq_t *handle, int q, int used);
438 
439 /*
440  */
441 size_t snd_seq_queue_status_sizeof(void);
443 #define snd_seq_queue_status_alloca(ptr) \
444  __snd_alloca(ptr, snd_seq_queue_status)
448 
454 
455 int snd_seq_get_queue_status(snd_seq_t *handle, int q, snd_seq_queue_status_t *status);
456 
457 /*
458  */
459 size_t snd_seq_queue_tempo_sizeof(void);
461 #define snd_seq_queue_tempo_alloca(ptr) \
462  __snd_alloca(ptr, snd_seq_queue_tempo)
466 
468 unsigned int snd_seq_queue_tempo_get_tempo(const snd_seq_queue_tempo_t *info);
470 unsigned int snd_seq_queue_tempo_get_skew(const snd_seq_queue_tempo_t *info);
472 void snd_seq_queue_tempo_set_tempo(snd_seq_queue_tempo_t *info, unsigned int tempo);
474 void snd_seq_queue_tempo_set_skew(snd_seq_queue_tempo_t *info, unsigned int skew);
475 void snd_seq_queue_tempo_set_skew_base(snd_seq_queue_tempo_t *info, unsigned int base);
476 
477 int snd_seq_get_queue_tempo(snd_seq_t *handle, int q, snd_seq_queue_tempo_t *tempo);
478 int snd_seq_set_queue_tempo(snd_seq_t *handle, int q, snd_seq_queue_tempo_t *tempo);
479 
480 /*
481  */
482 
484 typedef enum {
485  SND_SEQ_TIMER_ALSA = 0, /* ALSA timer */
486  SND_SEQ_TIMER_MIDI_CLOCK = 1, /* Midi Clock (CLOCK event) */
487  SND_SEQ_TIMER_MIDI_TICK = 2 /* Midi Timer Tick (TICK event */
489 
490 size_t snd_seq_queue_timer_sizeof(void);
492 #define snd_seq_queue_timer_alloca(ptr) \
493  __snd_alloca(ptr, snd_seq_queue_timer)
497 
502 
505 void snd_seq_queue_timer_set_resolution(snd_seq_queue_timer_t *info, unsigned int resolution);
506 
507 int snd_seq_get_queue_timer(snd_seq_t *handle, int q, snd_seq_queue_timer_t *timer);
508 int snd_seq_set_queue_timer(snd_seq_t *handle, int q, snd_seq_queue_timer_t *timer);
509 
525 int snd_seq_event_input_pending(snd_seq_t *seq, int fetch_sequencer);
526 int snd_seq_drain_output(snd_seq_t *handle);
529 int snd_seq_drop_output(snd_seq_t *handle);
531 int snd_seq_drop_input(snd_seq_t *handle);
533 
535 typedef struct _snd_seq_remove_events snd_seq_remove_events_t;
536 
538 #define SND_SEQ_REMOVE_INPUT (1<<0)
539 #define SND_SEQ_REMOVE_OUTPUT (1<<1)
540 #define SND_SEQ_REMOVE_DEST (1<<2)
541 #define SND_SEQ_REMOVE_DEST_CHANNEL (1<<3)
542 #define SND_SEQ_REMOVE_TIME_BEFORE (1<<4)
543 #define SND_SEQ_REMOVE_TIME_AFTER (1<<5)
544 #define SND_SEQ_REMOVE_TIME_TICK (1<<6)
545 #define SND_SEQ_REMOVE_EVENT_TYPE (1<<7)
546 #define SND_SEQ_REMOVE_IGNORE_OFF (1<<8)
547 #define SND_SEQ_REMOVE_TAG_MATCH (1<<9)
549 size_t snd_seq_remove_events_sizeof(void);
550 
551 #define snd_seq_remove_events_alloca(ptr) \
552  __snd_alloca(ptr, snd_seq_remove_events)
556 
564 
565 void snd_seq_remove_events_set_condition(snd_seq_remove_events_t *info, unsigned int flags);
572 
574 
584 void snd_seq_set_bit(int nr, void *array);
585 void snd_seq_unset_bit(int nr, void *array);
586 int snd_seq_change_bit(int nr, void *array);
587 int snd_seq_get_bit(int nr, void *array);
588 
599 /* event type macros */
600 enum {
601  SND_SEQ_EVFLG_RESULT,
602  SND_SEQ_EVFLG_NOTE,
603  SND_SEQ_EVFLG_CONTROL,
604  SND_SEQ_EVFLG_QUEUE,
605  SND_SEQ_EVFLG_SYSTEM,
606  SND_SEQ_EVFLG_MESSAGE,
607  SND_SEQ_EVFLG_CONNECTION,
608  SND_SEQ_EVFLG_SAMPLE,
609  SND_SEQ_EVFLG_USERS,
610  SND_SEQ_EVFLG_INSTR,
611  SND_SEQ_EVFLG_QUOTE,
612  SND_SEQ_EVFLG_NONE,
613  SND_SEQ_EVFLG_RAW,
614  SND_SEQ_EVFLG_FIXED,
615  SND_SEQ_EVFLG_VARIABLE,
616  SND_SEQ_EVFLG_VARUSR
617 };
618 
619 enum {
620  SND_SEQ_EVFLG_NOTE_ONEARG,
621  SND_SEQ_EVFLG_NOTE_TWOARG
622 };
623 
624 enum {
625  SND_SEQ_EVFLG_QUEUE_NOARG,
626  SND_SEQ_EVFLG_QUEUE_TICK,
627  SND_SEQ_EVFLG_QUEUE_TIME,
628  SND_SEQ_EVFLG_QUEUE_VALUE
629 };
630 
636 extern const unsigned int snd_seq_event_types[];
637 
638 #define _SND_SEQ_TYPE(x) (1<<(x))
639 #define _SND_SEQ_TYPE_OPT(x) ((x)<<24)
642 #define snd_seq_type_check(ev,x) (snd_seq_event_types[(ev)->type] & _SND_SEQ_TYPE(x))
643 
645 #define snd_seq_ev_is_result_type(ev) \
646  snd_seq_type_check(ev, SND_SEQ_EVFLG_RESULT)
647 
648 #define snd_seq_ev_is_note_type(ev) \
649  snd_seq_type_check(ev, SND_SEQ_EVFLG_NOTE)
650 
651 #define snd_seq_ev_is_control_type(ev) \
652  snd_seq_type_check(ev, SND_SEQ_EVFLG_CONTROL)
653 
654 #define snd_seq_ev_is_channel_type(ev) \
655  (snd_seq_event_types[(ev)->type] & (_SND_SEQ_TYPE(SND_SEQ_EVFLG_NOTE) | _SND_SEQ_TYPE(SND_SEQ_EVFLG_CONTROL)))
656 
658 #define snd_seq_ev_is_queue_type(ev) \
659  snd_seq_type_check(ev, SND_SEQ_EVFLG_QUEUE)
660 
661 #define snd_seq_ev_is_message_type(ev) \
662  snd_seq_type_check(ev, SND_SEQ_EVFLG_MESSAGE)
663 
664 #define snd_seq_ev_is_subscribe_type(ev) \
665  snd_seq_type_check(ev, SND_SEQ_EVFLG_CONNECTION)
666 
667 #define snd_seq_ev_is_sample_type(ev) \
668  snd_seq_type_check(ev, SND_SEQ_EVFLG_SAMPLE)
669 
670 #define snd_seq_ev_is_user_type(ev) \
671  snd_seq_type_check(ev, SND_SEQ_EVFLG_USERS)
672 
673 #define snd_seq_ev_is_instr_type(ev) \
674  snd_seq_type_check(ev, SND_SEQ_EVFLG_INSTR)
675 
676 #define snd_seq_ev_is_fixed_type(ev) \
677  snd_seq_type_check(ev, SND_SEQ_EVFLG_FIXED)
678 
679 #define snd_seq_ev_is_variable_type(ev) \
680  snd_seq_type_check(ev, SND_SEQ_EVFLG_VARIABLE)
681 
682 #define snd_seq_ev_is_varusr_type(ev) \
683  snd_seq_type_check(ev, SND_SEQ_EVFLG_VARUSR)
684 
685 #define snd_seq_ev_is_reserved(ev) \
686  (! snd_seq_event_types[(ev)->type])
687 
692 #define snd_seq_ev_is_prior(ev) \
693  (((ev)->flags & SND_SEQ_PRIORITY_MASK) == SND_SEQ_PRIORITY_HIGH)
694 
696 #define snd_seq_ev_length_type(ev) \
697  ((ev)->flags & SND_SEQ_EVENT_LENGTH_MASK)
698 
699 #define snd_seq_ev_is_fixed(ev) \
700  (snd_seq_ev_length_type(ev) == SND_SEQ_EVENT_LENGTH_FIXED)
701 
702 #define snd_seq_ev_is_variable(ev) \
703  (snd_seq_ev_length_type(ev) == SND_SEQ_EVENT_LENGTH_VARIABLE)
704 
705 #define snd_seq_ev_is_varusr(ev) \
706  (snd_seq_ev_length_type(ev) == SND_SEQ_EVENT_LENGTH_VARUSR)
707 
709 #define snd_seq_ev_timestamp_type(ev) \
710  ((ev)->flags & SND_SEQ_TIME_STAMP_MASK)
711 
712 #define snd_seq_ev_is_tick(ev) \
713  (snd_seq_ev_timestamp_type(ev) == SND_SEQ_TIME_STAMP_TICK)
714 
715 #define snd_seq_ev_is_real(ev) \
716  (snd_seq_ev_timestamp_type(ev) == SND_SEQ_TIME_STAMP_REAL)
717 
719 #define snd_seq_ev_timemode_type(ev) \
720  ((ev)->flags & SND_SEQ_TIME_MODE_MASK)
721 
722 #define snd_seq_ev_is_abstime(ev) \
723  (snd_seq_ev_timemode_type(ev) == SND_SEQ_TIME_MODE_ABS)
724 
725 #define snd_seq_ev_is_reltime(ev) \
726  (snd_seq_ev_timemode_type(ev) == SND_SEQ_TIME_MODE_REL)
727 
729 #define snd_seq_ev_is_direct(ev) \
730  ((ev)->queue == SND_SEQ_QUEUE_DIRECT)
731 
734 #ifdef __cplusplus
735 }
736 #endif
737 
738 #endif /* __ALSA_SEQ_H */
739