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