[linux-block.git] / include / sound / emux_synth.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __SOUND_EMUX_SYNTH_H
#define __SOUND_EMUX_SYNTH_H

/*
 *  Defines for the Emu-series WaveTable chip
 *
 *  Copyright (C) 2000 Takashi Iwai <tiwai@suse.de>
 */

#include <sound/seq_kernel.h>
#include <sound/seq_device.h>
#include <sound/soundfont.h>
#include <sound/seq_midi_emul.h>
#include <sound/seq_oss.h>
#include <sound/emux_legacy.h>
#include <sound/seq_virmidi.h>

/*
 * compile flags
 */
#define SNDRV_EMUX_USE_RAW_EFFECT

struct snd_emux;
struct snd_emux_port;
struct snd_emux_voice;
struct snd_emux_effect_table;

/*
 * operators
 */
struct snd_emux_operators {
	struct module *owner;
	struct snd_emux_voice *(*get_voice)(struct snd_emux *emu,
					    struct snd_emux_port *port);
	int (*prepare)(struct snd_emux_voice *vp);
	void (*trigger)(struct snd_emux_voice *vp);
	void (*release)(struct snd_emux_voice *vp);
	void (*update)(struct snd_emux_voice *vp, int update);
	void (*terminate)(struct snd_emux_voice *vp);
	void (*free_voice)(struct snd_emux_voice *vp);
	void (*reset)(struct snd_emux *emu, int ch);
	/* the first parameters are struct snd_emux */
	int (*sample_new)(struct snd_emux *emu, struct snd_sf_sample *sp,
			  struct snd_util_memhdr *hdr,
			  const void __user *data, long count);
	int (*sample_free)(struct snd_emux *emu, struct snd_sf_sample *sp,
			   struct snd_util_memhdr *hdr);
	void (*sample_reset)(struct snd_emux *emu);
	int (*load_fx)(struct snd_emux *emu, int type, int arg,
		       const void __user *data, long count);
	void (*sysex)(struct snd_emux *emu, char *buf, int len, int parsed,
		      struct snd_midi_channel_set *chset);
#if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
	int (*oss_ioctl)(struct snd_emux *emu, int cmd, int p1, int p2);
#endif
};


/*
 * constant values
 */
#define SNDRV_EMUX_MAX_PORTS		32	/* max # of sequencer ports */
#define SNDRV_EMUX_MAX_VOICES		64	/* max # of voices */
#define SNDRV_EMUX_MAX_MULTI_VOICES	16	/* max # of playable voices
						 * simultineously
						 */

/*
 * flags
 */
#define SNDRV_EMUX_ACCEPT_ROM		(1<<0)

/*
 * emuX wavetable
 */
struct snd_emux {

	struct snd_card *card;	/* assigned card */

	/* following should be initialized before registration */
	int max_voices;		/* Number of voices */
	int mem_size;		/* memory size (in byte) */
	int num_ports;		/* number of ports to be created */
	int pitch_shift;	/* pitch shift value (for Emu10k1) */
	struct snd_emux_operators ops;	/* operators */
	void *hw;		/* hardware */
	unsigned long flags;	/* other conditions */
	int midi_ports;		/* number of virtual midi devices */
	int midi_devidx;	/* device offset of virtual midi */
	unsigned int linear_panning: 1; /* panning is linear (sbawe = 1, emu10k1 = 0) */
	int hwdep_idx;		/* hwdep device index */
	struct snd_hwdep *hwdep;	/* hwdep device */

	/* private */
	int num_voices;		/* current number of voices */
	struct snd_sf_list *sflist;	/* root of SoundFont list */
	struct snd_emux_voice *voices;	/* Voices (EMU 'channel') */
	int use_time;	/* allocation counter */
	spinlock_t voice_lock;	/* Lock for voice access */
	struct mutex register_mutex;
	int client;		/* For the sequencer client */
	int ports[SNDRV_EMUX_MAX_PORTS];	/* The ports for this device */
	struct snd_emux_port *portptrs[SNDRV_EMUX_MAX_PORTS];
	int used;	/* use counter */
	char *name;	/* name of the device (internal) */
	struct snd_rawmidi **vmidi;
	struct timer_list tlist;	/* for pending note-offs */
	int timer_active;

	struct snd_util_memhdr *memhdr;	/* memory chunk information */

#ifdef CONFIG_SND_PROC_FS
	struct snd_info_entry *proc;
#endif

#if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
	struct snd_seq_device *oss_synth;
#endif
};


/*
 * sequencer port information
 */
struct snd_emux_port {

	struct snd_midi_channel_set chset;
	struct snd_emux *emu;

	char port_mode;			/* operation mode */
	int volume_atten;		/* emuX raw attenuation */
	unsigned long drum_flags;	/* drum bitmaps */
	int ctrls[EMUX_MD_END];		/* control parameters */
#ifdef SNDRV_EMUX_USE_RAW_EFFECT
	struct snd_emux_effect_table *effect;
#endif
#if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
	struct snd_seq_oss_arg *oss_arg;
#endif
};

/* port_mode */
#define SNDRV_EMUX_PORT_MODE_MIDI		0	/* normal MIDI port */
#define SNDRV_EMUX_PORT_MODE_OSS_SYNTH	1	/* OSS synth port */
#define SNDRV_EMUX_PORT_MODE_OSS_MIDI	2	/* OSS multi channel synth port */

/*
 * A structure to keep track of each hardware voice
 */
struct snd_emux_voice {
	int  ch;		/* Hardware channel number */

	int  state;		/* status */
#define SNDRV_EMUX_ST_OFF		0x00	/* Not playing, and inactive */
#define SNDRV_EMUX_ST_ON		0x01	/* Note on */
#define SNDRV_EMUX_ST_RELEASED 	(0x02|SNDRV_EMUX_ST_ON)	/* Note released */
#define SNDRV_EMUX_ST_SUSTAINED	(0x04|SNDRV_EMUX_ST_ON)	/* Note sustained */
#define SNDRV_EMUX_ST_STANDBY	(0x08|SNDRV_EMUX_ST_ON)	/* Waiting to be triggered */
#define SNDRV_EMUX_ST_PENDING 	(0x10|SNDRV_EMUX_ST_ON)	/* Note will be released */
#define SNDRV_EMUX_ST_LOCKED		0x100	/* Not accessible */

	unsigned int  time;	/* An allocation time */
	unsigned char note;	/* Note currently assigned to this voice */
	unsigned char key;
	unsigned char velocity;	/* Velocity of current note */

	struct snd_sf_zone *zone;	/* Zone assigned to this note */
	void *block;		/* sample block pointer (optional) */
	struct snd_midi_channel *chan;	/* Midi channel for this note */
	struct snd_emux_port *port;	/* associated port */
	struct snd_emux *emu;	/* assigned root info */
	void *hw;		/* hardware pointer (emu8000 or emu10k1) */
	unsigned long ontime;	/* jiffies at note triggered */
	
	/* Emu8k/Emu10k1 registers */
	struct soundfont_voice_info reg;

	/* additional registers */
	int avol;		/* volume attenuation */
	int acutoff;		/* cutoff target */
	int apitch;		/* pitch offset */
	int apan;		/* pan/aux pair */
	int aaux;
	int ptarget;		/* pitch target */
	int vtarget;		/* volume target */
	int ftarget;		/* filter target */

};

/*
 * update flags (can be combined)
 */
#define SNDRV_EMUX_UPDATE_VOLUME		(1<<0)
#define SNDRV_EMUX_UPDATE_PITCH		(1<<1)
#define SNDRV_EMUX_UPDATE_PAN		(1<<2)
#define SNDRV_EMUX_UPDATE_FMMOD		(1<<3)
#define SNDRV_EMUX_UPDATE_TREMFREQ	(1<<4)
#define SNDRV_EMUX_UPDATE_FM2FRQ2		(1<<5)
#define SNDRV_EMUX_UPDATE_Q		(1<<6)


#ifdef SNDRV_EMUX_USE_RAW_EFFECT
/*
 * effect table
 */
struct snd_emux_effect_table {
	/* Emu8000 specific effects */
	short val[EMUX_NUM_EFFECTS];
	unsigned char flag[EMUX_NUM_EFFECTS];
};
#endif /* SNDRV_EMUX_USE_RAW_EFFECT */


/*
 * prototypes - interface to Emu10k1 and Emu8k routines
 */
int snd_emux_new(struct snd_emux **remu);
int snd_emux_register(struct snd_emux *emu, struct snd_card *card, int index, char *name);
int snd_emux_free(struct snd_emux *emu);

/*
 * exported functions
 */
void snd_emux_terminate_all(struct snd_emux *emu);
void snd_emux_lock_voice(struct snd_emux *emu, int voice);
void snd_emux_unlock_voice(struct snd_emux *emu, int voice);

#endif /* __SOUND_EMUX_SYNTH_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	#ifndef __SOUND_EMUX_SYNTH_H
	3	#define __SOUND_EMUX_SYNTH_H
	4
	5	/*
	6	* Defines for the Emu-series WaveTable chip
	7	*
	8	* Copyright (C) 2000 Takashi Iwai <tiwai@suse.de>
1da177e4 LT	9	*/
1da177e4 LT	10
a1ce3928 DH	11	#include <sound/seq_kernel.h>
	12	#include <sound/seq_device.h>
	13	#include <sound/soundfont.h>
	14	#include <sound/seq_midi_emul.h>
a1ce3928	15	#include <sound/seq_oss.h>
a1ce3928 DH	16	#include <sound/emux_legacy.h>
a1ce3928 DH	17	#include <sound/seq_virmidi.h>
1da177e4 LT	18
	19	/*
	20	* compile flags
	21	*/
	22	#define SNDRV_EMUX_USE_RAW_EFFECT
	23
03da312a TI	24	struct snd_emux;
	25	struct snd_emux_port;
	26	struct snd_emux_voice;
	27	struct snd_emux_effect_table;
1da177e4 LT	28
	29	/*
	30	* operators
	31	*/
03da312a	32	struct snd_emux_operators {
1da177e4	33	struct module *owner;
03da312a TI	34	struct snd_emux_voice (get_voice)(struct snd_emux *emu,
	35	struct snd_emux_port *port);
	36	int (prepare)(struct snd_emux_voice vp);
	37	void (trigger)(struct snd_emux_voice vp);
	38	void (release)(struct snd_emux_voice vp);
	39	void (update)(struct snd_emux_voice vp, int update);
	40	void (terminate)(struct snd_emux_voice vp);
	41	void (free_voice)(struct snd_emux_voice vp);
	42	void (reset)(struct snd_emux emu, int ch);
	43	/* the first parameters are struct snd_emux */
	44	int (sample_new)(struct snd_emux emu, struct snd_sf_sample *sp,
	45	struct snd_util_memhdr *hdr,
	46	const void __user *data, long count);
	47	int (sample_free)(struct snd_emux emu, struct snd_sf_sample *sp,
	48	struct snd_util_memhdr *hdr);
	49	void (sample_reset)(struct snd_emux emu);
	50	int (load_fx)(struct snd_emux emu, int type, int arg,
	51	const void __user *data, long count);
	52	void (sysex)(struct snd_emux emu, char *buf, int len, int parsed,
	53	struct snd_midi_channel_set *chset);
3d774d5e	54	#if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
03da312a	55	int (oss_ioctl)(struct snd_emux emu, int cmd, int p1, int p2);
1da177e4	56	#endif
03da312a	57	};
1da177e4 LT	58
	59
	60	/*
	61	* constant values
	62	*/
	63	#define SNDRV_EMUX_MAX_PORTS 32 /* max # of sequencer ports */
	64	#define SNDRV_EMUX_MAX_VOICES 64 /* max # of voices */
	65	#define SNDRV_EMUX_MAX_MULTI_VOICES 16 /* max # of playable voices
	66	* simultineously
	67	*/
	68
	69	/*
	70	* flags
	71	*/
	72	#define SNDRV_EMUX_ACCEPT_ROM (1<<0)
	73
	74	/*
	75	* emuX wavetable
	76	*/
	77	struct snd_emux {
	78
03da312a	79	struct snd_card card; / assigned card */
1da177e4 LT	80
	81	/* following should be initialized before registration */
	82	int max_voices; /* Number of voices */
	83	int mem_size; /* memory size (in byte) */
	84	int num_ports; /* number of ports to be created */
	85	int pitch_shift; /* pitch shift value (for Emu10k1) */
03da312a	86	struct snd_emux_operators ops; /* operators */
1da177e4 LT	87	void hw; / hardware */
	88	unsigned long flags; /* other conditions */
	89	int midi_ports; /* number of virtual midi devices */
	90	int midi_devidx; /* device offset of virtual midi */
	91	unsigned int linear_panning: 1; /* panning is linear (sbawe = 1, emu10k1 = 0) */
	92	int hwdep_idx; /* hwdep device index */
03da312a	93	struct snd_hwdep hwdep; / hwdep device */
1da177e4 LT	94
	95	/* private */
	96	int num_voices; /* current number of voices */
03da312a TI	97	struct snd_sf_list sflist; / root of SoundFont list */
03da312a TI	98	struct snd_emux_voice voices; / Voices (EMU 'channel') */
1da177e4 LT	99	int use_time; /* allocation counter */
1da177e4 LT	100	spinlock_t voice_lock; /* Lock for voice access */
ef9f0a42	101	struct mutex register_mutex;
1da177e4 LT	102	int client; /* For the sequencer client */
1da177e4 LT	103	int ports[SNDRV_EMUX_MAX_PORTS]; /* The ports for this device */
03da312a	104	struct snd_emux_port *portptrs[SNDRV_EMUX_MAX_PORTS];
1da177e4 LT	105	int used; /* use counter */
1da177e4 LT	106	char name; / name of the device (internal) */
03da312a	107	struct snd_rawmidi **vmidi;
1da177e4 LT	108	struct timer_list tlist; /* for pending note-offs */
	109	int timer_active;
	110
03da312a	111	struct snd_util_memhdr memhdr; / memory chunk information */
1da177e4	112
52262b4a	113	#ifdef CONFIG_SND_PROC_FS
03da312a	114	struct snd_info_entry *proc;
1da177e4 LT	115	#endif
1da177e4 LT	116
3d774d5e	117	#if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
03da312a	118	struct snd_seq_device *oss_synth;
1da177e4 LT	119	#endif
	120	};
	121
	122
	123	/*
	124	* sequencer port information
	125	*/
	126	struct snd_emux_port {
	127
03da312a TI	128	struct snd_midi_channel_set chset;
03da312a TI	129	struct snd_emux *emu;
1da177e4 LT	130
	131	char port_mode; /* operation mode */
	132	int volume_atten; /* emuX raw attenuation */
	133	unsigned long drum_flags; /* drum bitmaps */
	134	int ctrls[EMUX_MD_END]; /* control parameters */
	135	#ifdef SNDRV_EMUX_USE_RAW_EFFECT
03da312a	136	struct snd_emux_effect_table *effect;
1da177e4	137	#endif
3d774d5e	138	#if IS_ENABLED(CONFIG_SND_SEQUENCER_OSS)
03da312a	139	struct snd_seq_oss_arg *oss_arg;
1da177e4 LT	140	#endif
	141	};
	142
	143	/* port_mode */
	144	#define SNDRV_EMUX_PORT_MODE_MIDI 0 /* normal MIDI port */
	145	#define SNDRV_EMUX_PORT_MODE_OSS_SYNTH 1 /* OSS synth port */
	146	#define SNDRV_EMUX_PORT_MODE_OSS_MIDI 2 /* OSS multi channel synth port */
	147
	148	/*
	149	* A structure to keep track of each hardware voice
	150	*/
	151	struct snd_emux_voice {
	152	int ch; /* Hardware channel number */
	153
	154	int state; /* status */
	155	#define SNDRV_EMUX_ST_OFF 0x00 /* Not playing, and inactive */
	156	#define SNDRV_EMUX_ST_ON 0x01 /* Note on */
	157	#define SNDRV_EMUX_ST_RELEASED (0x02\|SNDRV_EMUX_ST_ON) /* Note released */
	158	#define SNDRV_EMUX_ST_SUSTAINED (0x04\|SNDRV_EMUX_ST_ON) /* Note sustained */
	159	#define SNDRV_EMUX_ST_STANDBY (0x08\|SNDRV_EMUX_ST_ON) /* Waiting to be triggered */
	160	#define SNDRV_EMUX_ST_PENDING (0x10\|SNDRV_EMUX_ST_ON) /* Note will be released */
	161	#define SNDRV_EMUX_ST_LOCKED 0x100 /* Not accessible */
	162
	163	unsigned int time; /* An allocation time */
	164	unsigned char note; /* Note currently assigned to this voice */
	165	unsigned char key;
	166	unsigned char velocity; /* Velocity of current note */
	167
03da312a	168	struct snd_sf_zone zone; / Zone assigned to this note */
1da177e4	169	void block; / sample block pointer (optional) */
03da312a TI	170	struct snd_midi_channel chan; / Midi channel for this note */
	171	struct snd_emux_port port; / associated port */
	172	struct snd_emux emu; / assigned root info */
	173	void hw; / hardware pointer (emu8000 or emu10k1) */
1da177e4 LT	174	unsigned long ontime; /* jiffies at note triggered */
	175
	176	/* Emu8k/Emu10k1 registers */
03da312a	177	struct soundfont_voice_info reg;
1da177e4 LT	178
	179	/* additional registers */
	180	int avol; /* volume attenuation */
	181	int acutoff; /* cutoff target */
	182	int apitch; /* pitch offset */
	183	int apan; /* pan/aux pair */
	184	int aaux;
	185	int ptarget; /* pitch target */
	186	int vtarget; /* volume target */
	187	int ftarget; /* filter target */
	188
	189	};
	190
	191	/*
	192	* update flags (can be combined)
	193	*/
	194	#define SNDRV_EMUX_UPDATE_VOLUME (1<<0)
	195	#define SNDRV_EMUX_UPDATE_PITCH (1<<1)
	196	#define SNDRV_EMUX_UPDATE_PAN (1<<2)
	197	#define SNDRV_EMUX_UPDATE_FMMOD (1<<3)
	198	#define SNDRV_EMUX_UPDATE_TREMFREQ (1<<4)
	199	#define SNDRV_EMUX_UPDATE_FM2FRQ2 (1<<5)
	200	#define SNDRV_EMUX_UPDATE_Q (1<<6)
	201
	202
	203	#ifdef SNDRV_EMUX_USE_RAW_EFFECT
	204	/*
	205	* effect table
	206	*/
	207	struct snd_emux_effect_table {
	208	/* Emu8000 specific effects */
	209	short val[EMUX_NUM_EFFECTS];
	210	unsigned char flag[EMUX_NUM_EFFECTS];
	211	};
	212	#endif /* SNDRV_EMUX_USE_RAW_EFFECT */
	213
	214
	215	/*
	216	* prototypes - interface to Emu10k1 and Emu8k routines
	217	*/
03da312a TI	218	int snd_emux_new(struct snd_emux **remu);
	219	int snd_emux_register(struct snd_emux emu, struct snd_card card, int index, char *name);
	220	int snd_emux_free(struct snd_emux *emu);
1da177e4 LT	221
	222	/*
	223	* exported functions
	224	*/
03da312a TI	225	void snd_emux_terminate_all(struct snd_emux *emu);
	226	void snd_emux_lock_voice(struct snd_emux *emu, int voice);
	227	void snd_emux_unlock_voice(struct snd_emux *emu, int voice);
1da177e4 LT	228
1da177e4 LT	229	#endif /* __SOUND_EMUX_SYNTH_H */