sound/drivers/virmidi.c

   1 /*
   2  *  Dummy soundcard for virtual rawmidi devices
   3  *
   4  *  Copyright (c) 2000 by Takashi Iwai <tiwai@suse.de>
   5  *
   6  *   This program is free software; you can redistribute it and/or modify
   7  *   it under the terms of the GNU General Public License as published by
   8  *   the Free Software Foundation; either version 2 of the License, or
   9  *   (at your option) any later version.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program; if not, write to the Free Software
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19  *
  20  */
  21
  22 /*
  23  * VIRTUAL RAW MIDI DEVICE CARDS
  24  *
  25  * This dummy card contains up to 4 virtual rawmidi devices.
  26  * They are not real rawmidi devices but just associated with sequencer
  27  * clients, so that any input/output sources can be connected as a raw
  28  * MIDI device arbitrary.
  29  * Also, multiple access is allowed to a single rawmidi device.
  30  *
  31  * Typical usage is like following:
  32  * - Load snd-virmidi module.
  33  *      # modprobe snd-virmidi index=2
  34  *   Then, sequencer clients 72:0 to 75:0 will be created, which are
  35  *   mapped from /dev/snd/midiC1D0 to /dev/snd/midiC1D3, respectively.
  36  *
  37  * - Connect input/output via aconnect.
  38  *      % aconnect 64:0 72:0    # keyboard input redirection 64:0 -> 72:0
  39  *      % aconnect 72:0 65:0    # output device redirection 72:0 -> 65:0
  40  *
  41  * - Run application using a midi device (eg. /dev/snd/midiC1D0)
  42  */
  43
  44 #include <sound/driver.h>
  45 #include <linux/init.h>
  46 #include <linux/wait.h>
  47 #include <linux/sched.h>
  48 #include <linux/moduleparam.h>
  49 #include <sound/core.h>
  50 #include <sound/seq_kernel.h>
  51 #include <sound/seq_virmidi.h>
  52 #include <sound/initval.h>
  53
  54 /* hack: OSS defines midi_devs, so undefine it (versioned symbols) */
  55 #undef midi_devs
  56
  57 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
  58 MODULE_DESCRIPTION("Dummy soundcard for virtual rawmidi devices");
  59 MODULE_LICENSE("GPL");
  60 MODULE_CLASSES("{sound}");
  61 MODULE_DEVICES("{{ALSA,Virtual rawmidi device}}");
  62
  63 #define MAX_MIDI_DEVICES        8
  64
  65 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  66 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  67 static int enable[SNDRV_CARDS] = {1, [1 ... (SNDRV_CARDS - 1)] = 0};
  68 static int midi_devs[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 4};
  69 static int boot_devs;
  70
  71 module_param_array(index, int, boot_devs, 0444);
  72 MODULE_PARM_DESC(index, "Index value for virmidi soundcard.");
  73 MODULE_PARM_SYNTAX(index, SNDRV_INDEX_DESC);
  74 module_param_array(id, charp, boot_devs, 0444);
  75 MODULE_PARM_DESC(id, "ID string for virmidi soundcard.");
  76 MODULE_PARM_SYNTAX(id, SNDRV_ID_DESC);
  77 module_param_array(enable, bool, boot_devs, 0444);
  78 MODULE_PARM_DESC(enable, "Enable this soundcard.");
  79 MODULE_PARM_SYNTAX(enable, SNDRV_ENABLE_DESC);
  80 module_param_array(midi_devs, int, boot_devs, 0444);
  81 MODULE_PARM_DESC(midi_devs, "MIDI devices # (1-8)");
  82 MODULE_PARM_SYNTAX(midi_devs, SNDRV_ENABLED ",allows:{{1,8}}");
  83
  84 typedef struct snd_card_virmidi {
  85         snd_card_t *card;
  86         snd_rawmidi_t *midi[MAX_MIDI_DEVICES];
  87 } snd_card_virmidi_t;
  88
  89 static snd_card_t *snd_virmidi_cards[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
  90
  91
  92 static int __init snd_card_virmidi_probe(int dev)
  93 {
  94         snd_card_t *card;
  95         struct snd_card_virmidi *vmidi;
  96         int idx, err;
  97
  98         if (!enable[dev])
  99                 return -ENODEV;
 100         card = snd_card_new(index[dev], id[dev], THIS_MODULE,
 101                             sizeof(struct snd_card_virmidi));
 102         if (card == NULL)
 103                 return -ENOMEM;
 104         vmidi = (struct snd_card_virmidi *)card->private_data;
 105         vmidi->card = card;
 106
 107         if (midi_devs[dev] > MAX_MIDI_DEVICES) {
 108                 snd_printk("too much midi devices for virmidi %d: force to use %d\n", dev, MAX_MIDI_DEVICES);
 109                 midi_devs[dev] = MAX_MIDI_DEVICES;
 110         }
 111         for (idx = 0; idx < midi_devs[dev]; idx++) {
 112                 snd_rawmidi_t *rmidi;
 113                 snd_virmidi_dev_t *rdev;
 114                 if ((err = snd_virmidi_new(card, idx, &rmidi)) < 0)
 115                         goto __nodev;
 116                 rdev = snd_magic_cast(snd_virmidi_dev_t, rmidi->private_data, continue);
 117                 vmidi->midi[idx] = rmidi;
 118                 strcpy(rmidi->name, "Virtual Raw MIDI");
 119                 rdev->seq_mode = SNDRV_VIRMIDI_SEQ_DISPATCH;
 120         }
 121
 122         strcpy(card->driver, "VirMIDI");
 123         strcpy(card->shortname, "VirMIDI");
 124         sprintf(card->longname, "Virtual MIDI Card %i", dev + 1);
 125         if ((err = snd_card_register(card)) == 0) {
 126                 snd_virmidi_cards[dev] = card;
 127                 return 0;
 128         }
 129       __nodev:
 130         snd_card_free(card);
 131         return err;
 132 }
 133
 134 static int __init alsa_card_virmidi_init(void)
 135 {
 136         int dev, cards;
 137
 138         for (dev = cards = 0; dev < SNDRV_CARDS && enable[dev]; dev++) {
 139                 if (snd_card_virmidi_probe(dev) < 0) {
 140 #ifdef MODULE
 141                         printk(KERN_ERR "Card-VirMIDI #%i not found or device busy\n", dev + 1);
 142 #endif
 143                         break;
 144                 }
 145                 cards++;
 146         }
 147         if (!cards) {
 148 #ifdef MODULE
 149                 printk(KERN_ERR "Card-VirMIDI soundcard not found or device busy\n");
 150 #endif
 151                 return -ENODEV;
 152         }
 153         return 0;
 154 }
 155
 156 static void __exit alsa_card_virmidi_exit(void)
 157 {
 158         int dev;
 159
 160         for (dev = 0; dev < SNDRV_CARDS; dev++)
 161                 snd_card_free(snd_virmidi_cards[dev]);
 162 }
 163
 164 module_init(alsa_card_virmidi_init)
 165 module_exit(alsa_card_virmidi_exit)