Annotation of src/usr.bin/sndiod/midi.c, Revision 1.18
1.18 ! ratchov 1: /* $OpenBSD: midi.c,v 1.17 2019/03/28 11:18:56 ratchov Exp $ */
1.1 ratchov 2: /*
3: * Copyright (c) 2008-2012 Alexandre Ratchov <alex@caoua.org>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #include <stdio.h>
18: #include <stdlib.h>
19: #include <string.h>
20:
21: #include "abuf.h"
22: #include "defs.h"
23: #include "dev.h"
24: #include "file.h"
25: #include "midi.h"
26: #include "miofile.h"
27: #include "sysex.h"
28: #include "utils.h"
29:
30: int port_open(struct port *);
31: void port_imsg(void *, unsigned char *, int);
32: void port_omsg(void *, unsigned char *, int);
33: void port_fill(void *, int);
34: void port_exit(void *);
35:
36: struct midiops port_midiops = {
37: port_imsg,
38: port_omsg,
39: port_fill,
40: port_exit
41: };
42:
43: #define MIDI_NEP 32
44: struct midi midi_ep[MIDI_NEP];
45: struct port *port_list = NULL;
46: unsigned int midi_portnum = 0;
47:
48: struct midithru {
1.2 ratchov 49: unsigned int txmask, rxmask;
1.1 ratchov 50: #define MIDITHRU_NMAX 32
51: } midithru[MIDITHRU_NMAX];
52:
53: /*
54: * length of voice and common messages (status byte included)
55: */
56: unsigned int voice_len[] = { 3, 3, 3, 3, 2, 2, 3 };
57: unsigned int common_len[] = { 0, 2, 3, 2, 0, 0, 1, 1 };
58:
59: void
60: midi_log(struct midi *ep)
61: {
62: log_puts("midi");
63: log_putu(ep - midi_ep);
64: }
65:
66: void
67: midi_init(void)
68: {
69: }
70:
71: void
72: midi_done(void)
73: {
74: }
75:
76: struct midi *
77: midi_new(struct midiops *ops, void *arg, int mode)
78: {
79: int i;
80: struct midi *ep;
81:
82: for (i = 0, ep = midi_ep;; i++, ep++) {
83: if (i == MIDI_NEP)
84: return NULL;
85: if (ep->ops == NULL)
86: break;
87: }
88: ep->ops = ops;
89: ep->arg = arg;
90: ep->used = 0;
91: ep->len = 0;
92: ep->idx = 0;
93: ep->st = 0;
94: ep->txmask = 0;
1.2 ratchov 95: ep->self = 1 << i;
96: ep->tickets = 0;
1.1 ratchov 97: ep->mode = mode;
1.2 ratchov 98:
1.1 ratchov 99: /*
1.16 ratchov 100: * the output buffer is the client input
1.1 ratchov 101: */
1.2 ratchov 102: if (ep->mode & MODE_MIDIIN)
1.1 ratchov 103: abuf_init(&ep->obuf, MIDI_BUFSZ);
1.2 ratchov 104: midi_tickets(ep);
1.1 ratchov 105: return ep;
106: }
107:
108: void
109: midi_del(struct midi *ep)
110: {
111: int i;
1.2 ratchov 112: struct midi *peer;
1.1 ratchov 113:
1.2 ratchov 114: ep->txmask = 0;
115: for (i = 0; i < MIDI_NEP; i++) {
116: peer = midi_ep + i;
117: if (peer->txmask & ep->self) {
118: peer->txmask &= ~ep->self;
119: midi_tickets(peer);
120: }
121: }
122: for (i = 0; i < MIDITHRU_NMAX; i++) {
123: midithru[i].txmask &= ~ep->self;
124: midithru[i].rxmask &= ~ep->self;
125: }
1.1 ratchov 126: ep->ops = NULL;
127: if (ep->mode & MODE_MIDIIN) {
128: abuf_done(&ep->obuf);
129: }
130: }
131:
132: /*
1.2 ratchov 133: * connect two midi endpoints
1.1 ratchov 134: */
135: void
1.2 ratchov 136: midi_link(struct midi *ep, struct midi *peer)
1.1 ratchov 137: {
1.2 ratchov 138: if (ep->mode & MODE_MIDIOUT) {
139: ep->txmask |= peer->self;
140: midi_tickets(ep);
141: }
142: if (ep->mode & MODE_MIDIIN) {
143: #ifdef DEBUG
144: if (ep->obuf.used > 0) {
145: midi_log(ep);
146: log_puts(": linked with non-empty buffer\n");
147: panic();
148: }
149: #endif
1.16 ratchov 150: /* ep has empty buffer, so no need to call midi_tickets() */
1.2 ratchov 151: peer->txmask |= ep->self;
1.1 ratchov 152: }
153: }
154:
155: /*
1.2 ratchov 156: * add the midi endpoint in the ``tag'' midi thru box
1.1 ratchov 157: */
158: void
1.2 ratchov 159: midi_tag(struct midi *ep, unsigned int tag)
1.1 ratchov 160: {
1.2 ratchov 161: struct midi *peer;
162: struct midithru *t = midithru + tag;
1.1 ratchov 163: int i;
164:
1.2 ratchov 165: if (ep->mode & MODE_MIDIOUT) {
166: ep->txmask |= t->txmask;
167: midi_tickets(ep);
168: }
169: if (ep->mode & MODE_MIDIIN) {
170: #ifdef DEBUG
171: if (ep->obuf.used > 0) {
172: midi_log(ep);
173: log_puts(": tagged with non-empty buffer\n");
174: panic();
175: }
176: #endif
177: for (i = 0; i < MIDI_NEP; i++) {
178: if (!(t->rxmask & (1 << i)))
179: continue;
180: peer = midi_ep + i;
181: peer->txmask |= ep->self;
182: }
1.1 ratchov 183: }
1.2 ratchov 184: if (ep->mode & MODE_MIDIOUT)
185: t->rxmask |= ep->self;
186: if (ep->mode & MODE_MIDIIN)
187: t->txmask |= ep->self;
1.1 ratchov 188: }
189:
190: /*
1.6 ratchov 191: * broadcast the given message to other endpoints
1.1 ratchov 192: */
193: void
194: midi_send(struct midi *iep, unsigned char *msg, int size)
195: {
196: struct midi *oep;
197: int i;
198:
199: #ifdef DEBUG
200: if (log_level >= 4) {
201: midi_log(iep);
202: log_puts(": sending:");
203: for (i = 0; i < size; i++) {
204: log_puts(" ");
205: log_putx(msg[i]);
206: }
207: log_puts("\n");
208: }
209: #endif
210: for (i = 0; i < MIDI_NEP ; i++) {
211: if ((iep->txmask & (1 << i)) == 0)
212: continue;
213: oep = midi_ep + i;
214: if (msg[0] <= 0x7f) {
215: if (oep->owner != iep)
216: continue;
217: } else if (msg[0] <= 0xf7)
218: oep->owner = iep;
219: #ifdef DEBUG
220: if (log_level >= 4) {
221: midi_log(iep);
222: log_puts(" -> ");
223: midi_log(oep);
224: log_puts("\n");
225: }
226: #endif
227: oep->ops->omsg(oep->arg, msg, size);
228: }
229: }
230:
1.2 ratchov 231: /*
232: * determine if we have gained more input tickets, and if so call the
233: * fill() call-back to notify the i/o layer that it can send more data
234: */
235: void
236: midi_tickets(struct midi *iep)
237: {
238: int i, tickets, avail, maxavail;
239: struct midi *oep;
1.17 ratchov 240:
241: /*
242: * don't request iep->ops->fill() too often as it generates
243: * useless network traffic: wait until we reach half of the
244: * max tickets count. As in the worst case (see comment below)
245: * one ticket may consume two bytes, the max ticket count is
246: * BUFSZ / 2 and halt of it is simply BUFSZ / 4.
247: */
248: if (iep->tickets >= MIDI_BUFSZ / 4)
249: return;
1.2 ratchov 250:
251: maxavail = MIDI_BUFSZ;
252: for (i = 0; i < MIDI_NEP ; i++) {
253: if ((iep->txmask & (1 << i)) == 0)
254: continue;
255: oep = midi_ep + i;
256: avail = oep->obuf.len - oep->obuf.used;
257: if (maxavail > avail)
258: maxavail = avail;
259: }
260:
261: /*
1.15 ratchov 262: * in the worst case output message is twice the
1.2 ratchov 263: * input message (2-byte messages with running status)
264: */
265: tickets = maxavail / 2 - iep->tickets;
266: if (tickets > 0) {
267: iep->tickets += tickets;
268: iep->ops->fill(iep->arg, tickets);
269: }
270: }
271:
272: /*
273: * recalculate tickets of endpoints sending data to this one
274: */
1.1 ratchov 275: void
276: midi_fill(struct midi *oep)
277: {
1.2 ratchov 278: int i;
1.1 ratchov 279: struct midi *iep;
280:
1.2 ratchov 281: for (i = 0; i < MIDI_NEP; i++) {
1.1 ratchov 282: iep = midi_ep + i;
1.2 ratchov 283: if (iep->txmask & oep->self)
284: midi_tickets(iep);
1.1 ratchov 285: }
286: }
287:
288: /*
1.2 ratchov 289: * parse then give data chunk, and calling imsg() for each message
1.1 ratchov 290: */
291: void
1.2 ratchov 292: midi_in(struct midi *iep, unsigned char *idata, int icount)
1.1 ratchov 293: {
294: int i;
295: unsigned char c;
296:
297: for (i = 0; i < icount; i++) {
298: c = *idata++;
299: if (c >= 0xf8) {
300: if (c != MIDI_ACK)
301: iep->ops->imsg(iep->arg, &c, 1);
302: } else if (c == SYSEX_END) {
303: if (iep->st == SYSEX_START) {
304: iep->msg[iep->idx++] = c;
305: iep->ops->imsg(iep->arg, iep->msg, iep->idx);
306: }
307: iep->st = 0;
308: iep->idx = 0;
309: } else if (c >= 0xf0) {
310: iep->msg[0] = c;
1.18 ! ratchov 311: iep->len = common_len[c >> 5];
! 312: log_puti(iep->len);
1.1 ratchov 313: iep->st = c;
314: iep->idx = 1;
315: } else if (c >= 0x80) {
316: iep->msg[0] = c;
317: iep->len = voice_len[(c >> 4) & 7];
318: iep->st = c;
319: iep->idx = 1;
320: } else if (iep->st) {
321: if (iep->idx == 0 && iep->st != SYSEX_START)
322: iep->msg[iep->idx++] = iep->st;
323: iep->msg[iep->idx++] = c;
324: if (iep->idx == iep->len) {
325: iep->ops->imsg(iep->arg, iep->msg, iep->idx);
326: if (iep->st >= 0xf0)
327: iep->st = 0;
328: iep->idx = 0;
329: } else if (iep->idx == MIDI_MSGMAX) {
330: /* sysex continued */
331: iep->ops->imsg(iep->arg, iep->msg, iep->idx);
332: iep->idx = 0;
333: }
334: }
335: }
1.2 ratchov 336: iep->tickets -= icount;
337: if (iep->tickets < 0)
338: iep->tickets = 0;
1.7 ratchov 339: midi_tickets(iep);
1.1 ratchov 340: }
341:
342: /*
343: * store the given message in the output buffer
344: */
345: void
1.15 ratchov 346: midi_out(struct midi *oep, unsigned char *idata, int icount)
1.1 ratchov 347: {
348: unsigned char *odata;
349: int ocount;
350: #ifdef DEBUG
351: int i;
352: #endif
1.15 ratchov 353:
1.1 ratchov 354: while (icount > 0) {
355: if (oep->obuf.used == oep->obuf.len) {
356: #ifdef DEBUG
357: if (log_level >= 2) {
358: midi_log(oep);
1.2 ratchov 359: log_puts(": too slow, discarding ");
1.1 ratchov 360: log_putu(oep->obuf.used);
361: log_puts(" bytes\n");
362: }
363: #endif
364: abuf_rdiscard(&oep->obuf, oep->obuf.used);
365: oep->owner = NULL;
366: return;
367: }
368: odata = abuf_wgetblk(&oep->obuf, &ocount);
369: if (ocount > icount)
370: ocount = icount;
371: memcpy(odata, idata, ocount);
372: #ifdef DEBUG
373: if (log_level >= 4) {
374: midi_log(oep);
375: log_puts(": out: ");
376: for (i = 0; i < ocount; i++) {
377: log_puts(" ");
378: log_putx(odata[i]);
379: }
380: log_puts("\n");
381: }
382: #endif
383: abuf_wcommit(&oep->obuf, ocount);
384: icount -= ocount;
385: idata += ocount;
386: }
387: }
388:
389: void
390: port_log(struct port *p)
391: {
392: midi_log(p->midi);
393: }
394:
395: void
396: port_imsg(void *arg, unsigned char *msg, int size)
397: {
398: struct port *p = arg;
399:
400: midi_send(p->midi, msg, size);
401: }
402:
403:
404: void
405: port_omsg(void *arg, unsigned char *msg, int size)
406: {
407: struct port *p = arg;
408:
409: midi_out(p->midi, msg, size);
410: }
411:
412: void
413: port_fill(void *arg, int count)
414: {
415: /* no flow control */
416: }
417:
418: void
419: port_exit(void *arg)
420: {
421: #ifdef DEBUG
422: struct port *p = arg;
423:
424: if (log_level >= 3) {
425: port_log(p);
1.3 ratchov 426: log_puts(": port exit\n");
427: panic();
1.1 ratchov 428: }
429: #endif
430: }
431:
432: /*
433: * create a new midi port
434: */
435: struct port *
1.4 ratchov 436: port_new(char *path, unsigned int mode, int hold)
1.1 ratchov 437: {
1.12 ratchov 438: struct port *c;
1.1 ratchov 439:
440: c = xmalloc(sizeof(struct port));
1.14 ratchov 441: c->path = xstrdup(path);
1.1 ratchov 442: c->state = PORT_CFG;
1.4 ratchov 443: c->hold = hold;
1.1 ratchov 444: c->midi = midi_new(&port_midiops, c, mode);
1.11 ratchov 445: c->num = midi_portnum++;
1.12 ratchov 446: c->next = port_list;
447: port_list = c;
1.1 ratchov 448: return c;
449: }
450:
451: /*
452: * destroy the given midi port
453: */
454: void
455: port_del(struct port *c)
456: {
457: struct port **p;
458:
459: if (c->state != PORT_CFG)
460: port_close(c);
461: midi_del(c->midi);
462: for (p = &port_list; *p != c; p = &(*p)->next) {
463: #ifdef DEBUG
464: if (*p == NULL) {
465: log_puts("port to delete not on list\n");
466: panic();
467: }
468: #endif
469: }
470: *p = c->next;
1.14 ratchov 471: xfree(c->path);
1.1 ratchov 472: xfree(c);
473: }
474:
1.3 ratchov 475: int
476: port_ref(struct port *c)
477: {
478: #ifdef DEBUG
479: if (log_level >= 3) {
480: port_log(c);
481: log_puts(": port requested\n");
482: }
483: #endif
484: if (c->state == PORT_CFG && !port_open(c))
485: return 0;
486: return 1;
487: }
488:
489: void
490: port_unref(struct port *c)
491: {
492: int i, rxmask;
493:
494: #ifdef DEBUG
495: if (log_level >= 3) {
496: port_log(c);
497: log_puts(": port released\n");
498: }
499: #endif
500: for (rxmask = 0, i = 0; i < MIDI_NEP; i++)
501: rxmask |= midi_ep[i].txmask;
1.10 ratchov 502: if ((rxmask & c->midi->self) == 0 && c->midi->txmask == 0 &&
503: c->state == PORT_INIT && !c->hold)
1.5 ratchov 504: port_drain(c);
1.3 ratchov 505: }
506:
1.1 ratchov 507: struct port *
508: port_bynum(int num)
509: {
510: struct port *p;
511:
512: for (p = port_list; p != NULL; p = p->next) {
1.12 ratchov 513: if (p->num == num)
1.1 ratchov 514: return p;
515: }
516: return NULL;
517: }
518:
519: int
520: port_open(struct port *c)
521: {
522: if (!port_mio_open(c)) {
523: if (log_level >= 1) {
524: log_puts(c->path);
525: log_puts(": failed to open midi port\n");
526: }
527: return 0;
528: }
529: c->state = PORT_INIT;
530: return 1;
531: }
532:
533: int
534: port_close(struct port *c)
535: {
1.3 ratchov 536: int i;
537: struct midi *ep;
1.1 ratchov 538: #ifdef DEBUG
539: if (c->state == PORT_CFG) {
540: port_log(c);
541: log_puts(": can't close port (not opened)\n");
1.3 ratchov 542: panic();
1.1 ratchov 543: }
544: #endif
1.15 ratchov 545: c->state = PORT_CFG;
1.1 ratchov 546: port_mio_close(c);
1.15 ratchov 547:
1.3 ratchov 548: for (i = 0; i < MIDI_NEP; i++) {
549: ep = midi_ep + i;
550: if ((ep->txmask & c->midi->self) ||
551: (c->midi->txmask & ep->self))
552: ep->ops->exit(ep->arg);
553: }
1.1 ratchov 554: return 1;
555: }
556:
1.5 ratchov 557: void
558: port_drain(struct port *c)
559: {
560: struct midi *ep = c->midi;
561:
562: if (!(ep->mode & MODE_MIDIOUT) || ep->obuf.used == 0)
563: port_close(c);
564: else {
565: c->state = PORT_DRAIN;
566: #ifdef DEBUG
567: if (log_level >= 3) {
568: port_log(c);
569: log_puts(": draining\n");
570: }
571: #endif
572: }
573: }
574:
1.1 ratchov 575: int
576: port_init(struct port *c)
577: {
1.4 ratchov 578: if (c->hold)
579: return port_open(c);
580: return 1;
1.1 ratchov 581: }
582:
583: void
584: port_done(struct port *c)
585: {
1.5 ratchov 586: if (c->state == PORT_INIT)
587: port_drain(c);
1.1 ratchov 588: }