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 <sound/core.h>
26 #include <sound/seq_kernel.h>
27 #include <sound/seq_midi_event.h>
28 #include <sound/asoundef.h>
30 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>, Jaroslav Kysela <perex@perex.cz>");
31 MODULE_DESCRIPTION("MIDI byte <-> sequencer event coder");
32 MODULE_LICENSE("GPL");
34 /* event type, index into status_event[] */
35 /* from 0 to 6 are normal commands (note off, on, etc.) for 0x9?-0xe? */
38 #define ST_SYSEX ST_SPECIAL
39 /* from 8 to 15 are events for 0xf0-0xf7 */
45 static void note_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
46 static void one_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
47 static void pitchbend_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
48 static void two_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
49 static void one_param_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
50 static void songpos_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
51 static void note_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
52 static void one_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
53 static void pitchbend_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
54 static void two_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
55 static void songpos_decode(struct snd_seq_event
*ev
, unsigned char *buf
);
60 static struct status_event_list
{
63 void (*encode
)(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
);
64 void (*decode
)(struct snd_seq_event
*ev
, unsigned char *buf
);
67 {SNDRV_SEQ_EVENT_NOTEOFF
, 2, note_event
, note_decode
},
68 {SNDRV_SEQ_EVENT_NOTEON
, 2, note_event
, note_decode
},
69 {SNDRV_SEQ_EVENT_KEYPRESS
, 2, note_event
, note_decode
},
70 {SNDRV_SEQ_EVENT_CONTROLLER
, 2, two_param_ctrl_event
, two_param_decode
},
71 {SNDRV_SEQ_EVENT_PGMCHANGE
, 1, one_param_ctrl_event
, one_param_decode
},
72 {SNDRV_SEQ_EVENT_CHANPRESS
, 1, one_param_ctrl_event
, one_param_decode
},
73 {SNDRV_SEQ_EVENT_PITCHBEND
, 2, pitchbend_ctrl_event
, pitchbend_decode
},
75 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
},
77 {SNDRV_SEQ_EVENT_SYSEX
, 1, NULL
, NULL
}, /* sysex: 0xf0 */
78 {SNDRV_SEQ_EVENT_QFRAME
, 1, one_param_event
, one_param_decode
}, /* 0xf1 */
79 {SNDRV_SEQ_EVENT_SONGPOS
, 2, songpos_event
, songpos_decode
}, /* 0xf2 */
80 {SNDRV_SEQ_EVENT_SONGSEL
, 1, one_param_event
, one_param_decode
}, /* 0xf3 */
81 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf4 */
82 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf5 */
83 {SNDRV_SEQ_EVENT_TUNE_REQUEST
, 0, NULL
, NULL
}, /* 0xf6 */
84 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf7 */
85 {SNDRV_SEQ_EVENT_CLOCK
, 0, NULL
, NULL
}, /* 0xf8 */
86 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xf9 */
87 {SNDRV_SEQ_EVENT_START
, 0, NULL
, NULL
}, /* 0xfa */
88 {SNDRV_SEQ_EVENT_CONTINUE
, 0, NULL
, NULL
}, /* 0xfb */
89 {SNDRV_SEQ_EVENT_STOP
, 0, NULL
, NULL
}, /* 0xfc */
90 {SNDRV_SEQ_EVENT_NONE
, -1, NULL
, NULL
}, /* 0xfd */
91 {SNDRV_SEQ_EVENT_SENSING
, 0, NULL
, NULL
}, /* 0xfe */
92 {SNDRV_SEQ_EVENT_RESET
, 0, NULL
, NULL
}, /* 0xff */
95 static int extra_decode_ctrl14(struct snd_midi_event
*dev
, unsigned char *buf
, int len
,
96 struct snd_seq_event
*ev
);
97 static int extra_decode_xrpn(struct snd_midi_event
*dev
, unsigned char *buf
, int count
,
98 struct snd_seq_event
*ev
);
100 static struct extra_event_list
{
102 int (*decode
)(struct snd_midi_event
*dev
, unsigned char *buf
, int len
,
103 struct snd_seq_event
*ev
);
105 {SNDRV_SEQ_EVENT_CONTROL14
, extra_decode_ctrl14
},
106 {SNDRV_SEQ_EVENT_NONREGPARAM
, extra_decode_xrpn
},
107 {SNDRV_SEQ_EVENT_REGPARAM
, extra_decode_xrpn
},
114 int snd_midi_event_new(int bufsize
, struct snd_midi_event
**rdev
)
116 struct snd_midi_event
*dev
;
119 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
123 dev
->buf
= kmalloc(bufsize
, GFP_KERNEL
);
124 if (dev
->buf
== NULL
) {
129 dev
->bufsize
= bufsize
;
131 dev
->type
= ST_INVALID
;
132 spin_lock_init(&dev
->lock
);
137 void snd_midi_event_free(struct snd_midi_event
*dev
)
148 static inline void reset_encode(struct snd_midi_event
*dev
)
152 dev
->type
= ST_INVALID
;
155 void snd_midi_event_reset_encode(struct snd_midi_event
*dev
)
159 spin_lock_irqsave(&dev
->lock
, flags
);
161 spin_unlock_irqrestore(&dev
->lock
, flags
);
164 void snd_midi_event_reset_decode(struct snd_midi_event
*dev
)
168 spin_lock_irqsave(&dev
->lock
, flags
);
170 spin_unlock_irqrestore(&dev
->lock
, flags
);
174 void snd_midi_event_init(struct snd_midi_event
*dev
)
176 snd_midi_event_reset_encode(dev
);
177 snd_midi_event_reset_decode(dev
);
181 void snd_midi_event_no_status(struct snd_midi_event
*dev
, int on
)
183 dev
->nostat
= on
? 1 : 0;
190 int snd_midi_event_resize_buffer(struct snd_midi_event
*dev
, int bufsize
)
192 unsigned char *new_buf
, *old_buf
;
195 if (bufsize
== dev
->bufsize
)
197 new_buf
= kmalloc(bufsize
, GFP_KERNEL
);
200 spin_lock_irqsave(&dev
->lock
, flags
);
203 dev
->bufsize
= bufsize
;
205 spin_unlock_irqrestore(&dev
->lock
, flags
);
212 * read bytes and encode to sequencer event if finished
213 * return the size of encoded bytes
215 long snd_midi_event_encode(struct snd_midi_event
*dev
, unsigned char *buf
, long count
,
216 struct snd_seq_event
*ev
)
221 ev
->type
= SNDRV_SEQ_EVENT_NONE
;
223 while (count
-- > 0) {
224 rc
= snd_midi_event_encode_byte(dev
, *buf
++, ev
);
236 * read one byte and encode to sequencer event:
237 * return 1 if MIDI bytes are encoded to an event
238 * 0 data is not finished
241 int snd_midi_event_encode_byte(struct snd_midi_event
*dev
, int c
,
242 struct snd_seq_event
*ev
)
249 if (c
>= MIDI_CMD_COMMON_CLOCK
) {
250 /* real-time event */
251 ev
->type
= status_event
[ST_SPECIAL
+ c
- 0xf0].event
;
252 ev
->flags
&= ~SNDRV_SEQ_EVENT_LENGTH_MASK
;
253 ev
->flags
|= SNDRV_SEQ_EVENT_LENGTH_FIXED
;
254 return ev
->type
!= SNDRV_SEQ_EVENT_NONE
;
257 spin_lock_irqsave(&dev
->lock
, flags
);
259 (c
!= MIDI_CMD_COMMON_SYSEX_END
|| dev
->type
!= ST_SYSEX
)) {
262 if ((c
& 0xf0) == 0xf0) /* system messages */
263 dev
->type
= (c
& 0x0f) + ST_SPECIAL
;
265 dev
->type
= (c
>> 4) & 0x07;
267 dev
->qlen
= status_event
[dev
->type
].qlen
;
270 /* rest of command */
271 dev
->buf
[dev
->read
++] = c
;
272 if (dev
->type
!= ST_SYSEX
)
277 dev
->qlen
= status_event
[dev
->type
].qlen
- 1;
281 if (dev
->qlen
== 0) {
282 ev
->type
= status_event
[dev
->type
].event
;
283 ev
->flags
&= ~SNDRV_SEQ_EVENT_LENGTH_MASK
;
284 ev
->flags
|= SNDRV_SEQ_EVENT_LENGTH_FIXED
;
285 if (status_event
[dev
->type
].encode
) /* set data values */
286 status_event
[dev
->type
].encode(dev
, ev
);
287 if (dev
->type
>= ST_SPECIAL
)
288 dev
->type
= ST_INVALID
;
290 } else if (dev
->type
== ST_SYSEX
) {
291 if (c
== MIDI_CMD_COMMON_SYSEX_END
||
292 dev
->read
>= dev
->bufsize
) {
293 ev
->flags
&= ~SNDRV_SEQ_EVENT_LENGTH_MASK
;
294 ev
->flags
|= SNDRV_SEQ_EVENT_LENGTH_VARIABLE
;
295 ev
->type
= SNDRV_SEQ_EVENT_SYSEX
;
296 ev
->data
.ext
.len
= dev
->read
;
297 ev
->data
.ext
.ptr
= dev
->buf
;
298 if (c
!= MIDI_CMD_COMMON_SYSEX_END
)
299 dev
->read
= 0; /* continue to parse */
301 reset_encode(dev
); /* all parsed */
306 spin_unlock_irqrestore(&dev
->lock
, flags
);
310 /* encode note event */
311 static void note_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
313 ev
->data
.note
.channel
= dev
->buf
[0] & 0x0f;
314 ev
->data
.note
.note
= dev
->buf
[1];
315 ev
->data
.note
.velocity
= dev
->buf
[2];
318 /* encode one parameter controls */
319 static void one_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
321 ev
->data
.control
.channel
= dev
->buf
[0] & 0x0f;
322 ev
->data
.control
.value
= dev
->buf
[1];
325 /* encode pitch wheel change */
326 static void pitchbend_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
328 ev
->data
.control
.channel
= dev
->buf
[0] & 0x0f;
329 ev
->data
.control
.value
= (int)dev
->buf
[2] * 128 + (int)dev
->buf
[1] - 8192;
332 /* encode midi control change */
333 static void two_param_ctrl_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
335 ev
->data
.control
.channel
= dev
->buf
[0] & 0x0f;
336 ev
->data
.control
.param
= dev
->buf
[1];
337 ev
->data
.control
.value
= dev
->buf
[2];
340 /* encode one parameter value*/
341 static void one_param_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
343 ev
->data
.control
.value
= dev
->buf
[1];
346 /* encode song position */
347 static void songpos_event(struct snd_midi_event
*dev
, struct snd_seq_event
*ev
)
349 ev
->data
.control
.value
= (int)dev
->buf
[2] * 128 + (int)dev
->buf
[1];
353 * decode from a sequencer event to midi bytes
354 * return the size of decoded midi events
356 long snd_midi_event_decode(struct snd_midi_event
*dev
, unsigned char *buf
, long count
,
357 struct snd_seq_event
*ev
)
359 unsigned int cmd
, type
;
361 if (ev
->type
== SNDRV_SEQ_EVENT_NONE
)
364 for (type
= 0; type
< ARRAY_SIZE(status_event
); type
++) {
365 if (ev
->type
== status_event
[type
].event
)
368 for (type
= 0; type
< ARRAY_SIZE(extra_event
); type
++) {
369 if (ev
->type
== extra_event
[type
].event
)
370 return extra_event
[type
].decode(dev
, buf
, count
, ev
);
375 if (type
>= ST_SPECIAL
)
376 cmd
= 0xf0 + (type
- ST_SPECIAL
);
378 /* data.note.channel and data.control.channel is identical */
379 cmd
= 0x80 | (type
<< 4) | (ev
->data
.note
.channel
& 0x0f);
382 if (cmd
== MIDI_CMD_COMMON_SYSEX
) {
383 snd_midi_event_reset_decode(dev
);
384 return snd_seq_expand_var_event(ev
, count
, buf
, 1, 0);
387 unsigned char xbuf
[4];
390 spin_lock_irqsave(&dev
->lock
, flags
);
391 if ((cmd
& 0xf0) == 0xf0 || dev
->lastcmd
!= cmd
|| dev
->nostat
) {
393 spin_unlock_irqrestore(&dev
->lock
, flags
);
395 if (status_event
[type
].decode
)
396 status_event
[type
].decode(ev
, xbuf
+ 1);
397 qlen
= status_event
[type
].qlen
+ 1;
399 spin_unlock_irqrestore(&dev
->lock
, flags
);
400 if (status_event
[type
].decode
)
401 status_event
[type
].decode(ev
, xbuf
+ 0);
402 qlen
= status_event
[type
].qlen
;
406 memcpy(buf
, xbuf
, qlen
);
412 /* decode note event */
413 static void note_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
415 buf
[0] = ev
->data
.note
.note
& 0x7f;
416 buf
[1] = ev
->data
.note
.velocity
& 0x7f;
419 /* decode one parameter controls */
420 static void one_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
422 buf
[0] = ev
->data
.control
.value
& 0x7f;
425 /* decode pitch wheel change */
426 static void pitchbend_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
428 int value
= ev
->data
.control
.value
+ 8192;
429 buf
[0] = value
& 0x7f;
430 buf
[1] = (value
>> 7) & 0x7f;
433 /* decode midi control change */
434 static void two_param_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
436 buf
[0] = ev
->data
.control
.param
& 0x7f;
437 buf
[1] = ev
->data
.control
.value
& 0x7f;
440 /* decode song position */
441 static void songpos_decode(struct snd_seq_event
*ev
, unsigned char *buf
)
443 buf
[0] = ev
->data
.control
.value
& 0x7f;
444 buf
[1] = (ev
->data
.control
.value
>> 7) & 0x7f;
447 /* decode 14bit control */
448 static int extra_decode_ctrl14(struct snd_midi_event
*dev
, unsigned char *buf
,
449 int count
, struct snd_seq_event
*ev
)
454 cmd
= MIDI_CMD_CONTROL
|(ev
->data
.control
.channel
& 0x0f);
455 if (ev
->data
.control
.param
< 0x20) {
458 if (dev
->nostat
&& count
< 6)
460 if (cmd
!= dev
->lastcmd
|| dev
->nostat
) {
463 buf
[idx
++] = dev
->lastcmd
= cmd
;
465 buf
[idx
++] = ev
->data
.control
.param
;
466 buf
[idx
++] = (ev
->data
.control
.value
>> 7) & 0x7f;
469 buf
[idx
++] = ev
->data
.control
.param
+ 0x20;
470 buf
[idx
++] = ev
->data
.control
.value
& 0x7f;
474 if (cmd
!= dev
->lastcmd
|| dev
->nostat
) {
477 buf
[idx
++] = dev
->lastcmd
= cmd
;
479 buf
[idx
++] = ev
->data
.control
.param
& 0x7f;
480 buf
[idx
++] = ev
->data
.control
.value
& 0x7f;
485 /* decode reg/nonreg param */
486 static int extra_decode_xrpn(struct snd_midi_event
*dev
, unsigned char *buf
,
487 int count
, struct snd_seq_event
*ev
)
491 static char cbytes_nrpn
[4] = { MIDI_CTL_NONREG_PARM_NUM_MSB
,
492 MIDI_CTL_NONREG_PARM_NUM_LSB
,
493 MIDI_CTL_MSB_DATA_ENTRY
,
494 MIDI_CTL_LSB_DATA_ENTRY
};
495 static char cbytes_rpn
[4] = { MIDI_CTL_REGIST_PARM_NUM_MSB
,
496 MIDI_CTL_REGIST_PARM_NUM_LSB
,
497 MIDI_CTL_MSB_DATA_ENTRY
,
498 MIDI_CTL_LSB_DATA_ENTRY
};
499 unsigned char bytes
[4];
504 if (dev
->nostat
&& count
< 12)
506 cmd
= MIDI_CMD_CONTROL
|(ev
->data
.control
.channel
& 0x0f);
507 bytes
[0] = (ev
->data
.control
.param
& 0x3f80) >> 7;
508 bytes
[1] = ev
->data
.control
.param
& 0x007f;
509 bytes
[2] = (ev
->data
.control
.value
& 0x3f80) >> 7;
510 bytes
[3] = ev
->data
.control
.value
& 0x007f;
511 if (cmd
!= dev
->lastcmd
&& !dev
->nostat
) {
514 buf
[idx
++] = dev
->lastcmd
= cmd
;
516 cbytes
= ev
->type
== SNDRV_SEQ_EVENT_NONREGPARAM
? cbytes_nrpn
: cbytes_rpn
;
517 for (i
= 0; i
< 4; i
++) {
519 buf
[idx
++] = dev
->lastcmd
= cmd
;
520 buf
[idx
++] = cbytes
[i
];
521 buf
[idx
++] = bytes
[i
];
530 EXPORT_SYMBOL(snd_midi_event_new
);
531 EXPORT_SYMBOL(snd_midi_event_free
);
532 EXPORT_SYMBOL(snd_midi_event_reset_encode
);
533 EXPORT_SYMBOL(snd_midi_event_reset_decode
);
534 EXPORT_SYMBOL(snd_midi_event_no_status
);
535 EXPORT_SYMBOL(snd_midi_event_encode
);
536 EXPORT_SYMBOL(snd_midi_event_encode_byte
);
537 EXPORT_SYMBOL(snd_midi_event_decode
);
539 static int __init
alsa_seq_midi_event_init(void)
544 static void __exit
alsa_seq_midi_event_exit(void)
548 module_init(alsa_seq_midi_event_init
)
549 module_exit(alsa_seq_midi_event_exit
)