summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
author hap <happppp@users.noreply.github.com>2021-09-24 19:40:10 +0200
committer hap <happppp@users.noreply.github.com>2021-09-24 19:40:10 +0200
commitc9c3cac6c25d6abe80280190c3c80b146fd58d4f (patch)
tree7bfaecd27a57132b15dad0d3f0119d954ec97103 /docs
parent3a2ab1a6c6238aa2c027651ec854ade488034d43 (diff)
sound: make the compressor optional (clamp overdrive to -1.0-1.0 when off)
Diffstat (limited to 'docs')
-rw-r--r--docs/man/mame.63
-rw-r--r--docs/man/mess.63
-rw-r--r--docs/source/commandline/commandline-all.rst13
-rw-r--r--docs/source/commandline/commandline-index.rst2
4 files changed, 20 insertions, 1 deletions
diff --git a/docs/man/mame.6 b/docs/man/mame.6
index 3466ceef343..acb1d058625 100644
--- a/docs/man/mame.6
+++ b/docs/man/mame.6
@@ -938,6 +938,9 @@ cause higher audio quality but slower emulation speed. The default is
.B \-[no]samples
Use samples if available. The default is ON (\-samples).
.TP
+.B \-[no]compressor
+Use compressor for sound. The default is ON (\-compressor).
+.TP
.B \-volume, \-vol \fIvalue
Sets the startup volume. It can later be changed with the user interface
(see Keys section). The volume is an attenuation in dB: e.g.,
diff --git a/docs/man/mess.6 b/docs/man/mess.6
index ec6a16b6ab5..d39926a18cb 100644
--- a/docs/man/mess.6
+++ b/docs/man/mess.6
@@ -969,6 +969,9 @@ cause higher audio quality but slower emulation speed. The default is
.B \-[no]samples
Use samples if available. The default is ON (\-samples).
.TP
+.B \-[no]compressor
+Use compressor for sound. The default is ON (\-compressor).
+.TP
.B \-volume, \-vol \fIvalue
Sets the startup volume. It can later be changed with the user interface
(see Keys section). The volume is an attenuation in dB:
diff --git a/docs/source/commandline/commandline-all.rst b/docs/source/commandline/commandline-all.rst
index de46760271a..afe7cc2a72a 100644
--- a/docs/source/commandline/commandline-all.rst
+++ b/docs/source/commandline/commandline-all.rst
@@ -2824,6 +2824,19 @@ Core Sound Options
mame qbert -nosamples
+.. _mame-commandline-nocompressor:
+
+**-[no]compressor**
+
+ Use compressor for sound.
+
+ The default is ON (**-compressor**).
+
+ Example:
+ .. code-block:: bash
+
+ mame popeye -nocompressor
+
.. _mame-commandline-volume:
**-volume** / **-vol** *<value>*
diff --git a/docs/source/commandline/commandline-index.rst b/docs/source/commandline/commandline-index.rst
index c2cb93efbf1..b0cd9a51170 100644
--- a/docs/source/commandline/commandline-index.rst
+++ b/docs/source/commandline/commandline-index.rst
@@ -237,9 +237,9 @@ Core Video OpenGL GLSL Options
Core Sound Options
~~~~~~~~~~~~~~~~~~
-
| :ref:`samplerate <mame-commandline-samplerate>`
| :ref:`[no]samples <mame-commandline-nosamples>`
+| :ref:`[no]compressor <mame-commandline-nocompressor>`
| :ref:`volume <mame-commandline-volume>`
| :ref:`sound <mame-commandline-sound>`
| :ref:`audio_latency <mame-commandline-audiolatency>`