seq_midi.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478
  1. /*
  2. * Generic MIDI synth driver for ALSA sequencer
  3. * Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
  4. * Jaroslav Kysela <perex@suse.cz>
  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. Possible options for midisynth module:
  23. - automatic opening of midi ports on first received event or subscription
  24. (close will be performed when client leaves)
  25. */
  26. #include <sound/driver.h>
  27. #include <linux/init.h>
  28. #include <linux/slab.h>
  29. #include <linux/errno.h>
  30. #include <linux/string.h>
  31. #include <linux/moduleparam.h>
  32. #include <linux/mutex.h>
  33. #include <sound/core.h>
  34. #include <sound/rawmidi.h>
  35. #include <sound/seq_kernel.h>
  36. #include <sound/seq_device.h>
  37. #include <sound/seq_midi_event.h>
  38. #include <sound/initval.h>
  39. MODULE_AUTHOR("Frank van de Pol <fvdpol@coil.demon.nl>, Jaroslav Kysela <perex@suse.cz>");
  40. MODULE_DESCRIPTION("Advanced Linux Sound Architecture sequencer MIDI synth.");
  41. MODULE_LICENSE("GPL");
  42. static int output_buffer_size = PAGE_SIZE;
  43. module_param(output_buffer_size, int, 0644);
  44. MODULE_PARM_DESC(output_buffer_size, "Output buffer size in bytes.");
  45. static int input_buffer_size = PAGE_SIZE;
  46. module_param(input_buffer_size, int, 0644);
  47. MODULE_PARM_DESC(input_buffer_size, "Input buffer size in bytes.");
  48. /* data for this midi synth driver */
  49. struct seq_midisynth {
  50. struct snd_card *card;
  51. int device;
  52. int subdevice;
  53. struct snd_rawmidi_file input_rfile;
  54. struct snd_rawmidi_file output_rfile;
  55. int seq_client;
  56. int seq_port;
  57. struct snd_midi_event *parser;
  58. };
  59. struct seq_midisynth_client {
  60. int seq_client;
  61. int num_ports;
  62. int ports_per_device[SNDRV_RAWMIDI_DEVICES];
  63. struct seq_midisynth *ports[SNDRV_RAWMIDI_DEVICES];
  64. };
  65. static struct seq_midisynth_client *synths[SNDRV_CARDS];
  66. static DEFINE_MUTEX(register_mutex);
  67. /* handle rawmidi input event (MIDI v1.0 stream) */
  68. static void snd_midi_input_event(struct snd_rawmidi_substream *substream)
  69. {
  70. struct snd_rawmidi_runtime *runtime;
  71. struct seq_midisynth *msynth;
  72. struct snd_seq_event ev;
  73. char buf[16], *pbuf;
  74. long res, count;
  75. if (substream == NULL)
  76. return;
  77. runtime = substream->runtime;
  78. msynth = runtime->private_data;
  79. if (msynth == NULL)
  80. return;
  81. memset(&ev, 0, sizeof(ev));
  82. while (runtime->avail > 0) {
  83. res = snd_rawmidi_kernel_read(substream, buf, sizeof(buf));
  84. if (res <= 0)
  85. continue;
  86. if (msynth->parser == NULL)
  87. continue;
  88. pbuf = buf;
  89. while (res > 0) {
  90. count = snd_midi_event_encode(msynth->parser, pbuf, res, &ev);
  91. if (count < 0)
  92. break;
  93. pbuf += count;
  94. res -= count;
  95. if (ev.type != SNDRV_SEQ_EVENT_NONE) {
  96. ev.source.port = msynth->seq_port;
  97. ev.dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
  98. snd_seq_kernel_client_dispatch(msynth->seq_client, &ev, 1, 0);
  99. /* clear event and reset header */
  100. memset(&ev, 0, sizeof(ev));
  101. }
  102. }
  103. }
  104. }
  105. static int dump_midi(struct snd_rawmidi_substream *substream, const char *buf, int count)
  106. {
  107. struct snd_rawmidi_runtime *runtime;
  108. int tmp;
  109. snd_assert(substream != NULL || buf != NULL, return -EINVAL);
  110. runtime = substream->runtime;
  111. if ((tmp = runtime->avail) < count) {
  112. snd_printd("warning, output event was lost (count = %i, available = %i)\n", count, tmp);
  113. return -ENOMEM;
  114. }
  115. if (snd_rawmidi_kernel_write(substream, buf, count) < count)
  116. return -EINVAL;
  117. return 0;
  118. }
  119. static int event_process_midi(struct snd_seq_event *ev, int direct,
  120. void *private_data, int atomic, int hop)
  121. {
  122. struct seq_midisynth *msynth = private_data;
  123. unsigned char msg[10]; /* buffer for constructing midi messages */
  124. struct snd_rawmidi_substream *substream;
  125. int len;
  126. snd_assert(msynth != NULL, return -EINVAL);
  127. substream = msynth->output_rfile.output;
  128. if (substream == NULL)
  129. return -ENODEV;
  130. if (ev->type == SNDRV_SEQ_EVENT_SYSEX) { /* special case, to save space */
  131. if ((ev->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE) {
  132. /* invalid event */
  133. snd_printd("seq_midi: invalid sysex event flags = 0x%x\n", ev->flags);
  134. return 0;
  135. }
  136. snd_seq_dump_var_event(ev, (snd_seq_dump_func_t)dump_midi, substream);
  137. snd_midi_event_reset_decode(msynth->parser);
  138. } else {
  139. if (msynth->parser == NULL)
  140. return -EIO;
  141. len = snd_midi_event_decode(msynth->parser, msg, sizeof(msg), ev);
  142. if (len < 0)
  143. return 0;
  144. if (dump_midi(substream, msg, len) < 0)
  145. snd_midi_event_reset_decode(msynth->parser);
  146. }
  147. return 0;
  148. }
  149. static int snd_seq_midisynth_new(struct seq_midisynth *msynth,
  150. struct snd_card *card,
  151. int device,
  152. int subdevice)
  153. {
  154. if (snd_midi_event_new(MAX_MIDI_EVENT_BUF, &msynth->parser) < 0)
  155. return -ENOMEM;
  156. msynth->card = card;
  157. msynth->device = device;
  158. msynth->subdevice = subdevice;
  159. return 0;
  160. }
  161. /* open associated midi device for input */
  162. static int midisynth_subscribe(void *private_data, struct snd_seq_port_subscribe *info)
  163. {
  164. int err;
  165. struct seq_midisynth *msynth = private_data;
  166. struct snd_rawmidi_runtime *runtime;
  167. struct snd_rawmidi_params params;
  168. /* open midi port */
  169. if ((err = snd_rawmidi_kernel_open(msynth->card, msynth->device,
  170. msynth->subdevice,
  171. SNDRV_RAWMIDI_LFLG_INPUT,
  172. &msynth->input_rfile)) < 0) {
  173. snd_printd("midi input open failed!!!\n");
  174. return err;
  175. }
  176. runtime = msynth->input_rfile.input->runtime;
  177. memset(&params, 0, sizeof(params));
  178. params.avail_min = 1;
  179. params.buffer_size = input_buffer_size;
  180. if ((err = snd_rawmidi_input_params(msynth->input_rfile.input, &params)) < 0) {
  181. snd_rawmidi_kernel_release(&msynth->input_rfile);
  182. return err;
  183. }
  184. snd_midi_event_reset_encode(msynth->parser);
  185. runtime->event = snd_midi_input_event;
  186. runtime->private_data = msynth;
  187. snd_rawmidi_kernel_read(msynth->input_rfile.input, NULL, 0);
  188. return 0;
  189. }
  190. /* close associated midi device for input */
  191. static int midisynth_unsubscribe(void *private_data, struct snd_seq_port_subscribe *info)
  192. {
  193. int err;
  194. struct seq_midisynth *msynth = private_data;
  195. snd_assert(msynth->input_rfile.input != NULL, return -EINVAL);
  196. err = snd_rawmidi_kernel_release(&msynth->input_rfile);
  197. return err;
  198. }
  199. /* open associated midi device for output */
  200. static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *info)
  201. {
  202. int err;
  203. struct seq_midisynth *msynth = private_data;
  204. struct snd_rawmidi_params params;
  205. /* open midi port */
  206. if ((err = snd_rawmidi_kernel_open(msynth->card, msynth->device,
  207. msynth->subdevice,
  208. SNDRV_RAWMIDI_LFLG_OUTPUT,
  209. &msynth->output_rfile)) < 0) {
  210. snd_printd("midi output open failed!!!\n");
  211. return err;
  212. }
  213. memset(&params, 0, sizeof(params));
  214. params.avail_min = 1;
  215. params.buffer_size = output_buffer_size;
  216. if ((err = snd_rawmidi_output_params(msynth->output_rfile.output, &params)) < 0) {
  217. snd_rawmidi_kernel_release(&msynth->output_rfile);
  218. return err;
  219. }
  220. snd_midi_event_reset_decode(msynth->parser);
  221. return 0;
  222. }
  223. /* close associated midi device for output */
  224. static int midisynth_unuse(void *private_data, struct snd_seq_port_subscribe *info)
  225. {
  226. struct seq_midisynth *msynth = private_data;
  227. unsigned char buf = 0xff; /* MIDI reset */
  228. snd_assert(msynth->output_rfile.output != NULL, return -EINVAL);
  229. /* sending single MIDI reset message to shut the device up */
  230. snd_rawmidi_kernel_write(msynth->output_rfile.output, &buf, 1);
  231. snd_rawmidi_drain_output(msynth->output_rfile.output);
  232. return snd_rawmidi_kernel_release(&msynth->output_rfile);
  233. }
  234. /* delete given midi synth port */
  235. static void snd_seq_midisynth_delete(struct seq_midisynth *msynth)
  236. {
  237. if (msynth == NULL)
  238. return;
  239. if (msynth->seq_client > 0) {
  240. /* delete port */
  241. snd_seq_event_port_detach(msynth->seq_client, msynth->seq_port);
  242. }
  243. if (msynth->parser)
  244. snd_midi_event_free(msynth->parser);
  245. }
  246. /* register new midi synth port */
  247. static int
  248. snd_seq_midisynth_register_port(struct snd_seq_device *dev)
  249. {
  250. struct seq_midisynth_client *client;
  251. struct seq_midisynth *msynth, *ms;
  252. struct snd_seq_port_info *port;
  253. struct snd_rawmidi_info *info;
  254. struct snd_rawmidi *rmidi = dev->private_data;
  255. int newclient = 0;
  256. unsigned int p, ports;
  257. struct snd_seq_port_callback pcallbacks;
  258. struct snd_card *card = dev->card;
  259. int device = dev->device;
  260. unsigned int input_count = 0, output_count = 0;
  261. snd_assert(card != NULL && device >= 0 && device < SNDRV_RAWMIDI_DEVICES, return -EINVAL);
  262. info = kmalloc(sizeof(*info), GFP_KERNEL);
  263. if (! info)
  264. return -ENOMEM;
  265. info->device = device;
  266. info->stream = SNDRV_RAWMIDI_STREAM_OUTPUT;
  267. info->subdevice = 0;
  268. if (snd_rawmidi_info_select(card, info) >= 0)
  269. output_count = info->subdevices_count;
  270. info->stream = SNDRV_RAWMIDI_STREAM_INPUT;
  271. if (snd_rawmidi_info_select(card, info) >= 0) {
  272. input_count = info->subdevices_count;
  273. }
  274. ports = output_count;
  275. if (ports < input_count)
  276. ports = input_count;
  277. if (ports == 0) {
  278. kfree(info);
  279. return -ENODEV;
  280. }
  281. if (ports > (256 / SNDRV_RAWMIDI_DEVICES))
  282. ports = 256 / SNDRV_RAWMIDI_DEVICES;
  283. mutex_lock(&register_mutex);
  284. client = synths[card->number];
  285. if (client == NULL) {
  286. newclient = 1;
  287. client = kzalloc(sizeof(*client), GFP_KERNEL);
  288. if (client == NULL) {
  289. mutex_unlock(&register_mutex);
  290. kfree(info);
  291. return -ENOMEM;
  292. }
  293. client->seq_client =
  294. snd_seq_create_kernel_client(
  295. card, 0, "%s", card->shortname[0] ?
  296. (const char *)card->shortname : "External MIDI");
  297. if (client->seq_client < 0) {
  298. kfree(client);
  299. mutex_unlock(&register_mutex);
  300. kfree(info);
  301. return -ENOMEM;
  302. }
  303. }
  304. msynth = kcalloc(ports, sizeof(struct seq_midisynth), GFP_KERNEL);
  305. port = kmalloc(sizeof(*port), GFP_KERNEL);
  306. if (msynth == NULL || port == NULL)
  307. goto __nomem;
  308. for (p = 0; p < ports; p++) {
  309. ms = &msynth[p];
  310. if (snd_seq_midisynth_new(ms, card, device, p) < 0)
  311. goto __nomem;
  312. /* declare port */
  313. memset(port, 0, sizeof(*port));
  314. port->addr.client = client->seq_client;
  315. port->addr.port = device * (256 / SNDRV_RAWMIDI_DEVICES) + p;
  316. port->flags = SNDRV_SEQ_PORT_FLG_GIVEN_PORT;
  317. memset(info, 0, sizeof(*info));
  318. info->device = device;
  319. if (p < output_count)
  320. info->stream = SNDRV_RAWMIDI_STREAM_OUTPUT;
  321. else
  322. info->stream = SNDRV_RAWMIDI_STREAM_INPUT;
  323. info->subdevice = p;
  324. if (snd_rawmidi_info_select(card, info) >= 0)
  325. strcpy(port->name, info->subname);
  326. if (! port->name[0]) {
  327. if (info->name[0]) {
  328. if (ports > 1)
  329. snprintf(port->name, sizeof(port->name), "%s-%d", info->name, p);
  330. else
  331. snprintf(port->name, sizeof(port->name), "%s", info->name);
  332. } else {
  333. /* last resort */
  334. if (ports > 1)
  335. sprintf(port->name, "MIDI %d-%d-%d", card->number, device, p);
  336. else
  337. sprintf(port->name, "MIDI %d-%d", card->number, device);
  338. }
  339. }
  340. if ((info->flags & SNDRV_RAWMIDI_INFO_OUTPUT) && p < output_count)
  341. port->capability |= SNDRV_SEQ_PORT_CAP_WRITE | SNDRV_SEQ_PORT_CAP_SYNC_WRITE | SNDRV_SEQ_PORT_CAP_SUBS_WRITE;
  342. if ((info->flags & SNDRV_RAWMIDI_INFO_INPUT) && p < input_count)
  343. port->capability |= SNDRV_SEQ_PORT_CAP_READ | SNDRV_SEQ_PORT_CAP_SYNC_READ | SNDRV_SEQ_PORT_CAP_SUBS_READ;
  344. if ((port->capability & (SNDRV_SEQ_PORT_CAP_WRITE|SNDRV_SEQ_PORT_CAP_READ)) == (SNDRV_SEQ_PORT_CAP_WRITE|SNDRV_SEQ_PORT_CAP_READ) &&
  345. info->flags & SNDRV_RAWMIDI_INFO_DUPLEX)
  346. port->capability |= SNDRV_SEQ_PORT_CAP_DUPLEX;
  347. port->type = SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
  348. | SNDRV_SEQ_PORT_TYPE_HARDWARE
  349. | SNDRV_SEQ_PORT_TYPE_PORT;
  350. port->midi_channels = 16;
  351. memset(&pcallbacks, 0, sizeof(pcallbacks));
  352. pcallbacks.owner = THIS_MODULE;
  353. pcallbacks.private_data = ms;
  354. pcallbacks.subscribe = midisynth_subscribe;
  355. pcallbacks.unsubscribe = midisynth_unsubscribe;
  356. pcallbacks.use = midisynth_use;
  357. pcallbacks.unuse = midisynth_unuse;
  358. pcallbacks.event_input = event_process_midi;
  359. port->kernel = &pcallbacks;
  360. if (rmidi->ops && rmidi->ops->get_port_info)
  361. rmidi->ops->get_port_info(rmidi, p, port);
  362. if (snd_seq_kernel_client_ctl(client->seq_client, SNDRV_SEQ_IOCTL_CREATE_PORT, port)<0)
  363. goto __nomem;
  364. ms->seq_client = client->seq_client;
  365. ms->seq_port = port->addr.port;
  366. }
  367. client->ports_per_device[device] = ports;
  368. client->ports[device] = msynth;
  369. client->num_ports++;
  370. if (newclient)
  371. synths[card->number] = client;
  372. mutex_unlock(&register_mutex);
  373. kfree(info);
  374. kfree(port);
  375. return 0; /* success */
  376. __nomem:
  377. if (msynth != NULL) {
  378. for (p = 0; p < ports; p++)
  379. snd_seq_midisynth_delete(&msynth[p]);
  380. kfree(msynth);
  381. }
  382. if (newclient) {
  383. snd_seq_delete_kernel_client(client->seq_client);
  384. kfree(client);
  385. }
  386. kfree(info);
  387. kfree(port);
  388. mutex_unlock(&register_mutex);
  389. return -ENOMEM;
  390. }
  391. /* release midi synth port */
  392. static int
  393. snd_seq_midisynth_unregister_port(struct snd_seq_device *dev)
  394. {
  395. struct seq_midisynth_client *client;
  396. struct seq_midisynth *msynth;
  397. struct snd_card *card = dev->card;
  398. int device = dev->device, p, ports;
  399. mutex_lock(&register_mutex);
  400. client = synths[card->number];
  401. if (client == NULL || client->ports[device] == NULL) {
  402. mutex_unlock(&register_mutex);
  403. return -ENODEV;
  404. }
  405. ports = client->ports_per_device[device];
  406. client->ports_per_device[device] = 0;
  407. msynth = client->ports[device];
  408. client->ports[device] = NULL;
  409. for (p = 0; p < ports; p++)
  410. snd_seq_midisynth_delete(&msynth[p]);
  411. kfree(msynth);
  412. client->num_ports--;
  413. if (client->num_ports <= 0) {
  414. snd_seq_delete_kernel_client(client->seq_client);
  415. synths[card->number] = NULL;
  416. kfree(client);
  417. }
  418. mutex_unlock(&register_mutex);
  419. return 0;
  420. }
  421. static int __init alsa_seq_midi_init(void)
  422. {
  423. static struct snd_seq_dev_ops ops = {
  424. snd_seq_midisynth_register_port,
  425. snd_seq_midisynth_unregister_port,
  426. };
  427. memset(&synths, 0, sizeof(synths));
  428. snd_seq_autoload_lock();
  429. snd_seq_device_register_driver(SNDRV_SEQ_DEV_ID_MIDISYNTH, &ops, 0);
  430. snd_seq_autoload_unlock();
  431. return 0;
  432. }
  433. static void __exit alsa_seq_midi_exit(void)
  434. {
  435. snd_seq_device_unregister_driver(SNDRV_SEQ_DEV_ID_MIDISYNTH);
  436. }
  437. module_init(alsa_seq_midi_init)
  438. module_exit(alsa_seq_midi_exit)