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