asequencer.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679
  1. /*
  2. * Main header file for the ALSA sequencer
  3. * Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
  4. * (c) 1998-1999 by Jaroslav Kysela <perex@perex.cz>
  5. *
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 2 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program; if not, write to the Free Software
  19. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20. *
  21. */
  22. #ifndef __SOUND_ASEQUENCER_H
  23. #define __SOUND_ASEQUENCER_H
  24. #ifdef __KERNEL__
  25. #include <linux/ioctl.h>
  26. #include <sound/asound.h>
  27. #endif
  28. /** version of the sequencer */
  29. #define SNDRV_SEQ_VERSION SNDRV_PROTOCOL_VERSION (1, 0, 1)
  30. /**
  31. * definition of sequencer event types
  32. */
  33. /** system messages
  34. * event data type = #snd_seq_result
  35. */
  36. #define SNDRV_SEQ_EVENT_SYSTEM 0
  37. #define SNDRV_SEQ_EVENT_RESULT 1
  38. /** note messages (channel specific)
  39. * event data type = #snd_seq_ev_note
  40. */
  41. #define SNDRV_SEQ_EVENT_NOTE 5
  42. #define SNDRV_SEQ_EVENT_NOTEON 6
  43. #define SNDRV_SEQ_EVENT_NOTEOFF 7
  44. #define SNDRV_SEQ_EVENT_KEYPRESS 8
  45. /** control messages (channel specific)
  46. * event data type = #snd_seq_ev_ctrl
  47. */
  48. #define SNDRV_SEQ_EVENT_CONTROLLER 10
  49. #define SNDRV_SEQ_EVENT_PGMCHANGE 11
  50. #define SNDRV_SEQ_EVENT_CHANPRESS 12
  51. #define SNDRV_SEQ_EVENT_PITCHBEND 13 /**< from -8192 to 8191 */
  52. #define SNDRV_SEQ_EVENT_CONTROL14 14 /**< 14 bit controller value */
  53. #define SNDRV_SEQ_EVENT_NONREGPARAM 15 /**< 14 bit NRPN address + 14 bit unsigned value */
  54. #define SNDRV_SEQ_EVENT_REGPARAM 16 /**< 14 bit RPN address + 14 bit unsigned value */
  55. /** synchronisation messages
  56. * event data type = #snd_seq_ev_ctrl
  57. */
  58. #define SNDRV_SEQ_EVENT_SONGPOS 20 /* Song Position Pointer with LSB and MSB values */
  59. #define SNDRV_SEQ_EVENT_SONGSEL 21 /* Song Select with song ID number */
  60. #define SNDRV_SEQ_EVENT_QFRAME 22 /* midi time code quarter frame */
  61. #define SNDRV_SEQ_EVENT_TIMESIGN 23 /* SMF Time Signature event */
  62. #define SNDRV_SEQ_EVENT_KEYSIGN 24 /* SMF Key Signature event */
  63. /** timer messages
  64. * event data type = snd_seq_ev_queue_control
  65. */
  66. #define SNDRV_SEQ_EVENT_START 30 /* midi Real Time Start message */
  67. #define SNDRV_SEQ_EVENT_CONTINUE 31 /* midi Real Time Continue message */
  68. #define SNDRV_SEQ_EVENT_STOP 32 /* midi Real Time Stop message */
  69. #define SNDRV_SEQ_EVENT_SETPOS_TICK 33 /* set tick queue position */
  70. #define SNDRV_SEQ_EVENT_SETPOS_TIME 34 /* set realtime queue position */
  71. #define SNDRV_SEQ_EVENT_TEMPO 35 /* (SMF) Tempo event */
  72. #define SNDRV_SEQ_EVENT_CLOCK 36 /* midi Real Time Clock message */
  73. #define SNDRV_SEQ_EVENT_TICK 37 /* midi Real Time Tick message */
  74. #define SNDRV_SEQ_EVENT_QUEUE_SKEW 38 /* skew queue tempo */
  75. /** others
  76. * event data type = none
  77. */
  78. #define SNDRV_SEQ_EVENT_TUNE_REQUEST 40 /* tune request */
  79. #define SNDRV_SEQ_EVENT_RESET 41 /* reset to power-on state */
  80. #define SNDRV_SEQ_EVENT_SENSING 42 /* "active sensing" event */
  81. /** echo back, kernel private messages
  82. * event data type = any type
  83. */
  84. #define SNDRV_SEQ_EVENT_ECHO 50 /* echo event */
  85. #define SNDRV_SEQ_EVENT_OSS 51 /* OSS raw event */
  86. /** system status messages (broadcast for subscribers)
  87. * event data type = snd_seq_addr
  88. */
  89. #define SNDRV_SEQ_EVENT_CLIENT_START 60 /* new client has connected */
  90. #define SNDRV_SEQ_EVENT_CLIENT_EXIT 61 /* client has left the system */
  91. #define SNDRV_SEQ_EVENT_CLIENT_CHANGE 62 /* client status/info has changed */
  92. #define SNDRV_SEQ_EVENT_PORT_START 63 /* new port was created */
  93. #define SNDRV_SEQ_EVENT_PORT_EXIT 64 /* port was deleted from system */
  94. #define SNDRV_SEQ_EVENT_PORT_CHANGE 65 /* port status/info has changed */
  95. /** port connection changes
  96. * event data type = snd_seq_connect
  97. */
  98. #define SNDRV_SEQ_EVENT_PORT_SUBSCRIBED 66 /* ports connected */
  99. #define SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED 67 /* ports disconnected */
  100. /* 70-89: synthesizer events - obsoleted */
  101. /** user-defined events with fixed length
  102. * event data type = any
  103. */
  104. #define SNDRV_SEQ_EVENT_USR0 90
  105. #define SNDRV_SEQ_EVENT_USR1 91
  106. #define SNDRV_SEQ_EVENT_USR2 92
  107. #define SNDRV_SEQ_EVENT_USR3 93
  108. #define SNDRV_SEQ_EVENT_USR4 94
  109. #define SNDRV_SEQ_EVENT_USR5 95
  110. #define SNDRV_SEQ_EVENT_USR6 96
  111. #define SNDRV_SEQ_EVENT_USR7 97
  112. #define SNDRV_SEQ_EVENT_USR8 98
  113. #define SNDRV_SEQ_EVENT_USR9 99
  114. /* 100-118: instrument layer - obsoleted */
  115. /* 119-129: reserved */
  116. /* 130-139: variable length events
  117. * event data type = snd_seq_ev_ext
  118. * (SNDRV_SEQ_EVENT_LENGTH_VARIABLE must be set)
  119. */
  120. #define SNDRV_SEQ_EVENT_SYSEX 130 /* system exclusive data (variable length) */
  121. #define SNDRV_SEQ_EVENT_BOUNCE 131 /* error event */
  122. /* 132-134: reserved */
  123. #define SNDRV_SEQ_EVENT_USR_VAR0 135
  124. #define SNDRV_SEQ_EVENT_USR_VAR1 136
  125. #define SNDRV_SEQ_EVENT_USR_VAR2 137
  126. #define SNDRV_SEQ_EVENT_USR_VAR3 138
  127. #define SNDRV_SEQ_EVENT_USR_VAR4 139
  128. /* 150-151: kernel events with quote - DO NOT use in user clients */
  129. #define SNDRV_SEQ_EVENT_KERNEL_ERROR 150
  130. #define SNDRV_SEQ_EVENT_KERNEL_QUOTE 151 /* obsolete */
  131. /* 152-191: reserved */
  132. /* 192-254: hardware specific events */
  133. /* 255: special event */
  134. #define SNDRV_SEQ_EVENT_NONE 255
  135. typedef unsigned char snd_seq_event_type_t;
  136. /** event address */
  137. struct snd_seq_addr {
  138. unsigned char client; /**< Client number: 0..255, 255 = broadcast to all clients */
  139. unsigned char port; /**< Port within client: 0..255, 255 = broadcast to all ports */
  140. };
  141. /** port connection */
  142. struct snd_seq_connect {
  143. struct snd_seq_addr sender;
  144. struct snd_seq_addr dest;
  145. };
  146. #define SNDRV_SEQ_ADDRESS_UNKNOWN 253 /* unknown source */
  147. #define SNDRV_SEQ_ADDRESS_SUBSCRIBERS 254 /* send event to all subscribed ports */
  148. #define SNDRV_SEQ_ADDRESS_BROADCAST 255 /* send event to all queues/clients/ports/channels */
  149. #define SNDRV_SEQ_QUEUE_DIRECT 253 /* direct dispatch */
  150. /* event mode flag - NOTE: only 8 bits available! */
  151. #define SNDRV_SEQ_TIME_STAMP_TICK (0<<0) /* timestamp in clock ticks */
  152. #define SNDRV_SEQ_TIME_STAMP_REAL (1<<0) /* timestamp in real time */
  153. #define SNDRV_SEQ_TIME_STAMP_MASK (1<<0)
  154. #define SNDRV_SEQ_TIME_MODE_ABS (0<<1) /* absolute timestamp */
  155. #define SNDRV_SEQ_TIME_MODE_REL (1<<1) /* relative to current time */
  156. #define SNDRV_SEQ_TIME_MODE_MASK (1<<1)
  157. #define SNDRV_SEQ_EVENT_LENGTH_FIXED (0<<2) /* fixed event size */
  158. #define SNDRV_SEQ_EVENT_LENGTH_VARIABLE (1<<2) /* variable event size */
  159. #define SNDRV_SEQ_EVENT_LENGTH_VARUSR (2<<2) /* variable event size - user memory space */
  160. #define SNDRV_SEQ_EVENT_LENGTH_MASK (3<<2)
  161. #define SNDRV_SEQ_PRIORITY_NORMAL (0<<4) /* normal priority */
  162. #define SNDRV_SEQ_PRIORITY_HIGH (1<<4) /* event should be processed before others */
  163. #define SNDRV_SEQ_PRIORITY_MASK (1<<4)
  164. /* note event */
  165. struct snd_seq_ev_note {
  166. unsigned char channel;
  167. unsigned char note;
  168. unsigned char velocity;
  169. unsigned char off_velocity; /* only for SNDRV_SEQ_EVENT_NOTE */
  170. unsigned int duration; /* only for SNDRV_SEQ_EVENT_NOTE */
  171. };
  172. /* controller event */
  173. struct snd_seq_ev_ctrl {
  174. unsigned char channel;
  175. unsigned char unused1, unused2, unused3; /* pad */
  176. unsigned int param;
  177. signed int value;
  178. };
  179. /* generic set of bytes (12x8 bit) */
  180. struct snd_seq_ev_raw8 {
  181. unsigned char d[12]; /* 8 bit value */
  182. };
  183. /* generic set of integers (3x32 bit) */
  184. struct snd_seq_ev_raw32 {
  185. unsigned int d[3]; /* 32 bit value */
  186. };
  187. /* external stored data */
  188. struct snd_seq_ev_ext {
  189. unsigned int len; /* length of data */
  190. void *ptr; /* pointer to data (note: maybe 64-bit) */
  191. } __attribute__((packed));
  192. struct snd_seq_result {
  193. int event; /* processed event type */
  194. int result;
  195. };
  196. struct snd_seq_real_time {
  197. unsigned int tv_sec; /* seconds */
  198. unsigned int tv_nsec; /* nanoseconds */
  199. };
  200. typedef unsigned int snd_seq_tick_time_t; /* midi ticks */
  201. union snd_seq_timestamp {
  202. snd_seq_tick_time_t tick;
  203. struct snd_seq_real_time time;
  204. };
  205. struct snd_seq_queue_skew {
  206. unsigned int value;
  207. unsigned int base;
  208. };
  209. /* queue timer control */
  210. struct snd_seq_ev_queue_control {
  211. unsigned char queue; /* affected queue */
  212. unsigned char pad[3]; /* reserved */
  213. union {
  214. signed int value; /* affected value (e.g. tempo) */
  215. union snd_seq_timestamp time; /* time */
  216. unsigned int position; /* sync position */
  217. struct snd_seq_queue_skew skew;
  218. unsigned int d32[2];
  219. unsigned char d8[8];
  220. } param;
  221. };
  222. /* quoted event - inside the kernel only */
  223. struct snd_seq_ev_quote {
  224. struct snd_seq_addr origin; /* original sender */
  225. unsigned short value; /* optional data */
  226. struct snd_seq_event *event; /* quoted event */
  227. } __attribute__((packed));
  228. /* sequencer event */
  229. struct snd_seq_event {
  230. snd_seq_event_type_t type; /* event type */
  231. unsigned char flags; /* event flags */
  232. char tag;
  233. unsigned char queue; /* schedule queue */
  234. union snd_seq_timestamp time; /* schedule time */
  235. struct snd_seq_addr source; /* source address */
  236. struct snd_seq_addr dest; /* destination address */
  237. union { /* event data... */
  238. struct snd_seq_ev_note note;
  239. struct snd_seq_ev_ctrl control;
  240. struct snd_seq_ev_raw8 raw8;
  241. struct snd_seq_ev_raw32 raw32;
  242. struct snd_seq_ev_ext ext;
  243. struct snd_seq_ev_queue_control queue;
  244. union snd_seq_timestamp time;
  245. struct snd_seq_addr addr;
  246. struct snd_seq_connect connect;
  247. struct snd_seq_result result;
  248. struct snd_seq_ev_quote quote;
  249. } data;
  250. };
  251. /*
  252. * bounce event - stored as variable size data
  253. */
  254. struct snd_seq_event_bounce {
  255. int err;
  256. struct snd_seq_event event;
  257. /* external data follows here. */
  258. };
  259. #ifdef __KERNEL__
  260. /* helper macro */
  261. #define snd_seq_event_bounce_ext_data(ev) ((void*)((char *)(ev)->data.ext.ptr + sizeof(struct snd_seq_event_bounce)))
  262. /*
  263. * type check macros
  264. */
  265. /* result events: 0-4 */
  266. #define snd_seq_ev_is_result_type(ev) ((ev)->type < 5)
  267. /* channel specific events: 5-19 */
  268. #define snd_seq_ev_is_channel_type(ev) ((ev)->type >= 5 && (ev)->type < 20)
  269. /* note events: 5-9 */
  270. #define snd_seq_ev_is_note_type(ev) ((ev)->type >= 5 && (ev)->type < 10)
  271. /* control events: 10-19 */
  272. #define snd_seq_ev_is_control_type(ev) ((ev)->type >= 10 && (ev)->type < 20)
  273. /* queue control events: 30-39 */
  274. #define snd_seq_ev_is_queue_type(ev) ((ev)->type >= 30 && (ev)->type < 40)
  275. /* system status messages */
  276. #define snd_seq_ev_is_message_type(ev) ((ev)->type >= 60 && (ev)->type < 69)
  277. /* sample messages */
  278. #define snd_seq_ev_is_sample_type(ev) ((ev)->type >= 70 && (ev)->type < 79)
  279. /* user-defined messages */
  280. #define snd_seq_ev_is_user_type(ev) ((ev)->type >= 90 && (ev)->type < 99)
  281. /* fixed length events: 0-99 */
  282. #define snd_seq_ev_is_fixed_type(ev) ((ev)->type < 100)
  283. /* variable length events: 130-139 */
  284. #define snd_seq_ev_is_variable_type(ev) ((ev)->type >= 130 && (ev)->type < 140)
  285. /* reserved for kernel */
  286. #define snd_seq_ev_is_reserved(ev) ((ev)->type >= 150)
  287. /* direct dispatched events */
  288. #define snd_seq_ev_is_direct(ev) ((ev)->queue == SNDRV_SEQ_QUEUE_DIRECT)
  289. /*
  290. * macros to check event flags
  291. */
  292. /* prior events */
  293. #define snd_seq_ev_is_prior(ev) (((ev)->flags & SNDRV_SEQ_PRIORITY_MASK) == SNDRV_SEQ_PRIORITY_HIGH)
  294. /* event length type */
  295. #define snd_seq_ev_length_type(ev) ((ev)->flags & SNDRV_SEQ_EVENT_LENGTH_MASK)
  296. #define snd_seq_ev_is_fixed(ev) (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_FIXED)
  297. #define snd_seq_ev_is_variable(ev) (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
  298. #define snd_seq_ev_is_varusr(ev) (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARUSR)
  299. /* time-stamp type */
  300. #define snd_seq_ev_timestamp_type(ev) ((ev)->flags & SNDRV_SEQ_TIME_STAMP_MASK)
  301. #define snd_seq_ev_is_tick(ev) (snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_TICK)
  302. #define snd_seq_ev_is_real(ev) (snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_REAL)
  303. /* time-mode type */
  304. #define snd_seq_ev_timemode_type(ev) ((ev)->flags & SNDRV_SEQ_TIME_MODE_MASK)
  305. #define snd_seq_ev_is_abstime(ev) (snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_ABS)
  306. #define snd_seq_ev_is_reltime(ev) (snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_REL)
  307. /* queue sync port */
  308. #define snd_seq_queue_sync_port(q) ((q) + 16)
  309. #endif /* __KERNEL__ */
  310. /* system information */
  311. struct snd_seq_system_info {
  312. int queues; /* maximum queues count */
  313. int clients; /* maximum clients count */
  314. int ports; /* maximum ports per client */
  315. int channels; /* maximum channels per port */
  316. int cur_clients; /* current clients */
  317. int cur_queues; /* current queues */
  318. char reserved[24];
  319. };
  320. /* system running information */
  321. struct snd_seq_running_info {
  322. unsigned char client; /* client id */
  323. unsigned char big_endian; /* 1 = big-endian */
  324. unsigned char cpu_mode; /* 4 = 32bit, 8 = 64bit */
  325. unsigned char pad; /* reserved */
  326. unsigned char reserved[12];
  327. };
  328. /* known client numbers */
  329. #define SNDRV_SEQ_CLIENT_SYSTEM 0
  330. /* internal client numbers */
  331. #define SNDRV_SEQ_CLIENT_DUMMY 14 /* midi through */
  332. #define SNDRV_SEQ_CLIENT_OSS 15 /* oss sequencer emulator */
  333. /* client types */
  334. typedef int __bitwise snd_seq_client_type_t;
  335. #define NO_CLIENT ((__force snd_seq_client_type_t) 0)
  336. #define USER_CLIENT ((__force snd_seq_client_type_t) 1)
  337. #define KERNEL_CLIENT ((__force snd_seq_client_type_t) 2)
  338. /* event filter flags */
  339. #define SNDRV_SEQ_FILTER_BROADCAST (1<<0) /* accept broadcast messages */
  340. #define SNDRV_SEQ_FILTER_MULTICAST (1<<1) /* accept multicast messages */
  341. #define SNDRV_SEQ_FILTER_BOUNCE (1<<2) /* accept bounce event in error */
  342. #define SNDRV_SEQ_FILTER_USE_EVENT (1<<31) /* use event filter */
  343. struct snd_seq_client_info {
  344. int client; /* client number to inquire */
  345. snd_seq_client_type_t type; /* client type */
  346. char name[64]; /* client name */
  347. unsigned int filter; /* filter flags */
  348. unsigned char multicast_filter[8]; /* multicast filter bitmap */
  349. unsigned char event_filter[32]; /* event filter bitmap */
  350. int num_ports; /* RO: number of ports */
  351. int event_lost; /* number of lost events */
  352. char reserved[64]; /* for future use */
  353. };
  354. /* client pool size */
  355. struct snd_seq_client_pool {
  356. int client; /* client number to inquire */
  357. int output_pool; /* outgoing (write) pool size */
  358. int input_pool; /* incoming (read) pool size */
  359. int output_room; /* minimum free pool size for select/blocking mode */
  360. int output_free; /* unused size */
  361. int input_free; /* unused size */
  362. char reserved[64];
  363. };
  364. /* Remove events by specified criteria */
  365. #define SNDRV_SEQ_REMOVE_INPUT (1<<0) /* Flush input queues */
  366. #define SNDRV_SEQ_REMOVE_OUTPUT (1<<1) /* Flush output queues */
  367. #define SNDRV_SEQ_REMOVE_DEST (1<<2) /* Restrict by destination q:client:port */
  368. #define SNDRV_SEQ_REMOVE_DEST_CHANNEL (1<<3) /* Restrict by channel */
  369. #define SNDRV_SEQ_REMOVE_TIME_BEFORE (1<<4) /* Restrict to before time */
  370. #define SNDRV_SEQ_REMOVE_TIME_AFTER (1<<5) /* Restrict to time or after */
  371. #define SNDRV_SEQ_REMOVE_TIME_TICK (1<<6) /* Time is in ticks */
  372. #define SNDRV_SEQ_REMOVE_EVENT_TYPE (1<<7) /* Restrict to event type */
  373. #define SNDRV_SEQ_REMOVE_IGNORE_OFF (1<<8) /* Do not flush off events */
  374. #define SNDRV_SEQ_REMOVE_TAG_MATCH (1<<9) /* Restrict to events with given tag */
  375. struct snd_seq_remove_events {
  376. unsigned int remove_mode; /* Flags that determine what gets removed */
  377. union snd_seq_timestamp time;
  378. unsigned char queue; /* Queue for REMOVE_DEST */
  379. struct snd_seq_addr dest; /* Address for REMOVE_DEST */
  380. unsigned char channel; /* Channel for REMOVE_DEST */
  381. int type; /* For REMOVE_EVENT_TYPE */
  382. char tag; /* Tag for REMOVE_TAG */
  383. int reserved[10]; /* To allow for future binary compatibility */
  384. };
  385. /* known port numbers */
  386. #define SNDRV_SEQ_PORT_SYSTEM_TIMER 0
  387. #define SNDRV_SEQ_PORT_SYSTEM_ANNOUNCE 1
  388. /* port capabilities (32 bits) */
  389. #define SNDRV_SEQ_PORT_CAP_READ (1<<0) /* readable from this port */
  390. #define SNDRV_SEQ_PORT_CAP_WRITE (1<<1) /* writable to this port */
  391. #define SNDRV_SEQ_PORT_CAP_SYNC_READ (1<<2)
  392. #define SNDRV_SEQ_PORT_CAP_SYNC_WRITE (1<<3)
  393. #define SNDRV_SEQ_PORT_CAP_DUPLEX (1<<4)
  394. #define SNDRV_SEQ_PORT_CAP_SUBS_READ (1<<5) /* allow read subscription */
  395. #define SNDRV_SEQ_PORT_CAP_SUBS_WRITE (1<<6) /* allow write subscription */
  396. #define SNDRV_SEQ_PORT_CAP_NO_EXPORT (1<<7) /* routing not allowed */
  397. /* port type */
  398. #define SNDRV_SEQ_PORT_TYPE_SPECIFIC (1<<0) /* hardware specific */
  399. #define SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC (1<<1) /* generic MIDI device */
  400. #define SNDRV_SEQ_PORT_TYPE_MIDI_GM (1<<2) /* General MIDI compatible device */
  401. #define SNDRV_SEQ_PORT_TYPE_MIDI_GS (1<<3) /* GS compatible device */
  402. #define SNDRV_SEQ_PORT_TYPE_MIDI_XG (1<<4) /* XG compatible device */
  403. #define SNDRV_SEQ_PORT_TYPE_MIDI_MT32 (1<<5) /* MT-32 compatible device */
  404. #define SNDRV_SEQ_PORT_TYPE_MIDI_GM2 (1<<6) /* General MIDI 2 compatible device */
  405. /* other standards...*/
  406. #define SNDRV_SEQ_PORT_TYPE_SYNTH (1<<10) /* Synth device (no MIDI compatible - direct wavetable) */
  407. #define SNDRV_SEQ_PORT_TYPE_DIRECT_SAMPLE (1<<11) /* Sampling device (support sample download) */
  408. #define SNDRV_SEQ_PORT_TYPE_SAMPLE (1<<12) /* Sampling device (sample can be downloaded at any time) */
  409. /*...*/
  410. #define SNDRV_SEQ_PORT_TYPE_HARDWARE (1<<16) /* driver for a hardware device */
  411. #define SNDRV_SEQ_PORT_TYPE_SOFTWARE (1<<17) /* implemented in software */
  412. #define SNDRV_SEQ_PORT_TYPE_SYNTHESIZER (1<<18) /* generates sound */
  413. #define SNDRV_SEQ_PORT_TYPE_PORT (1<<19) /* connects to other device(s) */
  414. #define SNDRV_SEQ_PORT_TYPE_APPLICATION (1<<20) /* application (sequencer/editor) */
  415. /* misc. conditioning flags */
  416. #define SNDRV_SEQ_PORT_FLG_GIVEN_PORT (1<<0)
  417. #define SNDRV_SEQ_PORT_FLG_TIMESTAMP (1<<1)
  418. #define SNDRV_SEQ_PORT_FLG_TIME_REAL (1<<2)
  419. struct snd_seq_port_info {
  420. struct snd_seq_addr addr; /* client/port numbers */
  421. char name[64]; /* port name */
  422. unsigned int capability; /* port capability bits */
  423. unsigned int type; /* port type bits */
  424. int midi_channels; /* channels per MIDI port */
  425. int midi_voices; /* voices per MIDI port */
  426. int synth_voices; /* voices per SYNTH port */
  427. int read_use; /* R/O: subscribers for output (from this port) */
  428. int write_use; /* R/O: subscribers for input (to this port) */
  429. void *kernel; /* reserved for kernel use (must be NULL) */
  430. unsigned int flags; /* misc. conditioning */
  431. unsigned char time_queue; /* queue # for timestamping */
  432. char reserved[59]; /* for future use */
  433. };
  434. /* queue flags */
  435. #define SNDRV_SEQ_QUEUE_FLG_SYNC (1<<0) /* sync enabled */
  436. /* queue information */
  437. struct snd_seq_queue_info {
  438. int queue; /* queue id */
  439. /*
  440. * security settings, only owner of this queue can start/stop timer
  441. * etc. if the queue is locked for other clients
  442. */
  443. int owner; /* client id for owner of the queue */
  444. unsigned locked:1; /* timing queue locked for other queues */
  445. char name[64]; /* name of this queue */
  446. unsigned int flags; /* flags */
  447. char reserved[60]; /* for future use */
  448. };
  449. /* queue info/status */
  450. struct snd_seq_queue_status {
  451. int queue; /* queue id */
  452. int events; /* read-only - queue size */
  453. snd_seq_tick_time_t tick; /* current tick */
  454. struct snd_seq_real_time time; /* current time */
  455. int running; /* running state of queue */
  456. int flags; /* various flags */
  457. char reserved[64]; /* for the future */
  458. };
  459. /* queue tempo */
  460. struct snd_seq_queue_tempo {
  461. int queue; /* sequencer queue */
  462. unsigned int tempo; /* current tempo, us/tick */
  463. int ppq; /* time resolution, ticks/quarter */
  464. unsigned int skew_value; /* queue skew */
  465. unsigned int skew_base; /* queue skew base */
  466. char reserved[24]; /* for the future */
  467. };
  468. /* sequencer timer sources */
  469. #define SNDRV_SEQ_TIMER_ALSA 0 /* ALSA timer */
  470. #define SNDRV_SEQ_TIMER_MIDI_CLOCK 1 /* Midi Clock (CLOCK event) */
  471. #define SNDRV_SEQ_TIMER_MIDI_TICK 2 /* Midi Timer Tick (TICK event) */
  472. /* queue timer info */
  473. struct snd_seq_queue_timer {
  474. int queue; /* sequencer queue */
  475. int type; /* source timer type */
  476. union {
  477. struct {
  478. struct snd_timer_id id; /* ALSA's timer ID */
  479. unsigned int resolution; /* resolution in Hz */
  480. } alsa;
  481. } u;
  482. char reserved[64]; /* for the future use */
  483. };
  484. struct snd_seq_queue_client {
  485. int queue; /* sequencer queue */
  486. int client; /* sequencer client */
  487. int used; /* queue is used with this client
  488. (must be set for accepting events) */
  489. /* per client watermarks */
  490. char reserved[64]; /* for future use */
  491. };
  492. #define SNDRV_SEQ_PORT_SUBS_EXCLUSIVE (1<<0) /* exclusive connection */
  493. #define SNDRV_SEQ_PORT_SUBS_TIMESTAMP (1<<1)
  494. #define SNDRV_SEQ_PORT_SUBS_TIME_REAL (1<<2)
  495. struct snd_seq_port_subscribe {
  496. struct snd_seq_addr sender; /* sender address */
  497. struct snd_seq_addr dest; /* destination address */
  498. unsigned int voices; /* number of voices to be allocated (0 = don't care) */
  499. unsigned int flags; /* modes */
  500. unsigned char queue; /* input time-stamp queue (optional) */
  501. unsigned char pad[3]; /* reserved */
  502. char reserved[64];
  503. };
  504. /* type of query subscription */
  505. #define SNDRV_SEQ_QUERY_SUBS_READ 0
  506. #define SNDRV_SEQ_QUERY_SUBS_WRITE 1
  507. struct snd_seq_query_subs {
  508. struct snd_seq_addr root; /* client/port id to be searched */
  509. int type; /* READ or WRITE */
  510. int index; /* 0..N-1 */
  511. int num_subs; /* R/O: number of subscriptions on this port */
  512. struct snd_seq_addr addr; /* R/O: result */
  513. unsigned char queue; /* R/O: result */
  514. unsigned int flags; /* R/O: result */
  515. char reserved[64]; /* for future use */
  516. };
  517. /*
  518. * IOCTL commands
  519. */
  520. #define SNDRV_SEQ_IOCTL_PVERSION _IOR ('S', 0x00, int)
  521. #define SNDRV_SEQ_IOCTL_CLIENT_ID _IOR ('S', 0x01, int)
  522. #define SNDRV_SEQ_IOCTL_SYSTEM_INFO _IOWR('S', 0x02, struct snd_seq_system_info)
  523. #define SNDRV_SEQ_IOCTL_RUNNING_MODE _IOWR('S', 0x03, struct snd_seq_running_info)
  524. #define SNDRV_SEQ_IOCTL_GET_CLIENT_INFO _IOWR('S', 0x10, struct snd_seq_client_info)
  525. #define SNDRV_SEQ_IOCTL_SET_CLIENT_INFO _IOW ('S', 0x11, struct snd_seq_client_info)
  526. #define SNDRV_SEQ_IOCTL_CREATE_PORT _IOWR('S', 0x20, struct snd_seq_port_info)
  527. #define SNDRV_SEQ_IOCTL_DELETE_PORT _IOW ('S', 0x21, struct snd_seq_port_info)
  528. #define SNDRV_SEQ_IOCTL_GET_PORT_INFO _IOWR('S', 0x22, struct snd_seq_port_info)
  529. #define SNDRV_SEQ_IOCTL_SET_PORT_INFO _IOW ('S', 0x23, struct snd_seq_port_info)
  530. #define SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT _IOW ('S', 0x30, struct snd_seq_port_subscribe)
  531. #define SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT _IOW ('S', 0x31, struct snd_seq_port_subscribe)
  532. #define SNDRV_SEQ_IOCTL_CREATE_QUEUE _IOWR('S', 0x32, struct snd_seq_queue_info)
  533. #define SNDRV_SEQ_IOCTL_DELETE_QUEUE _IOW ('S', 0x33, struct snd_seq_queue_info)
  534. #define SNDRV_SEQ_IOCTL_GET_QUEUE_INFO _IOWR('S', 0x34, struct snd_seq_queue_info)
  535. #define SNDRV_SEQ_IOCTL_SET_QUEUE_INFO _IOWR('S', 0x35, struct snd_seq_queue_info)
  536. #define SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE _IOWR('S', 0x36, struct snd_seq_queue_info)
  537. #define SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS _IOWR('S', 0x40, struct snd_seq_queue_status)
  538. #define SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO _IOWR('S', 0x41, struct snd_seq_queue_tempo)
  539. #define SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO _IOW ('S', 0x42, struct snd_seq_queue_tempo)
  540. #define SNDRV_SEQ_IOCTL_GET_QUEUE_OWNER _IOWR('S', 0x43, struct snd_seq_queue_owner)
  541. #define SNDRV_SEQ_IOCTL_SET_QUEUE_OWNER _IOW ('S', 0x44, struct snd_seq_queue_owner)
  542. #define SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER _IOWR('S', 0x45, struct snd_seq_queue_timer)
  543. #define SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER _IOW ('S', 0x46, struct snd_seq_queue_timer)
  544. /* XXX
  545. #define SNDRV_SEQ_IOCTL_GET_QUEUE_SYNC _IOWR('S', 0x53, struct snd_seq_queue_sync)
  546. #define SNDRV_SEQ_IOCTL_SET_QUEUE_SYNC _IOW ('S', 0x54, struct snd_seq_queue_sync)
  547. */
  548. #define SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT _IOWR('S', 0x49, struct snd_seq_queue_client)
  549. #define SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT _IOW ('S', 0x4a, struct snd_seq_queue_client)
  550. #define SNDRV_SEQ_IOCTL_GET_CLIENT_POOL _IOWR('S', 0x4b, struct snd_seq_client_pool)
  551. #define SNDRV_SEQ_IOCTL_SET_CLIENT_POOL _IOW ('S', 0x4c, struct snd_seq_client_pool)
  552. #define SNDRV_SEQ_IOCTL_REMOVE_EVENTS _IOW ('S', 0x4e, struct snd_seq_remove_events)
  553. #define SNDRV_SEQ_IOCTL_QUERY_SUBS _IOWR('S', 0x4f, struct snd_seq_query_subs)
  554. #define SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION _IOWR('S', 0x50, struct snd_seq_port_subscribe)
  555. #define SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT _IOWR('S', 0x51, struct snd_seq_client_info)
  556. #define SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT _IOWR('S', 0x52, struct snd_seq_port_info)
  557. #endif /* __SOUND_ASEQUENCER_H */