Root/include/sound/seq_midi_emul.h

1#ifndef __SOUND_SEQ_MIDI_EMUL_H
2#define __SOUND_SEQ_MIDI_EMUL_H
3
4/*
5 * Midi channel definition for optional channel management.
6 *
7 * Copyright (C) 1999 Steve Ratcliffe
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/seq_kernel.h>
26
27/*
28 * This structure is used to keep track of the current state on each
29 * channel. All drivers for hardware that does not understand midi
30 * directly will probably need to use this structure.
31 */
32struct snd_midi_channel {
33    void *private; /* A back pointer to driver data */
34    int number; /* The channel number */
35    int client; /* The client associated with this channel */
36    int port; /* The port associated with this channel */
37
38    unsigned char midi_mode; /* GM, GS, XG etc */
39    unsigned int
40        drum_channel:1, /* Drum channel */
41        param_type:1 /* RPN/NRPN */
42        ;
43
44    unsigned char midi_aftertouch; /* Aftertouch (key pressure) */
45    unsigned char midi_pressure; /* Channel pressure */
46    unsigned char midi_program; /* Instrument number */
47    short midi_pitchbend; /* Pitch bend amount */
48
49    unsigned char control[128]; /* Current value of all controls */
50    unsigned char note[128]; /* Current status for all notes */
51
52    short gm_rpn_pitch_bend_range; /* Pitch bend range */
53    short gm_rpn_fine_tuning; /* Master fine tuning */
54    short gm_rpn_coarse_tuning; /* Master coarse tuning */
55
56};
57
58/*
59 * A structure that represets a set of channels bound to a port. There
60 * would usually be 16 channels per port. But fewer could be used for
61 * particular cases.
62 * The channel set consists of information describing the client and
63 * port for this midi synth and an array of snd_midi_channel structures.
64 * A driver that had no need for snd_midi_channel could still use the
65 * channel set type if it wished with the channel array null.
66 */
67struct snd_midi_channel_set {
68    void *private_data; /* Driver data */
69    int client; /* Client for this port */
70    int port; /* The port number */
71
72    int max_channels; /* Size of the channels array */
73    struct snd_midi_channel *channels;
74
75    unsigned char midi_mode; /* MIDI operating mode */
76    unsigned char gs_master_volume; /* SYSEX master volume: 0-127 */
77    unsigned char gs_chorus_mode;
78    unsigned char gs_reverb_mode;
79
80};
81
82struct snd_midi_op {
83    void (*note_on)(void *private_data, int note, int vel, struct snd_midi_channel *chan);
84    void (*note_off)(void *private_data,int note, int vel, struct snd_midi_channel *chan); /* release note */
85    void (*key_press)(void *private_data, int note, int vel, struct snd_midi_channel *chan);
86    void (*note_terminate)(void *private_data, int note, struct snd_midi_channel *chan); /* terminate note immediately */
87    void (*control)(void *private_data, int type, struct snd_midi_channel *chan);
88    void (*nrpn)(void *private_data, struct snd_midi_channel *chan,
89             struct snd_midi_channel_set *chset);
90    void (*sysex)(void *private_data, unsigned char *buf, int len, int parsed,
91              struct snd_midi_channel_set *chset);
92};
93
94/*
95 * These defines are used so that pitchbend, aftertouch etc, can be
96 * distinguished from controller values.
97 */
98/* 0-127 controller values */
99#define MIDI_CTL_PITCHBEND 0x80
100#define MIDI_CTL_AFTERTOUCH 0x81
101#define MIDI_CTL_CHAN_PRESSURE 0x82
102
103/*
104 * These names exist to allow symbolic access to the controls array.
105 * The usage is eg: chan->gm_bank_select. Another implementation would
106 * be really have these members in the struct, and not the array.
107 */
108#define gm_bank_select control[0]
109#define gm_modulation control[1]
110#define gm_breath control[2]
111#define gm_foot_pedal control[4]
112#define gm_portamento_time control[5]
113#define gm_data_entry control[6]
114#define gm_volume control[7]
115#define gm_balance control[8]
116#define gm_pan control[10]
117#define gm_expression control[11]
118#define gm_effect_control1 control[12]
119#define gm_effect_control2 control[13]
120#define gm_slider1 control[16]
121#define gm_slider2 control[17]
122#define gm_slider3 control[18]
123#define gm_slider4 control[19]
124
125#define gm_bank_select_lsb control[32]
126#define gm_modulation_wheel_lsb control[33]
127#define gm_breath_lsb control[34]
128#define gm_foot_pedal_lsb control[36]
129#define gm_portamento_time_lsb control[37]
130#define gm_data_entry_lsb control[38]
131#define gm_volume_lsb control[39]
132#define gm_balance_lsb control[40]
133#define gm_pan_lsb control[42]
134#define gm_expression_lsb control[43]
135#define gm_effect_control1_lsb control[44]
136#define gm_effect_control2_lsb control[45]
137
138#define gm_sustain control[MIDI_CTL_SUSTAIN]
139#define gm_hold gm_sustain
140#define gm_portamento control[MIDI_CTL_PORTAMENTO]
141#define gm_sostenuto control[MIDI_CTL_SOSTENUTO]
142
143/*
144 * These macros give the complete value of the controls that consist
145 * of coarse and fine pairs. Of course the fine controls are seldom used
146 * but there is no harm in being complete.
147 */
148#define SNDRV_GM_BANK_SELECT(cp) (((cp)->control[0]<<7)|((cp)->control[32]))
149#define SNDRV_GM_MODULATION_WHEEL(cp) (((cp)->control[1]<<7)|((cp)->control[33]))
150#define SNDRV_GM_BREATH(cp) (((cp)->control[2]<<7)|((cp)->control[34]))
151#define SNDRV_GM_FOOT_PEDAL(cp) (((cp)->control[4]<<7)|((cp)->control[36]))
152#define SNDRV_GM_PORTAMENTO_TIME(cp) (((cp)->control[5]<<7)|((cp)->control[37]))
153#define SNDRV_GM_DATA_ENTRY(cp) (((cp)->control[6]<<7)|((cp)->control[38]))
154#define SNDRV_GM_VOLUME(cp) (((cp)->control[7]<<7)|((cp)->control[39]))
155#define SNDRV_GM_BALANCE(cp) (((cp)->control[8]<<7)|((cp)->control[40]))
156#define SNDRV_GM_PAN(cp) (((cp)->control[10]<<7)|((cp)->control[42]))
157#define SNDRV_GM_EXPRESSION(cp) (((cp)->control[11]<<7)|((cp)->control[43]))
158
159
160/* MIDI mode */
161#define SNDRV_MIDI_MODE_NONE 0 /* Generic midi */
162#define SNDRV_MIDI_MODE_GM 1
163#define SNDRV_MIDI_MODE_GS 2
164#define SNDRV_MIDI_MODE_XG 3
165#define SNDRV_MIDI_MODE_MT32 4
166
167/* MIDI note state */
168#define SNDRV_MIDI_NOTE_OFF 0x00
169#define SNDRV_MIDI_NOTE_ON 0x01
170#define SNDRV_MIDI_NOTE_RELEASED 0x02
171#define SNDRV_MIDI_NOTE_SOSTENUTO 0x04
172 
173#define SNDRV_MIDI_PARAM_TYPE_REGISTERED 0
174#define SNDRV_MIDI_PARAM_TYPE_NONREGISTERED 1
175
176/* SYSEX parse flag */
177enum {
178    SNDRV_MIDI_SYSEX_NOT_PARSED = 0,
179    SNDRV_MIDI_SYSEX_GM_ON,
180    SNDRV_MIDI_SYSEX_GS_ON,
181    SNDRV_MIDI_SYSEX_GS_RESET,
182    SNDRV_MIDI_SYSEX_GS_CHORUS_MODE,
183    SNDRV_MIDI_SYSEX_GS_REVERB_MODE,
184    SNDRV_MIDI_SYSEX_GS_MASTER_VOLUME,
185    SNDRV_MIDI_SYSEX_GS_PROGRAM,
186    SNDRV_MIDI_SYSEX_GS_DRUM_CHANNEL,
187    SNDRV_MIDI_SYSEX_XG_ON,
188};
189
190/* Prototypes for midi_process.c */
191void snd_midi_process_event(struct snd_midi_op *ops, struct snd_seq_event *ev,
192                struct snd_midi_channel_set *chanset);
193void snd_midi_channel_set_clear(struct snd_midi_channel_set *chset);
194struct snd_midi_channel_set *snd_midi_channel_alloc_set(int n);
195void snd_midi_channel_free_set(struct snd_midi_channel_set *chset);
196
197#endif /* __SOUND_SEQ_MIDI_EMUL_H */
198

Archive Download this file



interactive