Quelle  emux_synth.h   Sprache: C

/* 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
 int (*get_pitch_shift)(struct snd_emux *emu);
};


/*
 * 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 */
 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 */
 const 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 */