release preparation

Author: pedrolcl

CMakeLists.txt

@@ -93,7 +93,7 @@ endif()
 
 include(GNUInstallDirs)
 
-# set(PROJECT_RELEASE_DATE "April 13, 2025")
+set(PROJECT_RELEASE_DATE "December 30, 2025")
 
 if (BUILD_TESTING)
     find_package(GTest CONFIG)

README.md

@@ -72,7 +72,7 @@ You can use the program to listen MIDI files or to create audio files (like MP3
 
 ~~~
 $ ./sonivoxrender -h
-Usage: ./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] file.mid ...
+Usage: ./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] file.mid ...
 Render standard MIDI files into raw PCM audio.
 Options:
         -h, --help              this help message.
@@ -87,6 +87,7 @@ Options:
         -V, --Verbosity n       Verbosity: 0=no, 1=fatals, 2=errors, 3=warnings, 4=infos, 5=details
         -R, --reverb-post-mix   ignore CC91 reverb send.
         -C, --chorus-post-mix   ignore CC93 chorus send.
+        -s, --sndlib n		sound engine library: 1=wt, 2=fm, 3=hybrid.
 ~~~
 
 The following examples assume the default option USE_44KHZ=ON:

example/sonivoxrender.1

@@ -1,88 +1,90 @@
-.\" Automatically generated by Pandoc 3.8.1
+.\" Automatically generated by Pandoc 2.14.0.3
 .\"
-.TH "SONIVOXRENDER" "1" "April 13, 2025" "sonivox 4.0.0.0" "Sonivox MIDI File Renderer"
+.TH "SONIVOXRENDER" "1" "December 30, 2025" "sonivox 4.0.0.0" "Sonivox MIDI File Renderer"
+.hy
 .SH NAME
-\f[B]sonivoxrender\f[R] \(em Render standard MIDI files into raw PCM
+.PP
+\f[B]sonivoxrender\f[R] \[em] Render standard MIDI 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]] [\f[B]\-d|\-\-dls\f[R] \f[I]soundfont\f[R]]
-[\f[B]\-r|\-\-reverb\f[R] \f[I]0..4\f[R]] [\f[B]\-w|\-\-wet\f[R]
-\f[I]0..32767\f[R]] [\f[B]\-n|\-\-dry\f[R] \f[I]0..32767\f[R]]
-[\f[B]\-c|\-\-chorus\f[R] \f[I]0..4\f[R]] [\f[B]\-l|\-\-level\f[R]
-\f[I]0..32767\f[R]] [\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[B]sonivoxrender\f[R] [\f[B]-h|--help\f[R]] [\f[B]-v|--version\f[R]]
+[\f[B]-d|--dls\f[R] \f[I]soundfont\f[R]] [\f[B]-r|--reverb\f[R]
+\f[I]0..4\f[R]] [\f[B]-w|--wet\f[R] \f[I]0..32767\f[R]]
+[\f[B]-n|--dry\f[R] \f[I]0..32767\f[R]] [\f[B]-c|--chorus\f[R]
+\f[I]0..4\f[R]] [\f[B]-l|--level\f[R] \f[I]0..32767\f[R]]
+[\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]
 .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.
 .SS Options
 .TP
-\-h, \-\-help
+-h, --help
 Prints brief usage information.
 .TP
-\-v, \-\-version
+-v, --version
 Prints the version numbers.
 .TP
-\-d, \-\-dls \f[I]soundfont\f[R]
+-d, --dls \f[I]soundfont\f[R]
 Optional DLS or SF2 soundfont file name.
 If not provided, it uses an internal embedded soundfont.
 .TP
-\-r, \-\-reverb \f[I]reverb_preset\f[R]
+-r, --reverb \f[I]reverb_preset\f[R]
 Reverb preset between 0 and 4: 0=no, 1=large hall, 2=hall, 3=chamber,
 4=room.
 .TP
-\-w, \-\-wet \f[I]reverb_wet\f[R]
+-w, --wet \f[I]reverb_wet\f[R]
 Reverb wet level between 0 and 32767.
 .TP
-\-n, \-\-dry \f[I]reverb_dry\f[R]
+-n, --dry \f[I]reverb_dry\f[R]
 Reverb dry level between 0 and 32767.
 .TP
-\-c, \-\-chorus \f[I]chorus_preset\f[R]
+-c, --chorus \f[I]chorus_preset\f[R]
 Chorus preset between 0 and 4: 0=no, 1..4=presets.
 .TP
-\-l, \-\-level \f[I]chorus_level\f[R]
+-l, --level \f[I]chorus_level\f[R]
 Chorus level between 0 and 32767.
 .TP
-\-g, \-\-gain \f[I]master_gain\f[R]
+-g, --gain \f[I]master_gain\f[R]
 Master gain between 0 and 196, default is 100 (+0dB).
 The number is relative to 100, in 1dB increments, e.g.\ 120 = +20dB, 80
-= \-20dB.
+= -20dB.
 .TP
-\-V, \-\-Verbosity \f[I]verbosity\f[R]
+-V, --Verbosity \f[I]verbosity\f[R]
 Verbosity level between 0 and 5, where 0=no, 1..5=severity levels.
 .TP
-\-R, \-\-reverb\-post\-mix
+-R, --reverb-post-mix
 Ignore CC91 reverb send level.
 The reverb effect will apply to mixed output audio, which is the old
 behavior.
 .TP
-\-C, \-\-chorus\-post\-mix
+-C, --chorus-post-mix
 Ignore CC93 chorus send level.
-See also \f[B]\-\-reverb\-post\-mix\f[R].
+See also \f[B]--reverb-post-mix\f[R].
 .TP
-\-s, \-\-sndlib \f[I]index\f[R]
+-s, --sndlib \f[I]index\f[R]
 EAS sound library to use:
 .RS
-.IP \(bu 2
-1: wt_200k_G (default) \- WT\-only bank, used in Android devices.
-Also named \(lqCommon\(rq.
-Support 22050 Hz and 44100 Hz sample rates, 8\-bit and 16\-bit samples.
-.IP \(bu 2
-2: GMdblib\-3 \- FM\-only bank.
+.IP \[bu] 2
+1: wt_200k_G (default) - WT-only bank, used in Android devices.
+Also named \[lq]Common\[rq].
+Support 22050 Hz and 44100 Hz sample rates, 8-bit and 16-bit samples.
+.IP \[bu] 2
+2: GMdblib-3 - FM-only bank.
 Support all sample rates.
 Sample bit depth does not matter here.
-.IP \(bu 2
-3: hybrid_22khz_mcu \- Hybrid bank.
+.IP \[bu] 2
+3: hybrid_22khz_mcu - Hybrid bank.
 Use WT synth for drums and FM for melodic instruments.
-This bank is a combination of \f[CR]GMdblib\-3\f[R] and
-\f[CR]Sonic_20Khz_Drums\f[R].
-Support 22050 Hz sample rate and 8\-bit samples only.
+This bank is a combination of \f[C]GMdblib-3\f[R] and
+\f[C]Sonic_20Khz_Drums\f[R].
+Support 22050 Hz sample rate and 8-bit samples only.
 .PP
 \f[B]Note:\f[R] This option does not affect DLS/SF2.
 They will always use the DLS synth engine.
@@ -94,58 +96,78 @@ configuration, the program will fail with an error message.
 \f[I]midi_file\f[R]
 Input MID file name.
 .SH EXAMPLES
+.PP
 The following examples assume the default option USE_44KHZ=ON, which
 means an output sample rate = 44100 Hz.
 .PP
 Example 1: Render a MIDI file and save the rendered audio as a raw audio
 file:
 .IP
-.EX
+.nf
+\f[C]
 $ sonivoxrender ants.mid > ants.pcm
-.EE
+\f[R]
+.fi
 .PP
 Example 2: pipe the rendered audio thru the Linux ALSA \f[B]aplay\f[R]
 utility:
 .IP
-.EX
-$ sonivoxrender ants.mid | aplay \-c 2 \-f S16_LE \-r 44100
-.EE
+.nf
+\f[C]
+$ sonivoxrender ants.mid | aplay -c 2 -f S16_LE -r 44100
+\f[R]
+.fi
 .PP
 is equivalent to:
 .IP
-.EX
-$ sonivoxrender ants.mid | aplay \-f cd
-.EE
+.nf
+\f[C]
+$ sonivoxrender ants.mid | aplay -f cd
+\f[R]
+.fi
 .PP
 Example 3: pipe the rendered audio thru the \f[B]lame\f[R] utility
 creating a MP3 file:
 .IP
-.EX
-$ sonivoxrender ants.mid | lame \-r \-s 44100 \- ants.mp3
-.EE
+.nf
+\f[C]
+$ sonivoxrender ants.mid | lame -r -s 44100 - ants.mp3
+\f[R]
+.fi
 .PP
 Example 4: pipe the rendered audio thru the \f[B]sox\f[R] utility
 creating a WAV file:
 .IP
-.EX
-$ sonivoxrender ants.mid | sox \-t s16 \-c 2 \-r 44100 \- ants.wav
-.EE
+.nf
+\f[C]
+$ sonivoxrender ants.mid | sox -t s16 -c 2 -r 44100 - ants.wav
+\f[R]
+.fi
 .PP
-Example 5: pipe the rendered audio thru the PulseAudio\(cqs
+Example 5: pipe the rendered audio thru the PulseAudio\[cq]s
 \f[B]pacat\f[R] utility:
 .IP
-.EX
+.nf
+\f[C]
 $ sonivoxrender ants.mid | pacat
-.EE
+\f[R]
+.fi
+.PP
+Example 6: pipe the rendered audio thru the PipeWire\[cq]s
+\f[B]pw-play\f[R] utility:
+.IP
+.nf
+\f[C]
+$ sonivoxrender ants.mid | pw-play --rate 44100 -
+\f[R]
+.fi
 .SH BUGS
-See Tickets at GitHub \c
-.UR https://github.com/pedrolcl/sonivox/issues/
-.UE \c
+.PP
+See Tickets at GitHub <https://github.com/pedrolcl/sonivox/issues/>
 .SH LICENSE AND COPYRIGHT
+.PP
 Licensed under the Apache License, Version 2.0
 .PP
-Copyright (c) 2022\-2025 Pedro López\-Cabanillas and contributors
+Copyright (c) 2022-2025 Pedro L\['o]pez-Cabanillas and contributors
 .SH AUTHORS
-Pedro López\-Cabanillas \c
-.MT plcl@users.sf.net
-.ME \c.
+Pedro L\['o]pez-Cabanillas <plcl@users.sf.net>.

example/sonivoxrender.1.md

@@ -111,6 +111,10 @@ Example 5: pipe the rendered audio thru the PulseAudio's **pacat** utility:
 
     $ sonivoxrender ants.mid | pacat
 
+Example 6: pipe the rendered audio thru the PipeWire's **pw-play** utility:
+
+    $ sonivoxrender ants.mid | pw-play --rate 44100 -
+
 # BUGS
 
 See Tickets at GitHub <https://github.com/pedrolcl/sonivox/issues/>