2 * MIDI byte <-> sequencer event coder
4 * Copyright (C) 1998,99 Takashi Iwai <tiwai@suse.de>,
5 * Jaroslav Kysela <perex@perex.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 <linux/slab.h>
23 #include <linux/errno.h>
24 #include <linux/string.h>
25 #include <linux/module.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@perex.cz>");
32 MODULE_DESCRIPTION("MIDI byte <-> sequencer event coder");
33 MODULE_LICENSE("GPL");
35 /* event type, index into status_event[] */
36 /* from 0 to 6 are normal commands (note off, on, etc.) for 0x9?-0xe? */
39 #define ST_SYSEX ST_SPECIAL
40 /* from 8 to 15 are events for 0xf0-0xf7 */
46 static void note_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
47 static void one_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
48 static void pitchbend_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
49 static void two_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
50 static void one_param_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
51 static void songpos_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
52 static void note_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
53 static void one_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
54 static void pitchbend_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
55 static void two_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
56 static void songpos_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
61 static struct status_event_list
{
64 void (*encode
)(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
65 void (*decode
)(struct snd_seq_event
*ev
, unsigned char *buf
);
68 {SNDRV_SEQ_EVENT_NOTEOFF
, 2, note_event
, note_decode
},
69 {SNDRV_SEQ_EVENT_NOTEON
, 2, note_event
, note_decode
},
70 {SNDRV_SEQ_EVENT_KEYPRESS
, 2, note_event
, note_decode
},
71 {SNDRV_SEQ_EVENT_CONTROLLER
, 2, two_param_ctrl_event
, two_param_decode
},
72 {SNDRV_SEQ_EVENT_PGMCHANGE
, 1, one_param_ctrl_event
, one_param_decode
},
73 {SNDRV_SEQ_EVENT_CHANPRESS
, 1, one_param_ctrl_event
, one_param_decode
},
74 {SNDRV_SEQ_EVENT_PITCHBEND
, 2, pitchbend_ctrl_event
, pitchbend_decode
},
76 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
},
78 {SNDRV_SEQ_EVENT_SYSEX
, 1, NULL
, NULL
}, /* sysex: 0xf0 */
79 {SNDRV_SEQ_EVENT_QFRAME
, 1, one_param_event
, one_param_decode
}, /* 0xf1 */
80 {SNDRV_SEQ_EVENT_SONGPOS
, 2, songpos_event
, songpos_decode
}, /* 0xf2 */
81 {SNDRV_SEQ_EVENT_SONGSEL
, 1, one_param_event
, one_param_decode
}, /* 0xf3 */
82 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf4 */
83 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf5 */
84 {SNDRV_SEQ_EVENT_TUNE_REQUEST
, 0, NULL
, NULL
}, /* 0xf6 */
85 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf7 */
86 {SNDRV_SEQ_EVENT_CLOCK
, 0, NULL
, NULL
}, /* 0xf8 */
87 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf9 */
88 {SNDRV_SEQ_EVENT_START
, 0, NULL
, NULL
}, /* 0xfa */
89 {SNDRV_SEQ_EVENT_CONTINUE
, 0, NULL
, NULL
}, /* 0xfb */
90 {SNDRV_SEQ_EVENT_STOP
, 0, NULL
, NULL
}, /* 0xfc */
91 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xfd */
92 {SNDRV_SEQ_EVENT_SENSING
, 0, NULL
, NULL
}, /* 0xfe */
93 {SNDRV_SEQ_EVENT_RESET
, 0, NULL
, NULL
}, /* 0xff */
96 static int extra_decode_ctrl14(struct snd_midi_event
*dev
, unsigned char *buf
, int len
,
97 struct snd_seq_event
*ev
);
98 static int extra_decode_xrpn(struct snd_midi_event
*dev
, unsigned char *buf
, int count
,
99 struct snd_seq_event
*ev
);
101 static struct extra_event_list
{
103 int (*decode
)(struct snd_midi_event
*dev
, unsigned char *buf
, int len
,
104 struct snd_seq_event
*ev
);
106 {SNDRV_SEQ_EVENT_CONTROL14
, extra_decode_ctrl14
},
107 {SNDRV_SEQ_EVENT_NONREGPARAM
, extra_decode_xrpn
},
108 {SNDRV_SEQ_EVENT_REGPARAM
, extra_decode_xrpn
},
115 int snd_midi_event_new(int bufsize
, struct snd_midi_event
**rdev
)
117 struct snd_midi_event
*dev
;
120 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
124 dev
->buf
= kmalloc(bufsize
, GFP_KERNEL
);
125 if (dev
->buf
== NULL
) {
130 dev
->bufsize
= bufsize
;
132 dev
->type
= ST_INVALID
;
133 spin_lock_init(&dev
->lock
);
138 void snd_midi_event_free(struct snd_midi_event
*dev
)
149 static inline void reset_encode(struct snd_midi_event
*dev
)
153 dev
->type
= ST_INVALID
;
156 void snd_midi_event_reset_encode(struct snd_midi_event
*dev
)
160 spin_lock_irqsave(&dev
->lock
, flags
);
162 spin_unlock_irqrestore(&dev
->lock
, flags
);
165 void snd_midi_event_reset_decode(struct snd_midi_event
*dev
)
169 spin_lock_irqsave(&dev
->lock
, flags
);
171 spin_unlock_irqrestore(&dev
->lock
, flags
);
175 void snd_midi_event_init(struct snd_midi_event
*dev
)
177 snd_midi_event_reset_encode(dev
);
178 snd_midi_event_reset_decode(dev
);
182 void snd_midi_event_no_status(struct snd_midi_event
*dev
, int on
)
184 dev
->nostat
= on
? 1 : 0;
191 int snd_midi_event_resize_buffer(struct snd_midi_event
*dev
, int bufsize
)
193 unsigned char *new_buf
, *old_buf
;
196 if (bufsize
== dev
->bufsize
)
198 new_buf
= kmalloc(bufsize
, GFP_KERNEL
);
201 spin_lock_irqsave(&dev
->lock
, flags
);
204 dev
->bufsize
= bufsize
;
206 spin_unlock_irqrestore(&dev
->lock
, flags
);
213 * read bytes and encode to sequencer event if finished
214 * return the size of encoded bytes
216 long snd_midi_event_encode(struct snd_midi_event
*dev
, unsigned char *buf
, long count
,
217 struct snd_seq_event
*ev
)
222 ev
->type
= SNDRV_SEQ_EVENT_NONE
;
224 while (count
-- > 0) {
225 rc
= snd_midi_event_encode_byte(dev
, *buf
++, ev
);
237 * read one byte and encode to sequencer event:
238 * return 1 if MIDI bytes are encoded to an event
239 * 0 data is not finished
242 int snd_midi_event_encode_byte(struct snd_midi_event
*dev
, int c
,
243 struct snd_seq_event
*ev
)
250 if (c
>= MIDI_CMD_COMMON_CLOCK
) {
251 /* real-time event */
252 ev
->type
= status_event
[ST_SPECIAL
+ c
- 0xf0].event
;
253 ev
->flags
&= ~SNDRV_SEQ_EVENT_LENGTH_MASK
;
254 ev
->flags
|= SNDRV_SEQ_EVENT_LENGTH_FIXED
;
255 return ev
->type
!= SNDRV_SEQ_EVENT_NONE
;
258 spin_lock_irqsave(&dev
->lock
, flags
);
260 (c
!= MIDI_CMD_COMMON_SYSEX_END
|| dev
->type
!= ST_SYSEX
)) {
263 if ((c
& 0xf0) == 0xf0) /* system messages */
264 dev
->type
= (c
& 0x0f) + ST_SPECIAL
;
266 dev
->type
= (c
>> 4) & 0x07;
268 dev
->qlen
= status_event
[dev
->type
].qlen
;
271 /* rest of command */
272 dev
->buf
[dev
->read
++] = c
;
273 if (dev
->type
!= ST_SYSEX
)
278 dev
->qlen
= status_event
[dev
->type
].qlen
- 1;
282 if (dev
->qlen
== 0) {
283 ev
->type
= status_event
[dev
->type
].event
;
284 ev
->flags
&= ~SNDRV_SEQ_EVENT_LENGTH_MASK
;
285 ev
->flags
|= SNDRV_SEQ_EVENT_LENGTH_FIXED
;
286 if (status_event
[dev
->type
].encode
) /* set data values */
287 status_event
[dev
->type
].encode(dev
, ev
);
288 if (dev
->type
>= ST_SPECIAL
)
289 dev
->type
= ST_INVALID
;
291 } else if (dev
->type
== ST_SYSEX
) {
292 if (c
== MIDI_CMD_COMMON_SYSEX_END
||
293 dev
->read
>= dev
->bufsize
) {
294 ev
->flags
&= ~SNDRV_SEQ_EVENT_LENGTH_MASK
;
295 ev
->flags
|= SNDRV_SEQ_EVENT_LENGTH_VARIABLE
;
296 ev
->type
= SNDRV_SEQ_EVENT_SYSEX
;
297 ev
->data
.ext
.len
= dev
->read
;
298 ev
->data
.ext
.ptr
= dev
->buf
;
299 if (c
!= MIDI_CMD_COMMON_SYSEX_END
)
300 dev
->read
= 0; /* continue to parse */
302 reset_encode(dev
); /* all parsed */
307 spin_unlock_irqrestore(&dev
->lock
, flags
);
311 /* encode note event */
312 static void note_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
314 ev
->data
.note
.channel
= dev
->buf
[0] & 0x0f;
315 ev
->data
.note
.note
= dev
->buf
[1];
316 ev
->data
.note
.velocity
= dev
->buf
[2];
319 /* encode one parameter controls */
320 static void one_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
322 ev
->data
.control
.channel
= dev
->buf
[0] & 0x0f;
323 ev
->data
.control
.value
= dev
->buf
[1];
326 /* encode pitch wheel change */
327 static void pitchbend_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
329 ev
->data
.control
.channel
= dev
->buf
[0] & 0x0f;
330 ev
->data
.control
.value
= (int)dev
->buf
[2] * 128 + (int)dev
->buf
[1] - 8192;
333 /* encode midi control change */
334 static void two_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
336 ev
->data
.control
.channel
= dev
->buf
[0] & 0x0f;
337 ev
->data
.control
.param
= dev
->buf
[1];
338 ev
->data
.control
.value
= dev
->buf
[2];
341 /* encode one parameter value*/
342 static void one_param_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
344 ev
->data
.control
.value
= dev
->buf
[1];
347 /* encode song position */
348 static void songpos_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
350 ev
->data
.control
.value
= (int)dev
->buf
[2] * 128 + (int)dev
->buf
[1];
354 * decode from a sequencer event to midi bytes
355 * return the size of decoded midi events
357 long snd_midi_event_decode(struct snd_midi_event
*dev
, unsigned char *buf
, long count
,
358 struct snd_seq_event
*ev
)
360 unsigned int cmd
, type
;
362 if (ev
->type
== SNDRV_SEQ_EVENT_NONE
)
365 for (type
= 0; type
< ARRAY_SIZE(status_event
); type
++) {
366 if (ev
->type
== status_event
[type
].event
)
369 for (type
= 0; type
< ARRAY_SIZE(extra_event
); type
++) {
370 if (ev
->type
== extra_event
[type
].event
)
371 return extra_event
[type
].decode(dev
, buf
, count
, ev
);
376 if (type
>= ST_SPECIAL
)
377 cmd
= 0xf0 + (type
- ST_SPECIAL
);
379 /* data.note.channel and data.control.channel is identical */
380 cmd
= 0x80 | (type
<< 4) | (ev
->data
.note
.channel
& 0x0f);
383 if (cmd
== MIDI_CMD_COMMON_SYSEX
) {
384 snd_midi_event_reset_decode(dev
);
385 return snd_seq_expand_var_event(ev
, count
, buf
, 1, 0);
388 unsigned char xbuf
[4];
391 spin_lock_irqsave(&dev
->lock
, flags
);
392 if ((cmd
& 0xf0) == 0xf0 || dev
->lastcmd
!= cmd
|| dev
->nostat
) {
394 spin_unlock_irqrestore(&dev
->lock
, flags
);
396 if (status_event
[type
].decode
)
397 status_event
[type
].decode(ev
, xbuf
+ 1);
398 qlen
= status_event
[type
].qlen
+ 1;
400 spin_unlock_irqrestore(&dev
->lock
, flags
);
401 if (status_event
[type
].decode
)
402 status_event
[type
].decode(ev
, xbuf
+ 0);
403 qlen
= status_event
[type
].qlen
;
407 memcpy(buf
, xbuf
, qlen
);
413 /* decode note event */
414 static void note_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
416 buf
[0] = ev
->data
.note
.note
& 0x7f;
417 buf
[1] = ev
->data
.note
.velocity
& 0x7f;
420 /* decode one parameter controls */
421 static void one_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
423 buf
[0] = ev
->data
.control
.value
& 0x7f;
426 /* decode pitch wheel change */
427 static void pitchbend_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
429 int value
= ev
->data
.control
.value
+ 8192;
430 buf
[0] = value
& 0x7f;
431 buf
[1] = (value
>> 7) & 0x7f;
434 /* decode midi control change */
435 static void two_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
437 buf
[0] = ev
->data
.control
.param
& 0x7f;
438 buf
[1] = ev
->data
.control
.value
& 0x7f;
441 /* decode song position */
442 static void songpos_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
444 buf
[0] = ev
->data
.control
.value
& 0x7f;
445 buf
[1] = (ev
->data
.control
.value
>> 7) & 0x7f;
448 /* decode 14bit control */
449 static int extra_decode_ctrl14(struct snd_midi_event
*dev
, unsigned char *buf
,
450 int count
, struct snd_seq_event
*ev
)
455 cmd
= MIDI_CMD_CONTROL
|(ev
->data
.control
.channel
& 0x0f);
456 if (ev
->data
.control
.param
< 0x20) {
459 if (dev
->nostat
&& count
< 6)
461 if (cmd
!= dev
->lastcmd
|| dev
->nostat
) {
464 buf
[idx
++] = dev
->lastcmd
= cmd
;
466 buf
[idx
++] = ev
->data
.control
.param
;
467 buf
[idx
++] = (ev
->data
.control
.value
>> 7) & 0x7f;
470 buf
[idx
++] = ev
->data
.control
.param
+ 0x20;
471 buf
[idx
++] = ev
->data
.control
.value
& 0x7f;
475 if (cmd
!= dev
->lastcmd
|| dev
->nostat
) {
478 buf
[idx
++] = dev
->lastcmd
= cmd
;
480 buf
[idx
++] = ev
->data
.control
.param
& 0x7f;
481 buf
[idx
++] = ev
->data
.control
.value
& 0x7f;
486 /* decode reg/nonreg param */
487 static int extra_decode_xrpn(struct snd_midi_event
*dev
, unsigned char *buf
,
488 int count
, struct snd_seq_event
*ev
)
492 static char cbytes_nrpn
[4] = { MIDI_CTL_NONREG_PARM_NUM_MSB
,
493 MIDI_CTL_NONREG_PARM_NUM_LSB
,
494 MIDI_CTL_MSB_DATA_ENTRY
,
495 MIDI_CTL_LSB_DATA_ENTRY
};
496 static char cbytes_rpn
[4] = { MIDI_CTL_REGIST_PARM_NUM_MSB
,
497 MIDI_CTL_REGIST_PARM_NUM_LSB
,
498 MIDI_CTL_MSB_DATA_ENTRY
,
499 MIDI_CTL_LSB_DATA_ENTRY
};
500 unsigned char bytes
[4];
505 if (dev
->nostat
&& count
< 12)
507 cmd
= MIDI_CMD_CONTROL
|(ev
->data
.control
.channel
& 0x0f);
508 bytes
[0] = (ev
->data
.control
.param
& 0x3f80) >> 7;
509 bytes
[1] = ev
->data
.control
.param
& 0x007f;
510 bytes
[2] = (ev
->data
.control
.value
& 0x3f80) >> 7;
511 bytes
[3] = ev
->data
.control
.value
& 0x007f;
512 if (cmd
!= dev
->lastcmd
&& !dev
->nostat
) {
515 buf
[idx
++] = dev
->lastcmd
= cmd
;
517 cbytes
= ev
->type
== SNDRV_SEQ_EVENT_NONREGPARAM
? cbytes_nrpn
: cbytes_rpn
;
518 for (i
= 0; i
< 4; i
++) {
520 buf
[idx
++] = dev
->lastcmd
= cmd
;
521 buf
[idx
++] = cbytes
[i
];
522 buf
[idx
++] = bytes
[i
];
531 EXPORT_SYMBOL(snd_midi_event_new
);
532 EXPORT_SYMBOL(snd_midi_event_free
);
533 EXPORT_SYMBOL(snd_midi_event_reset_encode
);
534 EXPORT_SYMBOL(snd_midi_event_reset_decode
);
535 EXPORT_SYMBOL(snd_midi_event_no_status
);
536 EXPORT_SYMBOL(snd_midi_event_encode
);
537 EXPORT_SYMBOL(snd_midi_event_encode_byte
);
538 EXPORT_SYMBOL(snd_midi_event_decode
);
540 static int __init
alsa_seq_midi_event_init(void)
545 static void __exit
alsa_seq_midi_event_exit(void)
549 module_init(alsa_seq_midi_event_init
)
550 module_exit(alsa_seq_midi_event_exit
)