xref: /linux/include/sound/seq_virmidi.h (revision 827634added7f38b7d724cab1dccdb2b004c13c3)
1 #ifndef __SOUND_SEQ_VIRMIDI_H
2 #define __SOUND_SEQ_VIRMIDI_H
3 
4 /*
5  *  Virtual Raw MIDI client on Sequencer
6  *  Copyright (c) 2000 by Takashi Iwai <tiwai@suse.de>,
7  *                        Jaroslav Kysela <perex@perex.cz>
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  *
23  */
24 
25 #include <sound/rawmidi.h>
26 #include <sound/seq_midi_event.h>
27 
28 /*
29  * device file instance:
30  * This instance is created at each time the midi device file is
31  * opened.  Each instance has its own input buffer and MIDI parser
32  * (buffer), and is associated with the device instance.
33  */
34 struct snd_virmidi {
35 	struct list_head list;
36 	int seq_mode;
37 	int client;
38 	int port;
39 	unsigned int trigger: 1;
40 	struct snd_midi_event *parser;
41 	struct snd_seq_event event;
42 	struct snd_virmidi_dev *rdev;
43 	struct snd_rawmidi_substream *substream;
44 };
45 
46 #define SNDRV_VIRMIDI_SUBSCRIBE		(1<<0)
47 #define SNDRV_VIRMIDI_USE		(1<<1)
48 
49 /*
50  * device record:
51  * Each virtual midi device has one device instance.  It contains
52  * common information and the linked-list of opened files,
53  */
54 struct snd_virmidi_dev {
55 	struct snd_card *card;		/* associated card */
56 	struct snd_rawmidi *rmidi;		/* rawmidi device */
57 	int seq_mode;			/* SNDRV_VIRMIDI_XXX */
58 	int device;			/* sequencer device */
59 	int client;			/* created/attached client */
60 	int port;			/* created/attached port */
61 	unsigned int flags;		/* SNDRV_VIRMIDI_* */
62 	rwlock_t filelist_lock;
63 	struct list_head filelist;
64 };
65 
66 /* sequencer mode:
67  * ATTACH = input/output events from midi device are routed to the
68  *          attached sequencer port.  sequencer port is not created
69  *          by virmidi itself.
70  *          the input to rawmidi must be processed by passing the
71  *          incoming events via snd_virmidi_receive()
72  * DISPATCH = input/output events are routed to subscribers.
73  *            sequencer port is created in virmidi.
74  */
75 #define SNDRV_VIRMIDI_SEQ_NONE		0
76 #define SNDRV_VIRMIDI_SEQ_ATTACH	1
77 #define SNDRV_VIRMIDI_SEQ_DISPATCH	2
78 
79 int snd_virmidi_new(struct snd_card *card, int device, struct snd_rawmidi **rrmidi);
80 
81 #endif /* __SOUND_SEQ_VIRMIDI */
82