2 * MIDI byte <-> sequencer event coder
4 * Copyright (C) 1998,99 Takashi Iwai <tiwai@suse.de>,
5 * Jaroslav Kysela <perex@suse.cz>
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.
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.
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
22 #include <sound/driver.h>
23 #include <linux/slab.h>
24 #include <linux/errno.h>
25 #include <linux/string.h>
26 #include <sound/core.h>
27 #include <sound/seq_kernel.h>
28 #include <sound/seq_midi_event.h>
29 #include <sound/asoundef.h>
31 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>, Jaroslav Kysela <perex@suse.cz>");
32 MODULE_DESCRIPTION("MIDI byte <-> sequencer event coder");
33 MODULE_LICENSE("GPL");
36 /* from 0 to 7 are normal commands (note off, on, etc.) */
40 #define ST_SYSEX ST_SPECIAL
41 /* from 8 to 15 are events for 0xf0-0xf7 */
44 /* status event types */
45 typedef void (*event_encode_t)(snd_midi_event_t *dev, snd_seq_event_t *ev);
46 typedef void (*event_decode_t)(snd_seq_event_t *ev, unsigned char *buf);
51 static void note_event(snd_midi_event_t *dev, snd_seq_event_t *ev);
52 static void one_param_ctrl_event(snd_midi_event_t *dev, snd_seq_event_t *ev);
53 static void pitchbend_ctrl_event(snd_midi_event_t *dev, snd_seq_event_t *ev);
54 static void two_param_ctrl_event(snd_midi_event_t *dev, snd_seq_event_t *ev);
55 static void one_param_event(snd_midi_event_t *dev, snd_seq_event_t *ev);
56 static void songpos_event(snd_midi_event_t *dev, snd_seq_event_t *ev);
57 static void note_decode(snd_seq_event_t *ev, unsigned char *buf);
58 static void one_param_decode(snd_seq_event_t *ev, unsigned char *buf);
59 static void pitchbend_decode(snd_seq_event_t *ev, unsigned char *buf);
60 static void two_param_decode(snd_seq_event_t *ev, unsigned char *buf);
61 static void songpos_decode(snd_seq_event_t *ev, unsigned char *buf);
66 static struct status_event_list_t {
69 event_encode_t encode;
70 event_decode_t decode;
73 {SNDRV_SEQ_EVENT_NOTEOFF, 2, note_event, note_decode},
74 {SNDRV_SEQ_EVENT_NOTEON, 2, note_event, note_decode},
75 {SNDRV_SEQ_EVENT_KEYPRESS, 2, note_event, note_decode},
76 {SNDRV_SEQ_EVENT_CONTROLLER, 2, two_param_ctrl_event, two_param_decode},
77 {SNDRV_SEQ_EVENT_PGMCHANGE, 1, one_param_ctrl_event, one_param_decode},
78 {SNDRV_SEQ_EVENT_CHANPRESS, 1, one_param_ctrl_event, one_param_decode},
79 {SNDRV_SEQ_EVENT_PITCHBEND, 2, pitchbend_ctrl_event, pitchbend_decode},
80 {SNDRV_SEQ_EVENT_NONE, 0, NULL, NULL}, /* 0xf0 */
82 {SNDRV_SEQ_EVENT_SYSEX, 1, NULL, NULL}, /* sysex: 0xf0 */
83 {SNDRV_SEQ_EVENT_QFRAME, 1, one_param_event, one_param_decode}, /* 0xf1 */
84 {SNDRV_SEQ_EVENT_SONGPOS, 2, songpos_event, songpos_decode}, /* 0xf2 */
85 {SNDRV_SEQ_EVENT_SONGSEL, 1, one_param_event, one_param_decode}, /* 0xf3 */
86 {SNDRV_SEQ_EVENT_NONE, 0, NULL, NULL}, /* 0xf4 */
87 {SNDRV_SEQ_EVENT_NONE, 0, NULL, NULL}, /* 0xf5 */
88 {SNDRV_SEQ_EVENT_TUNE_REQUEST, 0, NULL, NULL}, /* 0xf6 */
89 {SNDRV_SEQ_EVENT_NONE, 0, NULL, NULL}, /* 0xf7 */
90 {SNDRV_SEQ_EVENT_CLOCK, 0, NULL, NULL}, /* 0xf8 */
91 {SNDRV_SEQ_EVENT_NONE, 0, NULL, NULL}, /* 0xf9 */
92 {SNDRV_SEQ_EVENT_START, 0, NULL, NULL}, /* 0xfa */
93 {SNDRV_SEQ_EVENT_CONTINUE, 0, NULL, NULL}, /* 0xfb */
94 {SNDRV_SEQ_EVENT_STOP, 0, NULL, NULL}, /* 0xfc */
95 {SNDRV_SEQ_EVENT_NONE, 0, NULL, NULL}, /* 0xfd */
96 {SNDRV_SEQ_EVENT_SENSING, 0, NULL, NULL}, /* 0xfe */
97 {SNDRV_SEQ_EVENT_RESET, 0, NULL, NULL}, /* 0xff */
100 static int extra_decode_ctrl14(snd_midi_event_t *dev, unsigned char *buf, int len, snd_seq_event_t *ev);
101 static int extra_decode_xrpn(snd_midi_event_t *dev, unsigned char *buf, int count, snd_seq_event_t *ev);
103 static struct extra_event_list_t {
105 int (*decode)(snd_midi_event_t *dev, unsigned char *buf, int len, snd_seq_event_t *ev);
107 {SNDRV_SEQ_EVENT_CONTROL14, extra_decode_ctrl14},
108 {SNDRV_SEQ_EVENT_NONREGPARAM, extra_decode_xrpn},
109 {SNDRV_SEQ_EVENT_REGPARAM, extra_decode_xrpn},
116 int snd_midi_event_new(int bufsize, snd_midi_event_t **rdev)
118 snd_midi_event_t *dev;
121 dev = kcalloc(1, sizeof(*dev), GFP_KERNEL);
125 dev->buf = kmalloc(bufsize, GFP_KERNEL);
126 if (dev->buf == NULL) {
131 dev->bufsize = bufsize;
133 spin_lock_init(&dev->lock);
138 void snd_midi_event_free(snd_midi_event_t *dev)
150 inline static void reset_encode(snd_midi_event_t *dev)
157 void snd_midi_event_reset_encode(snd_midi_event_t *dev)
161 spin_lock_irqsave(&dev->lock, flags);
163 spin_unlock_irqrestore(&dev->lock, flags);
166 void snd_midi_event_reset_decode(snd_midi_event_t *dev)
170 spin_lock_irqsave(&dev->lock, flags);
172 spin_unlock_irqrestore(&dev->lock, flags);
175 void snd_midi_event_init(snd_midi_event_t *dev)
177 snd_midi_event_reset_encode(dev);
178 snd_midi_event_reset_decode(dev);
181 void snd_midi_event_no_status(snd_midi_event_t *dev, int on)
183 dev->nostat = on ? 1 : 0;
189 int snd_midi_event_resize_buffer(snd_midi_event_t *dev, int bufsize)
191 unsigned char *new_buf, *old_buf;
194 if (bufsize == dev->bufsize)
196 new_buf = kmalloc(bufsize, GFP_KERNEL);
199 spin_lock_irqsave(&dev->lock, flags);
202 dev->bufsize = bufsize;
204 spin_unlock_irqrestore(&dev->lock, flags);
211 * read bytes and encode to sequencer event if finished
212 * return the size of encoded bytes
214 long snd_midi_event_encode(snd_midi_event_t *dev, unsigned char *buf, long count, snd_seq_event_t *ev)
219 ev->type = SNDRV_SEQ_EVENT_NONE;
221 while (count-- > 0) {
222 rc = snd_midi_event_encode_byte(dev, *buf++, ev);
234 * read one byte and encode to sequencer event:
235 * return 1 if MIDI bytes are encoded to an event
236 * 0 data is not finished
239 int snd_midi_event_encode_byte(snd_midi_event_t *dev, int c, snd_seq_event_t *ev)
246 if (c >= MIDI_CMD_COMMON_CLOCK) {
247 /* real-time event */
248 ev->type = status_event[ST_SPECIAL + c - 0xf0].event;
249 ev->flags &= ~SNDRV_SEQ_EVENT_LENGTH_MASK;
250 ev->flags |= SNDRV_SEQ_EVENT_LENGTH_FIXED;
254 spin_lock_irqsave(&dev->lock, flags);
256 /* rest of command */
257 dev->buf[dev->read++] = c;
258 if (dev->type != ST_SYSEX)
265 if ((c & 0xf0) == 0xf0) /* special events */
266 dev->type = (c & 0x0f) + ST_SPECIAL;
268 dev->type = (c >> 4) & 0x07;
269 dev->qlen = status_event[dev->type].qlen;
271 /* process this byte as argument */
272 dev->buf[dev->read++] = c;
273 dev->qlen = status_event[dev->type].qlen - 1;
276 if (dev->qlen == 0) {
277 ev->type = status_event[dev->type].event;
278 ev->flags &= ~SNDRV_SEQ_EVENT_LENGTH_MASK;
279 ev->flags |= SNDRV_SEQ_EVENT_LENGTH_FIXED;
280 if (status_event[dev->type].encode) /* set data values */
281 status_event[dev->type].encode(dev, ev);
283 } else if (dev->type == ST_SYSEX) {
284 if (c == MIDI_CMD_COMMON_SYSEX_END ||
285 dev->read >= dev->bufsize) {
286 ev->flags &= ~SNDRV_SEQ_EVENT_LENGTH_MASK;
287 ev->flags |= SNDRV_SEQ_EVENT_LENGTH_VARIABLE;
288 ev->type = SNDRV_SEQ_EVENT_SYSEX;
289 ev->data.ext.len = dev->read;
290 ev->data.ext.ptr = dev->buf;
291 if (c != MIDI_CMD_COMMON_SYSEX_END)
292 dev->read = 0; /* continue to parse */
294 reset_encode(dev); /* all parsed */
299 spin_unlock_irqrestore(&dev->lock, flags);
303 /* encode note event */
304 static void note_event(snd_midi_event_t *dev, snd_seq_event_t *ev)
306 ev->data.note.channel = dev->buf[0] & 0x0f;
307 ev->data.note.note = dev->buf[1];
308 ev->data.note.velocity = dev->buf[2];
311 /* encode one parameter controls */
312 static void one_param_ctrl_event(snd_midi_event_t *dev, snd_seq_event_t *ev)
314 ev->data.control.channel = dev->buf[0] & 0x0f;
315 ev->data.control.value = dev->buf[1];
318 /* encode pitch wheel change */
319 static void pitchbend_ctrl_event(snd_midi_event_t *dev, snd_seq_event_t *ev)
321 ev->data.control.channel = dev->buf[0] & 0x0f;
322 ev->data.control.value = (int)dev->buf[2] * 128 + (int)dev->buf[1] - 8192;
325 /* encode midi control change */
326 static void two_param_ctrl_event(snd_midi_event_t *dev, snd_seq_event_t *ev)
328 ev->data.control.channel = dev->buf[0] & 0x0f;
329 ev->data.control.param = dev->buf[1];
330 ev->data.control.value = dev->buf[2];
333 /* encode one parameter value*/
334 static void one_param_event(snd_midi_event_t *dev, snd_seq_event_t *ev)
336 ev->data.control.value = dev->buf[1];
339 /* encode song position */
340 static void songpos_event(snd_midi_event_t *dev, snd_seq_event_t *ev)
342 ev->data.control.value = (int)dev->buf[2] * 128 + (int)dev->buf[1];
346 * decode from a sequencer event to midi bytes
347 * return the size of decoded midi events
349 long snd_midi_event_decode(snd_midi_event_t *dev, unsigned char *buf, long count, snd_seq_event_t *ev)
351 unsigned int cmd, type;
353 if (ev->type == SNDRV_SEQ_EVENT_NONE)
356 for (type = 0; type < ARRAY_SIZE(status_event); type++) {
357 if (ev->type == status_event[type].event)
360 for (type = 0; type < ARRAY_SIZE(extra_event); type++) {
361 if (ev->type == extra_event[type].event)
362 return extra_event[type].decode(dev, buf, count, ev);
367 if (type >= ST_SPECIAL)
368 cmd = 0xf0 + (type - ST_SPECIAL);
370 /* data.note.channel and data.control.channel is identical */
371 cmd = 0x80 | (type << 4) | (ev->data.note.channel & 0x0f);
374 if (cmd == MIDI_CMD_COMMON_SYSEX) {
375 snd_midi_event_reset_decode(dev);
376 return snd_seq_expand_var_event(ev, count, buf, 1, 0);
379 unsigned char xbuf[4];
382 spin_lock_irqsave(&dev->lock, flags);
383 if ((cmd & 0xf0) == 0xf0 || dev->lastcmd != cmd || dev->nostat) {
385 spin_unlock_irqrestore(&dev->lock, flags);
387 if (status_event[type].decode)
388 status_event[type].decode(ev, xbuf + 1);
389 qlen = status_event[type].qlen + 1;
391 spin_unlock_irqrestore(&dev->lock, flags);
392 if (status_event[type].decode)
393 status_event[type].decode(ev, xbuf + 0);
394 qlen = status_event[type].qlen;
398 memcpy(buf, xbuf, qlen);
404 /* decode note event */
405 static void note_decode(snd_seq_event_t *ev, unsigned char *buf)
407 buf[0] = ev->data.note.note & 0x7f;
408 buf[1] = ev->data.note.velocity & 0x7f;
411 /* decode one parameter controls */
412 static void one_param_decode(snd_seq_event_t *ev, unsigned char *buf)
414 buf[0] = ev->data.control.value & 0x7f;
417 /* decode pitch wheel change */
418 static void pitchbend_decode(snd_seq_event_t *ev, unsigned char *buf)
420 int value = ev->data.control.value + 8192;
421 buf[0] = value & 0x7f;
422 buf[1] = (value >> 7) & 0x7f;
425 /* decode midi control change */
426 static void two_param_decode(snd_seq_event_t *ev, unsigned char *buf)
428 buf[0] = ev->data.control.param & 0x7f;
429 buf[1] = ev->data.control.value & 0x7f;
432 /* decode song position */
433 static void songpos_decode(snd_seq_event_t *ev, unsigned char *buf)
435 buf[0] = ev->data.control.value & 0x7f;
436 buf[1] = (ev->data.control.value >> 7) & 0x7f;
439 /* decode 14bit control */
440 static int extra_decode_ctrl14(snd_midi_event_t *dev, unsigned char *buf, int count, snd_seq_event_t *ev)
445 cmd = MIDI_CMD_CONTROL|(ev->data.control.channel & 0x0f);
446 if (ev->data.control.param < 0x20) {
449 if (dev->nostat && count < 6)
451 if (cmd != dev->lastcmd || dev->nostat) {
454 buf[idx++] = dev->lastcmd = cmd;
456 buf[idx++] = ev->data.control.param;
457 buf[idx++] = (ev->data.control.value >> 7) & 0x7f;
460 buf[idx++] = ev->data.control.param + 0x20;
461 buf[idx++] = ev->data.control.value & 0x7f;
465 if (cmd != dev->lastcmd || dev->nostat) {
468 buf[idx++] = dev->lastcmd = cmd;
470 buf[idx++] = ev->data.control.param & 0x7f;
471 buf[idx++] = ev->data.control.value & 0x7f;
476 /* decode reg/nonreg param */
477 static int extra_decode_xrpn(snd_midi_event_t *dev, unsigned char *buf, int count, snd_seq_event_t *ev)
481 static char cbytes_nrpn[4] = { MIDI_CTL_NONREG_PARM_NUM_MSB,
482 MIDI_CTL_NONREG_PARM_NUM_LSB,
483 MIDI_CTL_MSB_DATA_ENTRY,
484 MIDI_CTL_LSB_DATA_ENTRY };
485 static char cbytes_rpn[4] = { MIDI_CTL_REGIST_PARM_NUM_MSB,
486 MIDI_CTL_REGIST_PARM_NUM_LSB,
487 MIDI_CTL_MSB_DATA_ENTRY,
488 MIDI_CTL_LSB_DATA_ENTRY };
489 unsigned char bytes[4];
494 if (dev->nostat && count < 12)
496 cmd = MIDI_CMD_CONTROL|(ev->data.control.channel & 0x0f);
497 bytes[0] = ev->data.control.param & 0x007f;
498 bytes[1] = (ev->data.control.param & 0x3f80) >> 7;
499 bytes[2] = ev->data.control.value & 0x007f;
500 bytes[3] = (ev->data.control.value & 0x3f80) >> 7;
501 if (cmd != dev->lastcmd && !dev->nostat) {
504 buf[idx++] = dev->lastcmd = cmd;
506 cbytes = ev->type == SNDRV_SEQ_EVENT_NONREGPARAM ? cbytes_nrpn : cbytes_rpn;
507 for (i = 0; i < 4; i++) {
509 buf[idx++] = dev->lastcmd = cmd;
510 buf[idx++] = cbytes[i];
511 buf[idx++] = bytes[i];
520 EXPORT_SYMBOL(snd_midi_event_new);
521 EXPORT_SYMBOL(snd_midi_event_free);
522 EXPORT_SYMBOL(snd_midi_event_resize_buffer);
523 EXPORT_SYMBOL(snd_midi_event_init);
524 EXPORT_SYMBOL(snd_midi_event_reset_encode);
525 EXPORT_SYMBOL(snd_midi_event_reset_decode);
526 EXPORT_SYMBOL(snd_midi_event_no_status);
527 EXPORT_SYMBOL(snd_midi_event_encode);
528 EXPORT_SYMBOL(snd_midi_event_encode_byte);
529 EXPORT_SYMBOL(snd_midi_event_decode);