Skip to content

update man page #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rsp4jack merged 1 commit into from
Feb 13, 2026
Merged

update man page #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions example/sonivoxrender.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
.\" Automatically generated by Pandoc 2.14.0.3
.\"
.TH "SONIVOXRENDER" "1" "December 30, 2025" "sonivox 4.0.0.0" "Sonivox MIDI File Renderer"
.TH "SONIVOXRENDER" "1" "February 12, 2026" "sonivox 4.0.1.0" "Sonivox MIDI File Renderer"
.hy
.SH NAME
.PP
\f[B]sonivoxrender\f[R] \[em] Render standard MIDI files into raw PCM
audio
\f[B]sonivoxrender\f[R] \[em] Render MIDI song files into raw PCM audio
.SH SYNOPSIS
.PP
\f[B]sonivoxrender\f[R] [\f[B]-h|--help\f[R]] [\f[B]-v|--version\f[R]]
Expand All @@ -16,13 +15,14 @@ audio
[\f[B]-g|--gain\f[R] \f[I]0..196\f[R]] [\f[B]-V|--Verbosity\f[R]
\f[I]0..5\f[R]] [\f[B]-R|--reverb-post-mix\f[R]]
[\f[B]-C|--chorus-post-mix\f[R]] [\f[B]-s|--sndlib\f[R] \f[I]1..3\f[R]]
\f[I]midi_file\f[R]
\f[I]song_file\f[R]
.SH DESCRIPTION
.PP
This program is a MIDI file renderer based on the sonivox synthesizer
library.
It reads .MID (Standard MIDI Files) file format, and writes an audio
stream to the standard output as raw 16 bit stereo PCM samples.
It reads .MID (Standard MIDI Files), .RMI (RIFF-RMID), and .XMF
(Extensible Music Files) file formats, and writes an audio stream to the
standard output as raw 16 bit stereo PCM samples.
.SS Options
.TP
-h, --help
Expand Down Expand Up @@ -93,8 +93,8 @@ configuration, the program will fail with an error message.
.RE
.SS Arguments
.TP
\f[I]midi_file\f[R]
Input MID file name.
\f[I]song_file\f[R]
Input [\f[B]MID|RMI|XMF\f[R]] file name.
.SH EXAMPLES
.PP
The following examples assume the default option USE_44KHZ=ON, which
Expand Down Expand Up @@ -161,13 +161,30 @@ Example 6: pipe the rendered audio thru the PipeWire\[cq]s
$ sonivoxrender ants.mid | pw-play --rate 44100 -
\f[R]
.fi
.PP
Example 7: pipe the rendered audio thru the FFmpeg\[cq]s
\f[B]ffplay\f[R] utility:
.IP
.nf
\f[C]
$ sonivoxrender ants.mid | ffplay -i - -f s16le -ar 44.1k -ac 2 -nodisp -autoexit -loglevel quiet
\f[R]
.fi
.PP
Example 8: pipe the rendered audio thru the \f[B]mpv\f[R] media player:
.IP
.nf
\f[C]
$ sonivoxrender ants.mid | mpv --demuxer=rawaudio -demuxer-rawaudio-format=s16le --demuxer-rawaudio-rate=44100 --demuxer-rawaudio-channels=2 --no-video -
\f[R]
.fi
.SH BUGS
.PP
See Tickets at GitHub <https://github.com/pedrolcl/sonivox/issues/>
See Tickets at GitHub <https://github.com/EmbeddedSynth/sonivox/issues/>
.SH LICENSE AND COPYRIGHT
.PP
Licensed under the Apache License, Version 2.0
.PP
Copyright (c) 2022-2025 Pedro L\['o]pez-Cabanillas and contributors
Copyright (c) 2022-2026 Pedro L\['o]pez-Cabanillas and contributors
.SH AUTHORS
Pedro L\['o]pez-Cabanillas <plcl@users.sf.net>.
20 changes: 14 additions & 6 deletions example/sonivoxrender.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@

# NAME

**sonivoxrender** — Render standard MIDI files into raw PCM audio
**sonivoxrender** — Render MIDI song files into raw PCM audio

# SYNOPSIS

| **sonivoxrender** [**-h|-\-help**] [**-v|-\-version**] [**-d|-\-dls** _soundfont_] [**-r|-\-reverb** _0..4_] [**-w|-\-wet** _0..32767_] [**-n|-\-dry** _0..32767_] [**-c|-\-chorus** _0..4_] [**-l|-\-level** _0..32767_] [**-g|-\-gain** _0..196_] [**-V|-\-Verbosity** _0..5_] [**-R|-\-reverb-post-mix**] [**-C|-\-chorus-post-mix**] [**-s|-\-sndlib** _1..3_] _midi_file_
| **sonivoxrender** [**-h|-\-help**] [**-v|-\-version**] [**-d|-\-dls** _soundfont_] [**-r|-\-reverb** _0..4_] [**-w|-\-wet** _0..32767_] [**-n|-\-dry** _0..32767_] [**-c|-\-chorus** _0..4_] [**-l|-\-level** _0..32767_] [**-g|-\-gain** _0..196_] [**-V|-\-Verbosity** _0..5_] [**-R|-\-reverb-post-mix**] [**-C|-\-chorus-post-mix**] [**-s|-\-sndlib** _1..3_] _song_file_

# DESCRIPTION

This program is a MIDI file renderer based on the sonivox synthesizer library.
It reads .MID (Standard MIDI Files) file format, and writes an audio stream to the standard output as raw 16 bit stereo PCM samples.
It reads .MID (Standard MIDI Files), .RMI (RIFF-RMID), and .XMF (Extensible Music Files) file formats, and writes an audio stream to the standard output as raw 16 bit stereo PCM samples.

## Options

Expand Down Expand Up @@ -79,9 +79,9 @@ It reads .MID (Standard MIDI Files) file format, and writes an audio stream to t

## Arguments

_midi_file_
_song_file_

: Input MID file name.
: Input [**MID|RMI|XMF**] file name.

# EXAMPLES

Expand Down Expand Up @@ -115,9 +115,17 @@ Example 6: pipe the rendered audio thru the PipeWire's **pw-play** utility:

$ sonivoxrender ants.mid | pw-play --rate 44100 -

Example 7: pipe the rendered audio thru the FFmpeg's **ffplay** utility:

$ sonivoxrender ants.mid | ffplay -i - -f s16le -ar 44.1k -ac 2 -nodisp -autoexit -loglevel quiet

Example 8: pipe the rendered audio thru the **mpv** media player:

$ sonivoxrender ants.mid | mpv --demuxer=rawaudio -demuxer-rawaudio-format=s16le --demuxer-rawaudio-rate=44100 --demuxer-rawaudio-channels=2 --no-video -

# BUGS

See Tickets at GitHub <https://github.com/EnbeddedSynth/sonivox/issues/>
See Tickets at GitHub <https://github.com/EmbeddedSynth/sonivox/issues/>

# LICENSE AND COPYRIGHT

Expand Down