zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-04-22 07:30:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

remove fluidsettings doc from manpage

Browse source 
refer to xml instead
This commit is contained in:
derselbst 2017-10-18 18:03:44 +02:00
parent 9b5a204e02
commit 69a4ce44c3
1 changed files with 1 additions and 226 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

227
doc/fluidsynth.1
View file

@ -141,232 +141,7 @@ Show version of program
Size of each audio buffer
.SH SETTINGS
All settings are non-realtime (have no effect if set after startup), except for those
indicated as realtime.
.TP
.B SYNTHESIZER
.TP
.B synth.audio\-channels INT [min=1, max=128, def=1]
Number of audio channels (DOCME!).
.TP
.B synth.audio\-groups INT [min=1, max=128, def=1]
Number of audio groups (DOCME!).
.TP
.B synth.chorus.active BOOL [def=True]
Chorus effect enable toggle.
.TP
.B synth.cpu\-cores INT [min=1, max=256, def=1]
Number of CPU cores to use for multi-core support.
.TP
.B synth.device\-id INT [min=0, max=126, def=0] REALTIME
Device ID to use for accepting incoming SYSEX messages.
.TP
.B synth.effects\-channels INT [min=2, max=2, def=2]
No effect currently.
.TP
.B synth.gain FLOAT [min=0.000, max=10.000, def=0.200] REALTIME
Master synthesizer gain.
.TP
.B synth.ladspa.active BOOL [def=False]
LADSPA subsystem enable toggle.
.TP
.B synth.midi\-channels INT [min=16, max=256, def=16]
Total MIDI channel count (must be multiple of 16).
.TP
.B synth.midi\-bank\-select STR [def='gs' vals:'gm', 'gs', 'xg', 'mma']
MIDI Bank Select message style.
.TP
.B synth.min\-note\-length INT [min=0, max=65535, def=10]
Minimum duration for note events (work around for very short percussion notes).
.TP
.B synth.overflow.age FLOAT [min=\-10000, max=10000, def=1000]
Weigthing (on overflow) for a voice's duration.
.TP
.B synth.overflow.percussion FLOAT [min=\-10000, max=10000, def=4000]
Weighting (on overflow) for a voice being on the drum channel.
.TP
.B synth.overflow.released FLOAT [min=\-10000, max=10000, def=\-2000]
Weighting (on overflow) for a voice that has been released,
i e note off and no sustain pedal.
.TP
.B synth.overflow.sustained FLOAT [min=\-10000, max=10000, def=\-1000]
Weighting (on overflow) for a voice that has been sustained,
i e note off, but sustain pedal held down.
.TP
.B synth.overflow.volume FLOAT [min=\-10000, max=10000, def=500]
Weighting (on overflow) for a voice's volume.
.TP
.B synth.parallel-render BOOL [def=True]
Enables low-latency audio rendering response, even if synth is otherwise busy.
Should always to be true for usage by fluidsynth executable.
.TP
.B synth.polyphony INT [min=1, max=65535, def=256] REALTIME
Voice polyphony count (number of simultaneous voices allowed).
.TP
.B synth.reverb.active BOOL [def=True]
Reverb effect enable toggle.
.TP
.B synth.sample\-rate FLOAT [min=22050.000, max=96000.000, def=44100.000]
Synthesizer sample rate.
.TP
.B synth.threadsafe-api BOOL [def=True]
Serializes access to the synth API.
Must always to be true for usage by fluidsynth executable.
.TP
.B synth.verbose BOOL [def=False]
Print received MIDI events to stdout.
.TP
.B synth.volenv STR [def='emu' vals:'compliant', 'emu']
Specifies the kind of volume envelope processing. This esp. influences the way fluidsynth responses to noteon velocity. The default setting 'emu' causes the envelope to be highly dynamic (i.e. compatible with the EMU10K1). Alternatively this may be set to 'compliant' for a less dynamic envelope, as it was done before fluidsynth 1.0.9.
.TP
.B GENERAL AUDIO
.TP
.B audio.driver STR
Audio driver to use. Default and valid options depend on available drivers.
.TP
.B audio.input\-channels INT [min=0, max=2, def=0]
Not used currently? (DOCME).
.TP
.B audio.output\-channels INT [min=2, max=32, def=2]
DOCME
.TP
.B audio.period\-size INT [min=64, max=8192, def=64]
Period size for audio buffers. Used by many audio drivers.
.TP
.B audio.periods INT [min=2, max=64, def=16]
Count of audio buffers. Used by many audio drivers.
.TP
.B audio.realtime\-prio INT [min=0, max=99, def=60]
Realtime priority to assign to audio thread or 0 to disable high priority scheduling.
Only used by some audio drivers (currently 'alsa' and 'oss').
.TP
.B audio.sample\-format STR [def='16bits' vals:'16bits','float']
Audio output format, to select format for those drivers which support 16 bit or floating point.
.TP
.B AUDIO DRIVER SPECIFIC
.TP
.B audio.alsa.device STR [def='default']
ALSA audio driver output device.
.TP
.B audio.coreaudio.device STR [def='default']
CoreAudio driver output device. Valid options depend on system.
.TP
.B audio.dart.device STR [def='default']
OS/2 Dart audio driver device.
.TP
.B audio.dsound.device STR [def='default']
Device to use for DirectSound driver. Valid options depend on system.
.TP
.B audio.file.endian STR [def='auto' vals:'auto','big','cpu','little']
File renderer or file driver byte order selection. 'auto' selects the default for the selected
file type. 'cpu' uses the CPU byte order. Limited to 'cpu' if no libsndfile support.
.TP
.B audio.file.format STR [def='s16' vals:'double','float','s16','s24','s32','s8','u8']
File renderer or file driver audio format. Limited to 's16' if no libsndfile support.
.TP
.B audio.file.name STR [def='fluidsynth.wav']
Output file name for file renderer or file driver.
.TP
.B audio.file.type STR [def='auto' vals:'aiff','au','auto','flac','oga','raw','wav']
Output file type for file renderer or file driver. 'auto' attempts to determine type from file
extension in audio.file.name. Limited to 'raw' if no libsndfile support. Actual options will vary
depending on libsndfile library.
.TP
.B audio.jack.autoconnect BOOL [def=False]
If enabled, then FluidSynth is automatically connected to Jack system audio output ports.
.TP
.B audio.jack.id STR [def='fluidsynth']
Client ID to use when connecting to Jack.
.TP
.B audio.jack.multi BOOL [def=False]
TRUE to enable multi-channel output.
.TP
.B audio.jack.server STR [def='']
Jack server name. Blank for default.
.TP
.B audio.oss.device STR [def='/dev/dsp']
OSS driver output device.
.TP
.B audio.portaudio.device STR [def='PortAudio Default']
PortAudio driver output device. Available options depends on system.
.TP
.B audio.pulseaudio.adjust-latency BOOL [def=True]
Increases the latency dynamically if PulseAudio suggests so.
.TP
.B audio.pulseaudio.device STR [def='default']
PulseAudio driver output device.
.TP
.B audio.pulseaudio.media-role STR [def='music']
PulseAudio media role information.
.TP
.B audio.pulseaudio.server STR [def='default']
PulseAudio driver server.
.TP
.B GENERAL MIDI
.TP
.B midi.driver STR
MIDI driver to use. Default and valid options depend on available drivers.
.TP
.B midi.realtime\-prio INT [min=0, max=99, def=50]
Realtime priority to assign to MIDI thread or 0 to disable high priority scheduling.
Only used by some MIDI drivers (currently 'alsa_seq', 'alsa_raw' and 'oss').
.TP
.B MIDI DRIVER SPECIFIC
.TP
.B midi.alsa.device STR [def='default']
ALSA raw MIDI driver device.
.TP
.B midi.alsa_seq.device STR [def='default']
ALSA sequencer MIDI driver device.
.TP
.B midi.alsa_seq.id STR [def='pid']
ALSA sequencer client ID. 'pid' will use process ID as part of the client name.
.TP
.B midi.coremidi.id STR [def='pid']
Client ID to use for CoreMIDI driver. 'pid' will use process ID as port of the client name.
.TP
.B midi.jack.id STR [def='fluidsynth-midi']
Jack MIDI driver client ID.
.TP
.B midi.jack.server STR [def='']
Jack MIDI driver server. Blank to use default.
.TP
.B midi.oss.device STR [def='/dev/midi']
OSS MIDI driver device.
.TP
.B midi.portname STR [def='']
Port name used for CoreAudio and ALSA sequencer drivers.
.TP
.B midi.winmidi.device STR [def='default']
Device for Windows MIDI driver.
.TP
.B MISCELLANEOUS
.TP
.B player.reset\-synth BOOL [def=True]
TRUE to reset synthesizer MIDI state between MIDI songs.
.TP
.B player.timing\-source STR [def='sample' vals:'sample','system']
Selects timing source for MIDI sequencer. 'system' uses the system timer. 'sample'
uses the sample clock (amount of audio output, events synchronized with audio).
.TP
.B shell.port INT [min=1, max=65535, def=9800]
Shell command server TCP/IP port number to use.
.TP
.B shell.prompt STR [def='']
Shell prompt string.
The settings to be specified with \-o are documented in the fluidsettings.xml hopefully shipped with this distribution or online at http://www.fluidsynth.org/api/fluidsettings.xml . We recommend viewing this file in a webbrowser, favourably Firefox.
.SH SHELL COMMANDS
.TP