ALSA project - the C library reference
seqmid.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_SEQMID_H
29 #define __ALSA_SEQMID_H
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
48 #define snd_seq_ev_clear(ev) \
49  memset(ev, 0, sizeof(snd_seq_event_t))
50 
58 #define snd_seq_ev_set_tag(ev,t) \
59  ((ev)->tag = (t))
60 
71 #define snd_seq_ev_set_dest(ev,c,p) \
72  ((ev)->dest.client = (c), (ev)->dest.port = (p))
73 
82 #define snd_seq_ev_set_subs(ev) \
83  ((ev)->dest.client = SND_SEQ_ADDRESS_SUBSCRIBERS,\
84  (ev)->dest.port = SND_SEQ_ADDRESS_UNKNOWN)
85 
94 #define snd_seq_ev_set_broadcast(ev) \
95  ((ev)->dest.client = SND_SEQ_ADDRESS_BROADCAST,\
96  (ev)->dest.port = SND_SEQ_ADDRESS_BROADCAST)
97 
105 #define snd_seq_ev_set_source(ev,p) \
106  ((ev)->source.port = (p))
107 
117 #define snd_seq_ev_set_direct(ev) \
118  ((ev)->queue = SND_SEQ_QUEUE_DIRECT)
119 
132 #define snd_seq_ev_schedule_tick(ev, q, relative, ttick) \
133  ((ev)->flags &= ~(SND_SEQ_TIME_STAMP_MASK | SND_SEQ_TIME_MODE_MASK),\
134  (ev)->flags |= SND_SEQ_TIME_STAMP_TICK,\
135  (ev)->flags |= (relative) ? SND_SEQ_TIME_MODE_REL : SND_SEQ_TIME_MODE_ABS,\
136  (ev)->time.tick = (ttick),\
137  (ev)->queue = (q))
138 
151 #define snd_seq_ev_schedule_real(ev, q, relative, rtime) \
152  ((ev)->flags &= ~(SND_SEQ_TIME_STAMP_MASK | SND_SEQ_TIME_MODE_MASK),\
153  (ev)->flags |= SND_SEQ_TIME_STAMP_REAL,\
154  (ev)->flags |= (relative) ? SND_SEQ_TIME_MODE_REL : SND_SEQ_TIME_MODE_ABS,\
155  (ev)->time.time = *(rtime),\
156  (ev)->queue = (q))
157 
163 #define snd_seq_ev_set_priority(ev, high_prior) \
164  ((ev)->flags &= ~SND_SEQ_PRIORITY_MASK,\
165  (ev)->flags |= (high_prior) ? SND_SEQ_PRIORITY_HIGH : SND_SEQ_PRIORITY_NORMAL)
166 
175 #define snd_seq_ev_set_fixed(ev) \
176  ((ev)->flags &= ~SND_SEQ_EVENT_LENGTH_MASK,\
177  (ev)->flags |= SND_SEQ_EVENT_LENGTH_FIXED)
178 
189 #define snd_seq_ev_set_variable(ev, datalen, dataptr) \
190  ((ev)->flags &= ~SND_SEQ_EVENT_LENGTH_MASK,\
191  (ev)->flags |= SND_SEQ_EVENT_LENGTH_VARIABLE,\
192  (ev)->data.ext.len = (datalen),\
193  (ev)->data.ext.ptr = (dataptr))
194 
205 #define snd_seq_ev_set_varusr(ev, datalen, dataptr) \
206  ((ev)->flags &= ~SND_SEQ_EVENT_LENGTH_MASK,\
207  (ev)->flags |= SND_SEQ_EVENT_LENGTH_VARUSR,\
208  (ev)->data.ext.len = (datalen),\
209  (ev)->data.ext.ptr = (dataptr))
210 
218 #define snd_seq_ev_set_queue_control(ev, typ, q, val) \
219  ((ev)->type = (typ),\
220  snd_seq_ev_set_dest(ev, SND_SEQ_CLIENT_SYSTEM, SND_SEQ_PORT_SYSTEM_TIMER),\
221  (ev)->data.queue.queue = (q),\
222  (ev)->data.queue.param.value = (val))
223 
231 #define snd_seq_ev_set_queue_start(ev, q) \
232  snd_seq_ev_set_queue_control(ev, SND_SEQ_EVENT_START, q, 0)
233 
241 #define snd_seq_ev_set_queue_stop(ev, q) \
242  snd_seq_ev_set_queue_control(ev, SND_SEQ_EVENT_STOP, q, 0)
243 
251 #define snd_seq_ev_set_queue_continue(ev, q) \
252  snd_seq_ev_set_queue_control(ev, SND_SEQ_EVENT_CONTINUE, q, 0)
253 
260 #define snd_seq_ev_set_queue_tempo(ev, q, val) \
261  snd_seq_ev_set_queue_control(ev, SND_SEQ_EVENT_TEMPO, q, val)
262 
269 #define snd_seq_ev_set_queue_pos_real(ev, q, rtime) \
270  ((ev)->type = SND_SEQ_EVENT_SETPOS_TIME,\
271  snd_seq_ev_set_dest(ev, SND_SEQ_CLIENT_SYSTEM, SND_SEQ_PORT_SYSTEM_TIMER),\
272  (ev)->data.queue.queue = (q),\
273  (ev)->data.queue.param.time.time = *(rtime))
274 
281 #define snd_seq_ev_set_queue_pos_tick(ev, q, ttime) \
282  ((ev)->type = SND_SEQ_EVENT_SETPOS_TICK,\
283  snd_seq_ev_set_dest(ev, SND_SEQ_CLIENT_SYSTEM, SND_SEQ_PORT_SYSTEM_TIMER),\
284  (ev)->data.queue.queue = (q),\
285  (ev)->data.queue.param.time.tick = (ttime))
286 
291 static inline void snd_seq_ev_set_ump(snd_seq_ump_event_t *ev)
292 {
293  ev->flags |= SND_SEQ_EVENT_UMP;
294  ev->type = 0; /* unused for UMP */
295 }
296 
303 static inline int snd_seq_ev_set_ump_data(snd_seq_ump_event_t *ev, void *data, size_t bytes)
304 {
305  if (bytes > 16)
306  return -EINVAL;
307  snd_seq_ev_set_ump(ev);
308  memcpy(ev->ump, data, bytes);
309  return 0;
310 }
311 
312 /* set and send a queue control event */
313 int snd_seq_control_queue(snd_seq_t *seq, int q, int type, int value, snd_seq_event_t *ev);
314 
321 #define snd_seq_start_queue(seq, q, ev) \
322  snd_seq_control_queue(seq, q, SND_SEQ_EVENT_START, 0, ev)
323 
330 #define snd_seq_stop_queue(seq, q, ev) \
331  snd_seq_control_queue(seq, q, SND_SEQ_EVENT_STOP, 0, ev)
332 
339 #define snd_seq_continue_queue(seq, q, ev) \
340  snd_seq_control_queue(seq, q, SND_SEQ_EVENT_CONTINUE, 0, ev)
341 
349 #define snd_seq_change_queue_tempo(seq, q, tempo, ev) \
350  snd_seq_control_queue(seq, q, SND_SEQ_EVENT_TEMPO, tempo, ev)
351 
352 /* create a port - simple version - return the port number */
353 int snd_seq_create_simple_port(snd_seq_t *seq, const char *name,
354  unsigned int caps, unsigned int type);
355 /* delete the port */
356 int snd_seq_delete_simple_port(snd_seq_t *seq, int port);
357 
358 /* simple subscription between this port and another port
359  (w/o exclusive & time conversion)
360  */
361 int snd_seq_connect_from(snd_seq_t *seq, int my_port, int src_client, int src_port);
362 int snd_seq_connect_to(snd_seq_t *seq, int my_port, int dest_client, int dest_port);
363 int snd_seq_disconnect_from(snd_seq_t *seq, int my_port, int src_client, int src_port);
364 int snd_seq_disconnect_to(snd_seq_t *seq, int my_port, int dest_client, int dest_port);
365 
366 /*
367  * set client information
368  */
369 int snd_seq_set_client_name(snd_seq_t *seq, const char *name);
370 int snd_seq_set_client_event_filter(snd_seq_t *seq, int event_type);
371 int snd_seq_set_client_midi_version(snd_seq_t *seq, int midi_version);
372 int snd_seq_set_client_ump_conversion(snd_seq_t *seq, int enable);
373 int snd_seq_set_client_pool_output(snd_seq_t *seq, size_t size);
374 int snd_seq_set_client_pool_output_room(snd_seq_t *seq, size_t size);
375 int snd_seq_set_client_pool_input(snd_seq_t *seq, size_t size);
376 /* sync output queue */
378 
379 /*
380  * parse the given string and get the sequencer address
381  */
382 int snd_seq_parse_address(snd_seq_t *seq, snd_seq_addr_t *addr, const char *str);
383 
384 /*
385  * reset client input/output pool
386  */
389 
398 #define snd_seq_ev_set_note(ev, ch, key, vel, dur) \
399  ((ev)->type = SND_SEQ_EVENT_NOTE,\
400  snd_seq_ev_set_fixed(ev),\
401  (ev)->data.note.channel = (ch),\
402  (ev)->data.note.note = (key),\
403  (ev)->data.note.velocity = (vel),\
404  (ev)->data.note.duration = (dur))
405 
413 #define snd_seq_ev_set_noteon(ev, ch, key, vel) \
414  ((ev)->type = SND_SEQ_EVENT_NOTEON,\
415  snd_seq_ev_set_fixed(ev),\
416  (ev)->data.note.channel = (ch),\
417  (ev)->data.note.note = (key),\
418  (ev)->data.note.velocity = (vel))
419 
427 #define snd_seq_ev_set_noteoff(ev, ch, key, vel) \
428  ((ev)->type = SND_SEQ_EVENT_NOTEOFF,\
429  snd_seq_ev_set_fixed(ev),\
430  (ev)->data.note.channel = (ch),\
431  (ev)->data.note.note = (key),\
432  (ev)->data.note.velocity = (vel))
433 
441 #define snd_seq_ev_set_keypress(ev,ch,key,vel) \
442  ((ev)->type = SND_SEQ_EVENT_KEYPRESS,\
443  snd_seq_ev_set_fixed(ev),\
444  (ev)->data.note.channel = (ch),\
445  (ev)->data.note.note = (key),\
446  (ev)->data.note.velocity = (vel))
447 
455 #define snd_seq_ev_set_controller(ev,ch,cc,val) \
456  ((ev)->type = SND_SEQ_EVENT_CONTROLLER,\
457  snd_seq_ev_set_fixed(ev),\
458  (ev)->data.control.channel = (ch),\
459  (ev)->data.control.param = (cc),\
460  (ev)->data.control.value = (val))
461 
468 #define snd_seq_ev_set_pgmchange(ev,ch,val) \
469  ((ev)->type = SND_SEQ_EVENT_PGMCHANGE,\
470  snd_seq_ev_set_fixed(ev),\
471  (ev)->data.control.channel = (ch),\
472  (ev)->data.control.value = (val))
473 
480 #define snd_seq_ev_set_pitchbend(ev,ch,val) \
481  ((ev)->type = SND_SEQ_EVENT_PITCHBEND,\
482  snd_seq_ev_set_fixed(ev),\
483  (ev)->data.control.channel = (ch),\
484  (ev)->data.control.value = (val))
485 
492 #define snd_seq_ev_set_chanpress(ev,ch,val) \
493  ((ev)->type = SND_SEQ_EVENT_CHANPRESS,\
494  snd_seq_ev_set_fixed(ev),\
495  (ev)->data.control.channel = (ch),\
496  (ev)->data.control.value = (val))
497 
506 #define snd_seq_ev_set_sysex(ev,datalen,dataptr) \
507  ((ev)->type = SND_SEQ_EVENT_SYSEX,\
508  snd_seq_ev_set_variable(ev, datalen, dataptr))
509 
512 #ifdef __cplusplus
513 }
514 #endif
515 
516 #endif /* __ALSA_SEQMID_H */
517 
#define SND_SEQ_EVENT_UMP
Definition: seq_event.h:228
int snd_seq_set_client_pool_input(snd_seq_t *seq, size_t size)
change the input pool size of the given client
Definition: seqmid.c:340
int snd_seq_connect_from(snd_seq_t *seq, int my_port, int src_client, int src_port)
simple subscription (w/o exclusive & time conversion)
Definition: seqmid.c:119
int snd_seq_control_queue(snd_seq_t *seq, int q, int type, int value, snd_seq_event_t *ev)
queue controls - start/stop/continue
Definition: seqmid.c:46
int snd_seq_set_client_pool_output(snd_seq_t *seq, size_t size)
change the output pool size of the given client
Definition: seqmid.c:302
int snd_seq_reset_pool_output(snd_seq_t *seq)
reset client output pool
Definition: seqmid.c:358
int snd_seq_set_client_pool_output_room(snd_seq_t *seq, size_t size)
change the output room size of the given client
Definition: seqmid.c:321
int snd_seq_parse_address(snd_seq_t *seq, snd_seq_addr_t *addr, const char *str)
parse the given string and get the sequencer address
Definition: seqmid.c:425
int snd_seq_sync_output_queue(snd_seq_t *seq)
wait until all events are processed
Definition: seqmid.c:384
int snd_seq_set_client_event_filter(snd_seq_t *seq, int event_type)
add client event filter
Definition: seqmid.c:245
int snd_seq_delete_simple_port(snd_seq_t *seq, int port)
delete the port
Definition: seqmid.c:101
int snd_seq_disconnect_from(snd_seq_t *seq, int my_port, int src_client, int src_port)
simple disconnection
Definition: seqmid.c:173
int snd_seq_create_simple_port(snd_seq_t *seq, const char *name, unsigned int caps, unsigned int type)
create a port - simple version
Definition: seqmid.c:71
int snd_seq_connect_to(snd_seq_t *seq, int my_port, int dest_client, int dest_port)
simple subscription (w/o exclusive & time conversion)
Definition: seqmid.c:146
int snd_seq_set_client_midi_version(snd_seq_t *seq, int midi_version)
set client MIDI protocol version
Definition: seqmid.c:264
int snd_seq_set_client_ump_conversion(snd_seq_t *seq, int enable)
enable/disable client's automatic conversion of UMP/legacy events
Definition: seqmid.c:283
int snd_seq_reset_pool_input(snd_seq_t *seq)
reset client input pool
Definition: seqmid.c:370
int snd_seq_set_client_name(snd_seq_t *seq, const char *name)
set client name
Definition: seqmid.c:226
int snd_seq_disconnect_to(snd_seq_t *seq, int my_port, int dest_client, int dest_port)
simple disconnection
Definition: seqmid.c:200
struct _snd_seq snd_seq_t
Definition: seq.h:47
Definition: seq_event.h:178
Definition: seq_event.h:310
Definition: seq_event.h:325
unsigned char flags
Definition: seq_event.h:327
unsigned int ump[4]
Definition: seq_event.h:336
snd_seq_event_type_t type
Definition: seq_event.h:326