Home | History | Annotate | Line # | Download | only in dev
midisynvar.h revision 1.9.14.13 
      1 /*	$NetBSD: midisynvar.h,v 1.9.14.13 2006/06/07 05:31:43 chap Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Lennart Augustsson (augustss (at) NetBSD.org).
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef _SYS_DEV_MIDISYNVAR_H_
     40 #define _SYS_DEV_MIDISYNVAR_H_
     41 
     42 #include "midictl.h"
     43 
     44 typedef struct midisyn midisyn;
     45 
     46 /*
     47  * Important: any synth driver that uses midisyn must set up its methods
     48  * structure in a way that refers to members /by name/ and zeroes the rest
     49  * (as is the effect of C99 initializers with designators). This discipline
     50  * will allow the structure to evolve methods for newly implemented
     51  * functionality or to exploit capabilities of new drivers with a minimal
     52  * versioning burden.  Because midisyn is at present a very rudimentary and
     53  * partial implementation, change should be expected in this set of methods.
     54  * Do not hesitate to add one in the course of implementing new stuff, as
     55  * long as it will be generally useful and there is some reasonable fallback
     56  * for drivers without it.
     57  */
     58 struct midisyn_methods {
     59 	int  (*open)	(midisyn *, int);
     60 	void (*close)   (midisyn *);
     61 	int  (*ioctl)   (midisyn *, u_long, caddr_t, int, struct lwp *);
     62 	int  (*allocv)  (midisyn *, u_int32_t, u_int32_t);
     63 	void (*noteon)  (midisyn *, u_int32_t, u_int32_t, u_int32_t);
     64 	void (*noteoff) (midisyn *, u_int32_t, u_int32_t, u_int32_t);
     65 	void (*pgmchg)  (midisyn *, u_int32_t, u_int32_t);
     66 };
     67 
     68 struct voice {
     69 	u_int chan_note;	/* channel and note */
     70 #define MS_CHANNOTE(chan, note) ((chan) * 256 + (note))
     71 #define MS_GETCHAN(v) ((v)->chan_note >> 8)
     72 	u_int seqno;		/* allocation index (increases with time) */
     73 	u_char inuse;
     74 };
     75 
     76 #define MIDI_MAX_CHANS 16
     77 
     78 struct midisyn {
     79 	/* Filled by synth driver */
     80 	struct midisyn_methods *mets;
     81 	char name[32];
     82 	int nvoice;
     83 	int flags;
     84 #define MS_DOALLOC	1
     85 #define MS_FREQXLATE	2
     86 	void *data;
     87 
     88 	/* Set up by midisyn but available to synth driver for reading ctls */
     89 	/*
     90 	 * Note - there is currently no locking on this structure; if the synth
     91 	 * driver interacts with midictl it should do so synchronously, when
     92 	 * processing a call from midisyn, and not at other times such as upon
     93 	 * an interrupt. (may revisit locking if problems crop up.)
     94 	 */
     95 	midictl ctl;
     96 
     97 	/* Used by midisyn driver */
     98 	struct voice *voices;
     99 	u_int seqno;
    100 	u_int16_t pgms[MIDI_MAX_CHANS]; /* ref'd if driver uses MS_GETPGM */
    101 };
    102 
    103 #define MS_GETPGM(ms, vno) ((ms)->pgms[MS_GETCHAN(&(ms)->voices[vno])])
    104 
    105 struct midi_softc;
    106 
    107 extern const struct midi_hw_if midisyn_hw_if;
    108 
    109 void	midisyn_attach (struct midi_softc *, midisyn *);
    110 
    111 #define MIDISYN_FREQ_TO_HZ(f) ((f) >> 16)
    112 
    113 #endif /* _SYS_DEV_MIDISYNVAR_H_ */
    114