sound/core/seq/seq_virmidi.c

   1 /*
   2  *  Virtual Raw MIDI client on Sequencer
   3  *
   4  *  Copyright (c) 2000 by Takashi Iwai <tiwai@suse.de>,
   5  *                        Jaroslav Kysela <perex@perex.cz>
   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
  23 /*
  24  * Virtual Raw MIDI client
  25  *
  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.
  31  *
  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.
  35  *
  36  */
  37
  38 #include <sound/driver.h>
  39 #include <linux/init.h>
  40 #include <linux/wait.h>
  41 #include <linux/sched.h>
  42 #include <linux/slab.h>
  43 #include <sound/core.h>
  44 #include <sound/rawmidi.h>
  45 #include <sound/info.h>
  46 #include <sound/control.h>
  47 #include <sound/minors.h>
  48 #include <sound/seq_kernel.h>
  49 #include <sound/seq_midi_event.h>
  50 #include <sound/seq_virmidi.h>
  51
  52 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
  53 MODULE_DESCRIPTION("Virtual Raw MIDI client on Sequencer");
  54 MODULE_LICENSE("GPL");
  55
  56 /*
  57  * initialize an event record
  58  */
  59 static void snd_virmidi_init_event(struct snd_virmidi *vmidi,
  60                                    struct snd_seq_event *ev)
  61 {
  62         memset(ev, 0, sizeof(*ev));
  63         ev->source.port = vmidi->port;
  64         switch (vmidi->seq_mode) {
  65         case SNDRV_VIRMIDI_SEQ_DISPATCH:
  66                 ev->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
  67                 break;
  68         case SNDRV_VIRMIDI_SEQ_ATTACH:
  69                 /* FIXME: source and destination are same - not good.. */
  70                 ev->dest.client = vmidi->client;
  71                 ev->dest.port = vmidi->port;
  72                 break;
  73         }
  74         ev->type = SNDRV_SEQ_EVENT_NONE;
  75 }
  76
  77 /*
  78  * decode input event and put to read buffer of each opened file
  79  */
  80 static int snd_virmidi_dev_receive_event(struct snd_virmidi_dev *rdev,
  81                                          struct snd_seq_event *ev)
  82 {
  83         struct snd_virmidi *vmidi;
  84         unsigned char msg[4];
  85         int len;
  86
  87         read_lock(&rdev->filelist_lock);
  88         list_for_each_entry(vmidi, &rdev->filelist, list) {
  89                 if (!vmidi->trigger)
  90                         continue;
  91                 if (ev->type == SNDRV_SEQ_EVENT_SYSEX) {
  92                         if ((ev->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
  93                                 continue;
  94                         snd_seq_dump_var_event(ev, (snd_seq_dump_func_t)snd_rawmidi_receive, vmidi->substream);
  95                 } else {
  96                         len = snd_midi_event_decode(vmidi->parser, msg, sizeof(msg), ev);
  97                         if (len > 0)
  98                                 snd_rawmidi_receive(vmidi->substream, msg, len);
  99                 }
 100         }
 101         read_unlock(&rdev->filelist_lock);
 102
 103         return 0;
 104 }
 105
 106 /*
 107  * receive an event from the remote virmidi port
 108  *
 109  * for rawmidi inputs, you can call this function from the event
 110  * handler of a remote port which is attached to the virmidi via
 111  * SNDRV_VIRMIDI_SEQ_ATTACH.
 112  */
 113 #if 0
 114 int snd_virmidi_receive(struct snd_rawmidi *rmidi, struct snd_seq_event *ev)
 115 {
 116         struct snd_virmidi_dev *rdev;
 117
 118         rdev = rmidi->private_data;
 119         return snd_virmidi_dev_receive_event(rdev, ev);
 120 }
 121 #endif  /*  0  */
 122
 123 /*
 124  * event handler of virmidi port
 125  */
 126 static int snd_virmidi_event_input(struct snd_seq_event *ev, int direct,
 127                                    void *private_data, int atomic, int hop)
 128 {
 129         struct snd_virmidi_dev *rdev;
 130
 131         rdev = private_data;
 132         if (!(rdev->flags & SNDRV_VIRMIDI_USE))
 133                 return 0; /* ignored */
 134         return snd_virmidi_dev_receive_event(rdev, ev);
 135 }
 136
 137 /*
 138  * trigger rawmidi stream for input
 139  */
 140 static void snd_virmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
 141 {
 142         struct snd_virmidi *vmidi = substream->runtime->private_data;
 143
 144         if (up) {
 145                 vmidi->trigger = 1;
 146         } else {
 147                 vmidi->trigger = 0;
 148         }
 149 }
 150
 151 /*
 152  * trigger rawmidi stream for output
 153  */
 154 static void snd_virmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
 155 {
 156         struct snd_virmidi *vmidi = substream->runtime->private_data;
 157         int count, res;
 158         unsigned char buf[32], *pbuf;
 159
 160         if (up) {
 161                 vmidi->trigger = 1;
 162                 if (vmidi->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH &&
 163                     !(vmidi->rdev->flags & SNDRV_VIRMIDI_SUBSCRIBE)) {
 164                         snd_rawmidi_transmit_ack(substream, substream->runtime->buffer_size - substream->runtime->avail);
 165                         return;         /* ignored */
 166                 }
 167                 if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
 168                         if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
 169                                 return;
 170                         vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
 171                 }
 172                 while (1) {
 173                         count = snd_rawmidi_transmit_peek(substream, buf, sizeof(buf));
 174                         if (count <= 0)
 175                                 break;
 176                         pbuf = buf;
 177                         while (count > 0) {
 178                                 res = snd_midi_event_encode(vmidi->parser, pbuf, count, &vmidi->event);
 179                                 if (res < 0) {
 180                                         snd_midi_event_reset_encode(vmidi->parser);
 181                                         continue;
 182                                 }
 183                                 snd_rawmidi_transmit_ack(substream, res);
 184                                 pbuf += res;
 185                                 count -= res;
 186                                 if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
 187                                         if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
 188                                                 return;
 189                                         vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
 190                                 }
 191                         }
 192                 }
 193         } else {
 194                 vmidi->trigger = 0;
 195         }
 196 }
 197
 198 /*
 199  * open rawmidi handle for input
 200  */
 201 static int snd_virmidi_input_open(struct snd_rawmidi_substream *substream)
 202 {
 203         struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
 204         struct snd_rawmidi_runtime *runtime = substream->runtime;
 205         struct snd_virmidi *vmidi;
 206         unsigned long flags;
 207
 208         vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
 209         if (vmidi == NULL)
 210                 return -ENOMEM;
 211         vmidi->substream = substream;
 212         if (snd_midi_event_new(0, &vmidi->parser) < 0) {
 213                 kfree(vmidi);
 214                 return -ENOMEM;
 215         }
 216         vmidi->seq_mode = rdev->seq_mode;
 217         vmidi->client = rdev->client;
 218         vmidi->port = rdev->port;
 219         runtime->private_data = vmidi;
 220         write_lock_irqsave(&rdev->filelist_lock, flags);
 221         list_add_tail(&vmidi->list, &rdev->filelist);
 222         write_unlock_irqrestore(&rdev->filelist_lock, flags);
 223         vmidi->rdev = rdev;
 224         return 0;
 225 }
 226
 227 /*
 228  * open rawmidi handle for output
 229  */
 230 static int snd_virmidi_output_open(struct snd_rawmidi_substream *substream)
 231 {
 232         struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
 233         struct snd_rawmidi_runtime *runtime = substream->runtime;
 234         struct snd_virmidi *vmidi;
 235
 236         vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
 237         if (vmidi == NULL)
 238                 return -ENOMEM;
 239         vmidi->substream = substream;
 240         if (snd_midi_event_new(MAX_MIDI_EVENT_BUF, &vmidi->parser) < 0) {
 241                 kfree(vmidi);
 242                 return -ENOMEM;
 243         }
 244         vmidi->seq_mode = rdev->seq_mode;
 245         vmidi->client = rdev->client;
 246         vmidi->port = rdev->port;
 247         snd_virmidi_init_event(vmidi, &vmidi->event);
 248         vmidi->rdev = rdev;
 249         runtime->private_data = vmidi;
 250         return 0;
 251 }
 252
 253 /*
 254  * close rawmidi handle for input
 255  */
 256 static int snd_virmidi_input_close(struct snd_rawmidi_substream *substream)
 257 {
 258         struct snd_virmidi *vmidi = substream->runtime->private_data;
 259         snd_midi_event_free(vmidi->parser);
 260         list_del(&vmidi->list);
 261         substream->runtime->private_data = NULL;
 262         kfree(vmidi);
 263         return 0;
 264 }
 265
 266 /*
 267  * close rawmidi handle for output
 268  */
 269 static int snd_virmidi_output_close(struct snd_rawmidi_substream *substream)
 270 {
 271         struct snd_virmidi *vmidi = substream->runtime->private_data;
 272         snd_midi_event_free(vmidi->parser);
 273         substream->runtime->private_data = NULL;
 274         kfree(vmidi);
 275         return 0;
 276 }
 277
 278 /*
 279  * subscribe callback - allow output to rawmidi device
 280  */
 281 static int snd_virmidi_subscribe(void *private_data,
 282                                  struct snd_seq_port_subscribe *info)
 283 {
 284         struct snd_virmidi_dev *rdev;
 285
 286         rdev = private_data;
 287         if (!try_module_get(rdev->card->module))
 288                 return -EFAULT;
 289         rdev->flags |= SNDRV_VIRMIDI_SUBSCRIBE;
 290         return 0;
 291 }
 292
 293 /*
 294  * unsubscribe callback - disallow output to rawmidi device
 295  */
 296 static int snd_virmidi_unsubscribe(void *private_data,
 297                                    struct snd_seq_port_subscribe *info)
 298 {
 299         struct snd_virmidi_dev *rdev;
 300
 301         rdev = private_data;
 302         rdev->flags &= ~SNDRV_VIRMIDI_SUBSCRIBE;
 303         module_put(rdev->card->module);
 304         return 0;
 305 }
 306
 307
 308 /*
 309  * use callback - allow input to rawmidi device
 310  */
 311 static int snd_virmidi_use(void *private_data,
 312                            struct snd_seq_port_subscribe *info)
 313 {
 314         struct snd_virmidi_dev *rdev;
 315
 316         rdev = private_data;
 317         if (!try_module_get(rdev->card->module))
 318                 return -EFAULT;
 319         rdev->flags |= SNDRV_VIRMIDI_USE;
 320         return 0;
 321 }
 322
 323 /*
 324  * unuse callback - disallow input to rawmidi device
 325  */
 326 static int snd_virmidi_unuse(void *private_data,
 327                              struct snd_seq_port_subscribe *info)
 328 {
 329         struct snd_virmidi_dev *rdev;
 330
 331         rdev = private_data;
 332         rdev->flags &= ~SNDRV_VIRMIDI_USE;
 333         module_put(rdev->card->module);
 334         return 0;
 335 }
 336
 337
 338 /*
 339  *  Register functions
 340  */
 341
 342 static struct snd_rawmidi_ops snd_virmidi_input_ops = {
 343         .open = snd_virmidi_input_open,
 344         .close = snd_virmidi_input_close,
 345         .trigger = snd_virmidi_input_trigger,
 346 };
 347
 348 static struct snd_rawmidi_ops snd_virmidi_output_ops = {
 349         .open = snd_virmidi_output_open,
 350         .close = snd_virmidi_output_close,
 351         .trigger = snd_virmidi_output_trigger,
 352 };
 353
 354 /*
 355  * create a sequencer client and a port
 356  */
 357 static int snd_virmidi_dev_attach_seq(struct snd_virmidi_dev *rdev)
 358 {
 359         int client;
 360         struct snd_seq_port_callback pcallbacks;
 361         struct snd_seq_port_info *pinfo;
 362         int err;
 363
 364         if (rdev->client >= 0)
 365                 return 0;
 366
 367         pinfo = kmalloc(sizeof(*pinfo), GFP_KERNEL);
 368         if (!pinfo) {
 369                 err = -ENOMEM;
 370                 goto __error;
 371         }
 372
 373         client = snd_seq_create_kernel_client(rdev->card, rdev->device,
 374                                               "%s %d-%d", rdev->rmidi->name,
 375                                               rdev->card->number,
 376                                               rdev->device);
 377         if (client < 0) {
 378                 err = client;
 379                 goto __error;
 380         }
 381         rdev->client = client;
 382
 383         /* create a port */
 384         memset(pinfo, 0, sizeof(*pinfo));
 385         pinfo->addr.client = client;
 386         sprintf(pinfo->name, "VirMIDI %d-%d", rdev->card->number, rdev->device);
 387         /* set all capabilities */
 388         pinfo->capability |= SNDRV_SEQ_PORT_CAP_WRITE | SNDRV_SEQ_PORT_CAP_SYNC_WRITE | SNDRV_SEQ_PORT_CAP_SUBS_WRITE;
 389         pinfo->capability |= SNDRV_SEQ_PORT_CAP_READ | SNDRV_SEQ_PORT_CAP_SYNC_READ | SNDRV_SEQ_PORT_CAP_SUBS_READ;
 390         pinfo->capability |= SNDRV_SEQ_PORT_CAP_DUPLEX;
 391         pinfo->type = SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
 392                 | SNDRV_SEQ_PORT_TYPE_SOFTWARE
 393                 | SNDRV_SEQ_PORT_TYPE_PORT;
 394         pinfo->midi_channels = 16;
 395         memset(&pcallbacks, 0, sizeof(pcallbacks));
 396         pcallbacks.owner = THIS_MODULE;
 397         pcallbacks.private_data = rdev;
 398         pcallbacks.subscribe = snd_virmidi_subscribe;
 399         pcallbacks.unsubscribe = snd_virmidi_unsubscribe;
 400         pcallbacks.use = snd_virmidi_use;
 401         pcallbacks.unuse = snd_virmidi_unuse;
 402         pcallbacks.event_input = snd_virmidi_event_input;
 403         pinfo->kernel = &pcallbacks;
 404         err = snd_seq_kernel_client_ctl(client, SNDRV_SEQ_IOCTL_CREATE_PORT, pinfo);
 405         if (err < 0) {
 406                 snd_seq_delete_kernel_client(client);
 407                 rdev->client = -1;
 408                 goto __error;
 409         }
 410
 411         rdev->port = pinfo->addr.port;
 412         err = 0; /* success */
 413
 414  __error:
 415         kfree(pinfo);
 416         return err;
 417 }
 418
 419
 420 /*
 421  * release the sequencer client
 422  */
 423 static void snd_virmidi_dev_detach_seq(struct snd_virmidi_dev *rdev)
 424 {
 425         if (rdev->client >= 0) {
 426                 snd_seq_delete_kernel_client(rdev->client);
 427                 rdev->client = -1;
 428         }
 429 }
 430
 431 /*
 432  * register the device
 433  */
 434 static int snd_virmidi_dev_register(struct snd_rawmidi *rmidi)
 435 {
 436         struct snd_virmidi_dev *rdev = rmidi->private_data;
 437         int err;
 438
 439         switch (rdev->seq_mode) {
 440         case SNDRV_VIRMIDI_SEQ_DISPATCH:
 441                 err = snd_virmidi_dev_attach_seq(rdev);
 442                 if (err < 0)
 443                         return err;
 444                 break;
 445         case SNDRV_VIRMIDI_SEQ_ATTACH:
 446                 if (rdev->client == 0)
 447                         return -EINVAL;
 448                 /* should check presence of port more strictly.. */
 449                 break;
 450         default:
 451                 snd_printk(KERN_ERR "seq_mode is not set: %d\n", rdev->seq_mode);
 452                 return -EINVAL;
 453         }
 454         return 0;
 455 }
 456
 457
 458 /*
 459  * unregister the device
 460  */
 461 static int snd_virmidi_dev_unregister(struct snd_rawmidi *rmidi)
 462 {
 463         struct snd_virmidi_dev *rdev = rmidi->private_data;
 464
 465         if (rdev->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH)
 466                 snd_virmidi_dev_detach_seq(rdev);
 467         return 0;
 468 }
 469
 470 /*
 471  *
 472  */
 473 static struct snd_rawmidi_global_ops snd_virmidi_global_ops = {
 474         .dev_register = snd_virmidi_dev_register,
 475         .dev_unregister = snd_virmidi_dev_unregister,
 476 };
 477
 478 /*
 479  * free device
 480  */
 481 static void snd_virmidi_free(struct snd_rawmidi *rmidi)
 482 {
 483         struct snd_virmidi_dev *rdev = rmidi->private_data;
 484         kfree(rdev);
 485 }
 486
 487 /*
 488  * create a new device
 489  *
 490  */
 491 /* exported */
 492 int snd_virmidi_new(struct snd_card *card, int device, struct snd_rawmidi **rrmidi)
 493 {
 494         struct snd_rawmidi *rmidi;
 495         struct snd_virmidi_dev *rdev;
 496         int err;
 497
 498         *rrmidi = NULL;
 499         if ((err = snd_rawmidi_new(card, "VirMidi", device,
 500                                    16,  /* may be configurable */
 501                                    16,  /* may be configurable */
 502                                    &rmidi)) < 0)
 503                 return err;
 504         strcpy(rmidi->name, rmidi->id);
 505         rdev = kzalloc(sizeof(*rdev), GFP_KERNEL);
 506         if (rdev == NULL) {
 507                 snd_device_free(card, rmidi);
 508                 return -ENOMEM;
 509         }
 510         rdev->card = card;
 511         rdev->rmidi = rmidi;
 512         rdev->device = device;
 513         rdev->client = -1;
 514         rwlock_init(&rdev->filelist_lock);
 515         INIT_LIST_HEAD(&rdev->filelist);
 516         rdev->seq_mode = SNDRV_VIRMIDI_SEQ_DISPATCH;
 517         rmidi->private_data = rdev;
 518         rmidi->private_free = snd_virmidi_free;
 519         rmidi->ops = &snd_virmidi_global_ops;
 520         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_virmidi_input_ops);
 521         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_virmidi_output_ops);
 522         rmidi->info_flags = SNDRV_RAWMIDI_INFO_INPUT |
 523                             SNDRV_RAWMIDI_INFO_OUTPUT |
 524                             SNDRV_RAWMIDI_INFO_DUPLEX;
 525         *rrmidi = rmidi;
 526         return 0;
 527 }
 528
 529 /*
 530  *  ENTRY functions
 531  */
 532
 533 static int __init alsa_virmidi_init(void)
 534 {
 535         return 0;
 536 }
 537
 538 static void __exit alsa_virmidi_exit(void)
 539 {
 540 }
 541
 542 module_init(alsa_virmidi_init)
 543 module_exit(alsa_virmidi_exit)
 544
 545 EXPORT_SYMBOL(snd_virmidi_new);