Skip to content

Commit 0f997c3

Browse files
committed
update man page
1 parent 739bbd5 commit 0f997c3

2 files changed

Lines changed: 41 additions & 16 deletions

File tree

example/sonivoxrender.1

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
.\" Automatically generated by Pandoc 2.14.0.3
22
.\"
3-
.TH "SONIVOXRENDER" "1" "December 30, 2025" "sonivox 4.0.0.0" "Sonivox MIDI File Renderer"
3+
.TH "SONIVOXRENDER" "1" "February 12, 2026" "sonivox 4.0.1.0" "Sonivox MIDI File Renderer"
44
.hy
55
.SH NAME
66
.PP
7-
\f[B]sonivoxrender\f[R] \[em] Render standard MIDI files into raw PCM
8-
audio
7+
\f[B]sonivoxrender\f[R] \[em] Render MIDI song files into raw PCM audio
98
.SH SYNOPSIS
109
.PP
1110
\f[B]sonivoxrender\f[R] [\f[B]-h|--help\f[R]] [\f[B]-v|--version\f[R]]
@@ -16,13 +15,14 @@ audio
1615
[\f[B]-g|--gain\f[R] \f[I]0..196\f[R]] [\f[B]-V|--Verbosity\f[R]
1716
\f[I]0..5\f[R]] [\f[B]-R|--reverb-post-mix\f[R]]
1817
[\f[B]-C|--chorus-post-mix\f[R]] [\f[B]-s|--sndlib\f[R] \f[I]1..3\f[R]]
19-
\f[I]midi_file\f[R]
18+
\f[I]song_file\f[R]
2019
.SH DESCRIPTION
2120
.PP
2221
This program is a MIDI file renderer based on the sonivox synthesizer
2322
library.
24-
It reads .MID (Standard MIDI Files) file format, and writes an audio
25-
stream to the standard output as raw 16 bit stereo PCM samples.
23+
It reads .MID (Standard MIDI Files), .RMI (RIFF-RMID), and .XMF
24+
(Extensible Music Files) file formats, and writes an audio stream to the
25+
standard output as raw 16 bit stereo PCM samples.
2626
.SS Options
2727
.TP
2828
-h, --help
@@ -93,8 +93,8 @@ configuration, the program will fail with an error message.
9393
.RE
9494
.SS Arguments
9595
.TP
96-
\f[I]midi_file\f[R]
97-
Input MID file name.
96+
\f[I]song_file\f[R]
97+
Input [\f[B]MID|RMI|XMF\f[R]] file name.
9898
.SH EXAMPLES
9999
.PP
100100
The following examples assume the default option USE_44KHZ=ON, which
@@ -161,13 +161,30 @@ Example 6: pipe the rendered audio thru the PipeWire\[cq]s
161161
$ sonivoxrender ants.mid | pw-play --rate 44100 -
162162
\f[R]
163163
.fi
164+
.PP
165+
Example 7: pipe the rendered audio thru the FFmpeg\[cq]s
166+
\f[B]ffplay\f[R] utility:
167+
.IP
168+
.nf
169+
\f[C]
170+
$ sonivoxrender ants.mid | ffplay -i - -f s16le -ar 44.1k -ac 2 -nodisp -autoexit -loglevel quiet
171+
\f[R]
172+
.fi
173+
.PP
174+
Example 8: pipe the rendered audio thru the \f[B]mpv\f[R] media player:
175+
.IP
176+
.nf
177+
\f[C]
178+
$ sonivoxrender ants.mid | mpv --demuxer=rawaudio -demuxer-rawaudio-format=s16le --demuxer-rawaudio-rate=44100 --demuxer-rawaudio-channels=2 --no-video -
179+
\f[R]
180+
.fi
164181
.SH BUGS
165182
.PP
166-
See Tickets at GitHub <https://github.com/pedrolcl/sonivox/issues/>
183+
See Tickets at GitHub <https://github.com/EmbeddedSynth/sonivox/issues/>
167184
.SH LICENSE AND COPYRIGHT
168185
.PP
169186
Licensed under the Apache License, Version 2.0
170187
.PP
171-
Copyright (c) 2022-2025 Pedro L\['o]pez-Cabanillas and contributors
188+
Copyright (c) 2022-2026 Pedro L\['o]pez-Cabanillas and contributors
172189
.SH AUTHORS
173190
Pedro L\['o]pez-Cabanillas <plcl@users.sf.net>.

example/sonivoxrender.1.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33

44
# NAME
55

6-
**sonivoxrender** — Render standard MIDI files into raw PCM audio
6+
**sonivoxrender** — Render MIDI song files into raw PCM audio
77

88
# SYNOPSIS
99

10-
| **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_
10+
| **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_
1111

1212
# DESCRIPTION
1313

1414
This program is a MIDI file renderer based on the sonivox synthesizer library.
15-
It reads .MID (Standard MIDI Files) file format, and writes an audio stream to the standard output as raw 16 bit stereo PCM samples.
15+
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.
1616

1717
## Options
1818

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

8080
## Arguments
8181

82-
_midi_file_
82+
_song_file_
8383

84-
: Input MID file name.
84+
: Input [**MID|RMI|XMF**] file name.
8585

8686
# EXAMPLES
8787

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

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

118+
Example 7: pipe the rendered audio thru the FFmpeg's **ffplay** utility:
119+
120+
$ sonivoxrender ants.mid | ffplay -i - -f s16le -ar 44.1k -ac 2 -nodisp -autoexit -loglevel quiet
121+
122+
Example 8: pipe the rendered audio thru the **mpv** media player:
123+
124+
$ sonivoxrender ants.mid | mpv --demuxer=rawaudio -demuxer-rawaudio-format=s16le --demuxer-rawaudio-rate=44100 --demuxer-rawaudio-channels=2 --no-video -
125+
118126
# BUGS
119127

120-
See Tickets at GitHub <https://github.com/EnbeddedSynth/sonivox/issues/>
128+
See Tickets at GitHub <https://github.com/EmbeddedSynth/sonivox/issues/>
121129

122130
# LICENSE AND COPYRIGHT
123131

0 commit comments

Comments
 (0)