diff options
Diffstat (limited to 'docs/source/usingmame')
-rw-r--r-- | docs/source/usingmame/defaultkeys.rst | 57 | ||||
-rw-r--r-- | docs/source/usingmame/mamemenus.rst | 120 | ||||
-rw-r--r-- | docs/source/usingmame/ui.rst | 30 |
3 files changed, 175 insertions, 32 deletions
diff --git a/docs/source/usingmame/defaultkeys.rst b/docs/source/usingmame/defaultkeys.rst index f7a7e8ba682..9892c86cb1f 100644 --- a/docs/source/usingmame/defaultkeys.rst +++ b/docs/source/usingmame/defaultkeys.rst @@ -72,13 +72,6 @@ and saving/loading save states. **Delete** Clear/reset to default when highlighting an entry on the input configuration, cheat options, and plugin options pages. -**P** - Pauses the emulated machine. -**Left Shift+P** - While paused, advances to next frame. If rewind is enabled, a new rewind - save state is also captured. -**Left Shift+~** - While paused, loads the most recent rewind save state. **F1** Power the machine on for machines that have specific power button behavior. **F2** @@ -134,18 +127,20 @@ and saving/loading save states. * **Enter** - switch to palette/colortable mode. Note: Not all systems have decoded graphics and/or tilemaps. -**Left Ctrl+F5** - Toggle Filter. - (*SDL MAME only*) -**Left Alt+Left Ctrl+F5** - Toggle HLSL Post-Processing. - (*Windows non-SDL MAME only*) +**Left Shift+F4** + While paused, loads the most recent rewind save state. +**F5** + Pauses the emulated machine. +**Left Shift+F5** + While paused, advances to next frame. If rewind is enabled, a new rewind + save state is also captured. **F6** - Toggle cheat mode. (if started with “-cheat”) -**Left Ctrl+F6** - Decrease Prescaling. -**Left Ctrl+F7** - Increase Prescaling. + Create a save state. Requires an additional keypress to identify the state, + similar to the load option above. If an existing save state is present, it + will also appear in the selection menu to allow overwriting of that save + state. +**Left Shift+F6** + Create a quick save state. **F7** Load a save state. You will be prompted to press a key or select from the menu to determine which save state you wish to load. @@ -155,16 +150,27 @@ and saving/loading save states. receive a warning that the save state may not be valid when attempting to save or load.* **Left Shift+F7** - Create a save state. Requires an additional keypress to identify the state, - similar to the load option above. If an existing save state is present, it - will also appear in the selection menu to allow overwriting of that save - state. + Load a quick save state. **F8** Decrease frame skipping on the fly. +**Left Shift+F8** + Toggle cheat mode. (if started with “-cheat”) +**Left Alt+F8** + Decrease Prescaling. + (*SDL MAME only*) **F9** Increase frame skipping on the fly. +**Left Alt+F9** + Increase Prescaling. + (*SDL MAME only*) **F10** Toggle speed throttling. +**Left Alt+F10** + Toggle HLSL Post-Processing. + (*Windows non-SDL MAME only*) +**Left Alt+F10** + Toggle Filter. + (*SDL MAME only*) **F11** Toggles speed display. **Left Shift+F11** @@ -179,14 +185,9 @@ and saving/loading save states. Begin recording AVI video. **Left Alt+F12** Take HLSL Rendered Snapshot. -**Insert** +**Insert** (Windows non-SDL MAME)/**Page Down** (SDL MAME) Fast forward. While held, runs game with throttling disabled and with the maximum frameskip. - (*Windows non-SDL MAME only*) -**Page Down** - Fast forward. While held, runs game with throttling disabled and with the - maximum frameskip. - (*SDL MAME only*) **Left Alt+Enter** Toggles between full-screen and windowed mode. **Scroll Lock**/**Forward Delete** (Mac Desktop)/**fn-Delete** (Mac Laptop) diff --git a/docs/source/usingmame/mamemenus.rst b/docs/source/usingmame/mamemenus.rst index 9bae9407acc..963bb42ecae 100644 --- a/docs/source/usingmame/mamemenus.rst +++ b/docs/source/usingmame/mamemenus.rst @@ -27,7 +27,7 @@ settings. Emulated system inputs are ignored while menus are displayed. You can still pause or resume the running system while most menus are displayed by pressing -the **Pause** key or button (**P** on the keyboard by default). +the **Pause** key or button (**F5** on the keyboard by default). If you start MAME without specifying a system on the command line, the system selection menu will be shown (assuming the @@ -110,6 +110,14 @@ Network Devices Shows the Network Devices menu, where you can set up emulated network adapters that support bridging to a host network. This item is not shown if there are no network adaptors that support bridging in the running system. +Audio Mixer + Shows the :ref:`Audio Mixer <menus-audiomixer>` menu, where you + decide how to connect your system audio inputs and outputs to the + emulated system's microphones and speakers. +Audio Effects + Shows the :ref:`Audio Effects <menus-audioeffects>` menu, which + allows to configure the audio effects applied between the emulated + system's speakers and the actual system audio outputs. Slider Controls Shows the Slider Controls menu, where you can adjust various settings, including video adjustments and individual sound channel levels. @@ -285,3 +293,113 @@ graphical form below the menu. Digital control states are either zero ID** to copy the device’s ID to the clipboard. This is useful for setting up :ref:`stable controller IDs <devicemap>` in :ref:`controller configuration files <ctrlrcfg>`. + + +.. _menus-audiomixer: + +Audio Mixer menu +---------------- + +The Audio Mixer menu allows to establish connections between emulated +speakers and microphones, and system audio inputs and outputs. It +uses the standard up/down arrows to select a device and/or current +mapping, left/right arrows to change a value (system audio port, +level, channel...) and [ ] to change column. In addition the (by +default) F key adds a full mapping, C a channel mapping, and Delete +clears a mapping. + +A full mapping sends all channels of a speaker to the appropriate(s) +channel(s) of the system output, and similarly retrieves all channels +of a microphone from the appropriate(s) input(s) of a system input. +For instance a mono speaker will send audio to both channels of a +stereo system output. + +A channel mapping maps between one channel of speaker or a microphone +and one channel of a system input or output. It can be a little +tedious, but it allows for instance to take two mono speakers and turn +it into the left and right channels of a system output, which is +useful for some cabinets. + +Every mapping has a configurable volume associated. When changing the +volume, optionally hold shift/ctrl/alt keys to adjust the step amount. + +The mapping configuration is saved in the system cfg file. + +Some OSes propose an external interface to change mappings and volumes +dynamically, for instance pipewire on linux. Mame does its best to +follow that and keep the information in the cfg file for future runs. + + +.. _menus-audioeffects: + +Audio Effects menu +------------------ + +This menu allows to configure the audio effects that are applied to +the speaker outputs between the speaker device and the audio mixer. +In other words, the output channels as seen in the audio mixer are the +outputs of the effect chains. Each speaker has an independant effect +chain applied. + +The chain itself is not configurable it is always in order: + +* Filter +* Compressor +* Reverb +* EQ + +The parameters of each are fully configurable though. A configured +parameter shows as white, a default as grey, and Clear allows to go +back to the default value. The default parameters for the chain of a +given speaker are the parameters of the Default chain, and the default +parameters of the Default chain are fixed. The default chain allows +to create a global setup that one likes and have it applied everywhere +by default. + +In addition, this menu allows to choose the resampler to use when +converting sample rates between emulated devices. The type allows to +choose between a fast, lower quality one, "LoFi", and a slow, high +quality one "HQ". The HQ resampler is configurable. The latency +indicates the max latency of the resampler, which allows better +quality when higher, the filter length balances quality and speed +where a high value is highest quality but slowest speed, and phases +balances quality and resampler creation time, with one again higher +means better but slower. + + +Filter effect +~~~~~~~~~~~~~ + +This effect proposes an order-2 high-pass and order-2 low-pass filter. +The high-pass filter allows to remove the DC offset some emulated +hardware has which can create saturation when not needed. The +low-pass filter (defaulting to off) allows to reproduce how muffled +the sound of a number of cabinets and TVs were. + +The Q factor defines how sharp the transition is, the higher the +sharper. Over 0.7 the filter starts amplifying the frequencies around +the cutoff though, which can be surprising. + + +Compression effect +~~~~~~~~~~~~~~~~~~ + +Not implemented yet. + + +Reverb effect +~~~~~~~~~~~~~ + +Not implemented yet. + + +EQ effect +~~~~~~~~~ + +The 5-band parametric equalizer allows to amplify or reduce certain +bands of frequency in the spectrum. The three middle filters, and +also the extreme ones if configured as "Peak", change frequencies +around the cutoff. The Q factor selects the sharpness of the peak, +the higher the sharper. The extreme filters in "Shelf" mode move all +the frequencies under (or over) the cutoff frequency. + diff --git a/docs/source/usingmame/ui.rst b/docs/source/usingmame/ui.rst index 60bb55618a2..94c7eba413d 100644 --- a/docs/source/usingmame/ui.rst +++ b/docs/source/usingmame/ui.rst @@ -136,9 +136,9 @@ pointing device: * Click menu items to highlight them. * Double-click menu items to select them. * Click the left- or right-pointing triangle to adjust settings. -* For menus with too many items to fit on the screen, click the upward- or - downward-pointing triangle at the top or bottom to scroll up or down by one - screen at a time. +* For menus or text boxes with too many items or lines to fit on the screen, + press on the upward- or downward-pointing triangle at the top or bottom to + scroll up or down. * Use vertical scrolling gestures to scroll menus or text boxes with too many items or lines to fit on the screen. * Click toolbar items to select them, or hover over them to see a description. @@ -148,6 +148,28 @@ combinations to the **Show/Hide Menu**, **Pause**, **UI Back** and/or **UI Cancel** inputs to make it possible to use MAME without a keyboard. +.. _ui-menus-touch: + +Using a touch screen +~~~~~~~~~~~~~~~~~~~~ + +MAME has basic support for navigating menus using a touch screen: + +* Tap menu items to highlight them. +* Double-tap menu items to select them. +* Swipe left or right (horizontally) on the highlighted menu item to adjust the + setting if applicable. +* Swipe up or down (vertically) to scroll menus or text boxes with too many + items to fit on the screen. +* For menus or text boxes with too many items or lines to fit on the screen, + press on the upward- or downward-pointing triangle at the top or bottom to + scroll up or down. + +Note that for SDL-based MAME, the +:ref:`enable_touch <mame-scommandline-enabletouch>` option must be switched on +to use touch screen support. + + .. _ui-inptcfg: Configuring inputs @@ -493,6 +515,8 @@ or info source with left/right. When focus is on the info/image tabs, left/right switch between tabs. When focus is on the image/info tabs or source, you can scroll the info using up, down, page up, page down, home and end. +You can move focus to an area by clicking on it with the middle mouse button. + .. _ui-simpleselmenu: |