sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Various minor formatting and wording fixes. Added missing description for set_oversampling

Browse source
This commit is contained in:
Ambrose Li 2024-05-26 23:35:12 -04:00 • committed by Paul Ferrand
parent e62e703505
commit e5657be03d
2 changed files with 41 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
clients/sfizz_jack.man.in
View file

@ -1,31 +1,34 @@
.TH sfizz_jack 1 "@MAN_TODAY@" "@CMAKE_PROJECT_VERSION@" "sfizz_jack man page" .TH sfizz_jack 1 "@MAN_TODAY@" "@CMAKE_PROJECT_VERSION@" "sfizz"
.SH NAME .SH NAME
sfizz_jack \- Launch a sfizz instance as a JACK client sfizz_jack \- launch a sfizz instance as a JACK client
.SH SYNOPSIS .SH SYNOPSIS
sfizz_jack [FILE] [OPTIONS...] .B sfizz_jack
[\fIFILE\fR] [\fIOPTIONS\fR...]
.SH DESCRIPTION .SH DESCRIPTION
sfizz_jack wraps the sfizz SFZ library in a JACK client that can be controlled by a text interface. sfizz_jack wraps the sfizz SFZ library in a JACK client that can be controlled by a text interface.
.SH OPTIONS .SH OPTIONS
.IP FILE .IP \fIFILE\fR
An optional SFZ file name to load at firsts An optional SFZ file name to load on startup
.IP "--client_name" .IP "\fB--client_name\fR"
Name for the JACK client Name for the JACK client
.IP "--num_voices NUMBER" .IP "\fB--num_voices\fR \fINUMBER\fR"
Change the maximum polyphony Change the maximum polyphony
.IP "--preload_size NUMBER" .IP "\fB--preload_size\fR \fINUMBER\fR"
Bytes to preload in cache for samples Bytes to preload in cache for samples
.IP "--state" .IP "\fB--state\fR"
Output the state in the JACK loop Periodically output the state of the synth
.IP "--jack_autoconnect" .IP "\fB--jack_autoconnect\fR"
Autoconnect the JACK outputs Autoconnect the JACK outputs
.SH TEXT INTERFACE .SH TEXT INTERFACE
It is possible it interact with the JACK client through the standard input. It is possible it interact with the JACK client through the standard input.
The possible commands are The possible commands are
.IP "load_instrument FILE" .IP "load_instrument \fIFILE\fR"
Load an instrument Load an instrument
.IP "set_preload_size NUMBER" .IP "set_oversampling \fINUMBER\fR"
Set the number of bytes to preload in cache for samples Change the oversampling factor
.IP "set_voices NUMBER" .IP "set_preload_size \fINUMBER\fR"
Set the number of bytes to preload in the cache for samples
.IP "set_voices \fINUMBER\fR"
Change the maximum polyphony Change the maximum polyphony
.IP quit .IP quit
Quit Quit

36
clients/sfizz_render.man.in
View file

@ -1,26 +1,36 @@
.TH sfizz_render 1 "@MAN_TODAY@" "@CMAKE_PROJECT_VERSION@" "sfizz_render man page" .TH sfizz_render 1 "@MAN_TODAY@" "@CMAKE_PROJECT_VERSION@" "sfizz"
.SH NAME .SH NAME
sfizz_render \- Render a MIDI file as a WAV file using an SFZ instrument description. sfizz_render \- render a MIDI file as a WAV file using an SFZ instrument description
.SH SYNOPSIS .SH SYNOPSIS
sfizz_render --sfz FILE --wav FILE --midi FILE [OPTIONS...] .B sfizz_render
.B --sfz
.I FILE
.B --wav
.I FILE
.B --midi
.I FILE
[\fIOPTIONS\fR...]
.SH DESCRIPTION .SH DESCRIPTION
sfizz_render wraps the sfizz SFZ library and can be used to render midi file as sound files using an SFZ description file and its associated samples. sfizz_render uses the sfizz SFZ library to render a MIDI file into a sound file using an SFZ description file and its associated samples.
.SH OPTIONS .SH OPTIONS
.IP "-b, --blocksize NUMBER" .IP "\fB-b\fR, \fB--blocksize\fR \fINUMBER\fP"
Block size for the sfizz callbacks Block size for the sfizz callbacks
.IP "-s, --samplerate NUMBER" .IP "\fB-s\fR, \fB--samplerate\fR \fINUMBER\fP"
Output sample rate Output sample rate
.IP "-q, --quality NUMBER" .IP "\fB-q\fR, \fB--quality\fR \fINUMBER\fP"
Resampling quality, like the SFZ sample_quality opcode. A value of 1 will use a linear interpolation of source samples, while higher value will use increasingly better algorithms. Resampling quality.
.IP "-p, --polyphony NUMBER" .I NUMBER
has the same meaning as the SFZ sample_quality opcode.
A value of 1 will use a linear interpolation of source samples, while higher values will use increasingly better algorithms.
.IP "\fB-p\fR, \fB--polyphony\fR \fINUMBER\fP"
Maximum polyphony Maximum polyphony
.IP "-v, --verbose" .IP "\fB-v\fR, \fB--verbose\fR"
Verbose output Verbose output
.IP "--log PREFIX" .IP "\fB--log\fR \fIPREFIX\fR"
Produce logs Produce logs
.IP "--use-eot" .IP "\fB--use-eot\fR"
End the rendering at the last End of Track Midi message End the rendering at the last End of Track Midi message
.IP "-h, --help" .IP "\fB-h\fR, \fB--help\fR"
Show help Show help
.SH SEE ALSO .SH SEE ALSO
sfizz_jack(1) sfizz_jack(1)