2 * Virtual Raw MIDI client on Sequencer
4 * Copyright (c) 2000 by 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
24 * Virtual Raw MIDI client
26 * The virtual rawmidi client is a sequencer client which associate
27 * a rawmidi device file. The created rawmidi device file can be
28 * accessed as a normal raw midi, but its MIDI source and destination
29 * are arbitrary. For example, a user-client software synth connected
30 * to this port can be used as a normal midi device as well.
32 * The virtual rawmidi device accepts also multiple opens. Each file
33 * has its own input buffer, so that no conflict would occur. The drain
34 * of input/output buffer acts only to the local buffer.
38 #include <linux/init.h>
39 #include <linux/wait.h>
40 #include <linux/module.h>
41 #include <linux/slab.h>
42 #include <sound/core.h>
43 #include <sound/rawmidi.h>
44 #include <sound/info.h>
45 #include <sound/control.h>
46 #include <sound/minors.h>
47 #include <sound/seq_kernel.h>
48 #include <sound/seq_midi_event.h>
49 #include <sound/seq_virmidi.h>
51 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
52 MODULE_DESCRIPTION("Virtual Raw MIDI client on Sequencer");
53 MODULE_LICENSE("GPL");
56 * initialize an event record
58 static void snd_virmidi_init_event(struct snd_virmidi *vmidi,
59 struct snd_seq_event *ev)
61 memset(ev, 0, sizeof(*ev));
62 ev->source.port = vmidi->port;
63 switch (vmidi->seq_mode) {
64 case SNDRV_VIRMIDI_SEQ_DISPATCH:
65 ev->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
67 case SNDRV_VIRMIDI_SEQ_ATTACH:
68 /* FIXME: source and destination are same - not good.. */
69 ev->dest.client = vmidi->client;
70 ev->dest.port = vmidi->port;
73 ev->type = SNDRV_SEQ_EVENT_NONE;
77 * decode input event and put to read buffer of each opened file
79 static int snd_virmidi_dev_receive_event(struct snd_virmidi_dev *rdev,
80 struct snd_seq_event *ev)
82 struct snd_virmidi *vmidi;
86 read_lock(&rdev->filelist_lock);
87 list_for_each_entry(vmidi, &rdev->filelist, list) {
90 if (ev->type == SNDRV_SEQ_EVENT_SYSEX) {
91 if ((ev->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
93 snd_seq_dump_var_event(ev, (snd_seq_dump_func_t)snd_rawmidi_receive, vmidi->substream);
95 len = snd_midi_event_decode(vmidi->parser, msg, sizeof(msg), ev);
97 snd_rawmidi_receive(vmidi->substream, msg, len);
100 read_unlock(&rdev->filelist_lock);
106 * receive an event from the remote virmidi port
108 * for rawmidi inputs, you can call this function from the event
109 * handler of a remote port which is attached to the virmidi via
110 * SNDRV_VIRMIDI_SEQ_ATTACH.
113 int snd_virmidi_receive(struct snd_rawmidi *rmidi, struct snd_seq_event *ev)
115 struct snd_virmidi_dev *rdev;
117 rdev = rmidi->private_data;
118 return snd_virmidi_dev_receive_event(rdev, ev);
123 * event handler of virmidi port
125 static int snd_virmidi_event_input(struct snd_seq_event *ev, int direct,
126 void *private_data, int atomic, int hop)
128 struct snd_virmidi_dev *rdev;
131 if (!(rdev->flags & SNDRV_VIRMIDI_USE))
132 return 0; /* ignored */
133 return snd_virmidi_dev_receive_event(rdev, ev);
137 * trigger rawmidi stream for input
139 static void snd_virmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
141 struct snd_virmidi *vmidi = substream->runtime->private_data;
151 * trigger rawmidi stream for output
153 static void snd_virmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
155 struct snd_virmidi *vmidi = substream->runtime->private_data;
157 unsigned char buf[32], *pbuf;
162 if (vmidi->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH &&
163 !(vmidi->rdev->flags & SNDRV_VIRMIDI_SUBSCRIBE)) {
164 while (snd_rawmidi_transmit(substream, buf,
170 if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
171 if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
173 vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
175 spin_lock_irqsave(&substream->runtime->lock, flags);
177 count = __snd_rawmidi_transmit_peek(substream, buf, sizeof(buf));
182 res = snd_midi_event_encode(vmidi->parser, pbuf, count, &vmidi->event);
184 snd_midi_event_reset_encode(vmidi->parser);
187 __snd_rawmidi_transmit_ack(substream, res);
190 if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
191 if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
193 vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
198 spin_unlock_irqrestore(&substream->runtime->lock, flags);
205 * open rawmidi handle for input
207 static int snd_virmidi_input_open(struct snd_rawmidi_substream *substream)
209 struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
210 struct snd_rawmidi_runtime *runtime = substream->runtime;
211 struct snd_virmidi *vmidi;
214 vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
217 vmidi->substream = substream;
218 if (snd_midi_event_new(0, &vmidi->parser) < 0) {
222 vmidi->seq_mode = rdev->seq_mode;
223 vmidi->client = rdev->client;
224 vmidi->port = rdev->port;
225 runtime->private_data = vmidi;
226 write_lock_irqsave(&rdev->filelist_lock, flags);
227 list_add_tail(&vmidi->list, &rdev->filelist);
228 write_unlock_irqrestore(&rdev->filelist_lock, flags);
234 * open rawmidi handle for output
236 static int snd_virmidi_output_open(struct snd_rawmidi_substream *substream)
238 struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
239 struct snd_rawmidi_runtime *runtime = substream->runtime;
240 struct snd_virmidi *vmidi;
242 vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
245 vmidi->substream = substream;
246 if (snd_midi_event_new(MAX_MIDI_EVENT_BUF, &vmidi->parser) < 0) {
250 vmidi->seq_mode = rdev->seq_mode;
251 vmidi->client = rdev->client;
252 vmidi->port = rdev->port;
253 snd_virmidi_init_event(vmidi, &vmidi->event);
255 runtime->private_data = vmidi;
260 * close rawmidi handle for input
262 static int snd_virmidi_input_close(struct snd_rawmidi_substream *substream)
264 struct snd_virmidi *vmidi = substream->runtime->private_data;
265 snd_midi_event_free(vmidi->parser);
266 list_del(&vmidi->list);
267 substream->runtime->private_data = NULL;
273 * close rawmidi handle for output
275 static int snd_virmidi_output_close(struct snd_rawmidi_substream *substream)
277 struct snd_virmidi *vmidi = substream->runtime->private_data;
278 snd_midi_event_free(vmidi->parser);
279 substream->runtime->private_data = NULL;
285 * subscribe callback - allow output to rawmidi device
287 static int snd_virmidi_subscribe(void *private_data,
288 struct snd_seq_port_subscribe *info)
290 struct snd_virmidi_dev *rdev;
293 if (!try_module_get(rdev->card->module))
295 rdev->flags |= SNDRV_VIRMIDI_SUBSCRIBE;
300 * unsubscribe callback - disallow output to rawmidi device
302 static int snd_virmidi_unsubscribe(void *private_data,
303 struct snd_seq_port_subscribe *info)
305 struct snd_virmidi_dev *rdev;
308 rdev->flags &= ~SNDRV_VIRMIDI_SUBSCRIBE;
309 module_put(rdev->card->module);
315 * use callback - allow input to rawmidi device
317 static int snd_virmidi_use(void *private_data,
318 struct snd_seq_port_subscribe *info)
320 struct snd_virmidi_dev *rdev;
323 if (!try_module_get(rdev->card->module))
325 rdev->flags |= SNDRV_VIRMIDI_USE;
330 * unuse callback - disallow input to rawmidi device
332 static int snd_virmidi_unuse(void *private_data,
333 struct snd_seq_port_subscribe *info)
335 struct snd_virmidi_dev *rdev;
338 rdev->flags &= ~SNDRV_VIRMIDI_USE;
339 module_put(rdev->card->module);
348 static struct snd_rawmidi_ops snd_virmidi_input_ops = {
349 .open = snd_virmidi_input_open,
350 .close = snd_virmidi_input_close,
351 .trigger = snd_virmidi_input_trigger,
354 static struct snd_rawmidi_ops snd_virmidi_output_ops = {
355 .open = snd_virmidi_output_open,
356 .close = snd_virmidi_output_close,
357 .trigger = snd_virmidi_output_trigger,
361 * create a sequencer client and a port
363 static int snd_virmidi_dev_attach_seq(struct snd_virmidi_dev *rdev)
366 struct snd_seq_port_callback pcallbacks;
367 struct snd_seq_port_info *pinfo;
370 if (rdev->client >= 0)
373 pinfo = kzalloc(sizeof(*pinfo), GFP_KERNEL);
379 client = snd_seq_create_kernel_client(rdev->card, rdev->device,
380 "%s %d-%d", rdev->rmidi->name,
387 rdev->client = client;
390 pinfo->addr.client = client;
391 sprintf(pinfo->name, "VirMIDI %d-%d", rdev->card->number, rdev->device);
392 /* set all capabilities */
393 pinfo->capability |= SNDRV_SEQ_PORT_CAP_WRITE | SNDRV_SEQ_PORT_CAP_SYNC_WRITE | SNDRV_SEQ_PORT_CAP_SUBS_WRITE;
394 pinfo->capability |= SNDRV_SEQ_PORT_CAP_READ | SNDRV_SEQ_PORT_CAP_SYNC_READ | SNDRV_SEQ_PORT_CAP_SUBS_READ;
395 pinfo->capability |= SNDRV_SEQ_PORT_CAP_DUPLEX;
396 pinfo->type = SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
397 | SNDRV_SEQ_PORT_TYPE_SOFTWARE
398 | SNDRV_SEQ_PORT_TYPE_PORT;
399 pinfo->midi_channels = 16;
400 memset(&pcallbacks, 0, sizeof(pcallbacks));
401 pcallbacks.owner = THIS_MODULE;
402 pcallbacks.private_data = rdev;
403 pcallbacks.subscribe = snd_virmidi_subscribe;
404 pcallbacks.unsubscribe = snd_virmidi_unsubscribe;
405 pcallbacks.use = snd_virmidi_use;
406 pcallbacks.unuse = snd_virmidi_unuse;
407 pcallbacks.event_input = snd_virmidi_event_input;
408 pinfo->kernel = &pcallbacks;
409 err = snd_seq_kernel_client_ctl(client, SNDRV_SEQ_IOCTL_CREATE_PORT, pinfo);
411 snd_seq_delete_kernel_client(client);
416 rdev->port = pinfo->addr.port;
417 err = 0; /* success */
426 * release the sequencer client
428 static void snd_virmidi_dev_detach_seq(struct snd_virmidi_dev *rdev)
430 if (rdev->client >= 0) {
431 snd_seq_delete_kernel_client(rdev->client);
437 * register the device
439 static int snd_virmidi_dev_register(struct snd_rawmidi *rmidi)
441 struct snd_virmidi_dev *rdev = rmidi->private_data;
444 switch (rdev->seq_mode) {
445 case SNDRV_VIRMIDI_SEQ_DISPATCH:
446 err = snd_virmidi_dev_attach_seq(rdev);
450 case SNDRV_VIRMIDI_SEQ_ATTACH:
451 if (rdev->client == 0)
453 /* should check presence of port more strictly.. */
456 pr_err("ALSA: seq_virmidi: seq_mode is not set: %d\n", rdev->seq_mode);
464 * unregister the device
466 static int snd_virmidi_dev_unregister(struct snd_rawmidi *rmidi)
468 struct snd_virmidi_dev *rdev = rmidi->private_data;
470 if (rdev->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH)
471 snd_virmidi_dev_detach_seq(rdev);
478 static struct snd_rawmidi_global_ops snd_virmidi_global_ops = {
479 .dev_register = snd_virmidi_dev_register,
480 .dev_unregister = snd_virmidi_dev_unregister,
486 static void snd_virmidi_free(struct snd_rawmidi *rmidi)
488 struct snd_virmidi_dev *rdev = rmidi->private_data;
493 * create a new device
497 int snd_virmidi_new(struct snd_card *card, int device, struct snd_rawmidi **rrmidi)
499 struct snd_rawmidi *rmidi;
500 struct snd_virmidi_dev *rdev;
504 if ((err = snd_rawmidi_new(card, "VirMidi", device,
505 16, /* may be configurable */
506 16, /* may be configurable */
509 strcpy(rmidi->name, rmidi->id);
510 rdev = kzalloc(sizeof(*rdev), GFP_KERNEL);
512 snd_device_free(card, rmidi);
517 rdev->device = device;
519 rwlock_init(&rdev->filelist_lock);
520 INIT_LIST_HEAD(&rdev->filelist);
521 rdev->seq_mode = SNDRV_VIRMIDI_SEQ_DISPATCH;
522 rmidi->private_data = rdev;
523 rmidi->private_free = snd_virmidi_free;
524 rmidi->ops = &snd_virmidi_global_ops;
525 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_virmidi_input_ops);
526 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_virmidi_output_ops);
527 rmidi->info_flags = SNDRV_RAWMIDI_INFO_INPUT |
528 SNDRV_RAWMIDI_INFO_OUTPUT |
529 SNDRV_RAWMIDI_INFO_DUPLEX;
538 static int __init alsa_virmidi_init(void)
543 static void __exit alsa_virmidi_exit(void)
547 module_init(alsa_virmidi_init)
548 module_exit(alsa_virmidi_exit)
550 EXPORT_SYMBOL(snd_virmidi_new);